From 5ea5af8b9e147359a1bc42fadcbda174f47c80eb Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 26 Jun 2025 09:24:47 +0000 Subject: [PATCH 01/20] Initial plan From 47b51fc5ed62e770b8f9d589002ab25004bd0137 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 26 Jun 2025 09:33:49 +0000 Subject: [PATCH 02/20] Move metadata and hosting APIs from framework to core folder Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com> --- .../hosting/assemblybindinfo-structure.md | 0 .../hosting/bucketparameters-structure.md | 0 .../hosting/callfunctionshim-function.md | 0 ...es-added-in-the-net-framework-4-and-4-5.md | 0 .../hosting/clr-hosting-interfaces.md | 0 .../hosting/clrcreateinstance-function.md | 0 .../clrcreatemanagedinstance-function.md | 0 .../hosting/clrruntimehost-coclass.md | 0 .../clsid-resolution-flags-enumeration.md | 0 .../hosting/coeeshutdowncom-function.md | 0 .../hosting/coinitializecor-function.md | 0 .../hosting/coinitializeee-function.md | 0 .../hosting/comcallunmarshal-coclass.md | 0 .../hosting/cor-gc-stat-types-enumeration.md | 0 .../hosting/cor-gc-stats-structure.md | 0 .../hosting/cor-gc-thread-stats-structure.md | 0 .../cor-gc-thread-stats-types-enumeration.md | 0 .../corbindtocurrentruntime-function.md | 0 .../hosting/corbindtoruntime-function.md | 0 .../hosting/corbindtoruntimebycfg-function.md | 0 .../hosting/corbindtoruntimeex-function.md | 0 .../hosting/corbindtoruntimehost-function.md | 0 .../hosting/cordllmain-function.md | 0 .../hosting/corexemain-function.md | 0 .../hosting/corexemain2-function.md | 0 .../hosting/corexitprocess-function.md | 0 .../hosting/corimageunloading-function.md | 0 .../hosting/corlaunchapplication-function.md | 0 .../cormarkthreadinthreadpool-function.md | 0 .../hosting/corruntimehost-coclass.md | 0 .../hosting/corvalidateimage-function.md | 0 .../hosting/couninitializecor-function.md | 0 .../hosting/couninitializeee-function.md | 0 ...edebugginginterfacefromversion-function.md | 0 .../hosting/createiceefilegen-function.md | 0 .../hosting/customdumpitem-structure.md | 0 .../deprecated-clr-hosting-functions.md | 0 ...ed-clr-hosting-interfaces-and-coclasses.md | 0 .../hosting/destroyiceefilegen-function.md | 0 .../hosting/eapicategories-enumeration.md | 0 .../hosting/ebindpolicylevels-enumeration.md | 0 .../eclrassemblyidentityflags-enumeration.md | 0 .../hosting/eclrevent-enumeration.md | 0 .../hosting/eclrfailure-enumeration.md | 0 .../hosting/eclroperation-enumeration.md | 0 .../eclrunhandledexception-enumeration.md | 0 .../hosting/econtexttype-enumeration.md | 0 .../hosting/ecustomdumpflavor-enumeration.md | 0 .../ecustomdumpitemkind-enumeration.md | 0 .../ehostapplicationpolicy-enumeration.md | 0 ...ostbindingpolicymodifyflags-enumeration.md | 0 .../einitializenewdomainflags-enumeration.md | 0 .../hosting/ememoryavailable-enumeration.md | 0 .../ememorycriticallevel-enumeration.md | 0 .../hosting/epolicyaction-enumeration.md | 0 .../esymbolreadingpolicy-enumeration.md | 0 .../hosting/etasktype-enumeration.md | 0 ...uteinappdomaincallback-function-pointer.md | 0 ...lockclrversioncallback-function-pointer.md | 0 .../hosting/getclridentitymanager-function.md | 0 .../hosting/getcorrequiredversion-function.md | 0 .../hosting/getcorsystemdirectory-function.md | 0 .../hosting/getcorversion-function.md | 0 .../hosting/getfileversion-function.md | 0 .../hosting/getrealprocaddress-function.md | 0 .../getrequestedruntimeinfo-function.md | 0 .../getrequestedruntimeversion-function.md | 0 ...equestedruntimeversionforclsid-function.md | 0 .../hosting/getversionfromprocess-function.md | 0 .../hosting/host-type-enumeration.md | 0 .../hosting/hosting-coclasses.md | 0 .../hosting/hosting-enumerations.md | 0 .../hosting-global-static-functions.md | 0 .../hosting/hosting-interfaces.md | 0 .../hosting/hosting-structures.md | 0 .../hosting/iactiononclrevent-interface.md | 0 .../iactiononclrevent-onevent-method.md | 0 .../iapartmentcallback-docallback-method.md | 0 .../hosting/iapartmentcallback-interface.md | 0 .../hosting/iappdomainbinding-interface.md | 0 .../iappdomainbinding-onappdomain-method.md | 0 .../hosting/iappdomainsetup-interface.md | 0 .../icatalogservices-autodone-method.md | 0 .../hosting/icatalogservices-interface.md | 0 .../icatalogservices-notautodone-method.md | 0 .../hosting/iceefilegen-class.md | 0 ...ourcemonitor-getcurrentallocated-method.md | 0 ...esourcemonitor-getcurrentcputime-method.md | 0 ...sourcemonitor-getcurrentsurvived-method.md | 0 .../iclrappdomainresourcemonitor-interface.md | 0 ...nager-getbindingidentityfromfile-method.md | 0 ...ger-getbindingidentityfromstream-method.md | 0 ...ager-getclrassemblyreferencelist-method.md | 0 ...etprobingassembliesfromreference-method.md | 0 ...-getreferencedassembliesfromfile-method.md | 0 ...etreferencedassembliesfromstream-method.md | 0 .../iclrassemblyidentitymanager-interface.md | 0 ...yidentitymanager-isstronglynamed-method.md | 0 .../iclrassemblyreferencelist-interface.md | 0 ...celist-isassemblyreferenceinlist-method.md | 0 ...-isstringassemblyreferenceinlist-method.md | 0 .../iclrcontrol-getclrmanager-method.md | 0 .../hosting/iclrcontrol-interface.md | 0 ...rcontrol-setappdomainmanagertype-method.md | 0 ...iclrdebugmanager-beginconnection-method.md | 0 .../iclrdebugmanager-endconnection-method.md | 0 .../iclrdebugmanager-getdacl-method.md | 0 .../hosting/iclrdebugmanager-interface.md | 0 ...rdebugmanager-isdebuggerattached-method.md | 0 ...rdebugmanager-setconnectiontasks-method.md | 0 .../iclrdebugmanager-setdacl-method.md | 0 ...ugmanager-setsymbolreadingpolicy-method.md | 0 .../hosting/iclrdomainmanager-interface.md | 0 ...nmanager-setappdomainmanagertype-method.md | 0 ...setpropertiesfordefaultappdomain-method.md | 0 ...reportingmanager-begincustomdump-method.md | 0 ...orreportingmanager-endcustomdump-method.md | 0 ...ketparametersforcurrentexception-method.md | 0 .../iclrerrorreportingmanager-interface.md | 0 .../hosting/iclrgcmanager-collect-method.md | 0 .../hosting/iclrgcmanager-getstats-method.md | 0 .../hosting/iclrgcmanager-interface.md | 0 ...iclrgcmanager-setgcstartuplimits-method.md | 0 .../hosting/iclrgcmanager2-interface.md | 0 ...rgcmanager2-setgcstartuplimitsex-method.md | 0 ...dingpolicymanager-evaluatepolicy-method.md | 0 .../iclrhostbindingpolicymanager-interface.md | 0 ...ymanager-modifyapplicationpolicy-method.md | 0 .../iclrhostprotectionmanager-interface.md | 0 ...nager-seteagerserializegrantsets-method.md | 0 ...onmanager-setprotectedcategories-method.md | 0 .../iclriocompletionmanager-interface.md | 0 ...lriocompletionmanager-oncomplete-method.md | 0 ...clrmemorynotificationcallback-interface.md | 0 ...ioncallback-onmemorynotification-method.md | 0 ...ahost-enumerateinstalledruntimes-method.md | 0 ...metahost-enumerateloadedruntimes-method.md | 0 .../iclrmetahost-exitprocess-method.md | 0 .../hosting/iclrmetahost-getruntime-method.md | 0 .../iclrmetahost-getversionfromfile-method.md | 0 .../hosting/iclrmetahost-interface.md | 0 ...host-querylegacyv2runtimebinding-method.md | 0 ...requestruntimeloadednotification-method.md | 0 ...tahostpolicy-getrequestedruntime-method.md | 0 .../hosting/iclrmetahostpolicy-interface.md | 0 .../hosting/iclroneventmanager-interface.md | 0 ...entmanager-registeractiononevent-method.md | 0 ...tmanager-unregisteractiononevent-method.md | 0 .../hosting/iclrpolicymanager-interface.md | 0 ...policymanager-setactiononfailure-method.md | 0 ...policymanager-setactionontimeout-method.md | 0 ...lrpolicymanager-setdefaultaction-method.md | 0 .../iclrpolicymanager-settimeout-method.md | 0 ...olicymanager-settimeoutandaction-method.md | 0 ...ager-setunhandledexceptionpolicy-method.md | 0 .../iclrprobingassemblyenum-get-method.md | 0 .../iclrprobingassemblyenum-interface.md | 0 .../iclrreferenceassemblyenum-get-method.md | 0 .../iclrreferenceassemblyenum-interface.md | 0 ...lrruntimehost-executeapplication-method.md | 0 ...lrruntimehost-executeinappdomain-method.md | 0 ...mehost-executeindefaultappdomain-method.md | 0 .../iclrruntimehost-getclrcontrol-method.md | 0 ...untimehost-getcurrentappdomainid-method.md | 0 .../hosting/iclrruntimehost-interface.md | 0 .../iclrruntimehost-sethostcontrol-method.md | 0 .../hosting/iclrruntimehost-start-method.md | 0 .../hosting/iclrruntimehost-stop-method.md | 0 .../iclrruntimehost-unloadappdomain-method.md | 0 ...untimeinfo-bindaslegacyv2runtime-method.md | 0 ...ntimeinfo-getdefaultstartupflags-method.md | 0 .../iclrruntimeinfo-getinterface-method.md | 0 .../iclrruntimeinfo-getprocaddress-method.md | 0 ...rruntimeinfo-getruntimedirectory-method.md | 0 ...iclrruntimeinfo-getversionstring-method.md | 0 .../hosting/iclrruntimeinfo-interface.md | 0 .../iclrruntimeinfo-isloadable-method.md | 0 .../iclrruntimeinfo-isloaded-method.md | 0 .../iclrruntimeinfo-isstarted-method.md | 0 .../iclrruntimeinfo-loaderrorstring-method.md | 0 .../iclrruntimeinfo-loadlibrary-method.md | 0 ...ntimeinfo-setdefaultstartupflags-method.md | 0 ...rongname-gethashfromassemblyfile-method.md | 0 ...ongname-gethashfromassemblyfilew-method.md | 0 .../iclrstrongname-gethashfromblob-method.md | 0 .../iclrstrongname-gethashfromfile-method.md | 0 .../iclrstrongname-gethashfromfilew-method.md | 0 ...iclrstrongname-gethashfromhandle-method.md | 0 .../hosting/iclrstrongname-interface.md | 0 ...name-strongnamecompareassemblies-method.md | 0 ...rstrongname-strongnamefreebuffer-method.md | 0 ...iclrstrongname-strongnamegetblob-method.md | 0 ...gname-strongnamegetblobfromimage-method.md | 0 ...trongname-strongnamegetpublickey-method.md | 0 ...clrstrongname-strongnamehashsize-method.md | 0 ...lrstrongname-strongnamekeydelete-method.md | 0 .../iclrstrongname-strongnamekeygen-method.md | 0 ...clrstrongname-strongnamekeygenex-method.md | 0 ...rstrongname-strongnamekeyinstall-method.md | 0 ...me-strongnamesignaturegeneration-method.md | 0 ...-strongnamesignaturegenerationex-method.md | 0 ...rongname-strongnamesignaturesize-method.md | 0 ...-strongnamesignatureverification-method.md | 0 ...trongnamesignatureverificationex-method.md | 0 ...mesignatureverificationfromimage-method.md | 0 ...name-strongnametokenfromassembly-method.md | 0 ...me-strongnametokenfromassemblyex-method.md | 0 ...ame-strongnametokenfrompublickey-method.md | 0 .../hosting/iclrstrongname2-interface.md | 0 ...anager-createrwlockowneriterator-method.md | 0 ...anager-deleterwlockowneriterator-method.md | 0 .../iclrsyncmanager-getmonitorowner-method.md | 0 ...lrsyncmanager-getrwlockownernext-method.md | 0 .../hosting/iclrsyncmanager-interface.md | 0 .../hosting/iclrtask-abort-method.md | 0 .../hosting/iclrtask-exittask-method.md | 0 .../hosting/iclrtask-getmemstats-method.md | 0 .../hosting/iclrtask-interface.md | 0 .../hosting/iclrtask-locksheld-method.md | 0 ...iclrtask-needspriorityscheduling-method.md | 0 .../hosting/iclrtask-reset-method.md | 0 .../hosting/iclrtask-rudeabort-method.md | 0 .../iclrtask-settaskidentifier-method.md | 0 .../hosting/iclrtask-switchin-method.md | 0 .../hosting/iclrtask-switchout-method.md | 0 .../hosting/iclrtask-yieldtask-method.md | 0 ...iclrtask2-beginpreventasyncabort-method.md | 0 .../iclrtask2-endpreventasyncabort-method.md | 0 .../hosting/iclrtask2-interface.md | 0 .../iclrtaskmanager-createtask-method.md | 0 .../iclrtaskmanager-getcurrenttask-method.md | 0 ...lrtaskmanager-getcurrenttasktype-method.md | 0 .../hosting/iclrtaskmanager-interface.md | 0 .../iclrtaskmanager-setlocale-method.md | 0 .../iclrtaskmanager-setuilocale-method.md | 0 .../iclrvalidator-formateventinfo-method.md | 0 .../hosting/iclrvalidator-interface.md | 0 .../hosting/iclrvalidator-validate-method.md | 0 ...uration-adddebuggerspecialthread-method.md | 0 .../hosting/icorconfiguration-interface.md | 0 ...uration-setdebuggerthreadcontrol-method.md | 0 ...orconfiguration-setgchostcontrol-method.md | 0 ...configuration-setgcthreadcontrol-method.md | 0 .../icorruntimehost-closeenum-method.md | 0 .../icorruntimehost-createdomain-method.md | 0 .../icorruntimehost-createdomainex-method.md | 0 ...corruntimehost-createdomainsetup-method.md | 0 .../icorruntimehost-createevidence-method.md | 0 ...imehost-createlogicalthreadstate-method.md | 0 .../icorruntimehost-currentdomain-method.md | 0 ...imehost-deletelogicalthreadstate-method.md | 0 .../icorruntimehost-enumdomains-method.md | 0 ...icorruntimehost-getconfiguration-method.md | 0 ...icorruntimehost-getdefaultdomain-method.md | 0 .../hosting/icorruntimehost-interface.md | 0 ...imehost-locksheldbylogicalthread-method.md | 0 .../hosting/icorruntimehost-mapfile-method.md | 0 .../icorruntimehost-nextdomain-method.md | 0 .../hosting/icorruntimehost-start-method.md | 0 .../hosting/icorruntimehost-stop-method.md | 0 ...ehost-switchinlogicalthreadstate-method.md | 0 ...host-switchoutlogicalthreadstate-method.md | 0 .../icorruntimehost-unloaddomain-method.md | 0 ...pool-corbindiocompletioncallback-method.md | 0 ...dpool-corcallorqueueuserworkitem-method.md | 0 .../icorthreadpool-corchangetimer-method.md | 0 .../icorthreadpool-corcreatetimer-method.md | 0 .../icorthreadpool-cordeletetimer-method.md | 0 ...hreadpool-corgetavailablethreads-method.md | 0 .../icorthreadpool-corgetmaxthreads-method.md | 0 ...rthreadpool-corqueueuserworkitem-method.md | 0 ...l-corregisterwaitforsingleobject-method.md | 0 .../icorthreadpool-corsetmaxthreads-method.md | 0 ...icorthreadpool-corunregisterwait-method.md | 0 .../hosting/icorthreadpool-interface.md | 0 .../hosting/idebuggerinfo-interface.md | 0 ...idebuggerinfo-isdebuggerattached-method.md | 0 .../idebuggerthreadcontrol-interface.md | 0 ...control-releaseallruntimethreads-method.md | 0 ...control-startblockingfordebugger-method.md | 0 ...trol-threadisblockingfordebugger-method.md | 0 .../hosting/igchost-collect-method.md | 0 .../hosting/igchost-getstats-method.md | 0 .../hosting/igchost-getthreadstats-method.md | 0 .../hosting/igchost-interface.md | 0 .../igchost-setgcstartuplimits-method.md | 0 .../igchost-setvirtualmemlimit-method.md | 0 .../hosting/igchost2-interface.md | 0 .../igchost2-setgcstartuplimitsex-method.md | 0 .../hosting/igchostcontrol-interface.md | 0 ...stcontrol-requestvirtualmemlimit-method.md | 0 .../hosting/igcthreadcontrol-interface.md | 0 ...gcthreadcontrol-suspensionending-method.md | 0 ...threadcontrol-suspensionstarting-method.md | 0 ...ol-threadisblockingforsuspension-method.md | 0 ...assemblymanager-getassemblystore-method.md | 0 ...anager-getnonhoststoreassemblies-method.md | 0 .../hosting/ihostassemblymanager-interface.md | 0 .../hosting/ihostassemblystore-interface.md | 0 ...ostassemblystore-provideassembly-method.md | 0 ...ihostassemblystore-providemodule-method.md | 0 .../hosting/ihostautoevent-interface.md | 0 .../hosting/ihostautoevent-set-method.md | 0 .../hosting/ihostautoevent-wait-method.md | 0 .../ihostcontrol-gethostmanager-method.md | 0 .../hosting/ihostcontrol-interface.md | 0 ...ihostcontrol-setappdomainmanager-method.md | 0 .../hosting/ihostcrst-enter-method.md | 0 .../hosting/ihostcrst-interface.md | 0 .../hosting/ihostcrst-leave-method.md | 0 .../hosting/ihostcrst-setspincount-method.md | 0 .../hosting/ihostcrst-tryenter-method.md | 0 .../hosting/ihostgcmanager-interface.md | 0 .../ihostgcmanager-suspensionending-method.md | 0 ...hostgcmanager-suspensionstarting-method.md | 0 ...er-threadisblockingforsuspension-method.md | 0 .../ihostiocompletionmanager-bind-method.md | 0 ...ionmanager-closeiocompletionport-method.md | 0 ...onmanager-createiocompletionport-method.md | 0 ...etionmanager-getavailablethreads-method.md | 0 ...ionmanager-gethostoverlappedsize-method.md | 0 ...ocompletionmanager-getmaxthreads-method.md | 0 ...ocompletionmanager-getminthreads-method.md | 0 ...manager-initializehostoverlapped-method.md | 0 .../ihostiocompletionmanager-interface.md | 0 ...anager-setclriocompletionmanager-method.md | 0 ...ocompletionmanager-setmaxthreads-method.md | 0 ...ocompletionmanager-setminthreads-method.md | 0 .../hosting/ihostmalloc-alloc-method.md | 0 .../hosting/ihostmalloc-debugalloc-method.md | 0 .../hosting/ihostmalloc-free-method.md | 0 .../hosting/ihostmalloc-interface.md | 0 .../hosting/ihostmanualevent-interface.md | 0 .../hosting/ihostmanualevent-reset-method.md | 0 .../hosting/ihostmanualevent-set-method.md | 0 .../hosting/ihostmanualevent-wait-method.md | 0 ...ager-acquiredvirtualaddressspace-method.md | 0 .../ihostmemorymanager-createmalloc-method.md | 0 ...ihostmemorymanager-getmemoryload-method.md | 0 .../hosting/ihostmemorymanager-interface.md | 0 ...manager-needsvirtualaddressspace-method.md | 0 ...gistermemorynotificationcallback-method.md | 0 ...ager-releasedvirtualaddressspace-method.md | 0 .../ihostmemorymanager-virtualalloc-method.md | 0 .../ihostmemorymanager-virtualfree-method.md | 0 ...hostmemorymanager-virtualprotect-method.md | 0 .../ihostmemorymanager-virtualquery-method.md | 0 .../hosting/ihostpolicymanager-interface.md | 0 ...ostpolicymanager-ondefaultaction-method.md | 0 .../ihostpolicymanager-onfailure-method.md | 0 .../ihostpolicymanager-ontimeout-method.md | 0 .../ihostsecuritycontext-capture-method.md | 0 .../hosting/ihostsecuritycontext-interface.md | 0 ...curitymanager-getsecuritycontext-method.md | 0 ...ymanager-impersonateloggedonuser-method.md | 0 .../hosting/ihostsecuritymanager-interface.md | 0 ...tsecuritymanager-openthreadtoken-method.md | 0 ...hostsecuritymanager-reverttoself-method.md | 0 ...curitymanager-setsecuritycontext-method.md | 0 ...stsecuritymanager-setthreadtoken-method.md | 0 .../hosting/ihostsemaphore-interface.md | 0 .../ihostsemaphore-releasesemaphore-method.md | 0 .../hosting/ihostsemaphore-wait-method.md | 0 ...ihostsyncmanager-createautoevent-method.md | 0 .../ihostsyncmanager-createcrst-method.md | 0 ...cmanager-createcrstwithspincount-method.md | 0 ...ostsyncmanager-createmanualevent-method.md | 0 ...stsyncmanager-createmonitorevent-method.md | 0 ...cmanager-createrwlockreaderevent-method.md | 0 ...cmanager-createrwlockwriterevent-method.md | 0 ...ihostsyncmanager-createsemaphore-method.md | 0 .../hosting/ihostsyncmanager-interface.md | 0 ...ostsyncmanager-setclrsyncmanager-method.md | 0 .../hosting/ihosttask-alert-method.md | 0 .../hosting/ihosttask-getpriority-method.md | 0 .../hosting/ihosttask-interface.md | 0 .../hosting/ihosttask-join-method.md | 0 .../hosting/ihosttask-setclrtask-method.md | 0 .../hosting/ihosttask-setpriority-method.md | 0 .../hosting/ihosttask-start-method.md | 0 ...ihosttaskmanager-begindelayabort-method.md | 0 ...ttaskmanager-beginthreadaffinity-method.md | 0 ...osttaskmanager-callneedshosthook-method.md | 0 .../ihosttaskmanager-createtask-method.md | 0 .../ihosttaskmanager-enddelayabort-method.md | 0 ...osttaskmanager-endthreadaffinity-method.md | 0 .../ihosttaskmanager-enterruntime-method.md | 0 .../ihosttaskmanager-getcurrenttask-method.md | 0 ...osttaskmanager-getstackguarantee-method.md | 0 .../hosting/ihosttaskmanager-interface.md | 0 .../ihosttaskmanager-leaveruntime-method.md | 0 ...ttaskmanager-reverseenterruntime-method.md | 0 ...ttaskmanager-reverseleaveruntime-method.md | 0 ...osttaskmanager-setclrtaskmanager-method.md | 0 .../ihosttaskmanager-setlocale-method.md | 0 ...osttaskmanager-setstackguarantee-method.md | 0 .../ihosttaskmanager-setuilocale-method.md | 0 .../hosting/ihosttaskmanager-sleep-method.md | 0 .../ihosttaskmanager-switchtotask-method.md | 0 ...dpoolmanager-getavailablethreads-method.md | 0 ...tthreadpoolmanager-getmaxthreads-method.md | 0 ...tthreadpoolmanager-getminthreads-method.md | 0 .../ihostthreadpoolmanager-interface.md | 0 ...eadpoolmanager-queueuserworkitem-method.md | 0 ...tthreadpoolmanager-setmaxthreads-method.md | 0 ...tthreadpoolmanager-setminthreads-method.md | 0 ...imanagedobject-getobjectidentity-method.md | 0 ...anagedobject-getserializedbuffer-method.md | 0 .../hosting/imanagedobject-interface.md | 0 .../unmanaged-api/hosting/index.md | 18 +++++++------- .../hosting/iobjecthandle-interface.md | 0 .../hosting/iobjecthandle-unwrap-method.md | 0 .../itypename-getassemblyname-method.md | 0 .../itypename-getmodifierlength-method.md | 0 .../hosting/itypename-getmodifiers-method.md | 0 .../hosting/itypename-getnamecount-method.md | 0 .../hosting/itypename-getnames-method.md | 0 .../itypename-gettypeargumentcount-method.md | 0 .../itypename-gettypearguments-method.md | 0 .../hosting/itypename-interface.md | 0 .../itypenamebuilder-addarray-method.md | 0 ...itypenamebuilder-addassemblyspec-method.md | 0 .../itypenamebuilder-addbyref-method.md | 0 .../itypenamebuilder-addname-method.md | 0 .../itypenamebuilder-addpointer-method.md | 0 .../itypenamebuilder-addszarray-method.md | 0 .../hosting/itypenamebuilder-clear-method.md | 0 ...namebuilder-closegenericargument-method.md | 0 ...amebuilder-closegenericarguments-method.md | 0 .../hosting/itypenamebuilder-interface.md | 0 ...enamebuilder-opengenericargument-method.md | 0 ...namebuilder-opengenericarguments-method.md | 0 .../itypenamebuilder-tostring-method.md | 0 ...penamefactory-gettypenamebuilder-method.md | 0 .../hosting/itypenamefactory-interface.md | 0 .../itypenamefactory-parsetypename-method.md | 0 .../ivalidator-formateventinfo-method.md | 0 .../hosting/ivalidator-interface.md | 0 .../hosting/ivalidator-validate-method.md | 0 .../hosting/loadlibraryshim-function.md | 0 .../hosting/loadstringrc-function.md | 0 .../hosting/loadstringrcex-function.md | 0 .../hosting/lockclrversion-function.md | 0 ...ped-completion-routine-function-pointer.md | 0 ...lpthread-start-routine-function-pointer.md | 0 .../hosting/malloc-type-enumeration.md | 0 .../hosting/mdainfo-structure.md | 0 .../metahost-config-flags-enumeration.md | 0 .../metahost-policy-flags-enumeration.md | 0 .../hosting/modulebindinfo-structure.md | 0 ...ework-4-hosting-global-static-functions.md | 0 .../hosting/rundll32shimw-function.md | 0 .../hosting/runtime-info-flags-enumeration.md | 0 .../hosting/stackoverflowinfo-structure.md | 0 .../hosting/stackoverflowtype-enumeration.md | 0 .../hosting/startup-flags-enumeration.md | 0 .../strongnamegetpublickeyex-method.md | 0 ...rongnamesignatureverificationex2-method.md | 0 .../unmanaged-api/hosting/toc.yml | 0 .../hosting/typenamefactory-coclass.md | 0 .../hosting/validatorflags-enumeration.md | 0 .../hosting/wait-option-enumeration.md | 0 .../waitortimercallback-function-pointer.md | 0 docs/core/unmanaged-api/index.md | 24 +++++++++++++++++++ .../metadata/assemblyflags-enumeration.md | 0 .../metadata/assemblymetadata-structure.md | 0 .../metadata/assemblyrefflags-enumeration.md | 0 .../metadata/ceesectionattr-enumeration.md | 0 .../metadata/ceesectionrelocextra-union.md | 0 .../ceesectionreloctype-enumeration.md | 0 .../metadata/coiniticor-enumeration.md | 0 .../metadata/coinitiee-enumeration.md | 0 .../metadata/cor-field-offset-structure.md | 0 .../metadata/cor-native-link-structure.md | 0 .../metadata/corargtype-enumeration.md | 0 .../metadata/corassemblyflags-enumeration.md | 0 .../corattributetargets-enumeration.md | 0 .../corcallingconvention-enumeration.md | 0 .../corcheckduplicatesfor-enumeration.md | 0 .../metadata/cordeclsecurity-enumeration.md | 0 .../metadata/corelementtype-enumeration.md | 0 .../corerrorifemitoutoforder-enumeration.md | 0 .../metadata/coreventattr-enumeration.md | 0 .../metadata/corfieldattr-enumeration.md | 0 .../metadata/corfileflags-enumeration.md | 0 .../metadata/corfilemapping-enumeration.md | 0 .../corgenericparamattr-enumeration.md | 0 .../metadata/corimportoptions-enumeration.md | 0 .../metadata/corlinkeroptions-enumeration.md | 0 .../corlocalrefpreservation-enumeration.md | 0 .../cormanifestresourceflags-enumeration.md | 0 .../metadata/cormethodattr-enumeration.md | 0 .../metadata/cormethodimpl-enumeration.md | 0 .../cormethodsemanticsattr-enumeration.md | 0 .../cornativelinkflags-enumeration.md | 0 .../metadata/cornativelinktype-enumeration.md | 0 .../metadata/cornativetype-enumeration.md | 0 ...otificationfortokenmovement-enumeration.md | 0 .../metadata/coropenflags-enumeration.md | 0 .../metadata/corparamattr-enumeration.md | 0 .../metadata/corpekind-enumeration.md | 0 .../metadata/corpinvokemap-enumeration.md | 0 .../metadata/corpropertyattr-enumeration.md | 0 .../metadata/correftodefcheck-enumeration.md | 0 .../metadata/corregflags-enumeration.md | 0 .../metadata/corsavesize-enumeration.md | 0 .../corserializationtype-enumeration.md | 0 .../metadata/corsetenc-enumeration.md | 0 .../corthreadsafetyoptions-enumeration.md | 0 .../metadata/cortokentype-enumeration.md | 0 .../metadata/cortypeattr-enumeration.md | 0 ...runmanagedcallingconvention-enumeration.md | 0 .../corvalidatormoduletype-enumeration.md | 0 .../metadata/couninitiee-enumeration.md | 0 .../metadata/cvstruct-structure.md | 0 .../iceegen-addsectionreloc-method.md | 0 .../iceegen-allocatemethodbuffer-method.md | 0 .../metadata/iceegen-computepointer-method.md | 0 .../metadata/iceegen-emitstring-method.md | 0 .../iceegen-generateceefile-method.md | 0 .../iceegen-generateceememoryimage-method.md | 0 .../metadata/iceegen-getilsection-method.md | 0 .../iceegen-getimaptokeniface-method.md | 0 .../iceegen-getmethodbuffer-method.md | 0 .../iceegen-getsectionblock-method.md | 0 .../iceegen-getsectioncreate-method.md | 0 .../iceegen-getsectiondatalen-method.md | 0 .../metadata/iceegen-getstring-method.md | 0 .../iceegen-getstringsection-method.md | 0 .../metadata/iceegen-interface.md | 0 .../iceegen-truncatesection-method.md | 0 .../metadata/ihostfilter-interface.md | 0 .../metadata/ihostfilter-marktoken-method.md | 0 .../metadata/imaptoken-interface.md | 0 .../metadata/imaptoken-map-method.md | 0 ...adataassemblyemit-defineassembly-method.md | 0 ...taassemblyemit-defineassemblyref-method.md | 0 ...aassemblyemit-defineexportedtype-method.md | 0 ...imetadataassemblyemit-definefile-method.md | 0 ...emblyemit-definemanifestresource-method.md | 0 .../imetadataassemblyemit-interface.md | 0 ...ataassemblyemit-setassemblyprops-method.md | 0 ...assemblyemit-setassemblyrefprops-method.md | 0 ...ssemblyemit-setexportedtypeprops-method.md | 0 ...etadataassemblyemit-setfileprops-method.md | 0 ...blyemit-setmanifestresourceprops-method.md | 0 ...metadataassemblyimport-closeenum-method.md | 0 ...aassemblyimport-enumassemblyrefs-method.md | 0 ...assemblyimport-enumexportedtypes-method.md | 0 ...metadataassemblyimport-enumfiles-method.md | 0 ...mblyimport-enummanifestresources-method.md | 0 ...emblyimport-findassembliesbyname-method.md | 0 ...blyimport-findexportedtypebyname-method.md | 0 ...mport-findmanifestresourcebyname-method.md | 0 ...emblyimport-getassemblyfromscope-method.md | 0 ...aassemblyimport-getassemblyprops-method.md | 0 ...semblyimport-getassemblyrefprops-method.md | 0 ...emblyimport-getexportedtypeprops-method.md | 0 ...adataassemblyimport-getfileprops-method.md | 0 ...yimport-getmanifestresourceprops-method.md | 0 .../imetadataassemblyimport-interface.md | 0 ...onverter-getmetadatafromtypeinfo-method.md | 0 ...converter-getmetadatafromtypelib-method.md | 0 ...converter-gettypelibfrommetadata-method.md | 0 .../metadata/imetadataconverter-interface.md | 0 .../imetadatadispenser-definescope-method.md | 0 .../metadata/imetadatadispenser-interface.md | 0 .../imetadatadispenser-openscope-method.md | 0 ...adatadispenser-openscopeonmemory-method.md | 0 ...metadatadispenserex-findassembly-method.md | 0 ...tadispenserex-findassemblymodule-method.md | 0 ...ispenserex-getcorsystemdirectory-method.md | 0 .../imetadatadispenserex-getoption-method.md | 0 .../imetadatadispenserex-interface.md | 0 ...dispenserex-openscopeonitypeinfo-method.md | 0 .../imetadatadispenserex-setoption-method.md | 0 ...etadataemit-applyeditandcontinue-method.md | 0 ...tadataemit-definecustomattribute-method.md | 0 .../imetadataemit-defineevent-method.md | 0 .../imetadataemit-definefield-method.md | 0 ...imetadataemit-defineimportmember-method.md | 0 .../imetadataemit-defineimporttype-method.md | 0 .../imetadataemit-definememberref-method.md | 0 .../imetadataemit-definemethod-method.md | 0 .../imetadataemit-definemethodimpl-method.md | 0 .../imetadataemit-definemoduleref-method.md | 0 .../imetadataemit-definenestedtype-method.md | 0 .../imetadataemit-defineparam-method.md | 0 ...metadataemit-definepermissionset-method.md | 0 .../imetadataemit-definepinvokemap-method.md | 0 .../imetadataemit-defineproperty-method.md | 0 ...aemit-definesecurityattributeset-method.md | 0 .../imetadataemit-definetypedef-method.md | 0 ...metadataemit-definetyperefbyname-method.md | 0 .../imetadataemit-defineuserstring-method.md | 0 .../imetadataemit-deleteclasslayout-method.md | 0 ...imetadataemit-deletefieldmarshal-method.md | 0 .../imetadataemit-deletepinvokemap-method.md | 0 .../imetadataemit-deletetoken-method.md | 0 .../imetadataemit-getsavesize-method.md | 0 .../imetadataemit-gettokenfromsig-method.md | 0 ...etadataemit-gettokenfromtypespec-method.md | 0 .../metadata/imetadataemit-interface.md | 0 .../metadata/imetadataemit-merge-method.md | 0 .../metadata/imetadataemit-mergeend-method.md | 0 .../metadata/imetadataemit-save-method.md | 0 .../imetadataemit-savetomemory-method.md | 0 .../imetadataemit-savetostream-method.md | 0 .../imetadataemit-setclasslayout-method.md | 0 ...dataemit-setcustomattributevalue-method.md | 0 .../imetadataemit-seteventprops-method.md | 0 .../imetadataemit-setfieldmarshal-method.md | 0 .../imetadataemit-setfieldprops-method.md | 0 .../imetadataemit-setfieldrva-method.md | 0 .../imetadataemit-sethandler-method.md | 0 ...imetadataemit-setmethodimplflags-method.md | 0 .../imetadataemit-setmethodprops-method.md | 0 .../imetadataemit-setmoduleprops-method.md | 0 .../imetadataemit-setparamprops-method.md | 0 .../imetadataemit-setparent-method.md | 0 ...tadataemit-setpermissionsetprops-method.md | 0 .../imetadataemit-setpinvokemap-method.md | 0 .../imetadataemit-setpropertyprops-method.md | 0 .../metadata/imetadataemit-setrva-method.md | 0 .../imetadataemit-settypedefprops-method.md | 0 ...tadataemit-translatesigwithscope-method.md | 0 ...metadataemit2-definegenericparam-method.md | 0 .../imetadataemit2-definemethodspec-method.md | 0 .../imetadataemit2-getdeltasavesize-method.md | 0 .../metadata/imetadataemit2-interface.md | 0 .../imetadataemit2-resetenclog-method.md | 0 .../imetadataemit2-savedelta-method.md | 0 ...imetadataemit2-savedeltatomemory-method.md | 0 ...imetadataemit2-savedeltatostream-method.md | 0 ...tadataemit2-setgenericparamprops-method.md | 0 .../metadata/imetadataerror-interface.md | 0 .../metadata/imetadataerror-onerror-method.md | 0 .../metadata/imetadatafilter-interface.md | 0 .../imetadatafilter-istokenmarked-method.md | 0 .../imetadatafilter-marktoken-method.md | 0 .../imetadatafilter-unmarkall-method.md | 0 .../imetadataimport-closeenum-method.md | 0 .../imetadataimport-countenum-method.md | 0 ...adataimport-enumcustomattributes-method.md | 0 .../imetadataimport-enumevents-method.md | 0 .../imetadataimport-enumfields-method.md | 0 ...etadataimport-enumfieldswithname-method.md | 0 ...etadataimport-enuminterfaceimpls-method.md | 0 .../imetadataimport-enummemberrefs-method.md | 0 .../imetadataimport-enummembers-method.md | 0 ...tadataimport-enummemberswithname-method.md | 0 .../imetadataimport-enummethodimpls-method.md | 0 .../imetadataimport-enummethods-method.md | 0 ...tadataimport-enummethodsemantics-method.md | 0 ...tadataimport-enummethodswithname-method.md | 0 .../imetadataimport-enummodulerefs-method.md | 0 .../imetadataimport-enumparams-method.md | 0 ...etadataimport-enumpermissionsets-method.md | 0 .../imetadataimport-enumproperties-method.md | 0 .../imetadataimport-enumsignatures-method.md | 0 .../imetadataimport-enumtypedefs-method.md | 0 .../imetadataimport-enumtyperefs-method.md | 0 .../imetadataimport-enumtypespecs-method.md | 0 ...dataimport-enumunresolvedmethods-method.md | 0 .../imetadataimport-enumuserstrings-method.md | 0 .../imetadataimport-findfield-method.md | 0 .../imetadataimport-findmember-method.md | 0 .../imetadataimport-findmemberref-method.md | 0 .../imetadataimport-findmethod-method.md | 0 ...metadataimport-findtypedefbyname-method.md | 0 .../imetadataimport-findtyperef-method.md | 0 .../imetadataimport-getclasslayout-method.md | 0 ...aimport-getcustomattributebyname-method.md | 0 ...taimport-getcustomattributeprops-method.md | 0 .../imetadataimport-geteventprops-method.md | 0 .../imetadataimport-getfieldmarshal-method.md | 0 .../imetadataimport-getfieldprops-method.md | 0 ...dataimport-getinterfaceimplprops-method.md | 0 .../imetadataimport-getmemberprops-method.md | 0 ...metadataimport-getmemberrefprops-method.md | 0 .../imetadataimport-getmethodprops-method.md | 0 ...etadataimport-getmethodsemantics-method.md | 0 ...etadataimport-getmodulefromscope-method.md | 0 ...metadataimport-getmodulerefprops-method.md | 0 ...imetadataimport-getnamefromtoken-method.md | 0 ...aimport-getnativecallconvfromsig-method.md | 0 ...tadataimport-getnestedclassprops-method.md | 0 ...ataimport-getparamformethodindex-method.md | 0 .../imetadataimport-getparamprops-method.md | 0 ...dataimport-getpermissionsetprops-method.md | 0 .../imetadataimport-getpinvokemap-method.md | 0 ...imetadataimport-getpropertyprops-method.md | 0 .../metadata/imetadataimport-getrva-method.md | 0 .../imetadataimport-getscopeprops-method.md | 0 .../imetadataimport-getsigfromtoken-method.md | 0 .../imetadataimport-gettypedefprops-method.md | 0 .../imetadataimport-gettyperefprops-method.md | 0 ...adataimport-gettypespecfromtoken-method.md | 0 .../imetadataimport-getuserstring-method.md | 0 .../metadata/imetadataimport-interface.md | 0 .../imetadataimport-isglobal-method.md | 0 .../imetadataimport-isvalidtoken-method.md | 0 .../imetadataimport-resetenum-method.md | 0 .../imetadataimport-resolvetyperef-method.md | 0 ...ort2-enumgenericparamconstraints-method.md | 0 ...etadataimport2-enumgenericparams-method.md | 0 ...imetadataimport2-enummethodspecs-method.md | 0 ...2-getgenericparamconstraintprops-method.md | 0 ...dataimport2-getgenericparamprops-method.md | 0 ...tadataimport2-getmethodspecprops-method.md | 0 .../imetadataimport2-getpekind-method.md | 0 ...metadataimport2-getversionstring-method.md | 0 .../metadata/imetadataimport2-interface.md | 0 .../imetadatainfo-getfilemapping-method.md | 0 .../metadata/imetadatainfo-interface.md | 0 .../imetadatatables-getblob-method.md | 0 .../imetadatatables-getblobheapsize-method.md | 0 ...metadatatables-getcodedtokeninfo-method.md | 0 .../imetadatatables-getcolumn-method.md | 0 .../imetadatatables-getcolumninfo-method.md | 0 .../imetadatatables-getguid-method.md | 0 .../imetadatatables-getguidheapsize-method.md | 0 .../imetadatatables-getnextblob-method.md | 0 .../imetadatatables-getnextguid-method.md | 0 .../imetadatatables-getnextstring-method.md | 0 ...metadatatables-getnextuserstring-method.md | 0 .../imetadatatables-getnumtables-method.md | 0 .../metadata/imetadatatables-getrow-method.md | 0 .../imetadatatables-getstring-method.md | 0 ...metadatatables-getstringheapsize-method.md | 0 .../imetadatatables-gettableindex-method.md | 0 .../imetadatatables-gettableinfo-method.md | 0 .../imetadatatables-getuserstring-method.md | 0 ...datatables-getuserstringheapsize-method.md | 0 .../metadata/imetadatatables-interface.md | 0 ...tadatatables2-getmetadatastorage-method.md | 0 ...atatables2-getmetadatastreaminfo-method.md | 0 .../metadata/imetadatatables2-interface.md | 0 .../metadata/imetadatavalidate-interface.md | 0 ...etadatavalidate-validatemetadata-method.md | 0 .../imetadatavalidate-validatorinit-method.md | 0 .../unmanaged-api/metadata/index.md | 20 +++++++++------- .../metadata/metadata-enumerations.md | 0 .../metadata-global-static-functions.md | 0 .../metadata/metadata-interfaces.md | 0 .../metadata/metadata-structures.md | 0 .../unmanaged-api/metadata/metadata-unions.md | 0 .../metadata/osinfo-structure.md | 0 .../unmanaged-api/metadata/toc.yml | 0 docs/core/unmanaged-api/toc.yml | 11 +++++++++ docs/framework/unmanaged-api/index.md | 16 +++++++------ docs/framework/unmanaged-api/toc.yml | 6 +---- 752 files changed, 66 insertions(+), 29 deletions(-) rename docs/{framework => core}/unmanaged-api/hosting/assemblybindinfo-structure.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/bucketparameters-structure.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/callfunctionshim-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/clr-hosting-interfaces.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/clrcreateinstance-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/clrcreatemanagedinstance-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/clrruntimehost-coclass.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/coeeshutdowncom-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/coinitializecor-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/coinitializeee-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/comcallunmarshal-coclass.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/cor-gc-stats-structure.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/cor-gc-thread-stats-structure.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/corbindtocurrentruntime-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/corbindtoruntime-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/corbindtoruntimebycfg-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/corbindtoruntimeex-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/corbindtoruntimehost-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/cordllmain-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/corexemain-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/corexemain2-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/corexitprocess-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/corimageunloading-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/corlaunchapplication-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/corruntimehost-coclass.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/corvalidateimage-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/couninitializecor-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/couninitializeee-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/createiceefilegen-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/customdumpitem-structure.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/deprecated-clr-hosting-functions.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/deprecated-clr-hosting-interfaces-and-coclasses.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/destroyiceefilegen-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/eapicategories-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ebindpolicylevels-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/eclrevent-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/eclrfailure-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/eclroperation-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/eclrunhandledexception-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/econtexttype-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ememoryavailable-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ememorycriticallevel-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/epolicyaction-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/etasktype-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/getclridentitymanager-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/getcorrequiredversion-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/getcorsystemdirectory-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/getcorversion-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/getfileversion-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/getrealprocaddress-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/getrequestedruntimeinfo-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/getrequestedruntimeversion-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/getversionfromprocess-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/host-type-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/hosting-coclasses.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/hosting-enumerations.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/hosting-global-static-functions.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/hosting-interfaces.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/hosting-structures.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iactiononclrevent-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iactiononclrevent-onevent-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iapartmentcallback-docallback-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iapartmentcallback-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iappdomainbinding-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iappdomainsetup-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icatalogservices-autodone-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icatalogservices-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icatalogservices-notautodone-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iceefilegen-class.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentallocated-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentcputime-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromfile-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromstream-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrassemblyidentitymanager-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrassemblyidentitymanager-isstronglynamed-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrassemblyreferencelist-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrassemblyreferencelist-isassemblyreferenceinlist-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrcontrol-getclrmanager-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrcontrol-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrdebugmanager-beginconnection-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrdebugmanager-endconnection-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrdebugmanager-getdacl-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrdebugmanager-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrdebugmanager-isdebuggerattached-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrdebugmanager-setconnectiontasks-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrdebugmanager-setdacl-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrdebugmanager-setsymbolreadingpolicy-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrdomainmanager-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrdomainmanager-setappdomainmanagertype-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrdomainmanager-setpropertiesfordefaultappdomain-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrerrorreportingmanager-begincustomdump-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrerrorreportingmanager-endcustomdump-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrerrorreportingmanager-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrgcmanager-collect-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrgcmanager-getstats-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrgcmanager-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrgcmanager2-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclriocompletionmanager-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrmetahost-getruntime-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrmetahost-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrmetahostpolicy-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclroneventmanager-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrpolicymanager-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimehost-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimehost-start-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimehost-stop-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimeinfo-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrstrongname2-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrsyncmanager-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrtask-abort-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrtask-exittask-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrtask-getmemstats-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrtask-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrtask-locksheld-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrtask-reset-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrtask-rudeabort-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrtask-switchin-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrtask-switchout-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrtask-yieldtask-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrtask2-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrtaskmanager-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrvalidator-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iclrvalidator-validate-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorconfiguration-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorruntimehost-closeenum-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorruntimehost-createdomain-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorruntimehost-createevidence-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorruntimehost-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorruntimehost-mapfile-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorruntimehost-start-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorruntimehost-stop-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/icorthreadpool-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/idebuggerinfo-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/igchost-collect-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/igchost-getstats-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/igchost-getthreadstats-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/igchost-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/igchost2-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/igchostcontrol-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/igcthreadcontrol-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostassemblymanager-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostassemblystore-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostautoevent-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostautoevent-set-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostautoevent-wait-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostcontrol-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostcrst-enter-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostcrst-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostcrst-leave-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostcrst-setspincount-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostcrst-tryenter-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostgcmanager-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostiocompletionmanager-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostmalloc-alloc-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostmalloc-free-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostmalloc-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostmanualevent-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostmanualevent-reset-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostmanualevent-set-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostmanualevent-wait-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostmemorymanager-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostpolicymanager-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostsecuritycontext-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostsecuritymanager-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostsemaphore-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostsemaphore-wait-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostsyncmanager-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttask-alert-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttask-getpriority-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttask-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttask-join-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttask-setclrtask-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttask-setpriority-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttask-start-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttaskmanager-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/imanagedobject-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/index.md (64%) rename docs/{framework => core}/unmanaged-api/hosting/iobjecthandle-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/iobjecthandle-unwrap-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypename-getassemblyname-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypename-getmodifierlength-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypename-getmodifiers-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypename-getnamecount-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypename-getnames-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypename-gettypearguments-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypename-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypenamebuilder-addarray-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypenamebuilder-addname-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypenamebuilder-clear-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypenamebuilder-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypenamebuilder-tostring-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypenamefactory-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ivalidator-formateventinfo-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ivalidator-interface.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/ivalidator-validate-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/loadlibraryshim-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/loadstringrc-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/loadstringrcex-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/lockclrversion-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/malloc-type-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/mdainfo-structure.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/metahost-config-flags-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/metahost-policy-flags-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/modulebindinfo-structure.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/net-framework-4-hosting-global-static-functions.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/rundll32shimw-function.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/runtime-info-flags-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/stackoverflowinfo-structure.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/stackoverflowtype-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/startup-flags-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/strongnamegetpublickeyex-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/toc.yml (100%) rename docs/{framework => core}/unmanaged-api/hosting/typenamefactory-coclass.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/validatorflags-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/wait-option-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/hosting/waitortimercallback-function-pointer.md (100%) create mode 100644 docs/core/unmanaged-api/index.md rename docs/{framework => core}/unmanaged-api/metadata/assemblyflags-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/assemblymetadata-structure.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/assemblyrefflags-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/ceesectionattr-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/ceesectionrelocextra-union.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/ceesectionreloctype-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/coiniticor-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/coinitiee-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/cor-field-offset-structure.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/cor-native-link-structure.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corargtype-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corassemblyflags-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corattributetargets-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corcallingconvention-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/cordeclsecurity-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corelementtype-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/coreventattr-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corfieldattr-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corfileflags-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corfilemapping-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corgenericparamattr-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corimportoptions-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corlinkeroptions-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/cormethodattr-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/cormethodimpl-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/cornativelinkflags-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/cornativelinktype-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/cornativetype-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/coropenflags-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corparamattr-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corpekind-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corpinvokemap-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corpropertyattr-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/correftodefcheck-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corregflags-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corsavesize-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corserializationtype-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corsetenc-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/cortokentype-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/cortypeattr-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/couninitiee-enumeration.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/cvstruct-structure.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/iceegen-addsectionreloc-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/iceegen-computepointer-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/iceegen-emitstring-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/iceegen-generateceefile-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/iceegen-getilsection-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/iceegen-getsectionblock-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/iceegen-getsectioncreate-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/iceegen-getstring-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/iceegen-getstringsection-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/iceegen-interface.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/iceegen-truncatesection-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/ihostfilter-interface.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/ihostfilter-marktoken-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imaptoken-interface.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imaptoken-map-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyemit-interface.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataassemblyimport-interface.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataconverter-interface.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatadispenser-definescope-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatadispenser-interface.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatadispenser-openscope-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatadispenserex-interface.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-defineevent-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-definefield-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-definememberref-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-definemethod-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-defineparam-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-defineproperty-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-definetypedef-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-deletetoken-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-getsavesize-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-interface.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-merge-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-mergeend-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-save-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-savetomemory-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-savetostream-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-seteventprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-sethandler-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-setparamprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-setparent-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-setrva-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit2-interface.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit2-savedelta-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataerror-interface.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataerror-onerror-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatafilter-interface.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatafilter-marktoken-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-closeenum-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-countenum-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-enumevents-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-enumfields-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-enummembers-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-enummethods-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-enumparams-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-enumproperties-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-findfield-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-findmember-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-findmemberref-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-findmethod-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-findtyperef-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-geteventprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getparamprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getrva-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-getuserstring-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-interface.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-isglobal-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-resetenum-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport2-getpekind-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadataimport2-interface.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatainfo-interface.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables-getblob-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables-getcolumn-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables-getguid-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables-getnextblob-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables-getnextguid-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables-getnextstring-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables-getnumtables-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables-getrow-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables-getstring-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables-gettableindex-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables-getuserstring-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables-interface.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatatables2-interface.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatavalidate-interface.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/index.md (57%) rename docs/{framework => core}/unmanaged-api/metadata/metadata-enumerations.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/metadata-global-static-functions.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/metadata-interfaces.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/metadata-structures.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/metadata-unions.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/osinfo-structure.md (100%) rename docs/{framework => core}/unmanaged-api/metadata/toc.yml (100%) create mode 100644 docs/core/unmanaged-api/toc.yml diff --git a/docs/framework/unmanaged-api/hosting/assemblybindinfo-structure.md b/docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/assemblybindinfo-structure.md rename to docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md diff --git a/docs/framework/unmanaged-api/hosting/bucketparameters-structure.md b/docs/core/unmanaged-api/hosting/bucketparameters-structure.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/bucketparameters-structure.md rename to docs/core/unmanaged-api/hosting/bucketparameters-structure.md diff --git a/docs/framework/unmanaged-api/hosting/callfunctionshim-function.md b/docs/core/unmanaged-api/hosting/callfunctionshim-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/callfunctionshim-function.md rename to docs/core/unmanaged-api/hosting/callfunctionshim-function.md diff --git a/docs/framework/unmanaged-api/hosting/clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md b/docs/core/unmanaged-api/hosting/clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md rename to docs/core/unmanaged-api/hosting/clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md diff --git a/docs/framework/unmanaged-api/hosting/clr-hosting-interfaces.md b/docs/core/unmanaged-api/hosting/clr-hosting-interfaces.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/clr-hosting-interfaces.md rename to docs/core/unmanaged-api/hosting/clr-hosting-interfaces.md diff --git a/docs/framework/unmanaged-api/hosting/clrcreateinstance-function.md b/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/clrcreateinstance-function.md rename to docs/core/unmanaged-api/hosting/clrcreateinstance-function.md diff --git a/docs/framework/unmanaged-api/hosting/clrcreatemanagedinstance-function.md b/docs/core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/clrcreatemanagedinstance-function.md rename to docs/core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md diff --git a/docs/framework/unmanaged-api/hosting/clrruntimehost-coclass.md b/docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/clrruntimehost-coclass.md rename to docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md diff --git a/docs/framework/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md b/docs/core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md rename to docs/core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/coeeshutdowncom-function.md b/docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/coeeshutdowncom-function.md rename to docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md diff --git a/docs/framework/unmanaged-api/hosting/coinitializecor-function.md b/docs/core/unmanaged-api/hosting/coinitializecor-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/coinitializecor-function.md rename to docs/core/unmanaged-api/hosting/coinitializecor-function.md diff --git a/docs/framework/unmanaged-api/hosting/coinitializeee-function.md b/docs/core/unmanaged-api/hosting/coinitializeee-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/coinitializeee-function.md rename to docs/core/unmanaged-api/hosting/coinitializeee-function.md diff --git a/docs/framework/unmanaged-api/hosting/comcallunmarshal-coclass.md b/docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/comcallunmarshal-coclass.md rename to docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md diff --git a/docs/framework/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md b/docs/core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md rename to docs/core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/cor-gc-stats-structure.md b/docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/cor-gc-stats-structure.md rename to docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md diff --git a/docs/framework/unmanaged-api/hosting/cor-gc-thread-stats-structure.md b/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/cor-gc-thread-stats-structure.md rename to docs/core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md diff --git a/docs/framework/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md b/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md rename to docs/core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/corbindtocurrentruntime-function.md b/docs/core/unmanaged-api/hosting/corbindtocurrentruntime-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/corbindtocurrentruntime-function.md rename to docs/core/unmanaged-api/hosting/corbindtocurrentruntime-function.md diff --git a/docs/framework/unmanaged-api/hosting/corbindtoruntime-function.md b/docs/core/unmanaged-api/hosting/corbindtoruntime-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/corbindtoruntime-function.md rename to docs/core/unmanaged-api/hosting/corbindtoruntime-function.md diff --git a/docs/framework/unmanaged-api/hosting/corbindtoruntimebycfg-function.md b/docs/core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/corbindtoruntimebycfg-function.md rename to docs/core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md diff --git a/docs/framework/unmanaged-api/hosting/corbindtoruntimeex-function.md b/docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/corbindtoruntimeex-function.md rename to docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md diff --git a/docs/framework/unmanaged-api/hosting/corbindtoruntimehost-function.md b/docs/core/unmanaged-api/hosting/corbindtoruntimehost-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/corbindtoruntimehost-function.md rename to docs/core/unmanaged-api/hosting/corbindtoruntimehost-function.md diff --git a/docs/framework/unmanaged-api/hosting/cordllmain-function.md b/docs/core/unmanaged-api/hosting/cordllmain-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/cordllmain-function.md rename to docs/core/unmanaged-api/hosting/cordllmain-function.md diff --git a/docs/framework/unmanaged-api/hosting/corexemain-function.md b/docs/core/unmanaged-api/hosting/corexemain-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/corexemain-function.md rename to docs/core/unmanaged-api/hosting/corexemain-function.md diff --git a/docs/framework/unmanaged-api/hosting/corexemain2-function.md b/docs/core/unmanaged-api/hosting/corexemain2-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/corexemain2-function.md rename to docs/core/unmanaged-api/hosting/corexemain2-function.md diff --git a/docs/framework/unmanaged-api/hosting/corexitprocess-function.md b/docs/core/unmanaged-api/hosting/corexitprocess-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/corexitprocess-function.md rename to docs/core/unmanaged-api/hosting/corexitprocess-function.md diff --git a/docs/framework/unmanaged-api/hosting/corimageunloading-function.md b/docs/core/unmanaged-api/hosting/corimageunloading-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/corimageunloading-function.md rename to docs/core/unmanaged-api/hosting/corimageunloading-function.md diff --git a/docs/framework/unmanaged-api/hosting/corlaunchapplication-function.md b/docs/core/unmanaged-api/hosting/corlaunchapplication-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/corlaunchapplication-function.md rename to docs/core/unmanaged-api/hosting/corlaunchapplication-function.md diff --git a/docs/framework/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md b/docs/core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md rename to docs/core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md diff --git a/docs/framework/unmanaged-api/hosting/corruntimehost-coclass.md b/docs/core/unmanaged-api/hosting/corruntimehost-coclass.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/corruntimehost-coclass.md rename to docs/core/unmanaged-api/hosting/corruntimehost-coclass.md diff --git a/docs/framework/unmanaged-api/hosting/corvalidateimage-function.md b/docs/core/unmanaged-api/hosting/corvalidateimage-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/corvalidateimage-function.md rename to docs/core/unmanaged-api/hosting/corvalidateimage-function.md diff --git a/docs/framework/unmanaged-api/hosting/couninitializecor-function.md b/docs/core/unmanaged-api/hosting/couninitializecor-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/couninitializecor-function.md rename to docs/core/unmanaged-api/hosting/couninitializecor-function.md diff --git a/docs/framework/unmanaged-api/hosting/couninitializeee-function.md b/docs/core/unmanaged-api/hosting/couninitializeee-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/couninitializeee-function.md rename to docs/core/unmanaged-api/hosting/couninitializeee-function.md diff --git a/docs/framework/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md b/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md rename to docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md diff --git a/docs/framework/unmanaged-api/hosting/createiceefilegen-function.md b/docs/core/unmanaged-api/hosting/createiceefilegen-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/createiceefilegen-function.md rename to docs/core/unmanaged-api/hosting/createiceefilegen-function.md diff --git a/docs/framework/unmanaged-api/hosting/customdumpitem-structure.md b/docs/core/unmanaged-api/hosting/customdumpitem-structure.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/customdumpitem-structure.md rename to docs/core/unmanaged-api/hosting/customdumpitem-structure.md diff --git a/docs/framework/unmanaged-api/hosting/deprecated-clr-hosting-functions.md b/docs/core/unmanaged-api/hosting/deprecated-clr-hosting-functions.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/deprecated-clr-hosting-functions.md rename to docs/core/unmanaged-api/hosting/deprecated-clr-hosting-functions.md diff --git a/docs/framework/unmanaged-api/hosting/deprecated-clr-hosting-interfaces-and-coclasses.md b/docs/core/unmanaged-api/hosting/deprecated-clr-hosting-interfaces-and-coclasses.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/deprecated-clr-hosting-interfaces-and-coclasses.md rename to docs/core/unmanaged-api/hosting/deprecated-clr-hosting-interfaces-and-coclasses.md diff --git a/docs/framework/unmanaged-api/hosting/destroyiceefilegen-function.md b/docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/destroyiceefilegen-function.md rename to docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md diff --git a/docs/framework/unmanaged-api/hosting/eapicategories-enumeration.md b/docs/core/unmanaged-api/hosting/eapicategories-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/eapicategories-enumeration.md rename to docs/core/unmanaged-api/hosting/eapicategories-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/ebindpolicylevels-enumeration.md b/docs/core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ebindpolicylevels-enumeration.md rename to docs/core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md b/docs/core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md rename to docs/core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/eclrevent-enumeration.md b/docs/core/unmanaged-api/hosting/eclrevent-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/eclrevent-enumeration.md rename to docs/core/unmanaged-api/hosting/eclrevent-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/eclrfailure-enumeration.md b/docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/eclrfailure-enumeration.md rename to docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/eclroperation-enumeration.md b/docs/core/unmanaged-api/hosting/eclroperation-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/eclroperation-enumeration.md rename to docs/core/unmanaged-api/hosting/eclroperation-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/eclrunhandledexception-enumeration.md b/docs/core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/eclrunhandledexception-enumeration.md rename to docs/core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/econtexttype-enumeration.md b/docs/core/unmanaged-api/hosting/econtexttype-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/econtexttype-enumeration.md rename to docs/core/unmanaged-api/hosting/econtexttype-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md b/docs/core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md rename to docs/core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md b/docs/core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md rename to docs/core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md b/docs/core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md rename to docs/core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md b/docs/core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md rename to docs/core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md b/docs/core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md rename to docs/core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/ememoryavailable-enumeration.md b/docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ememoryavailable-enumeration.md rename to docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/ememorycriticallevel-enumeration.md b/docs/core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ememorycriticallevel-enumeration.md rename to docs/core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/epolicyaction-enumeration.md b/docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/epolicyaction-enumeration.md rename to docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md b/docs/core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md rename to docs/core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/etasktype-enumeration.md b/docs/core/unmanaged-api/hosting/etasktype-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/etasktype-enumeration.md rename to docs/core/unmanaged-api/hosting/etasktype-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md b/docs/core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md rename to docs/core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md diff --git a/docs/framework/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md b/docs/core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md rename to docs/core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md diff --git a/docs/framework/unmanaged-api/hosting/getclridentitymanager-function.md b/docs/core/unmanaged-api/hosting/getclridentitymanager-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/getclridentitymanager-function.md rename to docs/core/unmanaged-api/hosting/getclridentitymanager-function.md diff --git a/docs/framework/unmanaged-api/hosting/getcorrequiredversion-function.md b/docs/core/unmanaged-api/hosting/getcorrequiredversion-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/getcorrequiredversion-function.md rename to docs/core/unmanaged-api/hosting/getcorrequiredversion-function.md diff --git a/docs/framework/unmanaged-api/hosting/getcorsystemdirectory-function.md b/docs/core/unmanaged-api/hosting/getcorsystemdirectory-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/getcorsystemdirectory-function.md rename to docs/core/unmanaged-api/hosting/getcorsystemdirectory-function.md diff --git a/docs/framework/unmanaged-api/hosting/getcorversion-function.md b/docs/core/unmanaged-api/hosting/getcorversion-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/getcorversion-function.md rename to docs/core/unmanaged-api/hosting/getcorversion-function.md diff --git a/docs/framework/unmanaged-api/hosting/getfileversion-function.md b/docs/core/unmanaged-api/hosting/getfileversion-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/getfileversion-function.md rename to docs/core/unmanaged-api/hosting/getfileversion-function.md diff --git a/docs/framework/unmanaged-api/hosting/getrealprocaddress-function.md b/docs/core/unmanaged-api/hosting/getrealprocaddress-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/getrealprocaddress-function.md rename to docs/core/unmanaged-api/hosting/getrealprocaddress-function.md diff --git a/docs/framework/unmanaged-api/hosting/getrequestedruntimeinfo-function.md b/docs/core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/getrequestedruntimeinfo-function.md rename to docs/core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md diff --git a/docs/framework/unmanaged-api/hosting/getrequestedruntimeversion-function.md b/docs/core/unmanaged-api/hosting/getrequestedruntimeversion-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/getrequestedruntimeversion-function.md rename to docs/core/unmanaged-api/hosting/getrequestedruntimeversion-function.md diff --git a/docs/framework/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md b/docs/core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md rename to docs/core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md diff --git a/docs/framework/unmanaged-api/hosting/getversionfromprocess-function.md b/docs/core/unmanaged-api/hosting/getversionfromprocess-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/getversionfromprocess-function.md rename to docs/core/unmanaged-api/hosting/getversionfromprocess-function.md diff --git a/docs/framework/unmanaged-api/hosting/host-type-enumeration.md b/docs/core/unmanaged-api/hosting/host-type-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/host-type-enumeration.md rename to docs/core/unmanaged-api/hosting/host-type-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/hosting-coclasses.md b/docs/core/unmanaged-api/hosting/hosting-coclasses.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/hosting-coclasses.md rename to docs/core/unmanaged-api/hosting/hosting-coclasses.md diff --git a/docs/framework/unmanaged-api/hosting/hosting-enumerations.md b/docs/core/unmanaged-api/hosting/hosting-enumerations.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/hosting-enumerations.md rename to docs/core/unmanaged-api/hosting/hosting-enumerations.md diff --git a/docs/framework/unmanaged-api/hosting/hosting-global-static-functions.md b/docs/core/unmanaged-api/hosting/hosting-global-static-functions.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/hosting-global-static-functions.md rename to docs/core/unmanaged-api/hosting/hosting-global-static-functions.md diff --git a/docs/framework/unmanaged-api/hosting/hosting-interfaces.md b/docs/core/unmanaged-api/hosting/hosting-interfaces.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/hosting-interfaces.md rename to docs/core/unmanaged-api/hosting/hosting-interfaces.md diff --git a/docs/framework/unmanaged-api/hosting/hosting-structures.md b/docs/core/unmanaged-api/hosting/hosting-structures.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/hosting-structures.md rename to docs/core/unmanaged-api/hosting/hosting-structures.md diff --git a/docs/framework/unmanaged-api/hosting/iactiononclrevent-interface.md b/docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iactiononclrevent-interface.md rename to docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iactiononclrevent-onevent-method.md b/docs/core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iactiononclrevent-onevent-method.md rename to docs/core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md diff --git a/docs/framework/unmanaged-api/hosting/iapartmentcallback-docallback-method.md b/docs/core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iapartmentcallback-docallback-method.md rename to docs/core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md diff --git a/docs/framework/unmanaged-api/hosting/iapartmentcallback-interface.md b/docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iapartmentcallback-interface.md rename to docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iappdomainbinding-interface.md b/docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iappdomainbinding-interface.md rename to docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md b/docs/core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md rename to docs/core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md diff --git a/docs/framework/unmanaged-api/hosting/iappdomainsetup-interface.md b/docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iappdomainsetup-interface.md rename to docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md diff --git a/docs/framework/unmanaged-api/hosting/icatalogservices-autodone-method.md b/docs/core/unmanaged-api/hosting/icatalogservices-autodone-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icatalogservices-autodone-method.md rename to docs/core/unmanaged-api/hosting/icatalogservices-autodone-method.md diff --git a/docs/framework/unmanaged-api/hosting/icatalogservices-interface.md b/docs/core/unmanaged-api/hosting/icatalogservices-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icatalogservices-interface.md rename to docs/core/unmanaged-api/hosting/icatalogservices-interface.md diff --git a/docs/framework/unmanaged-api/hosting/icatalogservices-notautodone-method.md b/docs/core/unmanaged-api/hosting/icatalogservices-notautodone-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icatalogservices-notautodone-method.md rename to docs/core/unmanaged-api/hosting/icatalogservices-notautodone-method.md diff --git a/docs/framework/unmanaged-api/hosting/iceefilegen-class.md b/docs/core/unmanaged-api/hosting/iceefilegen-class.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iceefilegen-class.md rename to docs/core/unmanaged-api/hosting/iceefilegen-class.md diff --git a/docs/framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentallocated-method.md b/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentallocated-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentallocated-method.md rename to docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentallocated-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentcputime-method.md b/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentcputime-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentcputime-method.md rename to docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentcputime-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md b/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md rename to docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md b/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md rename to docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromfile-method.md b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromfile-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromfile-method.md rename to docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromfile-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromstream-method.md b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromstream-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromstream-method.md rename to docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromstream-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md rename to docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md rename to docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md rename to docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md rename to docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-interface.md b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-interface.md rename to docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-isstronglynamed-method.md b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-isstronglynamed-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-isstronglynamed-method.md rename to docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-isstronglynamed-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrassemblyreferencelist-interface.md b/docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrassemblyreferencelist-interface.md rename to docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrassemblyreferencelist-isassemblyreferenceinlist-method.md b/docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-isassemblyreferenceinlist-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrassemblyreferencelist-isassemblyreferenceinlist-method.md rename to docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-isassemblyreferenceinlist-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md b/docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md rename to docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrcontrol-getclrmanager-method.md b/docs/core/unmanaged-api/hosting/iclrcontrol-getclrmanager-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrcontrol-getclrmanager-method.md rename to docs/core/unmanaged-api/hosting/iclrcontrol-getclrmanager-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrcontrol-interface.md b/docs/core/unmanaged-api/hosting/iclrcontrol-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrcontrol-interface.md rename to docs/core/unmanaged-api/hosting/iclrcontrol-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.md b/docs/core/unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.md rename to docs/core/unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrdebugmanager-beginconnection-method.md b/docs/core/unmanaged-api/hosting/iclrdebugmanager-beginconnection-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrdebugmanager-beginconnection-method.md rename to docs/core/unmanaged-api/hosting/iclrdebugmanager-beginconnection-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrdebugmanager-endconnection-method.md b/docs/core/unmanaged-api/hosting/iclrdebugmanager-endconnection-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrdebugmanager-endconnection-method.md rename to docs/core/unmanaged-api/hosting/iclrdebugmanager-endconnection-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrdebugmanager-getdacl-method.md b/docs/core/unmanaged-api/hosting/iclrdebugmanager-getdacl-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrdebugmanager-getdacl-method.md rename to docs/core/unmanaged-api/hosting/iclrdebugmanager-getdacl-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrdebugmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrdebugmanager-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrdebugmanager-interface.md rename to docs/core/unmanaged-api/hosting/iclrdebugmanager-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrdebugmanager-isdebuggerattached-method.md b/docs/core/unmanaged-api/hosting/iclrdebugmanager-isdebuggerattached-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrdebugmanager-isdebuggerattached-method.md rename to docs/core/unmanaged-api/hosting/iclrdebugmanager-isdebuggerattached-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrdebugmanager-setconnectiontasks-method.md b/docs/core/unmanaged-api/hosting/iclrdebugmanager-setconnectiontasks-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrdebugmanager-setconnectiontasks-method.md rename to docs/core/unmanaged-api/hosting/iclrdebugmanager-setconnectiontasks-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrdebugmanager-setdacl-method.md b/docs/core/unmanaged-api/hosting/iclrdebugmanager-setdacl-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrdebugmanager-setdacl-method.md rename to docs/core/unmanaged-api/hosting/iclrdebugmanager-setdacl-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrdebugmanager-setsymbolreadingpolicy-method.md b/docs/core/unmanaged-api/hosting/iclrdebugmanager-setsymbolreadingpolicy-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrdebugmanager-setsymbolreadingpolicy-method.md rename to docs/core/unmanaged-api/hosting/iclrdebugmanager-setsymbolreadingpolicy-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrdomainmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrdomainmanager-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrdomainmanager-interface.md rename to docs/core/unmanaged-api/hosting/iclrdomainmanager-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrdomainmanager-setappdomainmanagertype-method.md b/docs/core/unmanaged-api/hosting/iclrdomainmanager-setappdomainmanagertype-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrdomainmanager-setappdomainmanagertype-method.md rename to docs/core/unmanaged-api/hosting/iclrdomainmanager-setappdomainmanagertype-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrdomainmanager-setpropertiesfordefaultappdomain-method.md b/docs/core/unmanaged-api/hosting/iclrdomainmanager-setpropertiesfordefaultappdomain-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrdomainmanager-setpropertiesfordefaultappdomain-method.md rename to docs/core/unmanaged-api/hosting/iclrdomainmanager-setpropertiesfordefaultappdomain-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrerrorreportingmanager-begincustomdump-method.md b/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-begincustomdump-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrerrorreportingmanager-begincustomdump-method.md rename to docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-begincustomdump-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrerrorreportingmanager-endcustomdump-method.md b/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-endcustomdump-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrerrorreportingmanager-endcustomdump-method.md rename to docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-endcustomdump-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md b/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md rename to docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrerrorreportingmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrerrorreportingmanager-interface.md rename to docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrgcmanager-collect-method.md b/docs/core/unmanaged-api/hosting/iclrgcmanager-collect-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrgcmanager-collect-method.md rename to docs/core/unmanaged-api/hosting/iclrgcmanager-collect-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrgcmanager-getstats-method.md b/docs/core/unmanaged-api/hosting/iclrgcmanager-getstats-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrgcmanager-getstats-method.md rename to docs/core/unmanaged-api/hosting/iclrgcmanager-getstats-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrgcmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrgcmanager-interface.md rename to docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md b/docs/core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md rename to docs/core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrgcmanager2-interface.md b/docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrgcmanager2-interface.md rename to docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md b/docs/core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md rename to docs/core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md rename to docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md rename to docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md rename to docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md rename to docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md rename to docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md rename to docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclriocompletionmanager-interface.md b/docs/core/unmanaged-api/hosting/iclriocompletionmanager-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclriocompletionmanager-interface.md rename to docs/core/unmanaged-api/hosting/iclriocompletionmanager-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md b/docs/core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md rename to docs/core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md b/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md rename to docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md b/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md rename to docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md rename to docs/core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md rename to docs/core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md rename to docs/core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrmetahost-getruntime-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrmetahost-getruntime-method.md rename to docs/core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md rename to docs/core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrmetahost-interface.md b/docs/core/unmanaged-api/hosting/iclrmetahost-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrmetahost-interface.md rename to docs/core/unmanaged-api/hosting/iclrmetahost-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md rename to docs/core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md rename to docs/core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md b/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md rename to docs/core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrmetahostpolicy-interface.md b/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrmetahostpolicy-interface.md rename to docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclroneventmanager-interface.md b/docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclroneventmanager-interface.md rename to docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md b/docs/core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md rename to docs/core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md b/docs/core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md rename to docs/core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrpolicymanager-interface.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrpolicymanager-interface.md rename to docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md rename to docs/core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md rename to docs/core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md rename to docs/core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md rename to docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md rename to docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md rename to docs/core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md b/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md rename to docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md b/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md rename to docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md b/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md rename to docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md b/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md rename to docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md rename to docs/core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md rename to docs/core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md rename to docs/core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md rename to docs/core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md rename to docs/core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimehost-interface.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimehost-interface.md rename to docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md rename to docs/core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimehost-start-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimehost-start-method.md rename to docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimehost-stop-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimehost-stop-method.md rename to docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md rename to docs/core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md rename to docs/core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md rename to docs/core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md rename to docs/core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md rename to docs/core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md rename to docs/core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md rename to docs/core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-interface.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimeinfo-interface.md rename to docs/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md rename to docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md rename to docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md rename to docs/core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md rename to docs/core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md rename to docs/core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md rename to docs/core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-interface.md b/docs/core/unmanaged-api/hosting/iclrstrongname-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-interface.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md rename to docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname2-interface.md b/docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrstrongname2-interface.md rename to docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md rename to docs/core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md rename to docs/core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md rename to docs/core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md rename to docs/core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrsyncmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrsyncmanager-interface.md rename to docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrtask-abort-method.md b/docs/core/unmanaged-api/hosting/iclrtask-abort-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrtask-abort-method.md rename to docs/core/unmanaged-api/hosting/iclrtask-abort-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrtask-exittask-method.md b/docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrtask-exittask-method.md rename to docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrtask-getmemstats-method.md b/docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrtask-getmemstats-method.md rename to docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrtask-interface.md b/docs/core/unmanaged-api/hosting/iclrtask-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrtask-interface.md rename to docs/core/unmanaged-api/hosting/iclrtask-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrtask-locksheld-method.md b/docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrtask-locksheld-method.md rename to docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md b/docs/core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md rename to docs/core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrtask-reset-method.md b/docs/core/unmanaged-api/hosting/iclrtask-reset-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrtask-reset-method.md rename to docs/core/unmanaged-api/hosting/iclrtask-reset-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrtask-rudeabort-method.md b/docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrtask-rudeabort-method.md rename to docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md b/docs/core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md rename to docs/core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrtask-switchin-method.md b/docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrtask-switchin-method.md rename to docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrtask-switchout-method.md b/docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrtask-switchout-method.md rename to docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrtask-yieldtask-method.md b/docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrtask-yieldtask-method.md rename to docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md b/docs/core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md rename to docs/core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md b/docs/core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md rename to docs/core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrtask2-interface.md b/docs/core/unmanaged-api/hosting/iclrtask2-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrtask2-interface.md rename to docs/core/unmanaged-api/hosting/iclrtask2-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md rename to docs/core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md rename to docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md rename to docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrtaskmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrtaskmanager-interface.md rename to docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md rename to docs/core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md rename to docs/core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md b/docs/core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md rename to docs/core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md diff --git a/docs/framework/unmanaged-api/hosting/iclrvalidator-interface.md b/docs/core/unmanaged-api/hosting/iclrvalidator-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrvalidator-interface.md rename to docs/core/unmanaged-api/hosting/iclrvalidator-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iclrvalidator-validate-method.md b/docs/core/unmanaged-api/hosting/iclrvalidator-validate-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iclrvalidator-validate-method.md rename to docs/core/unmanaged-api/hosting/iclrvalidator-validate-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md b/docs/core/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md rename to docs/core/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorconfiguration-interface.md b/docs/core/unmanaged-api/hosting/icorconfiguration-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorconfiguration-interface.md rename to docs/core/unmanaged-api/hosting/icorconfiguration-interface.md diff --git a/docs/framework/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md b/docs/core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md rename to docs/core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md b/docs/core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md rename to docs/core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md b/docs/core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md rename to docs/core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorruntimehost-closeenum-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorruntimehost-closeenum-method.md rename to docs/core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorruntimehost-createdomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorruntimehost-createdomain-method.md rename to docs/core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md rename to docs/core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md rename to docs/core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorruntimehost-createevidence-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorruntimehost-createevidence-method.md rename to docs/core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md rename to docs/core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md rename to docs/core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md rename to docs/core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md rename to docs/core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md rename to docs/core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md rename to docs/core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorruntimehost-interface.md b/docs/core/unmanaged-api/hosting/icorruntimehost-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorruntimehost-interface.md rename to docs/core/unmanaged-api/hosting/icorruntimehost-interface.md diff --git a/docs/framework/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md rename to docs/core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorruntimehost-mapfile-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorruntimehost-mapfile-method.md rename to docs/core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md rename to docs/core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorruntimehost-start-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorruntimehost-start-method.md rename to docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorruntimehost-stop-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorruntimehost-stop-method.md rename to docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md rename to docs/core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md rename to docs/core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md rename to docs/core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md rename to docs/core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md rename to docs/core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md rename to docs/core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md rename to docs/core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md rename to docs/core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md rename to docs/core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md rename to docs/core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md rename to docs/core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md rename to docs/core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md rename to docs/core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md rename to docs/core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-interface.md b/docs/core/unmanaged-api/hosting/icorthreadpool-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/icorthreadpool-interface.md rename to docs/core/unmanaged-api/hosting/icorthreadpool-interface.md diff --git a/docs/framework/unmanaged-api/hosting/idebuggerinfo-interface.md b/docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/idebuggerinfo-interface.md rename to docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md diff --git a/docs/framework/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md b/docs/core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md rename to docs/core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md diff --git a/docs/framework/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md rename to docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md diff --git a/docs/framework/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md rename to docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md diff --git a/docs/framework/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md rename to docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md diff --git a/docs/framework/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md rename to docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md diff --git a/docs/framework/unmanaged-api/hosting/igchost-collect-method.md b/docs/core/unmanaged-api/hosting/igchost-collect-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/igchost-collect-method.md rename to docs/core/unmanaged-api/hosting/igchost-collect-method.md diff --git a/docs/framework/unmanaged-api/hosting/igchost-getstats-method.md b/docs/core/unmanaged-api/hosting/igchost-getstats-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/igchost-getstats-method.md rename to docs/core/unmanaged-api/hosting/igchost-getstats-method.md diff --git a/docs/framework/unmanaged-api/hosting/igchost-getthreadstats-method.md b/docs/core/unmanaged-api/hosting/igchost-getthreadstats-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/igchost-getthreadstats-method.md rename to docs/core/unmanaged-api/hosting/igchost-getthreadstats-method.md diff --git a/docs/framework/unmanaged-api/hosting/igchost-interface.md b/docs/core/unmanaged-api/hosting/igchost-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/igchost-interface.md rename to docs/core/unmanaged-api/hosting/igchost-interface.md diff --git a/docs/framework/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md b/docs/core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md rename to docs/core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md diff --git a/docs/framework/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md b/docs/core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md rename to docs/core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md diff --git a/docs/framework/unmanaged-api/hosting/igchost2-interface.md b/docs/core/unmanaged-api/hosting/igchost2-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/igchost2-interface.md rename to docs/core/unmanaged-api/hosting/igchost2-interface.md diff --git a/docs/framework/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md b/docs/core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md rename to docs/core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md diff --git a/docs/framework/unmanaged-api/hosting/igchostcontrol-interface.md b/docs/core/unmanaged-api/hosting/igchostcontrol-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/igchostcontrol-interface.md rename to docs/core/unmanaged-api/hosting/igchostcontrol-interface.md diff --git a/docs/framework/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md b/docs/core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md rename to docs/core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md diff --git a/docs/framework/unmanaged-api/hosting/igcthreadcontrol-interface.md b/docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/igcthreadcontrol-interface.md rename to docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md diff --git a/docs/framework/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md b/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md rename to docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md diff --git a/docs/framework/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md b/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md rename to docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md diff --git a/docs/framework/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md b/docs/core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md rename to docs/core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md b/docs/core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md rename to docs/core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md b/docs/core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md rename to docs/core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostassemblymanager-interface.md b/docs/core/unmanaged-api/hosting/ihostassemblymanager-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostassemblymanager-interface.md rename to docs/core/unmanaged-api/hosting/ihostassemblymanager-interface.md diff --git a/docs/framework/unmanaged-api/hosting/ihostassemblystore-interface.md b/docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostassemblystore-interface.md rename to docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md diff --git a/docs/framework/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md b/docs/core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md rename to docs/core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md b/docs/core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md rename to docs/core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostautoevent-interface.md b/docs/core/unmanaged-api/hosting/ihostautoevent-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostautoevent-interface.md rename to docs/core/unmanaged-api/hosting/ihostautoevent-interface.md diff --git a/docs/framework/unmanaged-api/hosting/ihostautoevent-set-method.md b/docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostautoevent-set-method.md rename to docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostautoevent-wait-method.md b/docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostautoevent-wait-method.md rename to docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md b/docs/core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md rename to docs/core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostcontrol-interface.md b/docs/core/unmanaged-api/hosting/ihostcontrol-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostcontrol-interface.md rename to docs/core/unmanaged-api/hosting/ihostcontrol-interface.md diff --git a/docs/framework/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md b/docs/core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md rename to docs/core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostcrst-enter-method.md b/docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostcrst-enter-method.md rename to docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostcrst-interface.md b/docs/core/unmanaged-api/hosting/ihostcrst-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostcrst-interface.md rename to docs/core/unmanaged-api/hosting/ihostcrst-interface.md diff --git a/docs/framework/unmanaged-api/hosting/ihostcrst-leave-method.md b/docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostcrst-leave-method.md rename to docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostcrst-setspincount-method.md b/docs/core/unmanaged-api/hosting/ihostcrst-setspincount-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostcrst-setspincount-method.md rename to docs/core/unmanaged-api/hosting/ihostcrst-setspincount-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostcrst-tryenter-method.md b/docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostcrst-tryenter-method.md rename to docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostgcmanager-interface.md b/docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostgcmanager-interface.md rename to docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md diff --git a/docs/framework/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md b/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md rename to docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md b/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md rename to docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md b/docs/core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md rename to docs/core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md rename to docs/core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md rename to docs/core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md rename to docs/core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md rename to docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md rename to docs/core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md rename to docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md rename to docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md rename to docs/core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-interface.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-interface.md rename to docs/core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md diff --git a/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md rename to docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md rename to docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md rename to docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostmalloc-alloc-method.md b/docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostmalloc-alloc-method.md rename to docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md b/docs/core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md rename to docs/core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostmalloc-free-method.md b/docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostmalloc-free-method.md rename to docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostmalloc-interface.md b/docs/core/unmanaged-api/hosting/ihostmalloc-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostmalloc-interface.md rename to docs/core/unmanaged-api/hosting/ihostmalloc-interface.md diff --git a/docs/framework/unmanaged-api/hosting/ihostmanualevent-interface.md b/docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostmanualevent-interface.md rename to docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md diff --git a/docs/framework/unmanaged-api/hosting/ihostmanualevent-reset-method.md b/docs/core/unmanaged-api/hosting/ihostmanualevent-reset-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostmanualevent-reset-method.md rename to docs/core/unmanaged-api/hosting/ihostmanualevent-reset-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostmanualevent-set-method.md b/docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostmanualevent-set-method.md rename to docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostmanualevent-wait-method.md b/docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostmanualevent-wait-method.md rename to docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md rename to docs/core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md rename to docs/core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md rename to docs/core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostmemorymanager-interface.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostmemorymanager-interface.md rename to docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md diff --git a/docs/framework/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md rename to docs/core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md rename to docs/core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md rename to docs/core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md rename to docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md rename to docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md rename to docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md rename to docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostpolicymanager-interface.md b/docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostpolicymanager-interface.md rename to docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md diff --git a/docs/framework/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md b/docs/core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md rename to docs/core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md b/docs/core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md rename to docs/core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md b/docs/core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md rename to docs/core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md rename to docs/core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostsecuritycontext-interface.md b/docs/core/unmanaged-api/hosting/ihostsecuritycontext-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostsecuritycontext-interface.md rename to docs/core/unmanaged-api/hosting/ihostsecuritycontext-interface.md diff --git a/docs/framework/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md rename to docs/core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md rename to docs/core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostsecuritymanager-interface.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostsecuritymanager-interface.md rename to docs/core/unmanaged-api/hosting/ihostsecuritymanager-interface.md diff --git a/docs/framework/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md rename to docs/core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md rename to docs/core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md rename to docs/core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md rename to docs/core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostsemaphore-interface.md b/docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostsemaphore-interface.md rename to docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md diff --git a/docs/framework/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md b/docs/core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md rename to docs/core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostsemaphore-wait-method.md b/docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostsemaphore-wait-method.md rename to docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md rename to docs/core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md rename to docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md rename to docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md rename to docs/core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md rename to docs/core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md rename to docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md rename to docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md rename to docs/core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostsyncmanager-interface.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostsyncmanager-interface.md rename to docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md diff --git a/docs/framework/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md rename to docs/core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttask-alert-method.md b/docs/core/unmanaged-api/hosting/ihosttask-alert-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttask-alert-method.md rename to docs/core/unmanaged-api/hosting/ihosttask-alert-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttask-getpriority-method.md b/docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttask-getpriority-method.md rename to docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttask-interface.md b/docs/core/unmanaged-api/hosting/ihosttask-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttask-interface.md rename to docs/core/unmanaged-api/hosting/ihosttask-interface.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttask-join-method.md b/docs/core/unmanaged-api/hosting/ihosttask-join-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttask-join-method.md rename to docs/core/unmanaged-api/hosting/ihosttask-join-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttask-setclrtask-method.md b/docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttask-setclrtask-method.md rename to docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttask-setpriority-method.md b/docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttask-setpriority-method.md rename to docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttask-start-method.md b/docs/core/unmanaged-api/hosting/ihosttask-start-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttask-start-method.md rename to docs/core/unmanaged-api/hosting/ihosttask-start-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md rename to docs/core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md rename to docs/core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md rename to docs/core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md rename to docs/core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md rename to docs/core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md rename to docs/core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md rename to docs/core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md rename to docs/core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md rename to docs/core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttaskmanager-interface.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttaskmanager-interface.md rename to docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md rename to docs/core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md rename to docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md rename to docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md rename to docs/core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md rename to docs/core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md rename to docs/core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md rename to docs/core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md rename to docs/core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md rename to docs/core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md rename to docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md rename to docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md rename to docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md rename to docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md diff --git a/docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md rename to docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md rename to docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md diff --git a/docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md rename to docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md diff --git a/docs/framework/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md b/docs/core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md rename to docs/core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md diff --git a/docs/framework/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md b/docs/core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md rename to docs/core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md diff --git a/docs/framework/unmanaged-api/hosting/imanagedobject-interface.md b/docs/core/unmanaged-api/hosting/imanagedobject-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/imanagedobject-interface.md rename to docs/core/unmanaged-api/hosting/imanagedobject-interface.md diff --git a/docs/framework/unmanaged-api/hosting/index.md b/docs/core/unmanaged-api/hosting/index.md similarity index 64% rename from docs/framework/unmanaged-api/hosting/index.md rename to docs/core/unmanaged-api/hosting/index.md index c08be3ff940f6..30751e16f2244 100644 --- a/docs/framework/unmanaged-api/hosting/index.md +++ b/docs/core/unmanaged-api/hosting/index.md @@ -1,16 +1,18 @@ --- -description: "Learn more about: Hosting (Unmanaged API Reference)" -title: "Hosting (Unmanaged API Reference)" -ms.date: "03/30/2017" +description: "Learn more about unmanaged APIs for .NET hosting" +title: ".NET hosting (unmanaged API reference)" +ms.date: "09/19/2023" helpviewer_keywords: - - "unmanaged API reference [.NET Framework], hosting" - - "native API reference [.NET Framework], hosting" - - "hosting [.NET Framework], using the unmanaged API" + - "unmanaged API reference [.NET], hosting" + - "native API reference [.NET], hosting" + - "hosting [.NET], using the unmanaged API" ms.assetid: 14295c28-1da8-408b-a656-9584abcd9896 --- -# Hosting (Unmanaged API Reference) +# .NET hosting (unmanaged API reference) -The hosting API enables unmanaged hosts to integrate the common language runtime (CLR) into their applications. +The hosting API enables unmanaged hosts to integrate the common language runtime (CLR) into their applications. + +These articles describe APIs that can be used with both .NET Framework and .NET. For .NET Framework-specific unmanaged APIs, see [.NET Framework hosting](../../../framework/unmanaged-api/hosting/index.md). ## In This Section diff --git a/docs/framework/unmanaged-api/hosting/iobjecthandle-interface.md b/docs/core/unmanaged-api/hosting/iobjecthandle-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iobjecthandle-interface.md rename to docs/core/unmanaged-api/hosting/iobjecthandle-interface.md diff --git a/docs/framework/unmanaged-api/hosting/iobjecthandle-unwrap-method.md b/docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/iobjecthandle-unwrap-method.md rename to docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md diff --git a/docs/framework/unmanaged-api/hosting/itypename-getassemblyname-method.md b/docs/core/unmanaged-api/hosting/itypename-getassemblyname-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypename-getassemblyname-method.md rename to docs/core/unmanaged-api/hosting/itypename-getassemblyname-method.md diff --git a/docs/framework/unmanaged-api/hosting/itypename-getmodifierlength-method.md b/docs/core/unmanaged-api/hosting/itypename-getmodifierlength-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypename-getmodifierlength-method.md rename to docs/core/unmanaged-api/hosting/itypename-getmodifierlength-method.md diff --git a/docs/framework/unmanaged-api/hosting/itypename-getmodifiers-method.md b/docs/core/unmanaged-api/hosting/itypename-getmodifiers-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypename-getmodifiers-method.md rename to docs/core/unmanaged-api/hosting/itypename-getmodifiers-method.md diff --git a/docs/framework/unmanaged-api/hosting/itypename-getnamecount-method.md b/docs/core/unmanaged-api/hosting/itypename-getnamecount-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypename-getnamecount-method.md rename to docs/core/unmanaged-api/hosting/itypename-getnamecount-method.md diff --git a/docs/framework/unmanaged-api/hosting/itypename-getnames-method.md b/docs/core/unmanaged-api/hosting/itypename-getnames-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypename-getnames-method.md rename to docs/core/unmanaged-api/hosting/itypename-getnames-method.md diff --git a/docs/framework/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md b/docs/core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md rename to docs/core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md diff --git a/docs/framework/unmanaged-api/hosting/itypename-gettypearguments-method.md b/docs/core/unmanaged-api/hosting/itypename-gettypearguments-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypename-gettypearguments-method.md rename to docs/core/unmanaged-api/hosting/itypename-gettypearguments-method.md diff --git a/docs/framework/unmanaged-api/hosting/itypename-interface.md b/docs/core/unmanaged-api/hosting/itypename-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypename-interface.md rename to docs/core/unmanaged-api/hosting/itypename-interface.md diff --git a/docs/framework/unmanaged-api/hosting/itypenamebuilder-addarray-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypenamebuilder-addarray-method.md rename to docs/core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md diff --git a/docs/framework/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md rename to docs/core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md diff --git a/docs/framework/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md rename to docs/core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md diff --git a/docs/framework/unmanaged-api/hosting/itypenamebuilder-addname-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addname-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypenamebuilder-addname-method.md rename to docs/core/unmanaged-api/hosting/itypenamebuilder-addname-method.md diff --git a/docs/framework/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md rename to docs/core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md diff --git a/docs/framework/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md rename to docs/core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md diff --git a/docs/framework/unmanaged-api/hosting/itypenamebuilder-clear-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-clear-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypenamebuilder-clear-method.md rename to docs/core/unmanaged-api/hosting/itypenamebuilder-clear-method.md diff --git a/docs/framework/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md rename to docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md diff --git a/docs/framework/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md rename to docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md diff --git a/docs/framework/unmanaged-api/hosting/itypenamebuilder-interface.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypenamebuilder-interface.md rename to docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md diff --git a/docs/framework/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md rename to docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md diff --git a/docs/framework/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md rename to docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md diff --git a/docs/framework/unmanaged-api/hosting/itypenamebuilder-tostring-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypenamebuilder-tostring-method.md rename to docs/core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md diff --git a/docs/framework/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md b/docs/core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md rename to docs/core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md diff --git a/docs/framework/unmanaged-api/hosting/itypenamefactory-interface.md b/docs/core/unmanaged-api/hosting/itypenamefactory-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypenamefactory-interface.md rename to docs/core/unmanaged-api/hosting/itypenamefactory-interface.md diff --git a/docs/framework/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md b/docs/core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md rename to docs/core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md diff --git a/docs/framework/unmanaged-api/hosting/ivalidator-formateventinfo-method.md b/docs/core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ivalidator-formateventinfo-method.md rename to docs/core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md diff --git a/docs/framework/unmanaged-api/hosting/ivalidator-interface.md b/docs/core/unmanaged-api/hosting/ivalidator-interface.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ivalidator-interface.md rename to docs/core/unmanaged-api/hosting/ivalidator-interface.md diff --git a/docs/framework/unmanaged-api/hosting/ivalidator-validate-method.md b/docs/core/unmanaged-api/hosting/ivalidator-validate-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/ivalidator-validate-method.md rename to docs/core/unmanaged-api/hosting/ivalidator-validate-method.md diff --git a/docs/framework/unmanaged-api/hosting/loadlibraryshim-function.md b/docs/core/unmanaged-api/hosting/loadlibraryshim-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/loadlibraryshim-function.md rename to docs/core/unmanaged-api/hosting/loadlibraryshim-function.md diff --git a/docs/framework/unmanaged-api/hosting/loadstringrc-function.md b/docs/core/unmanaged-api/hosting/loadstringrc-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/loadstringrc-function.md rename to docs/core/unmanaged-api/hosting/loadstringrc-function.md diff --git a/docs/framework/unmanaged-api/hosting/loadstringrcex-function.md b/docs/core/unmanaged-api/hosting/loadstringrcex-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/loadstringrcex-function.md rename to docs/core/unmanaged-api/hosting/loadstringrcex-function.md diff --git a/docs/framework/unmanaged-api/hosting/lockclrversion-function.md b/docs/core/unmanaged-api/hosting/lockclrversion-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/lockclrversion-function.md rename to docs/core/unmanaged-api/hosting/lockclrversion-function.md diff --git a/docs/framework/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md b/docs/core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md rename to docs/core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md diff --git a/docs/framework/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md b/docs/core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md rename to docs/core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md diff --git a/docs/framework/unmanaged-api/hosting/malloc-type-enumeration.md b/docs/core/unmanaged-api/hosting/malloc-type-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/malloc-type-enumeration.md rename to docs/core/unmanaged-api/hosting/malloc-type-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/mdainfo-structure.md b/docs/core/unmanaged-api/hosting/mdainfo-structure.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/mdainfo-structure.md rename to docs/core/unmanaged-api/hosting/mdainfo-structure.md diff --git a/docs/framework/unmanaged-api/hosting/metahost-config-flags-enumeration.md b/docs/core/unmanaged-api/hosting/metahost-config-flags-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/metahost-config-flags-enumeration.md rename to docs/core/unmanaged-api/hosting/metahost-config-flags-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/metahost-policy-flags-enumeration.md b/docs/core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/metahost-policy-flags-enumeration.md rename to docs/core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/modulebindinfo-structure.md b/docs/core/unmanaged-api/hosting/modulebindinfo-structure.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/modulebindinfo-structure.md rename to docs/core/unmanaged-api/hosting/modulebindinfo-structure.md diff --git a/docs/framework/unmanaged-api/hosting/net-framework-4-hosting-global-static-functions.md b/docs/core/unmanaged-api/hosting/net-framework-4-hosting-global-static-functions.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/net-framework-4-hosting-global-static-functions.md rename to docs/core/unmanaged-api/hosting/net-framework-4-hosting-global-static-functions.md diff --git a/docs/framework/unmanaged-api/hosting/rundll32shimw-function.md b/docs/core/unmanaged-api/hosting/rundll32shimw-function.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/rundll32shimw-function.md rename to docs/core/unmanaged-api/hosting/rundll32shimw-function.md diff --git a/docs/framework/unmanaged-api/hosting/runtime-info-flags-enumeration.md b/docs/core/unmanaged-api/hosting/runtime-info-flags-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/runtime-info-flags-enumeration.md rename to docs/core/unmanaged-api/hosting/runtime-info-flags-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/stackoverflowinfo-structure.md b/docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/stackoverflowinfo-structure.md rename to docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md diff --git a/docs/framework/unmanaged-api/hosting/stackoverflowtype-enumeration.md b/docs/core/unmanaged-api/hosting/stackoverflowtype-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/stackoverflowtype-enumeration.md rename to docs/core/unmanaged-api/hosting/stackoverflowtype-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/startup-flags-enumeration.md b/docs/core/unmanaged-api/hosting/startup-flags-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/startup-flags-enumeration.md rename to docs/core/unmanaged-api/hosting/startup-flags-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/strongnamegetpublickeyex-method.md b/docs/core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/strongnamegetpublickeyex-method.md rename to docs/core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md diff --git a/docs/framework/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md b/docs/core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md rename to docs/core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md diff --git a/docs/framework/unmanaged-api/hosting/toc.yml b/docs/core/unmanaged-api/hosting/toc.yml similarity index 100% rename from docs/framework/unmanaged-api/hosting/toc.yml rename to docs/core/unmanaged-api/hosting/toc.yml diff --git a/docs/framework/unmanaged-api/hosting/typenamefactory-coclass.md b/docs/core/unmanaged-api/hosting/typenamefactory-coclass.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/typenamefactory-coclass.md rename to docs/core/unmanaged-api/hosting/typenamefactory-coclass.md diff --git a/docs/framework/unmanaged-api/hosting/validatorflags-enumeration.md b/docs/core/unmanaged-api/hosting/validatorflags-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/validatorflags-enumeration.md rename to docs/core/unmanaged-api/hosting/validatorflags-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/wait-option-enumeration.md b/docs/core/unmanaged-api/hosting/wait-option-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/wait-option-enumeration.md rename to docs/core/unmanaged-api/hosting/wait-option-enumeration.md diff --git a/docs/framework/unmanaged-api/hosting/waitortimercallback-function-pointer.md b/docs/core/unmanaged-api/hosting/waitortimercallback-function-pointer.md similarity index 100% rename from docs/framework/unmanaged-api/hosting/waitortimercallback-function-pointer.md rename to docs/core/unmanaged-api/hosting/waitortimercallback-function-pointer.md diff --git a/docs/core/unmanaged-api/index.md b/docs/core/unmanaged-api/index.md new file mode 100644 index 0000000000000..c0927bb136587 --- /dev/null +++ b/docs/core/unmanaged-api/index.md @@ -0,0 +1,24 @@ +--- +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. + +[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) +Describes the profiling API, which enables a profiler to monitor a program's execution by the CLR. \ No newline at end of file diff --git a/docs/framework/unmanaged-api/metadata/assemblyflags-enumeration.md b/docs/core/unmanaged-api/metadata/assemblyflags-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/assemblyflags-enumeration.md rename to docs/core/unmanaged-api/metadata/assemblyflags-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/assemblymetadata-structure.md b/docs/core/unmanaged-api/metadata/assemblymetadata-structure.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/assemblymetadata-structure.md rename to docs/core/unmanaged-api/metadata/assemblymetadata-structure.md diff --git a/docs/framework/unmanaged-api/metadata/assemblyrefflags-enumeration.md b/docs/core/unmanaged-api/metadata/assemblyrefflags-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/assemblyrefflags-enumeration.md rename to docs/core/unmanaged-api/metadata/assemblyrefflags-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/ceesectionattr-enumeration.md b/docs/core/unmanaged-api/metadata/ceesectionattr-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/ceesectionattr-enumeration.md rename to docs/core/unmanaged-api/metadata/ceesectionattr-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/ceesectionrelocextra-union.md b/docs/core/unmanaged-api/metadata/ceesectionrelocextra-union.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/ceesectionrelocextra-union.md rename to docs/core/unmanaged-api/metadata/ceesectionrelocextra-union.md diff --git a/docs/framework/unmanaged-api/metadata/ceesectionreloctype-enumeration.md b/docs/core/unmanaged-api/metadata/ceesectionreloctype-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/ceesectionreloctype-enumeration.md rename to docs/core/unmanaged-api/metadata/ceesectionreloctype-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/coiniticor-enumeration.md b/docs/core/unmanaged-api/metadata/coiniticor-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/coiniticor-enumeration.md rename to docs/core/unmanaged-api/metadata/coiniticor-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/coinitiee-enumeration.md b/docs/core/unmanaged-api/metadata/coinitiee-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/coinitiee-enumeration.md rename to docs/core/unmanaged-api/metadata/coinitiee-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/cor-field-offset-structure.md b/docs/core/unmanaged-api/metadata/cor-field-offset-structure.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/cor-field-offset-structure.md rename to docs/core/unmanaged-api/metadata/cor-field-offset-structure.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 100% rename from docs/framework/unmanaged-api/metadata/cor-native-link-structure.md rename to docs/core/unmanaged-api/metadata/cor-native-link-structure.md diff --git a/docs/framework/unmanaged-api/metadata/corargtype-enumeration.md b/docs/core/unmanaged-api/metadata/corargtype-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corargtype-enumeration.md rename to docs/core/unmanaged-api/metadata/corargtype-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corassemblyflags-enumeration.md b/docs/core/unmanaged-api/metadata/corassemblyflags-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corassemblyflags-enumeration.md rename to docs/core/unmanaged-api/metadata/corassemblyflags-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corattributetargets-enumeration.md b/docs/core/unmanaged-api/metadata/corattributetargets-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corattributetargets-enumeration.md rename to docs/core/unmanaged-api/metadata/corattributetargets-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corcallingconvention-enumeration.md b/docs/core/unmanaged-api/metadata/corcallingconvention-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corcallingconvention-enumeration.md rename to docs/core/unmanaged-api/metadata/corcallingconvention-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md b/docs/core/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md rename to docs/core/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/cordeclsecurity-enumeration.md b/docs/core/unmanaged-api/metadata/cordeclsecurity-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/cordeclsecurity-enumeration.md rename to docs/core/unmanaged-api/metadata/cordeclsecurity-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corelementtype-enumeration.md b/docs/core/unmanaged-api/metadata/corelementtype-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corelementtype-enumeration.md rename to docs/core/unmanaged-api/metadata/corelementtype-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md b/docs/core/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md rename to docs/core/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/coreventattr-enumeration.md b/docs/core/unmanaged-api/metadata/coreventattr-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/coreventattr-enumeration.md rename to docs/core/unmanaged-api/metadata/coreventattr-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corfieldattr-enumeration.md b/docs/core/unmanaged-api/metadata/corfieldattr-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corfieldattr-enumeration.md rename to docs/core/unmanaged-api/metadata/corfieldattr-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corfileflags-enumeration.md b/docs/core/unmanaged-api/metadata/corfileflags-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corfileflags-enumeration.md rename to docs/core/unmanaged-api/metadata/corfileflags-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corfilemapping-enumeration.md b/docs/core/unmanaged-api/metadata/corfilemapping-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corfilemapping-enumeration.md rename to docs/core/unmanaged-api/metadata/corfilemapping-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corgenericparamattr-enumeration.md b/docs/core/unmanaged-api/metadata/corgenericparamattr-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corgenericparamattr-enumeration.md rename to docs/core/unmanaged-api/metadata/corgenericparamattr-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corimportoptions-enumeration.md b/docs/core/unmanaged-api/metadata/corimportoptions-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corimportoptions-enumeration.md rename to docs/core/unmanaged-api/metadata/corimportoptions-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corlinkeroptions-enumeration.md b/docs/core/unmanaged-api/metadata/corlinkeroptions-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corlinkeroptions-enumeration.md rename to docs/core/unmanaged-api/metadata/corlinkeroptions-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md b/docs/core/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md rename to docs/core/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md b/docs/core/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md rename to docs/core/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/cormethodattr-enumeration.md b/docs/core/unmanaged-api/metadata/cormethodattr-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/cormethodattr-enumeration.md rename to docs/core/unmanaged-api/metadata/cormethodattr-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/cormethodimpl-enumeration.md b/docs/core/unmanaged-api/metadata/cormethodimpl-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/cormethodimpl-enumeration.md rename to docs/core/unmanaged-api/metadata/cormethodimpl-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md b/docs/core/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md rename to docs/core/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/cornativelinkflags-enumeration.md b/docs/core/unmanaged-api/metadata/cornativelinkflags-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/cornativelinkflags-enumeration.md rename to docs/core/unmanaged-api/metadata/cornativelinkflags-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/cornativelinktype-enumeration.md b/docs/core/unmanaged-api/metadata/cornativelinktype-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/cornativelinktype-enumeration.md rename to docs/core/unmanaged-api/metadata/cornativelinktype-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/cornativetype-enumeration.md b/docs/core/unmanaged-api/metadata/cornativetype-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/cornativetype-enumeration.md rename to docs/core/unmanaged-api/metadata/cornativetype-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md b/docs/core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md rename to docs/core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/coropenflags-enumeration.md b/docs/core/unmanaged-api/metadata/coropenflags-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/coropenflags-enumeration.md rename to docs/core/unmanaged-api/metadata/coropenflags-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corparamattr-enumeration.md b/docs/core/unmanaged-api/metadata/corparamattr-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corparamattr-enumeration.md rename to docs/core/unmanaged-api/metadata/corparamattr-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corpekind-enumeration.md b/docs/core/unmanaged-api/metadata/corpekind-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corpekind-enumeration.md rename to docs/core/unmanaged-api/metadata/corpekind-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corpinvokemap-enumeration.md b/docs/core/unmanaged-api/metadata/corpinvokemap-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corpinvokemap-enumeration.md rename to docs/core/unmanaged-api/metadata/corpinvokemap-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corpropertyattr-enumeration.md b/docs/core/unmanaged-api/metadata/corpropertyattr-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corpropertyattr-enumeration.md rename to docs/core/unmanaged-api/metadata/corpropertyattr-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/correftodefcheck-enumeration.md b/docs/core/unmanaged-api/metadata/correftodefcheck-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/correftodefcheck-enumeration.md rename to docs/core/unmanaged-api/metadata/correftodefcheck-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corregflags-enumeration.md b/docs/core/unmanaged-api/metadata/corregflags-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corregflags-enumeration.md rename to docs/core/unmanaged-api/metadata/corregflags-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corsavesize-enumeration.md b/docs/core/unmanaged-api/metadata/corsavesize-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corsavesize-enumeration.md rename to docs/core/unmanaged-api/metadata/corsavesize-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corserializationtype-enumeration.md b/docs/core/unmanaged-api/metadata/corserializationtype-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corserializationtype-enumeration.md rename to docs/core/unmanaged-api/metadata/corserializationtype-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corsetenc-enumeration.md b/docs/core/unmanaged-api/metadata/corsetenc-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corsetenc-enumeration.md rename to docs/core/unmanaged-api/metadata/corsetenc-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md b/docs/core/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md rename to docs/core/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/cortokentype-enumeration.md b/docs/core/unmanaged-api/metadata/cortokentype-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/cortokentype-enumeration.md rename to docs/core/unmanaged-api/metadata/cortokentype-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/cortypeattr-enumeration.md b/docs/core/unmanaged-api/metadata/cortypeattr-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/cortypeattr-enumeration.md rename to docs/core/unmanaged-api/metadata/cortypeattr-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md b/docs/core/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md rename to docs/core/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md b/docs/core/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md rename to docs/core/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/couninitiee-enumeration.md b/docs/core/unmanaged-api/metadata/couninitiee-enumeration.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/couninitiee-enumeration.md rename to docs/core/unmanaged-api/metadata/couninitiee-enumeration.md diff --git a/docs/framework/unmanaged-api/metadata/cvstruct-structure.md b/docs/core/unmanaged-api/metadata/cvstruct-structure.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/cvstruct-structure.md rename to docs/core/unmanaged-api/metadata/cvstruct-structure.md diff --git a/docs/framework/unmanaged-api/metadata/iceegen-addsectionreloc-method.md b/docs/core/unmanaged-api/metadata/iceegen-addsectionreloc-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/iceegen-addsectionreloc-method.md rename to docs/core/unmanaged-api/metadata/iceegen-addsectionreloc-method.md diff --git a/docs/framework/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md b/docs/core/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md rename to docs/core/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md diff --git a/docs/framework/unmanaged-api/metadata/iceegen-computepointer-method.md b/docs/core/unmanaged-api/metadata/iceegen-computepointer-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/iceegen-computepointer-method.md rename to docs/core/unmanaged-api/metadata/iceegen-computepointer-method.md diff --git a/docs/framework/unmanaged-api/metadata/iceegen-emitstring-method.md b/docs/core/unmanaged-api/metadata/iceegen-emitstring-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/iceegen-emitstring-method.md rename to docs/core/unmanaged-api/metadata/iceegen-emitstring-method.md diff --git a/docs/framework/unmanaged-api/metadata/iceegen-generateceefile-method.md b/docs/core/unmanaged-api/metadata/iceegen-generateceefile-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/iceegen-generateceefile-method.md rename to docs/core/unmanaged-api/metadata/iceegen-generateceefile-method.md diff --git a/docs/framework/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md b/docs/core/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md rename to docs/core/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md diff --git a/docs/framework/unmanaged-api/metadata/iceegen-getilsection-method.md b/docs/core/unmanaged-api/metadata/iceegen-getilsection-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/iceegen-getilsection-method.md rename to docs/core/unmanaged-api/metadata/iceegen-getilsection-method.md diff --git a/docs/framework/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md b/docs/core/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md rename to docs/core/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md diff --git a/docs/framework/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md b/docs/core/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md rename to docs/core/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md diff --git a/docs/framework/unmanaged-api/metadata/iceegen-getsectionblock-method.md b/docs/core/unmanaged-api/metadata/iceegen-getsectionblock-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/iceegen-getsectionblock-method.md rename to docs/core/unmanaged-api/metadata/iceegen-getsectionblock-method.md diff --git a/docs/framework/unmanaged-api/metadata/iceegen-getsectioncreate-method.md b/docs/core/unmanaged-api/metadata/iceegen-getsectioncreate-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/iceegen-getsectioncreate-method.md rename to docs/core/unmanaged-api/metadata/iceegen-getsectioncreate-method.md diff --git a/docs/framework/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md b/docs/core/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md rename to docs/core/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md diff --git a/docs/framework/unmanaged-api/metadata/iceegen-getstring-method.md b/docs/core/unmanaged-api/metadata/iceegen-getstring-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/iceegen-getstring-method.md rename to docs/core/unmanaged-api/metadata/iceegen-getstring-method.md diff --git a/docs/framework/unmanaged-api/metadata/iceegen-getstringsection-method.md b/docs/core/unmanaged-api/metadata/iceegen-getstringsection-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/iceegen-getstringsection-method.md rename to docs/core/unmanaged-api/metadata/iceegen-getstringsection-method.md diff --git a/docs/framework/unmanaged-api/metadata/iceegen-interface.md b/docs/core/unmanaged-api/metadata/iceegen-interface.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/iceegen-interface.md rename to docs/core/unmanaged-api/metadata/iceegen-interface.md diff --git a/docs/framework/unmanaged-api/metadata/iceegen-truncatesection-method.md b/docs/core/unmanaged-api/metadata/iceegen-truncatesection-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/iceegen-truncatesection-method.md rename to docs/core/unmanaged-api/metadata/iceegen-truncatesection-method.md diff --git a/docs/framework/unmanaged-api/metadata/ihostfilter-interface.md b/docs/core/unmanaged-api/metadata/ihostfilter-interface.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/ihostfilter-interface.md rename to docs/core/unmanaged-api/metadata/ihostfilter-interface.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 100% rename from docs/framework/unmanaged-api/metadata/ihostfilter-marktoken-method.md rename to docs/core/unmanaged-api/metadata/ihostfilter-marktoken-method.md diff --git a/docs/framework/unmanaged-api/metadata/imaptoken-interface.md b/docs/core/unmanaged-api/metadata/imaptoken-interface.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imaptoken-interface.md rename to docs/core/unmanaged-api/metadata/imaptoken-interface.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 100% rename from docs/framework/unmanaged-api/metadata/imaptoken-map-method.md rename to docs/core/unmanaged-api/metadata/imaptoken-map-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-interface.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-interface.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyemit-interface.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyemit-interface.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataassemblyimport-interface.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-interface.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataassemblyimport-interface.md rename to docs/core/unmanaged-api/metadata/imetadataassemblyimport-interface.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md rename to docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md rename to docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md b/docs/core/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md rename to docs/core/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataconverter-interface.md b/docs/core/unmanaged-api/metadata/imetadataconverter-interface.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataconverter-interface.md rename to docs/core/unmanaged-api/metadata/imetadataconverter-interface.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 100% rename from docs/framework/unmanaged-api/metadata/imetadatadispenser-definescope-method.md rename to docs/core/unmanaged-api/metadata/imetadatadispenser-definescope-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatadispenser-interface.md b/docs/core/unmanaged-api/metadata/imetadatadispenser-interface.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatadispenser-interface.md rename to docs/core/unmanaged-api/metadata/imetadatadispenser-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 100% rename from docs/framework/unmanaged-api/metadata/imetadatadispenser-openscope-method.md rename to docs/core/unmanaged-api/metadata/imetadatadispenser-openscope-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md rename to docs/core/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md rename to docs/core/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md rename to docs/core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md rename to docs/core/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md rename to docs/core/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatadispenserex-interface.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-interface.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatadispenserex-interface.md rename to docs/core/unmanaged-api/metadata/imetadatadispenserex-interface.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md rename to docs/core/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md rename to docs/core/unmanaged-api/metadata/imetadatadispenserex-setoption-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-defineevent-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineevent-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-defineevent-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-defineevent-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definefield-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definefield-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-defineimportmember-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-defineimporttype-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definememberref-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definememberref-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definemethod-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definemethod-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definemoduleref-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definenestedtype-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-defineparam-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-defineparam-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definepermissionset-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-defineproperty-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-defineproperty-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definetypedef-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definetypedef-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-defineuserstring-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-deletetoken-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-deletetoken-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-deletetoken-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-deletetoken-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-getsavesize-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-getsavesize-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-interface.md b/docs/core/unmanaged-api/metadata/imetadataemit-interface.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-interface.md rename to docs/core/unmanaged-api/metadata/imetadataemit-interface.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-merge-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-merge-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-mergeend-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-mergeend-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-save-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-save-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-save-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-save-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-savetomemory-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-savetomemory-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-savetostream-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-savetostream-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-savetostream-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-savetostream-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setclasslayout-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-seteventprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-seteventprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setfieldprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setfieldrva-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-sethandler-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-sethandler-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setmethodprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-setparamprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setparamprops-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setparamprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setparamprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setparent-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setparent-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit-setrva-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setrva-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-setrva-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-setrva-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-settypedefprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit2-interface.md b/docs/core/unmanaged-api/metadata/imetadataemit2-interface.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit2-interface.md rename to docs/core/unmanaged-api/metadata/imetadataemit2-interface.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataemit2-savedelta-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-savedelta-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit2-savedelta-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit2-savedelta-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataerror-interface.md b/docs/core/unmanaged-api/metadata/imetadataerror-interface.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataerror-interface.md rename to docs/core/unmanaged-api/metadata/imetadataerror-interface.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataerror-onerror-method.md b/docs/core/unmanaged-api/metadata/imetadataerror-onerror-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataerror-onerror-method.md rename to docs/core/unmanaged-api/metadata/imetadataerror-onerror-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatafilter-interface.md b/docs/core/unmanaged-api/metadata/imetadatafilter-interface.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatafilter-interface.md rename to docs/core/unmanaged-api/metadata/imetadatafilter-interface.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md b/docs/core/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md rename to docs/core/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatafilter-marktoken-method.md b/docs/core/unmanaged-api/metadata/imetadatafilter-marktoken-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatafilter-marktoken-method.md rename to docs/core/unmanaged-api/metadata/imetadatafilter-marktoken-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md b/docs/core/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md rename to docs/core/unmanaged-api/metadata/imetadatafilter-unmarkall-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-closeenum-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-closeenum-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-countenum-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-countenum-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumevents-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumevents-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enumevents-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enumevents-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enumfields-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enumfields-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enummembers-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enummembers-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enummethods-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummethods-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enummethods-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enummethods-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumparams-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumparams-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enumparams-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enumparams-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumproperties-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumproperties-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enumproperties-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enumproperties-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-findfield-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-findfield-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-findmember-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-findmember-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-findmemberref-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-findmemberref-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-findmethod-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-findmethod-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-findtyperef-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findtyperef-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-findtyperef-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-findtyperef-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getclasslayout-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-geteventprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-geteventprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getfieldprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getmemberprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getmethodprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getparamprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getparamprops-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getparamprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getparamprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getrva-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getrva-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getscopeprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-getuserstring-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getuserstring-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-getuserstring-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-getuserstring-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-interface.md b/docs/core/unmanaged-api/metadata/imetadataimport-interface.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-interface.md rename to docs/core/unmanaged-api/metadata/imetadataimport-interface.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-isglobal-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-isglobal-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-isglobal-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-isglobal-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport-resetenum-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-resetenum-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-resetenum-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-resetenum-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport2-getpekind-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getpekind-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport2-getpekind-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport2-getpekind-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md rename to docs/core/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadataimport2-interface.md b/docs/core/unmanaged-api/metadata/imetadataimport2-interface.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadataimport2-interface.md rename to docs/core/unmanaged-api/metadata/imetadataimport2-interface.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md b/docs/core/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md rename to docs/core/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatainfo-interface.md b/docs/core/unmanaged-api/metadata/imetadatainfo-interface.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatainfo-interface.md rename to docs/core/unmanaged-api/metadata/imetadatainfo-interface.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getblob-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getblob-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getblob-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getblob-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getcolumn-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getcolumn-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getguid-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getguid-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getnextblob-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnextblob-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getnextblob-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getnextblob-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getnextguid-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getnextguid-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getnextstring-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnextstring-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getnextstring-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getnextstring-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getnumtables-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnumtables-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getnumtables-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getnumtables-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getrow-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getrow-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getstring-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getstring-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getstring-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getstring-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables-gettableindex-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-gettableindex-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-gettableinfo-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getuserstring-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getuserstring-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables-interface.md b/docs/core/unmanaged-api/metadata/imetadatatables-interface.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables-interface.md rename to docs/core/unmanaged-api/metadata/imetadatatables-interface.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md b/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md b/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md rename to docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatatables2-interface.md b/docs/core/unmanaged-api/metadata/imetadatatables2-interface.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatatables2-interface.md rename to docs/core/unmanaged-api/metadata/imetadatatables2-interface.md diff --git a/docs/framework/unmanaged-api/metadata/imetadatavalidate-interface.md b/docs/core/unmanaged-api/metadata/imetadatavalidate-interface.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/imetadatavalidate-interface.md rename to docs/core/unmanaged-api/metadata/imetadatavalidate-interface.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 100% rename from docs/framework/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md rename to docs/core/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.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 100% rename from docs/framework/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md rename to docs/core/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md diff --git a/docs/framework/unmanaged-api/metadata/index.md b/docs/core/unmanaged-api/metadata/index.md similarity index 57% rename from docs/framework/unmanaged-api/metadata/index.md rename to docs/core/unmanaged-api/metadata/index.md index f7d9d1a77a12d..feb9b5221e36c 100644 --- a/docs/framework/unmanaged-api/metadata/index.md +++ b/docs/core/unmanaged-api/metadata/index.md @@ -1,21 +1,23 @@ --- -description: "Learn more about: Metadata (Unmanaged API Reference)" -title: "Metadata (Unmanaged API Reference)" -ms.date: "03/30/2017" +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 Framework], metadata" - - "native API reference [.NET Framework], metadata" - - "metadata [.NET Framework], using the unmanaged API" + - "unmanaged API reference [.NET], metadata" + - "native API reference [.NET], metadata" + - "metadata [.NET], using the unmanaged API" ms.assetid: 10cfea92-db5e-4bcb-b301-ef029bcf77a3 --- -# Metadata (Unmanaged API Reference) +# .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). +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 articles describe APIs that can be used with both .NET Framework and .NET. For .NET Framework-specific unmanaged APIs, see [.NET Framework metadata](../../../framework/unmanaged-api/metadata/index.md). ## 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. + Describes the unmanaged interfaces that provide access to the metadata exposed by the .NET 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. diff --git a/docs/framework/unmanaged-api/metadata/metadata-enumerations.md b/docs/core/unmanaged-api/metadata/metadata-enumerations.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/metadata-enumerations.md rename to docs/core/unmanaged-api/metadata/metadata-enumerations.md diff --git a/docs/framework/unmanaged-api/metadata/metadata-global-static-functions.md b/docs/core/unmanaged-api/metadata/metadata-global-static-functions.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/metadata-global-static-functions.md rename to docs/core/unmanaged-api/metadata/metadata-global-static-functions.md diff --git a/docs/framework/unmanaged-api/metadata/metadata-interfaces.md b/docs/core/unmanaged-api/metadata/metadata-interfaces.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/metadata-interfaces.md rename to docs/core/unmanaged-api/metadata/metadata-interfaces.md diff --git a/docs/framework/unmanaged-api/metadata/metadata-structures.md b/docs/core/unmanaged-api/metadata/metadata-structures.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/metadata-structures.md rename to docs/core/unmanaged-api/metadata/metadata-structures.md diff --git a/docs/framework/unmanaged-api/metadata/metadata-unions.md b/docs/core/unmanaged-api/metadata/metadata-unions.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/metadata-unions.md rename to docs/core/unmanaged-api/metadata/metadata-unions.md diff --git a/docs/framework/unmanaged-api/metadata/osinfo-structure.md b/docs/core/unmanaged-api/metadata/osinfo-structure.md similarity index 100% rename from docs/framework/unmanaged-api/metadata/osinfo-structure.md rename to docs/core/unmanaged-api/metadata/osinfo-structure.md diff --git a/docs/framework/unmanaged-api/metadata/toc.yml b/docs/core/unmanaged-api/metadata/toc.yml similarity index 100% rename from docs/framework/unmanaged-api/metadata/toc.yml rename to docs/core/unmanaged-api/metadata/toc.yml diff --git a/docs/core/unmanaged-api/toc.yml b/docs/core/unmanaged-api/toc.yml new file mode 100644 index 0000000000000..b1c6fae139573 --- /dev/null +++ b/docs/core/unmanaged-api/toc.yml @@ -0,0 +1,11 @@ +items: +- name: .NET unmanaged API reference + href: index.md +- name: Debugging + href: debugging/ +- name: Hosting + href: hosting/ +- name: Metadata + href: metadata/ +- name: Profiling + href: profiling/ \ No newline at end of file diff --git a/docs/framework/unmanaged-api/index.md b/docs/framework/unmanaged-api/index.md index eebc1dd6b19cf..907b35d084cf5 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,10 +9,12 @@ 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. +For unmanaged APIs that can be used with both .NET Framework and .NET, see [.NET unmanaged API reference](../../core/unmanaged-api/index.md). + ## In This Section [Common Data Types](common-data-types-unmanaged-api-reference.md) @@ -39,11 +41,11 @@ This section includes information on unmanaged APIs that can be used by managed- [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) - Describes the hosting API, which enables unmanaged hosts to integrate the CLR into their applications. + [Hosting](../../core/unmanaged-api/hosting/index.md) + For hosting APIs that can be used with both .NET Framework and .NET, see the .NET unmanaged API reference. - [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. + [Metadata](../../core/unmanaged-api/metadata/index.md) + For metadata APIs that can be used with both .NET Framework and .NET, see the .NET unmanaged API reference. [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/toc.yml b/docs/framework/unmanaged-api/toc.yml index cd603b8791981..2619166014f85 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 @@ -36,10 +36,6 @@ items: href: diagnostics/ - name: Fusion href: fusion/ -- name: Hosting - href: hosting/ -- name: Metadata - href: metadata/ - name: Profiling href: profiling/ - name: Strong naming From cf91c30d76fcfa92cd6111021f37e3a3f46f2cf9 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 26 Jun 2025 09:39:46 +0000 Subject: [PATCH 03/20] Fix cross-references to moved metadata and hosting APIs Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com> --- .../emitting-dynamic-methods-and-assemblies.md | 2 +- .../runtime-libraries/system-threading-thread.md | 2 +- .../app-domain-resource-monitoring.md | 14 +++++++------- docs/standard/garbage-collection/performance.md | 2 +- .../threading/exceptions-in-managed-threads.md | 2 +- docs/standard/threading/the-managed-thread-pool.md | 4 ++-- 6 files changed, 13 insertions(+), 13 deletions(-) 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/fundamentals/runtime-libraries/system-threading-thread.md b/docs/fundamentals/runtime-libraries/system-threading-thread.md index ea4362c976b6b..c731052e02488 100644 --- a/docs/fundamentals/runtime-libraries/system-threading-thread.md +++ b/docs/fundamentals/runtime-libraries/system-threading-thread.md @@ -124,7 +124,7 @@ You can retrieve a number of property values that provide information about a th - A thread ID. The value of the read-only property is assigned by the runtime and uniquely identifies a thread within its process. > [!NOTE] - > An operating-system [ThreadId](/windows/win32/api/processthreadsapi/nf-processthreadsapi-getthreadid) has no fixed relationship to a managed thread, because an unmanaged host can control the relationship between managed and unmanaged threads. Specifically, a sophisticated host can use the [CLR Hosting API](../../framework/unmanaged-api/hosting/index.md) to schedule many managed threads against the same operating system thread, or to move a managed thread between different operating system threads. + > An operating-system [ThreadId](/windows/win32/api/processthreadsapi/nf-processthreadsapi-getthreadid) has no fixed relationship to a managed thread, because an unmanaged host can control the relationship between managed and unmanaged threads. Specifically, a sophisticated host can use the [CLR Hosting API](../../core/unmanaged-api/hosting/index.md) to schedule many managed threads against the same operating system thread, or to move a managed thread between different operating system threads. - The thread's current state. For the duration of its existence, a thread is always in one or more of the states defined by the property. diff --git a/docs/standard/garbage-collection/app-domain-resource-monitoring.md b/docs/standard/garbage-collection/app-domain-resource-monitoring.md index 96155cd900fdf..d220d7fe8a6e5 100644 --- a/docs/standard/garbage-collection/app-domain-resource-monitoring.md +++ b/docs/standard/garbage-collection/app-domain-resource-monitoring.md @@ -25,7 +25,7 @@ As soon as ARM is enabled, it begins collecting data on all application domains - You can enable ARM at CLR startup by adding the [\](../../framework/configure-apps/file-schema/runtime/appdomainresourcemonitoring-element.md) element to the configuration file, and setting the `enabled` attribute to `true`. A value of `false` (the default) means only that ARM is not enabled at startup; you can activate it later by using one of the other activation mechanisms. -- The host can enable ARM by requesting the [ICLRAppDomainResourceMonitor](../../framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md) hosting interface. Once this interface is successfully obtained, ARM is enabled. +- The host can enable ARM by requesting the [ICLRAppDomainResourceMonitor](../../core/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md) hosting interface. Once this interface is successfully obtained, ARM is enabled. - Managed code can enable ARM by setting the static (`Shared` in Visual Basic) property to `true`. As soon as the property is set, ARM is enabled. @@ -39,7 +39,7 @@ ARM provides the total processor time that is used by an application domain and - Managed API: property. - - Hosting API: [ICLRAppDomainResourceMonitor::GetCurrentCpuTime](../../framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentcputime-method.md) method. + - Hosting API: [ICLRAppDomainResourceMonitor::GetCurrentCpuTime](../../core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentcputime-method.md) method. - ETW events: `ThreadCreated`, `ThreadAppDomainEnter`, and `ThreadTerminated` events. For information about providers and keywords, see "AppDomain Resource Monitoring Events" in [CLR ETW Events](../../framework/performance/clr-etw-events.md). @@ -47,7 +47,7 @@ ARM provides the total processor time that is used by an application domain and - Managed API: property. - - Hosting API: [ICLRAppDomainResourceMonitor::GetCurrentAllocated](../../framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentallocated-method.md) method. + - Hosting API: [ICLRAppDomainResourceMonitor::GetCurrentAllocated](../../core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentallocated-method.md) method. - ETW events: `AppDomainMemAllocated` event, `Allocated` field. @@ -55,7 +55,7 @@ ARM provides the total processor time that is used by an application domain and - Managed API: property. - - Hosting API: [ICLRAppDomainResourceMonitor::GetCurrentSurvived](../../framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md) method, `pAppDomainBytesSurvived` parameter. + - Hosting API: [ICLRAppDomainResourceMonitor::GetCurrentSurvived](../../core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md) method, `pAppDomainBytesSurvived` parameter. - ETW events: `AppDomainMemSurvived` event, `Survived` field. @@ -63,7 +63,7 @@ ARM provides the total processor time that is used by an application domain and - Managed API: property. - - Hosting API: [ICLRAppDomainResourceMonitor::GetCurrentSurvived](../../framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md) method, `pTotalBytesSurvived` parameter. + - Hosting API: [ICLRAppDomainResourceMonitor::GetCurrentSurvived](../../core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md) method, `pTotalBytesSurvived` parameter. - ETW events: `AppDomainMemSurvived` event, `ProcessSurvived` field. @@ -79,11 +79,11 @@ Alternatively, you can call the -- [ICLRAppDomainResourceMonitor Interface](../../framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md) +- [ICLRAppDomainResourceMonitor Interface](../../core/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md) - [\](../../framework/configure-apps/file-schema/runtime/appdomainresourcemonitoring-element.md) - [CLR ETW Events](../../framework/performance/clr-etw-events.md) diff --git a/docs/standard/garbage-collection/performance.md b/docs/standard/garbage-collection/performance.md index 49aad1f58ec9d..655a63b489f5b 100644 --- a/docs/standard/garbage-collection/performance.md +++ b/docs/standard/garbage-collection/performance.md @@ -117,7 +117,7 @@ If fragmentation of virtual memory is preventing the garbage collector from addi - Holding too many references to COM objects when interoperating with unmanaged code. - Creation of large transient objects, which causes the large object heap to allocate and free heap segments frequently. - When hosting the CLR, an application can request that the garbage collector retain its segments. This reduces the frequency of segment allocations. This is accomplished by using the STARTUP_HOARD_GC_VM flag in the [STARTUP_FLAGS Enumeration](../../framework/unmanaged-api/hosting/startup-flags-enumeration.md). + When hosting the CLR, an application can request that the garbage collector retain its segments. This reduces the frequency of segment allocations. This is accomplished by using the STARTUP_HOARD_GC_VM flag in the [STARTUP_FLAGS Enumeration](../../core/unmanaged-api/hosting/startup-flags-enumeration.md). |Performance checks| |------------------------| diff --git a/docs/standard/threading/exceptions-in-managed-threads.md b/docs/standard/threading/exceptions-in-managed-threads.md index c659812979970..8e08fe0d44f53 100644 --- a/docs/standard/threading/exceptions-in-managed-threads.md +++ b/docs/standard/threading/exceptions-in-managed-threads.md @@ -34,7 +34,7 @@ If these exceptions are unhandled in the main thread, or in threads that entered ## Host override -An unmanaged host can use the [ICLRPolicyManager](../../framework/unmanaged-api/hosting/iclrpolicymanager-interface.md) interface in the Hosting API to override the default unhandled exception policy of the common language runtime. The [ICLRPolicyManager::SetUnhandledExceptionPolicy](../../framework/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md) function is used to set the policy for unhandled exceptions. +An unmanaged host can use the [ICLRPolicyManager](../../core/unmanaged-api/hosting/iclrpolicymanager-interface.md) interface in the Hosting API to override the default unhandled exception policy of the common language runtime. The [ICLRPolicyManager::SetUnhandledExceptionPolicy](../../core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md) function is used to set the policy for unhandled exceptions. ## See also diff --git a/docs/standard/threading/the-managed-thread-pool.md b/docs/standard/threading/the-managed-thread-pool.md index 47c2c80e23525..316b19ef54807 100644 --- a/docs/standard/threading/the-managed-thread-pool.md +++ b/docs/standard/threading/the-managed-thread-pool.md @@ -38,7 +38,7 @@ The number of operations that can be queued to the thread pool is limited only b You can control the maximum number of threads by using the and methods. > [!NOTE] -> Code that hosts the common language runtime can set the size using the [`ICorThreadpool::CorSetMaxThreads`](../../framework/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md) method. +> Code that hosts the common language runtime can set the size using the [`ICorThreadpool::CorSetMaxThreads`](../../core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md) method. ### Thread pool minimums @@ -56,7 +56,7 @@ When a minimum is reached, the thread pool can create additional threads or wait The easiest way to use the thread pool is to use the [Task Parallel Library (TPL)](../parallel-programming/task-parallel-library-tpl.md). By default, TPL types like and use thread pool threads to run tasks. -You can also use the thread pool by calling from managed code (or [`ICorThreadpool::CorQueueUserWorkItem`](../../framework/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md) from unmanaged code) and passing a delegate representing the method that performs the task. +You can also use the thread pool by calling from managed code (or [`ICorThreadpool::CorQueueUserWorkItem`](../../core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md) from unmanaged code) and passing a delegate representing the method that performs the task. Another way to use the thread pool is to queue work items that are related to a wait operation by using the method and passing a that, when signaled or when timed out, calls the method represented by the delegate. Thread pool threads are used to invoke callback methods. From 9e84548ff19a22b9a6e6a97323bbb66a7e746f21 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 26 Jun 2025 09:43:22 +0000 Subject: [PATCH 04/20] Fix linting issues and finalize API move Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com> --- docs/core/unmanaged-api/index.md | 2 +- docs/core/unmanaged-api/toc.yml | 3 ++- docs/framework/unmanaged-api/toc.yml | 1 + 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/core/unmanaged-api/index.md b/docs/core/unmanaged-api/index.md index c0927bb136587..5c98323766f21 100644 --- a/docs/core/unmanaged-api/index.md +++ b/docs/core/unmanaged-api/index.md @@ -21,4 +21,4 @@ Describes the hosting API, which enables unmanaged hosts to integrate the CLR in 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. \ No newline at end of file +Describes the profiling API, which enables a profiler to monitor a program's execution by the CLR. diff --git a/docs/core/unmanaged-api/toc.yml b/docs/core/unmanaged-api/toc.yml index b1c6fae139573..843bd09bf83a7 100644 --- a/docs/core/unmanaged-api/toc.yml +++ b/docs/core/unmanaged-api/toc.yml @@ -1,4 +1,5 @@ items: + - name: .NET unmanaged API reference href: index.md - name: Debugging @@ -8,4 +9,4 @@ items: - name: Metadata href: metadata/ - name: Profiling - href: profiling/ \ No newline at end of file + href: profiling/ diff --git a/docs/framework/unmanaged-api/toc.yml b/docs/framework/unmanaged-api/toc.yml index 2619166014f85..6336be1765b22 100644 --- a/docs/framework/unmanaged-api/toc.yml +++ b/docs/framework/unmanaged-api/toc.yml @@ -1,4 +1,5 @@ items: + - name: .NET Framework unmanaged API reference href: index.md - name: Common data types From 4dc60657524839a0f4ed6b837c32c2874df6a237 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 26 Jun 2025 11:30:49 +0000 Subject: [PATCH 05/20] Fix invalid link warnings in moved API documentation Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com> --- docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md | 2 +- docs/core/unmanaged-api/hosting/bucketparameters-structure.md | 2 +- docs/core/unmanaged-api/hosting/callfunctionshim-function.md | 2 +- docs/core/unmanaged-api/hosting/clrcreateinstance-function.md | 2 +- .../unmanaged-api/hosting/clrcreatemanagedinstance-function.md | 2 +- docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md | 2 +- .../unmanaged-api/hosting/clsid-resolution-flags-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md | 2 +- docs/core/unmanaged-api/hosting/coinitializeee-function.md | 2 +- docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md | 2 +- .../core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md | 2 +- .../core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md | 2 +- .../hosting/cor-gc-thread-stats-types-enumeration.md | 2 +- .../unmanaged-api/hosting/corbindtocurrentruntime-function.md | 2 +- docs/core/unmanaged-api/hosting/corbindtoruntime-function.md | 2 +- .../unmanaged-api/hosting/corbindtoruntimebycfg-function.md | 2 +- docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md | 2 +- .../core/unmanaged-api/hosting/corbindtoruntimehost-function.md | 2 +- docs/core/unmanaged-api/hosting/cordllmain-function.md | 2 +- docs/core/unmanaged-api/hosting/corexemain-function.md | 2 +- docs/core/unmanaged-api/hosting/corexemain2-function.md | 2 +- docs/core/unmanaged-api/hosting/corexitprocess-function.md | 2 +- docs/core/unmanaged-api/hosting/corimageunloading-function.md | 2 +- .../core/unmanaged-api/hosting/corlaunchapplication-function.md | 2 +- .../unmanaged-api/hosting/cormarkthreadinthreadpool-function.md | 2 +- docs/core/unmanaged-api/hosting/corruntimehost-coclass.md | 2 +- docs/core/unmanaged-api/hosting/corvalidateimage-function.md | 2 +- .../hosting/createdebugginginterfacefromversion-function.md | 2 +- docs/core/unmanaged-api/hosting/createiceefilegen-function.md | 2 +- docs/core/unmanaged-api/hosting/customdumpitem-structure.md | 2 +- docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md | 2 +- docs/core/unmanaged-api/hosting/eapicategories-enumeration.md | 2 +- .../core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md | 2 +- .../hosting/eclrassemblyidentityflags-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/eclrevent-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/eclroperation-enumeration.md | 2 +- .../unmanaged-api/hosting/eclrunhandledexception-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/econtexttype-enumeration.md | 2 +- .../core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md | 2 +- .../unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md | 2 +- .../unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md | 2 +- .../hosting/ehostbindingpolicymodifyflags-enumeration.md | 2 +- .../hosting/einitializenewdomainflags-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md | 2 +- .../unmanaged-api/hosting/ememorycriticallevel-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md | 2 +- .../unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/etasktype-enumeration.md | 2 +- .../hosting/fexecuteinappdomaincallback-function-pointer.md | 2 +- .../hosting/flockclrversioncallback-function-pointer.md | 2 +- .../unmanaged-api/hosting/getclridentitymanager-function.md | 2 +- .../unmanaged-api/hosting/getcorrequiredversion-function.md | 2 +- .../unmanaged-api/hosting/getcorsystemdirectory-function.md | 2 +- docs/core/unmanaged-api/hosting/getcorversion-function.md | 2 +- docs/core/unmanaged-api/hosting/getfileversion-function.md | 2 +- docs/core/unmanaged-api/hosting/getrealprocaddress-function.md | 2 +- .../unmanaged-api/hosting/getrequestedruntimeinfo-function.md | 2 +- .../hosting/getrequestedruntimeversion-function.md | 2 +- .../hosting/getrequestedruntimeversionforclsid-function.md | 2 +- .../unmanaged-api/hosting/getversionfromprocess-function.md | 2 +- docs/core/unmanaged-api/hosting/host-type-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md | 2 +- .../unmanaged-api/hosting/iactiononclrevent-onevent-method.md | 2 +- .../hosting/iapartmentcallback-docallback-method.md | 2 +- docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md | 2 +- docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md | 2 +- .../hosting/iappdomainbinding-onappdomain-method.md | 2 +- docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md | 2 +- docs/core/unmanaged-api/hosting/iceefilegen-class.md | 2 +- .../iclrappdomainresourcemonitor-getcurrentallocated-method.md | 2 +- .../iclrappdomainresourcemonitor-getcurrentcputime-method.md | 2 +- .../iclrappdomainresourcemonitor-getcurrentsurvived-method.md | 2 +- .../hosting/iclrappdomainresourcemonitor-interface.md | 2 +- ...assemblyidentitymanager-getbindingidentityfromfile-method.md | 2 +- ...semblyidentitymanager-getbindingidentityfromstream-method.md | 2 +- ...ssemblyidentitymanager-getclrassemblyreferencelist-method.md | 2 +- ...yidentitymanager-getprobingassembliesfromreference-method.md | 2 +- ...blyidentitymanager-getreferencedassembliesfromfile-method.md | 2 +- ...yidentitymanager-getreferencedassembliesfromstream-method.md | 2 +- .../hosting/iclrassemblyidentitymanager-interface.md | 2 +- .../iclrassemblyidentitymanager-isstronglynamed-method.md | 2 +- .../hosting/iclrassemblyreferencelist-interface.md | 2 +- ...clrassemblyreferencelist-isassemblyreferenceinlist-method.md | 2 +- ...emblyreferencelist-isstringassemblyreferenceinlist-method.md | 2 +- .../unmanaged-api/hosting/iclrcontrol-getclrmanager-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrcontrol-interface.md | 2 +- .../hosting/iclrcontrol-setappdomainmanagertype-method.md | 2 +- .../hosting/iclrdebugmanager-beginconnection-method.md | 2 +- .../hosting/iclrdebugmanager-endconnection-method.md | 2 +- .../unmanaged-api/hosting/iclrdebugmanager-getdacl-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrdebugmanager-interface.md | 2 +- .../hosting/iclrdebugmanager-isdebuggerattached-method.md | 2 +- .../hosting/iclrdebugmanager-setconnectiontasks-method.md | 2 +- .../unmanaged-api/hosting/iclrdebugmanager-setdacl-method.md | 2 +- .../hosting/iclrdebugmanager-setsymbolreadingpolicy-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrdomainmanager-interface.md | 2 +- .../hosting/iclrdomainmanager-setappdomainmanagertype-method.md | 2 +- ...iclrdomainmanager-setpropertiesfordefaultappdomain-method.md | 2 +- .../hosting/iclrerrorreportingmanager-begincustomdump-method.md | 2 +- .../hosting/iclrerrorreportingmanager-endcustomdump-method.md | 2 +- ...tingmanager-getbucketparametersforcurrentexception-method.md | 2 +- .../hosting/iclrerrorreportingmanager-interface.md | 2 +- docs/core/unmanaged-api/hosting/iclrgcmanager-collect-method.md | 2 +- .../core/unmanaged-api/hosting/iclrgcmanager-getstats-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md | 2 +- .../hosting/iclrgcmanager-setgcstartuplimits-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md | 2 +- .../hosting/iclrgcmanager2-setgcstartuplimitsex-method.md | 2 +- .../iclrhostbindingpolicymanager-evaluatepolicy-method.md | 2 +- .../hosting/iclrhostbindingpolicymanager-interface.md | 2 +- ...lrhostbindingpolicymanager-modifyapplicationpolicy-method.md | 2 +- .../hosting/iclrhostprotectionmanager-interface.md | 2 +- ...lrhostprotectionmanager-seteagerserializegrantsets-method.md | 2 +- .../iclrhostprotectionmanager-setprotectedcategories-method.md | 2 +- .../unmanaged-api/hosting/iclriocompletionmanager-interface.md | 2 +- .../hosting/iclriocompletionmanager-oncomplete-method.md | 2 +- .../hosting/iclrmemorynotificationcallback-interface.md | 2 +- ...clrmemorynotificationcallback-onmemorynotification-method.md | 2 +- .../hosting/iclrmetahost-enumerateinstalledruntimes-method.md | 2 +- .../hosting/iclrmetahost-enumerateloadedruntimes-method.md | 2 +- .../unmanaged-api/hosting/iclrmetahost-exitprocess-method.md | 2 +- .../unmanaged-api/hosting/iclrmetahost-getruntime-method.md | 2 +- .../hosting/iclrmetahost-getversionfromfile-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrmetahost-interface.md | 2 +- .../hosting/iclrmetahost-querylegacyv2runtimebinding-method.md | 2 +- .../iclrmetahost-requestruntimeloadednotification-method.md | 2 +- .../hosting/iclrmetahostpolicy-getrequestedruntime-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md | 2 +- docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md | 2 +- .../hosting/iclroneventmanager-registeractiononevent-method.md | 2 +- .../iclroneventmanager-unregisteractiononevent-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md | 2 +- .../hosting/iclrpolicymanager-setactiononfailure-method.md | 2 +- .../hosting/iclrpolicymanager-setactionontimeout-method.md | 2 +- .../hosting/iclrpolicymanager-setdefaultaction-method.md | 2 +- .../hosting/iclrpolicymanager-settimeout-method.md | 2 +- .../hosting/iclrpolicymanager-settimeoutandaction-method.md | 2 +- .../iclrpolicymanager-setunhandledexceptionpolicy-method.md | 2 +- .../unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md | 2 +- .../unmanaged-api/hosting/iclrprobingassemblyenum-interface.md | 2 +- .../hosting/iclrreferenceassemblyenum-get-method.md | 2 +- .../hosting/iclrreferenceassemblyenum-interface.md | 2 +- .../hosting/iclrruntimehost-executeapplication-method.md | 2 +- .../hosting/iclrruntimehost-executeinappdomain-method.md | 2 +- .../hosting/iclrruntimehost-executeindefaultappdomain-method.md | 2 +- .../hosting/iclrruntimehost-getclrcontrol-method.md | 2 +- .../hosting/iclrruntimehost-getcurrentappdomainid-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md | 2 +- .../hosting/iclrruntimehost-sethostcontrol-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md | 2 +- .../hosting/iclrruntimehost-unloadappdomain-method.md | 2 +- .../hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md | 2 +- .../hosting/iclrruntimeinfo-getdefaultstartupflags-method.md | 2 +- .../hosting/iclrruntimeinfo-getinterface-method.md | 2 +- .../hosting/iclrruntimeinfo-getprocaddress-method.md | 2 +- .../hosting/iclrruntimeinfo-getruntimedirectory-method.md | 2 +- .../hosting/iclrruntimeinfo-getversionstring-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md | 2 +- .../unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md | 2 +- .../unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md | 2 +- .../unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md | 2 +- .../hosting/iclrruntimeinfo-loaderrorstring-method.md | 2 +- .../unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md | 2 +- .../hosting/iclrruntimeinfo-setdefaultstartupflags-method.md | 2 +- .../hosting/iclrstrongname-gethashfromassemblyfile-method.md | 2 +- .../hosting/iclrstrongname-gethashfromassemblyfilew-method.md | 2 +- .../hosting/iclrstrongname-gethashfromblob-method.md | 2 +- .../hosting/iclrstrongname-gethashfromfile-method.md | 2 +- .../hosting/iclrstrongname-gethashfromfilew-method.md | 2 +- .../hosting/iclrstrongname-gethashfromhandle-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrstrongname-interface.md | 2 +- .../iclrstrongname-strongnamecompareassemblies-method.md | 2 +- .../hosting/iclrstrongname-strongnamefreebuffer-method.md | 2 +- .../hosting/iclrstrongname-strongnamegetblob-method.md | 2 +- .../hosting/iclrstrongname-strongnamegetblobfromimage-method.md | 2 +- .../hosting/iclrstrongname-strongnamegetpublickey-method.md | 2 +- .../hosting/iclrstrongname-strongnamehashsize-method.md | 2 +- .../hosting/iclrstrongname-strongnamekeydelete-method.md | 2 +- .../hosting/iclrstrongname-strongnamekeygen-method.md | 2 +- .../hosting/iclrstrongname-strongnamekeygenex-method.md | 2 +- .../hosting/iclrstrongname-strongnamekeyinstall-method.md | 2 +- .../iclrstrongname-strongnamesignaturegeneration-method.md | 2 +- .../iclrstrongname-strongnamesignaturegenerationex-method.md | 2 +- .../hosting/iclrstrongname-strongnamesignaturesize-method.md | 2 +- .../iclrstrongname-strongnamesignatureverification-method.md | 2 +- .../iclrstrongname-strongnamesignatureverificationex-method.md | 2 +- ...trongname-strongnamesignatureverificationfromimage-method.md | 2 +- .../iclrstrongname-strongnametokenfromassembly-method.md | 2 +- .../iclrstrongname-strongnametokenfromassemblyex-method.md | 2 +- .../iclrstrongname-strongnametokenfrompublickey-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md | 2 +- .../hosting/iclrsyncmanager-createrwlockowneriterator-method.md | 2 +- .../hosting/iclrsyncmanager-deleterwlockowneriterator-method.md | 2 +- .../hosting/iclrsyncmanager-getmonitorowner-method.md | 2 +- .../hosting/iclrsyncmanager-getrwlockownernext-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-abort-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-interface.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md | 2 +- .../hosting/iclrtask-needspriorityscheduling-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-reset-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md | 2 +- .../unmanaged-api/hosting/iclrtask-settaskidentifier-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md | 2 +- .../hosting/iclrtask2-beginpreventasyncabort-method.md | 2 +- .../hosting/iclrtask2-endpreventasyncabort-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask2-interface.md | 2 +- .../unmanaged-api/hosting/iclrtaskmanager-createtask-method.md | 2 +- .../hosting/iclrtaskmanager-getcurrenttask-method.md | 2 +- .../hosting/iclrtaskmanager-getcurrenttasktype-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md | 2 +- .../unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md | 2 +- .../unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md | 2 +- .../hosting/iclrvalidator-formateventinfo-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrvalidator-interface.md | 2 +- .../core/unmanaged-api/hosting/iclrvalidator-validate-method.md | 2 +- .../icorconfiguration-adddebuggerspecialthread-method.md | 2 +- docs/core/unmanaged-api/hosting/icorconfiguration-interface.md | 2 +- .../icorconfiguration-setdebuggerthreadcontrol-method.md | 2 +- .../hosting/icorconfiguration-setgchostcontrol-method.md | 2 +- .../hosting/icorconfiguration-setgcthreadcontrol-method.md | 2 +- .../unmanaged-api/hosting/icorruntimehost-closeenum-method.md | 2 +- .../hosting/icorruntimehost-createdomain-method.md | 2 +- .../hosting/icorruntimehost-createdomainex-method.md | 2 +- .../hosting/icorruntimehost-createdomainsetup-method.md | 2 +- .../hosting/icorruntimehost-createevidence-method.md | 2 +- .../hosting/icorruntimehost-createlogicalthreadstate-method.md | 2 +- .../hosting/icorruntimehost-currentdomain-method.md | 2 +- .../hosting/icorruntimehost-deletelogicalthreadstate-method.md | 2 +- .../unmanaged-api/hosting/icorruntimehost-enumdomains-method.md | 2 +- .../hosting/icorruntimehost-getconfiguration-method.md | 2 +- .../hosting/icorruntimehost-getdefaultdomain-method.md | 2 +- docs/core/unmanaged-api/hosting/icorruntimehost-interface.md | 2 +- .../hosting/icorruntimehost-locksheldbylogicalthread-method.md | 2 +- .../unmanaged-api/hosting/icorruntimehost-mapfile-method.md | 2 +- .../unmanaged-api/hosting/icorruntimehost-nextdomain-method.md | 2 +- docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md | 2 +- docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md | 2 +- .../icorruntimehost-switchinlogicalthreadstate-method.md | 2 +- .../icorruntimehost-switchoutlogicalthreadstate-method.md | 2 +- .../hosting/icorruntimehost-unloaddomain-method.md | 2 +- .../icorthreadpool-corbindiocompletioncallback-method.md | 2 +- .../hosting/icorthreadpool-corcallorqueueuserworkitem-method.md | 2 +- .../hosting/icorthreadpool-corchangetimer-method.md | 2 +- .../hosting/icorthreadpool-corcreatetimer-method.md | 2 +- .../hosting/icorthreadpool-cordeletetimer-method.md | 2 +- .../hosting/icorthreadpool-corgetavailablethreads-method.md | 2 +- .../hosting/icorthreadpool-corgetmaxthreads-method.md | 2 +- .../hosting/icorthreadpool-corqueueuserworkitem-method.md | 2 +- .../icorthreadpool-corregisterwaitforsingleobject-method.md | 2 +- .../hosting/icorthreadpool-corsetmaxthreads-method.md | 2 +- .../hosting/icorthreadpool-corunregisterwait-method.md | 2 +- docs/core/unmanaged-api/hosting/icorthreadpool-interface.md | 2 +- docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md | 2 +- .../hosting/idebuggerinfo-isdebuggerattached-method.md | 2 +- .../unmanaged-api/hosting/idebuggerthreadcontrol-interface.md | 2 +- .../idebuggerthreadcontrol-releaseallruntimethreads-method.md | 2 +- .../idebuggerthreadcontrol-startblockingfordebugger-method.md | 2 +- ...idebuggerthreadcontrol-threadisblockingfordebugger-method.md | 2 +- docs/core/unmanaged-api/hosting/igchost-collect-method.md | 2 +- docs/core/unmanaged-api/hosting/igchost-getstats-method.md | 2 +- .../core/unmanaged-api/hosting/igchost-getthreadstats-method.md | 2 +- docs/core/unmanaged-api/hosting/igchost-interface.md | 2 +- .../unmanaged-api/hosting/igchost-setgcstartuplimits-method.md | 2 +- .../unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md | 2 +- docs/core/unmanaged-api/hosting/igchost2-interface.md | 2 +- .../hosting/igchost2-setgcstartuplimitsex-method.md | 2 +- docs/core/unmanaged-api/hosting/igchostcontrol-interface.md | 2 +- .../hosting/igchostcontrol-requestvirtualmemlimit-method.md | 2 +- docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md | 2 +- .../hosting/igcthreadcontrol-suspensionending-method.md | 2 +- .../hosting/igcthreadcontrol-suspensionstarting-method.md | 2 +- .../igcthreadcontrol-threadisblockingforsuspension-method.md | 2 +- .../hosting/ihostassemblymanager-getassemblystore-method.md | 2 +- .../ihostassemblymanager-getnonhoststoreassemblies-method.md | 2 +- .../unmanaged-api/hosting/ihostassemblymanager-interface.md | 2 +- docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md | 2 +- .../hosting/ihostassemblystore-provideassembly-method.md | 2 +- .../hosting/ihostassemblystore-providemodule-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostautoevent-interface.md | 2 +- docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md | 2 +- .../unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostcontrol-interface.md | 2 +- .../hosting/ihostcontrol-setappdomainmanager-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostcrst-interface.md | 2 +- docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md | 2 +- .../core/unmanaged-api/hosting/ihostcrst-setspincount-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md | 2 +- .../hosting/ihostgcmanager-suspensionending-method.md | 2 +- .../hosting/ihostgcmanager-suspensionstarting-method.md | 2 +- .../ihostgcmanager-threadisblockingforsuspension-method.md | 2 +- .../hosting/ihostiocompletionmanager-bind-method.md | 2 +- .../ihostiocompletionmanager-closeiocompletionport-method.md | 2 +- .../ihostiocompletionmanager-createiocompletionport-method.md | 2 +- .../ihostiocompletionmanager-getavailablethreads-method.md | 2 +- .../ihostiocompletionmanager-gethostoverlappedsize-method.md | 2 +- .../hosting/ihostiocompletionmanager-getmaxthreads-method.md | 2 +- .../hosting/ihostiocompletionmanager-getminthreads-method.md | 2 +- .../ihostiocompletionmanager-initializehostoverlapped-method.md | 2 +- .../unmanaged-api/hosting/ihostiocompletionmanager-interface.md | 2 +- ...ihostiocompletionmanager-setclriocompletionmanager-method.md | 2 +- .../hosting/ihostiocompletionmanager-setmaxthreads-method.md | 2 +- .../hosting/ihostiocompletionmanager-setminthreads-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md | 2 +- .../core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostmalloc-interface.md | 2 +- docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md | 2 +- .../core/unmanaged-api/hosting/ihostmanualevent-reset-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md | 2 +- .../ihostmemorymanager-acquiredvirtualaddressspace-method.md | 2 +- .../hosting/ihostmemorymanager-createmalloc-method.md | 2 +- .../hosting/ihostmemorymanager-getmemoryload-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md | 2 +- .../ihostmemorymanager-needsvirtualaddressspace-method.md | 2 +- ...stmemorymanager-registermemorynotificationcallback-method.md | 2 +- .../ihostmemorymanager-releasedvirtualaddressspace-method.md | 2 +- .../hosting/ihostmemorymanager-virtualalloc-method.md | 2 +- .../hosting/ihostmemorymanager-virtualfree-method.md | 2 +- .../hosting/ihostmemorymanager-virtualprotect-method.md | 2 +- .../hosting/ihostmemorymanager-virtualquery-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md | 2 +- .../hosting/ihostpolicymanager-ondefaultaction-method.md | 2 +- .../hosting/ihostpolicymanager-onfailure-method.md | 2 +- .../hosting/ihostpolicymanager-ontimeout-method.md | 2 +- .../hosting/ihostsecuritycontext-capture-method.md | 2 +- .../unmanaged-api/hosting/ihostsecuritycontext-interface.md | 2 +- .../hosting/ihostsecuritymanager-getsecuritycontext-method.md | 2 +- .../ihostsecuritymanager-impersonateloggedonuser-method.md | 2 +- .../unmanaged-api/hosting/ihostsecuritymanager-interface.md | 2 +- .../hosting/ihostsecuritymanager-openthreadtoken-method.md | 2 +- .../hosting/ihostsecuritymanager-reverttoself-method.md | 2 +- .../hosting/ihostsecuritymanager-setsecuritycontext-method.md | 2 +- .../hosting/ihostsecuritymanager-setthreadtoken-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md | 2 +- .../hosting/ihostsemaphore-releasesemaphore-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md | 2 +- .../hosting/ihostsyncmanager-createautoevent-method.md | 2 +- .../unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md | 2 +- .../hosting/ihostsyncmanager-createcrstwithspincount-method.md | 2 +- .../hosting/ihostsyncmanager-createmanualevent-method.md | 2 +- .../hosting/ihostsyncmanager-createmonitorevent-method.md | 2 +- .../hosting/ihostsyncmanager-createrwlockreaderevent-method.md | 2 +- .../hosting/ihostsyncmanager-createrwlockwriterevent-method.md | 2 +- .../hosting/ihostsyncmanager-createsemaphore-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md | 2 +- .../hosting/ihostsyncmanager-setclrsyncmanager-method.md | 2 +- docs/core/unmanaged-api/hosting/ihosttask-alert-method.md | 2 +- docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md | 2 +- docs/core/unmanaged-api/hosting/ihosttask-interface.md | 2 +- docs/core/unmanaged-api/hosting/ihosttask-join-method.md | 2 +- docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md | 2 +- docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md | 2 +- docs/core/unmanaged-api/hosting/ihosttask-start-method.md | 2 +- .../hosting/ihosttaskmanager-begindelayabort-method.md | 2 +- .../hosting/ihosttaskmanager-beginthreadaffinity-method.md | 2 +- .../hosting/ihosttaskmanager-callneedshosthook-method.md | 2 +- .../unmanaged-api/hosting/ihosttaskmanager-createtask-method.md | 2 +- .../hosting/ihosttaskmanager-enddelayabort-method.md | 2 +- .../hosting/ihosttaskmanager-endthreadaffinity-method.md | 2 +- .../hosting/ihosttaskmanager-enterruntime-method.md | 2 +- .../hosting/ihosttaskmanager-getcurrenttask-method.md | 2 +- .../hosting/ihosttaskmanager-getstackguarantee-method.md | 2 +- docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md | 2 +- .../hosting/ihosttaskmanager-leaveruntime-method.md | 2 +- .../hosting/ihosttaskmanager-reverseenterruntime-method.md | 2 +- .../hosting/ihosttaskmanager-reverseleaveruntime-method.md | 2 +- .../hosting/ihosttaskmanager-setclrtaskmanager-method.md | 2 +- .../unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md | 2 +- .../hosting/ihosttaskmanager-setstackguarantee-method.md | 2 +- .../hosting/ihosttaskmanager-setuilocale-method.md | 2 +- .../core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md | 2 +- .../hosting/ihosttaskmanager-switchtotask-method.md | 2 +- .../ihostthreadpoolmanager-getavailablethreads-method.md | 2 +- .../hosting/ihostthreadpoolmanager-getmaxthreads-method.md | 2 +- .../hosting/ihostthreadpoolmanager-getminthreads-method.md | 2 +- .../unmanaged-api/hosting/ihostthreadpoolmanager-interface.md | 2 +- .../hosting/ihostthreadpoolmanager-queueuserworkitem-method.md | 2 +- .../hosting/ihostthreadpoolmanager-setmaxthreads-method.md | 2 +- .../hosting/ihostthreadpoolmanager-setminthreads-method.md | 2 +- .../hosting/imanagedobject-getobjectidentity-method.md | 2 +- .../hosting/imanagedobject-getserializedbuffer-method.md | 2 +- docs/core/unmanaged-api/hosting/imanagedobject-interface.md | 2 +- docs/core/unmanaged-api/hosting/iobjecthandle-interface.md | 2 +- docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md | 2 +- .../unmanaged-api/hosting/itypename-getassemblyname-method.md | 2 +- .../unmanaged-api/hosting/itypename-getmodifierlength-method.md | 2 +- .../core/unmanaged-api/hosting/itypename-getmodifiers-method.md | 2 +- .../core/unmanaged-api/hosting/itypename-getnamecount-method.md | 2 +- docs/core/unmanaged-api/hosting/itypename-getnames-method.md | 2 +- .../hosting/itypename-gettypeargumentcount-method.md | 2 +- .../unmanaged-api/hosting/itypename-gettypearguments-method.md | 2 +- docs/core/unmanaged-api/hosting/itypename-interface.md | 2 +- .../unmanaged-api/hosting/itypenamebuilder-addarray-method.md | 2 +- .../hosting/itypenamebuilder-addassemblyspec-method.md | 2 +- .../unmanaged-api/hosting/itypenamebuilder-addbyref-method.md | 2 +- .../unmanaged-api/hosting/itypenamebuilder-addname-method.md | 2 +- .../unmanaged-api/hosting/itypenamebuilder-addpointer-method.md | 2 +- .../unmanaged-api/hosting/itypenamebuilder-addszarray-method.md | 2 +- .../core/unmanaged-api/hosting/itypenamebuilder-clear-method.md | 2 +- .../hosting/itypenamebuilder-closegenericargument-method.md | 2 +- .../hosting/itypenamebuilder-closegenericarguments-method.md | 2 +- docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md | 2 +- .../hosting/itypenamebuilder-opengenericargument-method.md | 2 +- .../hosting/itypenamebuilder-opengenericarguments-method.md | 2 +- .../unmanaged-api/hosting/itypenamebuilder-tostring-method.md | 2 +- .../hosting/itypenamefactory-gettypenamebuilder-method.md | 2 +- docs/core/unmanaged-api/hosting/itypenamefactory-interface.md | 2 +- .../hosting/itypenamefactory-parsetypename-method.md | 2 +- .../unmanaged-api/hosting/ivalidator-formateventinfo-method.md | 2 +- docs/core/unmanaged-api/hosting/ivalidator-interface.md | 2 +- docs/core/unmanaged-api/hosting/ivalidator-validate-method.md | 2 +- docs/core/unmanaged-api/hosting/loadlibraryshim-function.md | 2 +- docs/core/unmanaged-api/hosting/loadstringrc-function.md | 2 +- docs/core/unmanaged-api/hosting/loadstringrcex-function.md | 2 +- docs/core/unmanaged-api/hosting/lockclrversion-function.md | 2 +- .../hosting/lpoverlapped-completion-routine-function-pointer.md | 2 +- .../hosting/lpthread-start-routine-function-pointer.md | 2 +- docs/core/unmanaged-api/hosting/malloc-type-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/mdainfo-structure.md | 2 +- .../unmanaged-api/hosting/metahost-config-flags-enumeration.md | 2 +- .../unmanaged-api/hosting/metahost-policy-flags-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/modulebindinfo-structure.md | 2 +- docs/core/unmanaged-api/hosting/rundll32shimw-function.md | 2 +- .../unmanaged-api/hosting/runtime-info-flags-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md | 2 +- .../core/unmanaged-api/hosting/stackoverflowtype-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/startup-flags-enumeration.md | 2 +- .../unmanaged-api/hosting/strongnamegetpublickeyex-method.md | 2 +- .../hosting/strongnamesignatureverificationex2-method.md | 2 +- docs/core/unmanaged-api/hosting/typenamefactory-coclass.md | 2 +- docs/core/unmanaged-api/hosting/validatorflags-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/wait-option-enumeration.md | 2 +- .../hosting/waitortimercallback-function-pointer.md | 2 +- docs/core/unmanaged-api/metadata/assemblyflags-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/assemblymetadata-structure.md | 2 +- .../core/unmanaged-api/metadata/assemblyrefflags-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/ceesectionattr-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/ceesectionrelocextra-union.md | 2 +- .../unmanaged-api/metadata/ceesectionreloctype-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/coiniticor-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/coinitiee-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/cor-field-offset-structure.md | 2 +- docs/core/unmanaged-api/metadata/cor-native-link-structure.md | 2 +- docs/core/unmanaged-api/metadata/corargtype-enumeration.md | 2 +- .../core/unmanaged-api/metadata/corassemblyflags-enumeration.md | 2 +- .../unmanaged-api/metadata/corattributetargets-enumeration.md | 2 +- .../unmanaged-api/metadata/corcallingconvention-enumeration.md | 2 +- .../unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/cordeclsecurity-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corelementtype-enumeration.md | 2 +- .../metadata/corerrorifemitoutoforder-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/coreventattr-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corfieldattr-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corfileflags-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corfilemapping-enumeration.md | 2 +- .../unmanaged-api/metadata/corgenericparamattr-enumeration.md | 2 +- .../core/unmanaged-api/metadata/corimportoptions-enumeration.md | 2 +- .../core/unmanaged-api/metadata/corlinkeroptions-enumeration.md | 2 +- .../metadata/corlocalrefpreservation-enumeration.md | 2 +- .../metadata/cormanifestresourceflags-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/cormethodattr-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/cormethodimpl-enumeration.md | 2 +- .../metadata/cormethodsemanticsattr-enumeration.md | 2 +- .../unmanaged-api/metadata/cornativelinkflags-enumeration.md | 2 +- .../unmanaged-api/metadata/cornativelinktype-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/cornativetype-enumeration.md | 2 +- .../metadata/cornotificationfortokenmovement-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/coropenflags-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corparamattr-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corpekind-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corpinvokemap-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corpropertyattr-enumeration.md | 2 +- .../core/unmanaged-api/metadata/correftodefcheck-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corregflags-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corsavesize-enumeration.md | 2 +- .../unmanaged-api/metadata/corserializationtype-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corsetenc-enumeration.md | 2 +- .../metadata/corthreadsafetyoptions-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/cortokentype-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/cortypeattr-enumeration.md | 2 +- .../metadata/corunmanagedcallingconvention-enumeration.md | 2 +- .../metadata/corvalidatormoduletype-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/couninitiee-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/cvstruct-structure.md | 2 +- .../unmanaged-api/metadata/iceegen-addsectionreloc-method.md | 2 +- .../metadata/iceegen-allocatemethodbuffer-method.md | 2 +- .../unmanaged-api/metadata/iceegen-computepointer-method.md | 2 +- docs/core/unmanaged-api/metadata/iceegen-emitstring-method.md | 2 +- .../unmanaged-api/metadata/iceegen-generateceefile-method.md | 2 +- .../metadata/iceegen-generateceememoryimage-method.md | 2 +- docs/core/unmanaged-api/metadata/iceegen-getilsection-method.md | 2 +- .../unmanaged-api/metadata/iceegen-getimaptokeniface-method.md | 2 +- .../unmanaged-api/metadata/iceegen-getmethodbuffer-method.md | 2 +- .../unmanaged-api/metadata/iceegen-getsectionblock-method.md | 2 +- .../unmanaged-api/metadata/iceegen-getsectioncreate-method.md | 2 +- .../unmanaged-api/metadata/iceegen-getsectiondatalen-method.md | 2 +- docs/core/unmanaged-api/metadata/iceegen-getstring-method.md | 2 +- .../unmanaged-api/metadata/iceegen-getstringsection-method.md | 2 +- docs/core/unmanaged-api/metadata/iceegen-interface.md | 2 +- .../unmanaged-api/metadata/iceegen-truncatesection-method.md | 2 +- docs/core/unmanaged-api/metadata/ihostfilter-interface.md | 2 +- .../core/unmanaged-api/metadata/ihostfilter-marktoken-method.md | 2 +- docs/core/unmanaged-api/metadata/imaptoken-interface.md | 2 +- docs/core/unmanaged-api/metadata/imaptoken-map-method.md | 2 +- .../metadata/imetadataassemblyemit-defineassembly-method.md | 2 +- .../metadata/imetadataassemblyemit-defineassemblyref-method.md | 2 +- .../metadata/imetadataassemblyemit-defineexportedtype-method.md | 2 +- .../metadata/imetadataassemblyemit-definefile-method.md | 2 +- .../imetadataassemblyemit-definemanifestresource-method.md | 2 +- .../unmanaged-api/metadata/imetadataassemblyemit-interface.md | 2 +- .../metadata/imetadataassemblyemit-setassemblyprops-method.md | 2 +- .../imetadataassemblyemit-setassemblyrefprops-method.md | 2 +- .../imetadataassemblyemit-setexportedtypeprops-method.md | 2 +- .../metadata/imetadataassemblyemit-setfileprops-method.md | 2 +- .../imetadataassemblyemit-setmanifestresourceprops-method.md | 2 +- .../metadata/imetadataassemblyimport-closeenum-method.md | 2 +- .../metadata/imetadataassemblyimport-enumassemblyrefs-method.md | 2 +- .../imetadataassemblyimport-enumexportedtypes-method.md | 2 +- .../metadata/imetadataassemblyimport-enumfiles-method.md | 2 +- .../imetadataassemblyimport-enummanifestresources-method.md | 2 +- .../imetadataassemblyimport-findassembliesbyname-method.md | 2 +- .../imetadataassemblyimport-findexportedtypebyname-method.md | 2 +- ...imetadataassemblyimport-findmanifestresourcebyname-method.md | 2 +- .../imetadataassemblyimport-getassemblyfromscope-method.md | 2 +- .../metadata/imetadataassemblyimport-getassemblyprops-method.md | 2 +- .../imetadataassemblyimport-getassemblyrefprops-method.md | 2 +- .../imetadataassemblyimport-getexportedtypeprops-method.md | 2 +- .../metadata/imetadataassemblyimport-getfileprops-method.md | 2 +- .../imetadataassemblyimport-getmanifestresourceprops-method.md | 2 +- .../unmanaged-api/metadata/imetadataassemblyimport-interface.md | 2 +- .../imetadataconverter-getmetadatafromtypeinfo-method.md | 2 +- .../imetadataconverter-getmetadatafromtypelib-method.md | 2 +- .../imetadataconverter-gettypelibfrommetadata-method.md | 2 +- .../core/unmanaged-api/metadata/imetadataconverter-interface.md | 2 +- .../metadata/imetadatadispenser-definescope-method.md | 2 +- .../core/unmanaged-api/metadata/imetadatadispenser-interface.md | 2 +- .../metadata/imetadatadispenser-openscope-method.md | 2 +- .../metadata/imetadatadispenser-openscopeonmemory-method.md | 2 +- .../metadata/imetadatadispenserex-findassembly-method.md | 2 +- .../metadata/imetadatadispenserex-findassemblymodule-method.md | 2 +- .../imetadatadispenserex-getcorsystemdirectory-method.md | 2 +- .../metadata/imetadatadispenserex-getoption-method.md | 2 +- .../unmanaged-api/metadata/imetadatadispenserex-interface.md | 2 +- .../imetadatadispenserex-openscopeonitypeinfo-method.md | 2 +- .../metadata/imetadatadispenserex-setoption-method.md | 2 +- .../metadata/imetadataemit-applyeditandcontinue-method.md | 2 +- .../metadata/imetadataemit-definecustomattribute-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-defineevent-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-definefield-method.md | 2 +- .../metadata/imetadataemit-defineimportmember-method.md | 2 +- .../metadata/imetadataemit-defineimporttype-method.md | 2 +- .../metadata/imetadataemit-definememberref-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-definemethod-method.md | 2 +- .../metadata/imetadataemit-definemethodimpl-method.md | 2 +- .../metadata/imetadataemit-definemoduleref-method.md | 2 +- .../metadata/imetadataemit-definenestedtype-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-defineparam-method.md | 2 +- .../metadata/imetadataemit-definepermissionset-method.md | 2 +- .../metadata/imetadataemit-definepinvokemap-method.md | 2 +- .../metadata/imetadataemit-defineproperty-method.md | 2 +- .../metadata/imetadataemit-definesecurityattributeset-method.md | 2 +- .../metadata/imetadataemit-definetypedef-method.md | 2 +- .../metadata/imetadataemit-definetyperefbyname-method.md | 2 +- .../metadata/imetadataemit-defineuserstring-method.md | 2 +- .../metadata/imetadataemit-deleteclasslayout-method.md | 2 +- .../metadata/imetadataemit-deletefieldmarshal-method.md | 2 +- .../metadata/imetadataemit-deletepinvokemap-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-deletetoken-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-getsavesize-method.md | 2 +- .../metadata/imetadataemit-gettokenfromsig-method.md | 2 +- .../metadata/imetadataemit-gettokenfromtypespec-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadataemit-interface.md | 2 +- docs/core/unmanaged-api/metadata/imetadataemit-merge-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-mergeend-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadataemit-save-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-savetomemory-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-savetostream-method.md | 2 +- .../metadata/imetadataemit-setclasslayout-method.md | 2 +- .../metadata/imetadataemit-setcustomattributevalue-method.md | 2 +- .../metadata/imetadataemit-seteventprops-method.md | 2 +- .../metadata/imetadataemit-setfieldmarshal-method.md | 2 +- .../metadata/imetadataemit-setfieldprops-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-setfieldrva-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-sethandler-method.md | 2 +- .../metadata/imetadataemit-setmethodimplflags-method.md | 2 +- .../metadata/imetadataemit-setmethodprops-method.md | 2 +- .../metadata/imetadataemit-setmoduleprops-method.md | 2 +- .../metadata/imetadataemit-setparamprops-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-setparent-method.md | 2 +- .../metadata/imetadataemit-setpermissionsetprops-method.md | 2 +- .../metadata/imetadataemit-setpinvokemap-method.md | 2 +- .../metadata/imetadataemit-setpropertyprops-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadataemit-setrva-method.md | 2 +- .../metadata/imetadataemit-settypedefprops-method.md | 2 +- .../metadata/imetadataemit-translatesigwithscope-method.md | 2 +- .../metadata/imetadataemit2-definegenericparam-method.md | 2 +- .../metadata/imetadataemit2-definemethodspec-method.md | 2 +- .../metadata/imetadataemit2-getdeltasavesize-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadataemit2-interface.md | 2 +- .../unmanaged-api/metadata/imetadataemit2-resetenclog-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit2-savedelta-method.md | 2 +- .../metadata/imetadataemit2-savedeltatomemory-method.md | 2 +- .../metadata/imetadataemit2-savedeltatostream-method.md | 2 +- .../metadata/imetadataemit2-setgenericparamprops-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadataerror-interface.md | 2 +- .../unmanaged-api/metadata/imetadataerror-onerror-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadatafilter-interface.md | 2 +- .../metadata/imetadatafilter-istokenmarked-method.md | 2 +- .../unmanaged-api/metadata/imetadatafilter-marktoken-method.md | 2 +- .../unmanaged-api/metadata/imetadatafilter-unmarkall-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport-closeenum-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport-countenum-method.md | 2 +- .../metadata/imetadataimport-enumcustomattributes-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport-enumevents-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport-enumfields-method.md | 2 +- .../metadata/imetadataimport-enumfieldswithname-method.md | 2 +- .../metadata/imetadataimport-enuminterfaceimpls-method.md | 2 +- .../metadata/imetadataimport-enummemberrefs-method.md | 2 +- .../metadata/imetadataimport-enummembers-method.md | 2 +- .../metadata/imetadataimport-enummemberswithname-method.md | 2 +- .../metadata/imetadataimport-enummethodimpls-method.md | 2 +- .../metadata/imetadataimport-enummethods-method.md | 2 +- .../metadata/imetadataimport-enummethodsemantics-method.md | 2 +- .../metadata/imetadataimport-enummethodswithname-method.md | 2 +- .../metadata/imetadataimport-enummodulerefs-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport-enumparams-method.md | 2 +- .../metadata/imetadataimport-enumpermissionsets-method.md | 2 +- .../metadata/imetadataimport-enumproperties-method.md | 2 +- .../metadata/imetadataimport-enumsignatures-method.md | 2 +- .../metadata/imetadataimport-enumtypedefs-method.md | 2 +- .../metadata/imetadataimport-enumtyperefs-method.md | 2 +- .../metadata/imetadataimport-enumtypespecs-method.md | 2 +- .../metadata/imetadataimport-enumunresolvedmethods-method.md | 2 +- .../metadata/imetadataimport-enumuserstrings-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport-findfield-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport-findmember-method.md | 2 +- .../metadata/imetadataimport-findmemberref-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport-findmethod-method.md | 2 +- .../metadata/imetadataimport-findtypedefbyname-method.md | 2 +- .../metadata/imetadataimport-findtyperef-method.md | 2 +- .../metadata/imetadataimport-getclasslayout-method.md | 2 +- .../metadata/imetadataimport-getcustomattributebyname-method.md | 2 +- .../metadata/imetadataimport-getcustomattributeprops-method.md | 2 +- .../metadata/imetadataimport-geteventprops-method.md | 2 +- .../metadata/imetadataimport-getfieldmarshal-method.md | 2 +- .../metadata/imetadataimport-getfieldprops-method.md | 2 +- .../metadata/imetadataimport-getinterfaceimplprops-method.md | 2 +- .../metadata/imetadataimport-getmemberprops-method.md | 2 +- .../metadata/imetadataimport-getmemberrefprops-method.md | 2 +- .../metadata/imetadataimport-getmethodprops-method.md | 2 +- .../metadata/imetadataimport-getmethodsemantics-method.md | 2 +- .../metadata/imetadataimport-getmodulefromscope-method.md | 2 +- .../metadata/imetadataimport-getmodulerefprops-method.md | 2 +- .../metadata/imetadataimport-getnamefromtoken-method.md | 2 +- .../metadata/imetadataimport-getnativecallconvfromsig-method.md | 2 +- .../metadata/imetadataimport-getnestedclassprops-method.md | 2 +- .../metadata/imetadataimport-getparamformethodindex-method.md | 2 +- .../metadata/imetadataimport-getparamprops-method.md | 2 +- .../metadata/imetadataimport-getpermissionsetprops-method.md | 2 +- .../metadata/imetadataimport-getpinvokemap-method.md | 2 +- .../metadata/imetadataimport-getpropertyprops-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport-getrva-method.md | 2 +- .../metadata/imetadataimport-getscopeprops-method.md | 2 +- .../metadata/imetadataimport-getsigfromtoken-method.md | 2 +- .../metadata/imetadataimport-gettypedefprops-method.md | 2 +- .../metadata/imetadataimport-gettyperefprops-method.md | 2 +- .../metadata/imetadataimport-gettypespecfromtoken-method.md | 2 +- .../metadata/imetadataimport-getuserstring-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadataimport-interface.md | 2 +- .../unmanaged-api/metadata/imetadataimport-isglobal-method.md | 2 +- .../metadata/imetadataimport-isvalidtoken-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport-resetenum-method.md | 2 +- .../metadata/imetadataimport-resolvetyperef-method.md | 2 +- .../imetadataimport2-enumgenericparamconstraints-method.md | 2 +- .../metadata/imetadataimport2-enumgenericparams-method.md | 2 +- .../metadata/imetadataimport2-enummethodspecs-method.md | 2 +- .../imetadataimport2-getgenericparamconstraintprops-method.md | 2 +- .../metadata/imetadataimport2-getgenericparamprops-method.md | 2 +- .../metadata/imetadataimport2-getmethodspecprops-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport2-getpekind-method.md | 2 +- .../metadata/imetadataimport2-getversionstring-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadataimport2-interface.md | 2 +- .../metadata/imetadatainfo-getfilemapping-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadatainfo-interface.md | 2 +- .../unmanaged-api/metadata/imetadatatables-getblob-method.md | 2 +- .../metadata/imetadatatables-getblobheapsize-method.md | 2 +- .../metadata/imetadatatables-getcodedtokeninfo-method.md | 2 +- .../unmanaged-api/metadata/imetadatatables-getcolumn-method.md | 2 +- .../metadata/imetadatatables-getcolumninfo-method.md | 2 +- .../unmanaged-api/metadata/imetadatatables-getguid-method.md | 2 +- .../metadata/imetadatatables-getguidheapsize-method.md | 2 +- .../metadata/imetadatatables-getnextblob-method.md | 2 +- .../metadata/imetadatatables-getnextguid-method.md | 2 +- .../metadata/imetadatatables-getnextstring-method.md | 2 +- .../metadata/imetadatatables-getnextuserstring-method.md | 2 +- .../metadata/imetadatatables-getnumtables-method.md | 2 +- .../unmanaged-api/metadata/imetadatatables-getrow-method.md | 2 +- .../unmanaged-api/metadata/imetadatatables-getstring-method.md | 2 +- .../metadata/imetadatatables-getstringheapsize-method.md | 2 +- .../metadata/imetadatatables-gettableindex-method.md | 2 +- .../metadata/imetadatatables-gettableinfo-method.md | 2 +- .../metadata/imetadatatables-getuserstring-method.md | 2 +- .../metadata/imetadatatables-getuserstringheapsize-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadatatables-interface.md | 2 +- .../metadata/imetadatatables2-getmetadatastorage-method.md | 2 +- .../metadata/imetadatatables2-getmetadatastreaminfo-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadatatables2-interface.md | 2 +- docs/core/unmanaged-api/metadata/imetadatavalidate-interface.md | 2 +- .../metadata/imetadatavalidate-validatemetadata-method.md | 2 +- .../metadata/imetadatavalidate-validatorinit-method.md | 2 +- docs/core/unmanaged-api/metadata/osinfo-structure.md | 2 +- 723 files changed, 723 insertions(+), 723 deletions(-) diff --git a/docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md b/docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md index 64ab190159926..e50d1d6781972 100644 --- a/docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md +++ b/docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md @@ -46,7 +46,7 @@ typedef struct _AssemblyBindInfo { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/bucketparameters-structure.md b/docs/core/unmanaged-api/hosting/bucketparameters-structure.md index c0d9b7abda666..e244246bf705d 100644 --- a/docs/core/unmanaged-api/hosting/bucketparameters-structure.md +++ b/docs/core/unmanaged-api/hosting/bucketparameters-structure.md @@ -40,7 +40,7 @@ typedef struct _BucketParameters { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/callfunctionshim-function.md b/docs/core/unmanaged-api/hosting/callfunctionshim-function.md index 2a1f757d6065d..a6b7f75f0d628 100644 --- a/docs/core/unmanaged-api/hosting/callfunctionshim-function.md +++ b/docs/core/unmanaged-api/hosting/callfunctionshim-function.md @@ -57,7 +57,7 @@ HRESULT CallFunctionShim ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md b/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md index b2e2760299353..02008c4442530 100644 --- a/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md +++ b/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md @@ -95,7 +95,7 @@ hr = createInterface (CLSID_CLRDebugging, IID_ICLRDebugging, (LPVOID*)&pCLRDebu ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md b/docs/core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md index 896a6065d2e2d..df124bde5738f 100644 --- a/docs/core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md +++ b/docs/core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md @@ -53,7 +53,7 @@ STDAPI ClrCreateManagedInstance ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md b/docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md index c041c0e714b51..236264b1adfcc 100644 --- a/docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md +++ b/docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md @@ -38,7 +38,7 @@ coclass CLRRuntimeHost { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md b/docs/core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md index dfe9acb2b1345..194abb0a38023 100644 --- a/docs/core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md @@ -38,7 +38,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md b/docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md index c44b17e3cdf88..1ea3bc2ddc2bd 100644 --- a/docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md +++ b/docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md @@ -41,7 +41,7 @@ void CoEEShutDownCOM (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/hosting/coinitializeee-function.md b/docs/core/unmanaged-api/hosting/coinitializeee-function.md index a862de2ae0256..ac6cc3f5cb1a3 100644 --- a/docs/core/unmanaged-api/hosting/coinitializeee-function.md +++ b/docs/core/unmanaged-api/hosting/coinitializeee-function.md @@ -50,7 +50,7 @@ HRESULT CoInitializeEE ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md b/docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md index 6bd1331a43155..47ab58919b987 100644 --- a/docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md +++ b/docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md @@ -36,7 +36,7 @@ coclass ComCallUnmarshal { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md b/docs/core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md index ab1f264201edb..f6258624d318f 100644 --- a/docs/core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md +++ b/docs/core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md @@ -42,7 +42,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md b/docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md index 115771810ef12..b6c2bfd2142a2 100644 --- a/docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md +++ b/docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md @@ -74,7 +74,7 @@ pCLRGCManager->GetStats(&GCStats); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** GCHost.idl diff --git a/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md b/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md index 02b46225229ee..02cd9db46a14a 100644 --- a/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md +++ b/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md @@ -42,7 +42,7 @@ typedef struct _COR_GC_THREAD_STATS { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** GCHost.idl diff --git a/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md b/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md index 3953288aa843a..7882f1ac256af 100644 --- a/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md +++ b/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md @@ -36,7 +36,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/corbindtocurrentruntime-function.md b/docs/core/unmanaged-api/hosting/corbindtocurrentruntime-function.md index af90f77be1983..80ff2a9926e73 100644 --- a/docs/core/unmanaged-api/hosting/corbindtocurrentruntime-function.md +++ b/docs/core/unmanaged-api/hosting/corbindtocurrentruntime-function.md @@ -54,7 +54,7 @@ HRESULT CorBindToCurrentRuntime ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/corbindtoruntime-function.md b/docs/core/unmanaged-api/hosting/corbindtoruntime-function.md index 4cc10d40370b6..793968933207c 100644 --- a/docs/core/unmanaged-api/hosting/corbindtoruntime-function.md +++ b/docs/core/unmanaged-api/hosting/corbindtoruntime-function.md @@ -84,7 +84,7 @@ HRESULT CorBindToRuntime ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md b/docs/core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md index 8ba79290f85b5..769e35b7360c9 100644 --- a/docs/core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md +++ b/docs/core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md @@ -61,7 +61,7 @@ HRESULT CorBindToRuntimeByCfg ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md b/docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md index 841d734129753..b0f516481db6c 100644 --- a/docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md +++ b/docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md @@ -127,7 +127,7 @@ HRESULT CorBindToRuntimeEx ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/corbindtoruntimehost-function.md b/docs/core/unmanaged-api/hosting/corbindtoruntimehost-function.md index bda3717ab85dc..1fa17b846fb81 100644 --- a/docs/core/unmanaged-api/hosting/corbindtoruntimehost-function.md +++ b/docs/core/unmanaged-api/hosting/corbindtoruntimehost-function.md @@ -75,7 +75,7 @@ HRESULT CorBindToRuntimeHost ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/cordllmain-function.md b/docs/core/unmanaged-api/hosting/cordllmain-function.md index 9a329189ad375..3e123e4c3a67f 100644 --- a/docs/core/unmanaged-api/hosting/cordllmain-function.md +++ b/docs/core/unmanaged-api/hosting/cordllmain-function.md @@ -57,7 +57,7 @@ The `_CorDllMain` function is called directly by the operating system loader. ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/hosting/corexemain-function.md b/docs/core/unmanaged-api/hosting/corexemain-function.md index 708c87a9e02a7..b117c582cd494 100644 --- a/docs/core/unmanaged-api/hosting/corexemain-function.md +++ b/docs/core/unmanaged-api/hosting/corexemain-function.md @@ -39,7 +39,7 @@ __int32 STDMETHODCALLTYPE _CorExeMain (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/hosting/corexemain2-function.md b/docs/core/unmanaged-api/hosting/corexemain2-function.md index fc3bd53e240bd..9a646ad96a692 100644 --- a/docs/core/unmanaged-api/hosting/corexemain2-function.md +++ b/docs/core/unmanaged-api/hosting/corexemain2-function.md @@ -51,7 +51,7 @@ __int32 STDMETHODCALLTYPE _CorExeMain2 ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/hosting/corexitprocess-function.md b/docs/core/unmanaged-api/hosting/corexitprocess-function.md index bda4228850f8b..8b503b98b1167 100644 --- a/docs/core/unmanaged-api/hosting/corexitprocess-function.md +++ b/docs/core/unmanaged-api/hosting/corexitprocess-function.md @@ -46,7 +46,7 @@ void STDMETHODCALLTYPE CorExitProcess ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/corimageunloading-function.md b/docs/core/unmanaged-api/hosting/corimageunloading-function.md index 23492f385aa43..8bdd225a20683 100644 --- a/docs/core/unmanaged-api/hosting/corimageunloading-function.md +++ b/docs/core/unmanaged-api/hosting/corimageunloading-function.md @@ -37,7 +37,7 @@ STDAPI (VOID) _CorImageUnloading( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/hosting/corlaunchapplication-function.md b/docs/core/unmanaged-api/hosting/corlaunchapplication-function.md index 8b9c83e294621..28cc855af09eb 100644 --- a/docs/core/unmanaged-api/hosting/corlaunchapplication-function.md +++ b/docs/core/unmanaged-api/hosting/corlaunchapplication-function.md @@ -62,7 +62,7 @@ HRESULT CorLaunchApplication ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md b/docs/core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md index 43fd6e4383232..d6555ada34ae3 100644 --- a/docs/core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md +++ b/docs/core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md @@ -28,7 +28,7 @@ void CorMarkThreadInThreadPool (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/corruntimehost-coclass.md b/docs/core/unmanaged-api/hosting/corruntimehost-coclass.md index cf534395c9964..ca11d8e66f975 100644 --- a/docs/core/unmanaged-api/hosting/corruntimehost-coclass.md +++ b/docs/core/unmanaged-api/hosting/corruntimehost-coclass.md @@ -44,7 +44,7 @@ coclass CorRuntimeHost { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/corvalidateimage-function.md b/docs/core/unmanaged-api/hosting/corvalidateimage-function.md index c2b91d387f4bc..3ce741a7f5371 100644 --- a/docs/core/unmanaged-api/hosting/corvalidateimage-function.md +++ b/docs/core/unmanaged-api/hosting/corvalidateimage-function.md @@ -72,7 +72,7 @@ STDAPI _CorValidateImage ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md b/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md index e9bf85224e952..4deecf7b4a1af 100644 --- a/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md +++ b/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md @@ -59,7 +59,7 @@ HRESULT CreateDebuggingInterfaceFromVersion ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/createiceefilegen-function.md b/docs/core/unmanaged-api/hosting/createiceefilegen-function.md index 24ab165a71b1a..b155ccc6bc3d6 100644 --- a/docs/core/unmanaged-api/hosting/createiceefilegen-function.md +++ b/docs/core/unmanaged-api/hosting/createiceefilegen-function.md @@ -49,7 +49,7 @@ HRESULT CreateICeeFileGen ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** ICeeFileGen.h diff --git a/docs/core/unmanaged-api/hosting/customdumpitem-structure.md b/docs/core/unmanaged-api/hosting/customdumpitem-structure.md index aad14b6167376..55771ff66d029 100644 --- a/docs/core/unmanaged-api/hosting/customdumpitem-structure.md +++ b/docs/core/unmanaged-api/hosting/customdumpitem-structure.md @@ -44,7 +44,7 @@ struct { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md b/docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md index f7174816f5e73..2ef702670da99 100644 --- a/docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md +++ b/docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md @@ -47,7 +47,7 @@ HRESULT DestroyICeeFileGen ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** ICeeFileGen.h diff --git a/docs/core/unmanaged-api/hosting/eapicategories-enumeration.md b/docs/core/unmanaged-api/hosting/eapicategories-enumeration.md index 47d9b6a3b32fc..18a8bd74eb316 100644 --- a/docs/core/unmanaged-api/hosting/eapicategories-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eapicategories-enumeration.md @@ -62,7 +62,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md b/docs/core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md index bb85a723237db..5a01c14861673 100644 --- a/docs/core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md @@ -54,7 +54,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md b/docs/core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md index 801e6552b0cf0..3c2a639bb6429 100644 --- a/docs/core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md @@ -36,7 +36,7 @@ typedef enum _CLRAssemblyIdentityFlags { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/eclrevent-enumeration.md b/docs/core/unmanaged-api/hosting/eclrevent-enumeration.md index 81f508b485b8a..2fb5b50916944 100644 --- a/docs/core/unmanaged-api/hosting/eclrevent-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eclrevent-enumeration.md @@ -50,7 +50,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md b/docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md index 8034d6a1f23a0..9e143c39102f0 100644 --- a/docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md @@ -52,7 +52,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/eclroperation-enumeration.md b/docs/core/unmanaged-api/hosting/eclroperation-enumeration.md index eec0b271dc991..92177f5704217 100644 --- a/docs/core/unmanaged-api/hosting/eclroperation-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eclroperation-enumeration.md @@ -58,7 +58,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md b/docs/core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md index 8a86d2a2cd494..739d9cf88dfcc 100644 --- a/docs/core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md @@ -42,7 +42,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/econtexttype-enumeration.md b/docs/core/unmanaged-api/hosting/econtexttype-enumeration.md index defb350588e8a..4f71166b701f7 100644 --- a/docs/core/unmanaged-api/hosting/econtexttype-enumeration.md +++ b/docs/core/unmanaged-api/hosting/econtexttype-enumeration.md @@ -42,7 +42,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md b/docs/core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md index 303c9461d4244..3461796cca4c6 100644 --- a/docs/core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md @@ -42,7 +42,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md b/docs/core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md index ae2dfcb3794c2..c93e8255325f3 100644 --- a/docs/core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md @@ -36,7 +36,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md b/docs/core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md index 7e2a098e57582..0cbc2466b07cd 100644 --- a/docs/core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md @@ -30,7 +30,7 @@ typedef enum _HostApplicationPolicy { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md b/docs/core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md index b1eb428d36b79..11f18ca491899 100644 --- a/docs/core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md @@ -46,7 +46,7 @@ typedef enum _hostBindingPolicyModifyFlags { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md b/docs/core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md index 570311f2fd9aa..cfb0ef393cadd 100644 --- a/docs/core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md @@ -40,7 +40,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md b/docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md index 38802d4db65a5..bfde1b4656f87 100644 --- a/docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md @@ -44,7 +44,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md b/docs/core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md index 5e835bf908f57..4035e03668756 100644 --- a/docs/core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md @@ -44,7 +44,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md b/docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md index 33607cf297922..8d2cba5d957e9 100644 --- a/docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md +++ b/docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md @@ -58,7 +58,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md b/docs/core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md index a15c578301257..9a9f29afe89fc 100644 --- a/docs/core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md +++ b/docs/core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md @@ -44,7 +44,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/etasktype-enumeration.md b/docs/core/unmanaged-api/hosting/etasktype-enumeration.md index 1dfefef59fc79..1b98ee8166ccd 100644 --- a/docs/core/unmanaged-api/hosting/etasktype-enumeration.md +++ b/docs/core/unmanaged-api/hosting/etasktype-enumeration.md @@ -56,7 +56,7 @@ typedef enum ETaskType { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md b/docs/core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md index bda0d9c612152..b444c24ef9965 100644 --- a/docs/core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md +++ b/docs/core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md @@ -39,7 +39,7 @@ typedef HRESULT (__stdcall *FExecuteInAppDomainCallback) ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md b/docs/core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md index d9b8dcff456e3..624e4e62c44fa 100644 --- a/docs/core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md +++ b/docs/core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md @@ -34,7 +34,7 @@ typedef HRESULT (__stdcall *FLockClrVersionCallback) ( ); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getclridentitymanager-function.md b/docs/core/unmanaged-api/hosting/getclridentitymanager-function.md index d52b49f0b68d2..20a72685951f2 100644 --- a/docs/core/unmanaged-api/hosting/getclridentitymanager-function.md +++ b/docs/core/unmanaged-api/hosting/getclridentitymanager-function.md @@ -45,7 +45,7 @@ STDAPI GetCLRIdentityManager( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getcorrequiredversion-function.md b/docs/core/unmanaged-api/hosting/getcorrequiredversion-function.md index daf3b134991b7..e5b70adca0631 100644 --- a/docs/core/unmanaged-api/hosting/getcorrequiredversion-function.md +++ b/docs/core/unmanaged-api/hosting/getcorrequiredversion-function.md @@ -45,7 +45,7 @@ HRESULT GetCORRequiredVersion ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getcorsystemdirectory-function.md b/docs/core/unmanaged-api/hosting/getcorsystemdirectory-function.md index 955735ce31d7b..aa0764b6f331d 100644 --- a/docs/core/unmanaged-api/hosting/getcorsystemdirectory-function.md +++ b/docs/core/unmanaged-api/hosting/getcorsystemdirectory-function.md @@ -51,7 +51,7 @@ HRESULT GetCORSystemDirectory ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getcorversion-function.md b/docs/core/unmanaged-api/hosting/getcorversion-function.md index f5e66e9a53579..ba95b85c1917e 100644 --- a/docs/core/unmanaged-api/hosting/getcorversion-function.md +++ b/docs/core/unmanaged-api/hosting/getcorversion-function.md @@ -45,7 +45,7 @@ HRESULT GetCORVersion ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getfileversion-function.md b/docs/core/unmanaged-api/hosting/getfileversion-function.md index 6dd7f909f0930..efe13b554a702 100644 --- a/docs/core/unmanaged-api/hosting/getfileversion-function.md +++ b/docs/core/unmanaged-api/hosting/getfileversion-function.md @@ -49,7 +49,7 @@ HRESULT GetFileVersion ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getrealprocaddress-function.md b/docs/core/unmanaged-api/hosting/getrealprocaddress-function.md index 9ebeb1d8f9a52..f16272a5f20f7 100644 --- a/docs/core/unmanaged-api/hosting/getrealprocaddress-function.md +++ b/docs/core/unmanaged-api/hosting/getrealprocaddress-function.md @@ -51,7 +51,7 @@ HRESULT GetRealProcAddress ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md b/docs/core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md index fbafb3d896062..e64dca6a1caa7 100644 --- a/docs/core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md +++ b/docs/core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md @@ -113,7 +113,7 @@ HRESULT GetRequestedRuntimeInfo ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getrequestedruntimeversion-function.md b/docs/core/unmanaged-api/hosting/getrequestedruntimeversion-function.md index fb262435d6bf9..c7b5d658929b0 100644 --- a/docs/core/unmanaged-api/hosting/getrequestedruntimeversion-function.md +++ b/docs/core/unmanaged-api/hosting/getrequestedruntimeversion-function.md @@ -60,7 +60,7 @@ HRESULT GetRequestedRuntimeVersion ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md b/docs/core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md index c4ad8500dd6b9..4e67d4b296433 100644 --- a/docs/core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md +++ b/docs/core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md @@ -67,7 +67,7 @@ HRESULT GetRequestedRuntimeVersionForCLSID ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getversionfromprocess-function.md b/docs/core/unmanaged-api/hosting/getversionfromprocess-function.md index 509ca65487ae5..e8017118e0f8c 100644 --- a/docs/core/unmanaged-api/hosting/getversionfromprocess-function.md +++ b/docs/core/unmanaged-api/hosting/getversionfromprocess-function.md @@ -61,7 +61,7 @@ HRESULT GetVersionFromProcess ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/host-type-enumeration.md b/docs/core/unmanaged-api/hosting/host-type-enumeration.md index b9c656752ca68..cfc37602999e4 100644 --- a/docs/core/unmanaged-api/hosting/host-type-enumeration.md +++ b/docs/core/unmanaged-api/hosting/host-type-enumeration.md @@ -40,7 +40,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md b/docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md index 208df2d082cca..d561aa6491dd1 100644 --- a/docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md +++ b/docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md @@ -28,7 +28,7 @@ Provides the [IActionOnCLREvent::OnEvent](iactiononclrevent-onevent-method.md) m ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md b/docs/core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md index ea32f62c11012..9e3b79aec5fc0 100644 --- a/docs/core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md +++ b/docs/core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md @@ -57,7 +57,7 @@ HRESULT OnEvent ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md b/docs/core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md index 9411fd64bcad4..9b2bb438e0619 100644 --- a/docs/core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md +++ b/docs/core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md @@ -40,7 +40,7 @@ HRESULT _stdcall DoCallback( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md b/docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md index 7363f73a8a367..aad076cf6935a 100644 --- a/docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md +++ b/docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md @@ -28,7 +28,7 @@ Provides methods for making callbacks within an apartment. An *apartment* is a l ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md b/docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md index 1771a42db945c..d3dff2a5f6ff8 100644 --- a/docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md +++ b/docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md @@ -28,7 +28,7 @@ Provides a method that is called by the common language runtime (CLR) to notify ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md b/docs/core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md index 5e240ac72b2ac..aec068edee838 100644 --- a/docs/core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md +++ b/docs/core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md @@ -36,7 +36,7 @@ HRESULT OnAppDomain ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md b/docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md index e554df4dde1e8..e17214786a651 100644 --- a/docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md +++ b/docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md @@ -43,7 +43,7 @@ Provides properties that allow the host to configure an GetStats(&GCStats); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md index 1e3434ba2062a..3ab4b9296c9f0 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md @@ -37,7 +37,7 @@ Provides methods that allow a host to interact with the common language runtime' ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md b/docs/core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md index fa0e2f4599767..10110a7db801f 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md +++ b/docs/core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md @@ -62,7 +62,7 @@ HRESULT SetGCStartupLimits ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md b/docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md index 9681bc2892dc7..e4e2849e04bf0 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md @@ -34,7 +34,7 @@ Provides methods that allow a host to interact with the common language runtime' ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md b/docs/core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md index 9d8e1ece92928..5fc8c3289fe71 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md +++ b/docs/core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md @@ -61,7 +61,7 @@ HRESULT SetGCStartupLimitsEx ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md index 8c72e0eba30a8..6b8a320823756 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md +++ b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md @@ -73,7 +73,7 @@ HRESULT EvaluatePolicy ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md index 35149f9cd0d51..3bb60d4fc2a65 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md @@ -29,7 +29,7 @@ Provides methods for the host to evaluate current binding policy and communicate ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md index 4d445cad05b2e..5cd62a0ef9a76 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md +++ b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md @@ -77,7 +77,7 @@ HRESULT ModifyApplicationPolicy ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md index 542e476346a5c..61474bc4703df 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md @@ -29,7 +29,7 @@ Enables the host to block specific managed classes, methods, properties, and fie ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md index ed88817ca18e7..71a81297ae195 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md +++ b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md @@ -40,7 +40,7 @@ HRESULT SetEagerSerializeGrantSets (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md index 2ea84c486fe31..b8cac3ec4e955 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md +++ b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md @@ -51,7 +51,7 @@ HRESULT SetProtectedCategories ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclriocompletionmanager-interface.md b/docs/core/unmanaged-api/hosting/iclriocompletionmanager-interface.md index c47bcccee8381..15bd3f1eb6279 100644 --- a/docs/core/unmanaged-api/hosting/iclriocompletionmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclriocompletionmanager-interface.md @@ -32,7 +32,7 @@ Implements a callback method that allows the host to notify the common language ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md b/docs/core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md index 3472f782f7191..af2c0a3ecab11 100644 --- a/docs/core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md +++ b/docs/core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md @@ -65,7 +65,7 @@ HRESULT OnComplete ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md b/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md index 6abc883d099a5..6996e1bfc7463 100644 --- a/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md @@ -32,7 +32,7 @@ Allows the host to report memory pressure conditions using an approach similar t ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md b/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md index 7093a1f5b9c64..51d79b17f9d40 100644 --- a/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md @@ -54,7 +54,7 @@ HRESULT OnMemoryNotification ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md index 06189c6791235..c1fdd61cd562b 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md @@ -44,7 +44,7 @@ HRESULT EnumerateInstalledRuntimes ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md index 879ed8a875f22..3c28f3added67 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md @@ -53,7 +53,7 @@ HRESULT EnumerateLoadedRuntimes ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md index f87caae04a184..db592835796be 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md @@ -41,7 +41,7 @@ HRESULT ExitProcess ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md index 23b0457950a2d..14fc6d0f794a2 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md @@ -62,7 +62,7 @@ HRESULT GetRuntime ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md index 719207f82e8dc..b7bc2d9252ce5 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md @@ -59,7 +59,7 @@ HRESULT GetVersionFromFile ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-interface.md b/docs/core/unmanaged-api/hosting/iclrmetahost-interface.md index 4aab578cdebae..e6c37a4eea03b 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-interface.md @@ -44,7 +44,7 @@ HRESULT hr = CLRCreateInstance(CLSID_CLRMetaHost, ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md index d3fcf10076862..2c1e677ca343e 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md @@ -51,7 +51,7 @@ HRESULT QueryLegacyV2RuntimeBinding ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md index 13729e2ce2dd9..725858644d00f 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md @@ -88,7 +88,7 @@ typedef void (__stdcall *RuntimeLoadedCallbackFnPtr)( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md b/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md index 7056b85fde9fd..2e00238de2499 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md @@ -79,7 +79,7 @@ This method returns the following specific HRESULTs as well as HRESULT errors th ## Requirements -**Platforms:** See [System Requirements](../../get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md b/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md index 77fe3dc9f0be5..607f8935dbc60 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md @@ -43,7 +43,7 @@ HRESULT hr = CLRCreateInstance(CLSID_CLRMetaHostPolicy, ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md b/docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md index 9cc53d8741961..e227d8b504009 100644 --- a/docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md @@ -36,7 +36,7 @@ Provides methods that allow the host to register and unregister callbacks for co ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md b/docs/core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md index 209e6277284e5..3ff0289acfc8f 100644 --- a/docs/core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md +++ b/docs/core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md @@ -58,7 +58,7 @@ HRESULT RegisterActionOnEvent ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md b/docs/core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md index e46f20c30a2c4..6c62e8d3efff5 100644 --- a/docs/core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md +++ b/docs/core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md @@ -51,7 +51,7 @@ HRESULT UnregisterActionOnEvent ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md index a74c938610bfa..42f4468f68664 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md @@ -33,7 +33,7 @@ Provides methods that allow the host to specify policy actions to be taken in th ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md index cb08463cddbba..5edfb85592840 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md @@ -69,7 +69,7 @@ HRESULT SetActionOnFailure ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md index 30e8d493818ea..d6a80c9307933 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md @@ -72,7 +72,7 @@ HRESULT SetActionOnTimeout ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md index 4e1f6d16c8063..25aeaee5e1901 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md @@ -65,7 +65,7 @@ HRESULT SetDefaultAction ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md index c9e4b0efd9d2a..d412cbf5afcb3 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md @@ -60,7 +60,7 @@ HRESULT SetTimeout ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md index fba0204b0aaf7..8c054b95730b8 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md @@ -71,7 +71,7 @@ HRESULT SetTimeoutAndAction ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md index 9de11895438a7..2851ceb27ea0d 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md @@ -51,7 +51,7 @@ HRESULT SetUnhandledExceptionPolicy ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md b/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md index 423f93c02a248..be5edfed570e5 100644 --- a/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md +++ b/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md @@ -63,7 +63,7 @@ HRESULT Get ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md b/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md index 2de9d5d8246df..56606a455ed21 100644 --- a/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md @@ -32,7 +32,7 @@ Provides methods that enable the host to get the probing identities of an assemb ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md b/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md index a88de2907cc6e..02347831abc00 100644 --- a/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md +++ b/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md @@ -61,7 +61,7 @@ HRESULT Get ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md b/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md index 1393f288268b8..f6b5c527f846c 100644 --- a/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md @@ -28,7 +28,7 @@ Provides methods that allow the host to manipulate the set of assemblies referen ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md index d1d4c7fd913a2..6e42a9e8db874 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md @@ -76,7 +76,7 @@ HRESULT ExecuteApplication( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md index cae5694d7c317..b7b527ad79e4b 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md @@ -59,7 +59,7 @@ HRESULT ExecuteInAppDomain( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md index b9eb15bfdd611..a3d0384e881ef 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md @@ -73,7 +73,7 @@ static int pwzMethodName (String pwzArgument) ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md index 140a6a89c9f71..51e7ae5e1c3a6 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md @@ -52,7 +52,7 @@ HRESULT GetCLRControl( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md index 5b264fb645967..8abd97ae15344 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md @@ -51,7 +51,7 @@ HRESULT GetCurrentAppDomainId( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md index 6a0d977d95acb..0ee7347364d6c 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md @@ -47,7 +47,7 @@ Provides functionality similar to that of the [ICorRuntimeHost](icorruntimehost- ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md index a08755177023a..d72c77fc1270e 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md @@ -52,7 +52,7 @@ HRESULT SetHostControl( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md index ea6b86bb5f30e..232a272d8c576 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md @@ -44,7 +44,7 @@ HRESULT Start(); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md index 763a74f2ee6ad..c14f7220f4bc9 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md @@ -43,7 +43,7 @@ HRESULT Stop(); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md index 7b0c227d61f63..7e14e2c9b56c5 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md @@ -55,7 +55,7 @@ HRESULT UnloadAppDomain( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md index a69824369b18a..8e6b81a1d7d9b 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md @@ -42,7 +42,7 @@ HRESULT BindAsLegacyV2Runtime (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md index 0019cbf1daaf2..c550e54ef15da 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md @@ -55,7 +55,7 @@ HRESULT GetDefaultStartupFlags( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md index ebde545d9275e..4d687dec347af 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md @@ -72,7 +72,7 @@ HRESULT GetInterface( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md index 8ea6e3a07b2fc..d616e877ca34d 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md @@ -55,7 +55,7 @@ HRESULT GetProcAddress( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md index d2bac28c02bbb..b3c2dfdd69221 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md @@ -52,7 +52,7 @@ HRESULT GetRuntimeDirectory( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md index d43eacac6048d..9dc9ef6b434ce 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md @@ -59,7 +59,7 @@ HRESULT GetVersionString( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md index c874877bbf132..7e669b8df1ab2 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md @@ -39,7 +39,7 @@ Provides methods that return information about a specific common language runtim ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md index 13c0c7ba34274..cb7b99ad79d29 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md @@ -50,7 +50,7 @@ HRESULT IsLoadable( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md index 98325107f3a82..1e82761255d1d 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md @@ -62,7 +62,7 @@ HRESULT IsLoaded( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md index e38eb8ba3dcc1..48a2113b4f4ce 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md @@ -50,7 +50,7 @@ HRESULT IsStarted( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md index b6cec93e2e597..80a66807ff591 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md @@ -63,7 +63,7 @@ HRESULT LoadErrorString( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md index 8eaccd8dc9fb4..0ff80511920d7 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md @@ -55,7 +55,7 @@ HRESULT LoadLibrary( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md index ae74865958f44..fbcb8a1daee4a 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md @@ -51,7 +51,7 @@ HRESULT SetDefaultStartupFlags( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md index 4dcb1c50ec156..91bd5c0f172b1 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md @@ -56,7 +56,7 @@ HRESULT GetHashFromAssemblyFile ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md index 2106c425080b5..a8664014a16f4 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md @@ -56,7 +56,7 @@ HRESULT GetHashFromAssemblyFileW ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md index 012b1ca2c8f32..ef9bcb0277494 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md @@ -60,7 +60,7 @@ HRESULT GetHashFromBlob ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md index 17b1c3842383f..2118945ee4c42 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md @@ -60,7 +60,7 @@ HRESULT GetHashFromFile ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md index 66a29a7d9eaf0..1d4f868a77102 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md @@ -60,7 +60,7 @@ HRESULT GetHashFromFileW ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md index c3bf534c1c821..d1b9f8761c382 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md @@ -57,7 +57,7 @@ HRESULT GetHashFromHandle ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-interface.md b/docs/core/unmanaged-api/hosting/iclrstrongname-interface.md index cb54ecb2e915d..d41dc00106d30 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-interface.md @@ -56,7 +56,7 @@ Provides basic global static functions for signing assemblies with strong names. ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md index 08e0497bb4421..550876980e8a3 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md @@ -54,7 +54,7 @@ HRESULT StrongNameCompareAssemblies ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md index dadaf56652681..f214f82aab181 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md @@ -40,7 +40,7 @@ HRESULT StrongNameFreeBuffer ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md index c4bd0e040fee0..9d96a6b45342c 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md @@ -49,7 +49,7 @@ HRESULT StrongNameGetBlob ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md index b51c7449d3e68..559253c72ce0d 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md @@ -52,7 +52,7 @@ HRESULT StrongNameGetBlobFromImage ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md index efeb0c92e2697..6f67ad578c14d 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md @@ -64,7 +64,7 @@ HRESULT StrongNameGetPublicKey ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md index faaa6fddcd82a..0ccceaa31784f 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md @@ -44,7 +44,7 @@ HRESULT StrongNameHashSize ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md index f62b82747652f..47a490d7a2ce1 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md @@ -44,7 +44,7 @@ HRESULT StrongNameKeyDelete ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md index 3d597a8bae268..9f1e1378c409a 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md @@ -60,7 +60,7 @@ HRESULT StrongNameKeyGen ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md index aecb6b5684c2f..3bb0eec1a678d 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md @@ -66,7 +66,7 @@ HRESULT StrongNameKeyGenEx ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md index 94fcac9d9aabc..098e4a47670ef 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md @@ -52,7 +52,7 @@ HRESULT StrongNameKeyInstall ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md index 055d64f0e53eb..86d3592b067d2 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md @@ -74,7 +74,7 @@ HRESULT StrongNameSignatureGeneration ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md index 604f21020bd4d..fec6599668aa2 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md @@ -84,7 +84,7 @@ HRESULT StrongNameSignatureGenerationEx ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md index b3e71e9f85b2f..398bf9cb14fc4 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md @@ -48,7 +48,7 @@ HRESULT StrongNameSignatureSize ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md index 72b77067e55f2..c65fed0c80b5a 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md @@ -62,7 +62,7 @@ HRESULT StrongNameSignatureVerification ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md index fb45029a0fa40..5f71f9d72bf44 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md @@ -52,7 +52,7 @@ HRESULT StrongNameSignatureVerificationEx ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md index 946398fa5092f..02663afceae6f 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md @@ -66,7 +66,7 @@ HRESULT StrongNameSignatureVerificationFromImage ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md index 7c8a5bc0902d9..4311054642e12 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md @@ -54,7 +54,7 @@ HRESULT StrongNameTokenFromAssembly ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md index 5bd895e343c7d..3bde0c586d1f6 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md @@ -62,7 +62,7 @@ HRESULT StrongNameTokenFromAssemblyEx ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md index 769a3bb87434c..9127a37d2c35d 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md @@ -56,7 +56,7 @@ HRESULT StrongNameTokenFromPublicKey ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md b/docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md index cd4fba057ee33..54b4150f7c422 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md @@ -31,7 +31,7 @@ Provides the ability to create strong names using the SHA-2 group of Secure Hash ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md index f692f6c67dc48..833567b8c226f 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md +++ b/docs/core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md @@ -63,7 +63,7 @@ HRESULT CreateRWLockOwnerIterator ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md index 3991273713ec2..2c6b3b61b1db6 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md +++ b/docs/core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md @@ -51,7 +51,7 @@ HRESULT DeleteRWLockOwnerIterator ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md index 85ddf6a87d282..3f2e86668ccda 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md +++ b/docs/core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md @@ -60,7 +60,7 @@ HRESULT GetMonitorOwner ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md index d3dbfb390b15a..e469ad560c28b 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md +++ b/docs/core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md @@ -58,7 +58,7 @@ HRESULT GetRWLockOwnerNext ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md index 3ca29a8748bf3..16970c0e8277c 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md @@ -31,7 +31,7 @@ Defines methods that allow the host to get information about requested tasks and ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-abort-method.md b/docs/core/unmanaged-api/hosting/iclrtask-abort-method.md index a661e2d7de822..10e3ee10a02c0 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-abort-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-abort-method.md @@ -44,7 +44,7 @@ HRESULT Abort (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md b/docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md index 5497f6a16e077..2514fc0e88df1 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md @@ -44,7 +44,7 @@ HRESULT ExitTask (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md b/docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md index ca432b3fc546f..cf5e7edd7479c 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md @@ -47,7 +47,7 @@ HRESULT GetMemStats ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-interface.md b/docs/core/unmanaged-api/hosting/iclrtask-interface.md index 8b6f4ae2088f9..c753bec92f492 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-interface.md @@ -44,7 +44,7 @@ Provides methods that allow the host to make requests of the common language run ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md b/docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md index 842d35d918d45..c8f30a3ae6c52 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md @@ -47,7 +47,7 @@ HRESULT LocksHeld ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md b/docs/core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md index a6dec6a556022..f892bcd1ef75a 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md @@ -51,7 +51,7 @@ HRESULT NeedsPriorityScheduling ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-reset-method.md b/docs/core/unmanaged-api/hosting/iclrtask-reset-method.md index a6974ef802cf8..3eb71ea328e05 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-reset-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-reset-method.md @@ -67,7 +67,7 @@ HRESULT Reset ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md b/docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md index b3061e2c6045f..e75646ddc0dbd 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md @@ -44,7 +44,7 @@ HRESULT RudeAbort (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md b/docs/core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md index f99c5428d4da0..c45ea26eeae04 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md @@ -51,7 +51,7 @@ HRESULT SetTaskIdentifier ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md b/docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md index c84aed42f7bc9..506774ae2e696 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md @@ -55,7 +55,7 @@ HRESULT SwitchIn ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md b/docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md index b4f70e984f6ae..2733d00466ee3 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md @@ -44,7 +44,7 @@ HRESULT SwitchOut (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md b/docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md index 6d1a3243c8e44..41690ca9346c9 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md @@ -44,7 +44,7 @@ HRESULT YieldTask (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md b/docs/core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md index 919df21b722c4..b5c07dd39e796 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md @@ -48,7 +48,7 @@ HRESULT BeginPreventAsyncAbort(); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md b/docs/core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md index cb07573735a22..2105a30eeb277 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md @@ -46,7 +46,7 @@ HRESULT EndPreventAsyncAbort(); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask2-interface.md b/docs/core/unmanaged-api/hosting/iclrtask2-interface.md index 391ae72253559..a185a1d784e30 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask2-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrtask2-interface.md @@ -41,7 +41,7 @@ Provides all the functionality of the [ICLRTask](iclrtask-interface.md) interfac ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md index 3b672e3479cad..3c84e88e69a9d 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md @@ -57,7 +57,7 @@ HRESULT CreateTask ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md index e1470881a1ba2..f2fef63347312 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md @@ -51,7 +51,7 @@ HRESULT GetCurrentTask ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md index 7afdf761b2db1..1ce8a5e1c5f83 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md @@ -36,7 +36,7 @@ HRESULT GetCurrentTaskType( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md index b0badfdc2500e..4ad3b3582644c 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md @@ -36,7 +36,7 @@ Provides methods that allow the host to request explicitly that the common langu ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md index 90232b1ea67c6..d7d447ad7f191 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md @@ -51,7 +51,7 @@ HRESULT SetLocale ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md index f2ab9c4a71648..a59e0c6b31201 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md @@ -51,7 +51,7 @@ HRESULT SetUILocale ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md b/docs/core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md index 2740adf9ad619..8e52f82fa163b 100644 --- a/docs/core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md +++ b/docs/core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md @@ -63,7 +63,7 @@ HRESULT FormatEventInfo ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h diff --git a/docs/core/unmanaged-api/hosting/iclrvalidator-interface.md b/docs/core/unmanaged-api/hosting/iclrvalidator-interface.md index 3caf8c9b0279a..fdd4a8f092bb1 100644 --- a/docs/core/unmanaged-api/hosting/iclrvalidator-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrvalidator-interface.md @@ -29,7 +29,7 @@ Provides methods for validating portable executable (PE) images and reporting va ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h diff --git a/docs/core/unmanaged-api/hosting/iclrvalidator-validate-method.md b/docs/core/unmanaged-api/hosting/iclrvalidator-validate-method.md index 0ac6dd1afc64b..0cb59bf16c4f8 100644 --- a/docs/core/unmanaged-api/hosting/iclrvalidator-validate-method.md +++ b/docs/core/unmanaged-api/hosting/iclrvalidator-validate-method.md @@ -75,7 +75,7 @@ HRESULT Validate ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md b/docs/core/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md index fa007c0317271..70e001a4c4994 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md +++ b/docs/core/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md @@ -40,7 +40,7 @@ HRESULT AddDebuggerSpecialThread ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-interface.md b/docs/core/unmanaged-api/hosting/icorconfiguration-interface.md index 86a77af1871bd..ba3d257af776e 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-interface.md +++ b/docs/core/unmanaged-api/hosting/icorconfiguration-interface.md @@ -31,7 +31,7 @@ Provides methods for configuring the common language runtime (CLR). ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md b/docs/core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md index 8fa5b05dd792c..3caa66502b631 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md +++ b/docs/core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md @@ -36,7 +36,7 @@ HRESULT SetDebuggerThreadControl ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md b/docs/core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md index 41345d11bf57c..8045bbaacc788 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md +++ b/docs/core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md @@ -36,7 +36,7 @@ HRESULT SetGCHostControl ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md b/docs/core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md index 60e53f44d8bb6..b837e37a12ecf 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md +++ b/docs/core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md @@ -40,7 +40,7 @@ HRESULT SetGCThreadControl ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md index 8d57f5c2023c9..66137c8d3d168 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md @@ -45,7 +45,7 @@ HRESULT CloseEnum ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md index 3fed011a9378d..9c6df3bb8473d 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md @@ -53,7 +53,7 @@ HRESULT CreateDomain ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md index 67e84ec20b905..d941fe77f60c7 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md @@ -61,7 +61,7 @@ HRESULT CreateDomainEx ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md index a551383146682..8ec26aadc975e 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md @@ -49,7 +49,7 @@ HRESULT CreateDomainSetup ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md index a2dbb12fdae4b..7706bed14c501 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md @@ -49,7 +49,7 @@ HRESULT CreateEvidence ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md index e0c84d95c3304..d2b008eab5bb1 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md @@ -29,7 +29,7 @@ HRESULT CreateLogicalThreadState ( ); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md index 8b11555be3262..ef96c7e480660 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md @@ -45,7 +45,7 @@ HRESULT CurrentDomain ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md index 0740d660c4a96..836c7ac0e5162 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md @@ -29,7 +29,7 @@ HRESULT DeleteLogicalThreadState ( ); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md index 0b164731c9729..8e8499a666f16 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md @@ -45,7 +45,7 @@ HRESULT EnumDomains ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md index ce7be4ea895bf..9e12d52673347 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md @@ -40,7 +40,7 @@ HRESULT GetConfiguration( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md index 2e3ab52b90d08..17b89fbcc1694 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md @@ -47,7 +47,7 @@ HRESULT GetDefaultDomain ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-interface.md b/docs/core/unmanaged-api/hosting/icorruntimehost-interface.md index 875dc8ba349d7..8cf70229ab95b 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-interface.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-interface.md @@ -48,7 +48,7 @@ Provides methods that enable the host to start and stop the common language runt ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md index 8b0f23801bb07..870df2039e35d 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md @@ -38,7 +38,7 @@ HRESULT LocksHeldByLogicalThread( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md index 64bdca1e88efa..e1f299ba03d1c 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md @@ -40,7 +40,7 @@ HRESULT MapFile( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md index f9534b80d4964..9ab4ebd86b476 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md @@ -49,7 +49,7 @@ HRESULT NextDomain ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md index 37e41420c4f9d..d095c5bcbbca3 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md @@ -42,7 +42,7 @@ HRESULT Start (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md index 255fd84e8cb2b..917a2c1d0b14c 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md @@ -45,7 +45,7 @@ HRESULT Stop (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md index 148347c38a4bf..f074610cc5ac6 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md @@ -36,7 +36,7 @@ HRESULT SwitchInLogicalThreadState( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md index 2b98ff0852b3f..6a31090a464d3 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md @@ -36,7 +36,7 @@ HRESULT SwitchOutLogicalThreadState( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md index dff3c6d80a668..e7f33f213c2bc 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md @@ -45,7 +45,7 @@ HRESULT UnloadDomain ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md index bad222098d1de..1005b0d61361f 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md @@ -32,7 +32,7 @@ HRESULT CorBindIoCompletionCallback ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md index 53b9bf07b6c6a..756a07df3d457 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md @@ -33,7 +33,7 @@ HRESULT CorCallOrQueueUserWorkItem ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md index 80d48361c30c4..cd2340b66237c 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md @@ -34,7 +34,7 @@ HRESULT CorChangeTimer ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md index ec21f4403e406..7fa6866e596fa 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md @@ -36,7 +36,7 @@ HRESULT CorCreateTimer ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md index 9de264cbc3dda..9354888a566d7 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md @@ -33,7 +33,7 @@ HRESULT CorDeleteTimer ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md index 95c5c1cee836e..7f5fabc8e948d 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md @@ -32,7 +32,7 @@ HRESULT CorGetAvailableThreads ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md index 6c12d70ee2cb6..a7f4c87890386 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md @@ -32,7 +32,7 @@ HRESULT CorGetMaxThreads ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md index cba38b6c844b9..d2bbdc30794b2 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md @@ -34,7 +34,7 @@ HRESULT CorQueueUserWorkItem ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md index 76225acb7d207..795161956073a 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md @@ -37,7 +37,7 @@ HRESULT CorRegisterWaitForSingleObject ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md index 124e9cadd2d62..8b96c87dbffd8 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md @@ -32,7 +32,7 @@ HRESULT CorSetMaxThreads ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md index a7e8951731b1a..2a66bc7581533 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md @@ -33,7 +33,7 @@ HRESULT CorUnregisterWait ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-interface.md b/docs/core/unmanaged-api/hosting/icorthreadpool-interface.md index 1ef46e99bea08..c7978f641f42b 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-interface.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-interface.md @@ -41,7 +41,7 @@ Provides methods for accessing the thread pool. ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md b/docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md index 8ab95e1fba0e6..0a3de5acbd139 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md +++ b/docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md @@ -28,7 +28,7 @@ Provides methods for obtaining information about the state of the debugging serv ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md b/docs/core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md index 92fc8137a62df..3d6ba659f5e30 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md +++ b/docs/core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md @@ -36,7 +36,7 @@ HRESULT IsDebuggerAttached ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md index 163fa536f9b2f..0ef73b678db91 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md +++ b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md @@ -30,7 +30,7 @@ Provides methods for notifying the host about the blocking and unblocking of thr ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md index da3468da7871a..fd66be8fba876 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md +++ b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md @@ -33,7 +33,7 @@ HRESULT ReleaseAllRuntimeThreads ( ); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md index 953bff59db957..faf825801874b 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md +++ b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md @@ -40,7 +40,7 @@ HRESULT StartBlockingForDebugger ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md index 7bf73928fdd79..93014decc2dcc 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md +++ b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md @@ -35,7 +35,7 @@ HRESULT ThreadIsBlockingForDebugger ( ); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/igchost-collect-method.md b/docs/core/unmanaged-api/hosting/igchost-collect-method.md index dc0426b7da5f6..3628721848af6 100644 --- a/docs/core/unmanaged-api/hosting/igchost-collect-method.md +++ b/docs/core/unmanaged-api/hosting/igchost-collect-method.md @@ -36,7 +36,7 @@ HRESULT Collect ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchost-getstats-method.md b/docs/core/unmanaged-api/hosting/igchost-getstats-method.md index 4a3e905c75035..61ca28a612ce6 100644 --- a/docs/core/unmanaged-api/hosting/igchost-getstats-method.md +++ b/docs/core/unmanaged-api/hosting/igchost-getstats-method.md @@ -40,7 +40,7 @@ HRESULT GetStats ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchost-getthreadstats-method.md b/docs/core/unmanaged-api/hosting/igchost-getthreadstats-method.md index cdd63b9e54f6e..8ce0c8bceaff0 100644 --- a/docs/core/unmanaged-api/hosting/igchost-getthreadstats-method.md +++ b/docs/core/unmanaged-api/hosting/igchost-getthreadstats-method.md @@ -40,7 +40,7 @@ HRESULT GetThreadStats ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchost-interface.md b/docs/core/unmanaged-api/hosting/igchost-interface.md index 1981fd4a67f43..f9fc368f8bf77 100644 --- a/docs/core/unmanaged-api/hosting/igchost-interface.md +++ b/docs/core/unmanaged-api/hosting/igchost-interface.md @@ -38,7 +38,7 @@ Provides methods for obtaining information about the garbage collection system a ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md b/docs/core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md index 47f2f03714efc..84aef10899247 100644 --- a/docs/core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md +++ b/docs/core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md @@ -47,7 +47,7 @@ HRESULT SetGCStartupLimits ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md b/docs/core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md index ec6490a70f541..3e6e7cf8e80de 100644 --- a/docs/core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md +++ b/docs/core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md @@ -40,7 +40,7 @@ HRESULT SetVirtualMemLimit ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchost2-interface.md b/docs/core/unmanaged-api/hosting/igchost2-interface.md index 502e2f5ab7502..6867aba88ffc8 100644 --- a/docs/core/unmanaged-api/hosting/igchost2-interface.md +++ b/docs/core/unmanaged-api/hosting/igchost2-interface.md @@ -31,7 +31,7 @@ Provides methods for obtaining information about the garbage collection system a ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md b/docs/core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md index 5a66af63d8588..57e9a83dfba79 100644 --- a/docs/core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md +++ b/docs/core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md @@ -44,7 +44,7 @@ HRESULT SetGCStartupLimitsEx ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchostcontrol-interface.md b/docs/core/unmanaged-api/hosting/igchostcontrol-interface.md index d5462d766f50e..faaae2924c5b0 100644 --- a/docs/core/unmanaged-api/hosting/igchostcontrol-interface.md +++ b/docs/core/unmanaged-api/hosting/igchostcontrol-interface.md @@ -28,7 +28,7 @@ Provides a method that allows the garbage collector to request the host to chang ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md b/docs/core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md index fad3ebf5541b4..34edd78a77065 100644 --- a/docs/core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md +++ b/docs/core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md @@ -40,7 +40,7 @@ HRESULT RequestVirtualMemLimit ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md b/docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md index 44c1f39c21eb3..82c1464940513 100644 --- a/docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md +++ b/docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md @@ -30,7 +30,7 @@ Provides methods for participating in the scheduling of threads that would other ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md b/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md index 128b886c79e9c..1fdb754bdabb1 100644 --- a/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md +++ b/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md @@ -40,7 +40,7 @@ HRESULT SuspensionEnding ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md b/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md index df94fbbfa17a7..9652f561101bd 100644 --- a/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md +++ b/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md @@ -33,7 +33,7 @@ HRESULT SuspensionStarting ( ); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md b/docs/core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md index d59d24b1e2852..a632e936da4bd 100644 --- a/docs/core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md +++ b/docs/core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md @@ -33,7 +33,7 @@ HRESULT ThreadIsBlockingForSuspension ( ); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md b/docs/core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md index 53c16256b026c..802e258e96755 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md @@ -55,7 +55,7 @@ HRESULT GetAssemblyStore ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md b/docs/core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md index 7808c8c2f360a..0d8d9467b4479 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md @@ -65,7 +65,7 @@ HRESULT GetNonHostStoreAssemblies ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostassemblymanager-interface.md b/docs/core/unmanaged-api/hosting/ihostassemblymanager-interface.md index f287d9af6a396..61c4d5793375d 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblymanager-interface.md @@ -35,7 +35,7 @@ Provides methods that allow a host to specify sets of assemblies that should be ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md b/docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md index 8ff9b7a4652f5..598821965aa71 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md @@ -41,7 +41,7 @@ Provides methods that allow a host to load assemblies and modules independently ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md b/docs/core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md index 80568da0efdd9..d4cf6ace0818c 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md @@ -69,7 +69,7 @@ HRESULT ProvideAssembly ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md b/docs/core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md index 8beaecfc3de50..d542dbb21bfaf 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md @@ -65,7 +65,7 @@ HRESULT ProvideModule ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostautoevent-interface.md b/docs/core/unmanaged-api/hosting/ihostautoevent-interface.md index d18fd4787a87b..f04e24e51315d 100644 --- a/docs/core/unmanaged-api/hosting/ihostautoevent-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostautoevent-interface.md @@ -29,7 +29,7 @@ Provides a representation of the host's implementation of an auto-reset event. ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md b/docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md index 37520563497ee..1c15d56b85073 100644 --- a/docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md +++ b/docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md @@ -40,7 +40,7 @@ HRESULT Set (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md b/docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md index 3e778393d15c9..6fb089c532d00 100644 --- a/docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md +++ b/docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md @@ -52,7 +52,7 @@ HRESULT Wait ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md b/docs/core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md index 69c01420bbbd6..31395d0e51015 100644 --- a/docs/core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md @@ -79,7 +79,7 @@ HRESULT GetHostManager ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcontrol-interface.md b/docs/core/unmanaged-api/hosting/ihostcontrol-interface.md index a2b19c1a21aa9..44861851bb0a4 100644 --- a/docs/core/unmanaged-api/hosting/ihostcontrol-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostcontrol-interface.md @@ -29,7 +29,7 @@ Provides methods for configuring the loading of assemblies, and for determining ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md b/docs/core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md index bc49dd1a2a6e6..c39c9ccb83b39 100644 --- a/docs/core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md @@ -57,7 +57,7 @@ HRESULT SetAppDomainManager ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md b/docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md index 4d702cdb023b1..a4158850f9843 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md @@ -54,7 +54,7 @@ HRESULT Enter ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-interface.md b/docs/core/unmanaged-api/hosting/ihostcrst-interface.md index bbab0ccc50f8d..da88f96bea59a 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostcrst-interface.md @@ -35,7 +35,7 @@ Serves as the host's representation of a critical section for threading. ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md b/docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md index 4c03044fa5b32..2eaa0c2f0eb55 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md @@ -44,7 +44,7 @@ HRESULT Leave (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-setspincount-method.md b/docs/core/unmanaged-api/hosting/ihostcrst-setspincount-method.md index 968c65df2f404..76c451e4e14ac 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-setspincount-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcrst-setspincount-method.md @@ -53,7 +53,7 @@ HRESULT SetSpinCount ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md b/docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md index 882a9bf13dc82..84f75b71a736b 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md @@ -55,7 +55,7 @@ HRESULT TryEnter ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md b/docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md index 01cba1fee02e1..ec3accad6b3d8 100644 --- a/docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md @@ -30,7 +30,7 @@ Provides methods that notify the host of events in the garbage collection mechan ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md b/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md index e0e4ec6ca0233..7b3b97b1320a8 100644 --- a/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md +++ b/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md @@ -54,7 +54,7 @@ HRESULT SuspensionEnding ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md b/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md index 1595c0add386f..3f7c7d42edf86 100644 --- a/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md +++ b/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md @@ -47,7 +47,7 @@ HRESULT SuspensionStarting (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md b/docs/core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md index 8b0420b788712..4617ccf730c11 100644 --- a/docs/core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md +++ b/docs/core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md @@ -47,7 +47,7 @@ HRESULT ThreadIsBlockingForSuspension (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md index eb6a3c95cea8c..9de4119de1db3 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md @@ -58,7 +58,7 @@ HRESULT Bind ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md index e449235c0ac07..3299964862c96 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md @@ -52,7 +52,7 @@ HRESULT CloseIoCompletionPort ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md index cd4f5e905648c..68047f4a86bbe 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md @@ -52,7 +52,7 @@ HRESULT CreateIoCompletionPort ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md index d4be50962f0e4..5095c4f6717e3 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md @@ -52,7 +52,7 @@ HRESULT GetAvailableThreads ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md index a9ca204dc9863..871c556a8f8cf 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md @@ -61,7 +61,7 @@ HRESULT GetHostOverlappedSize ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md index 298d8c9154071..d8d112d9691fd 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md @@ -52,7 +52,7 @@ HRESULT GetMaxThreads ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md index 7faadc1b6d8a1..87f8d01a4d5fe 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md @@ -52,7 +52,7 @@ HRESULT GetMinThreads ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md index fdb92967fe625..792b83b342700 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md @@ -57,7 +57,7 @@ HRESULT InitializeHostOverlapped ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md index b2fb17246de1e..84f99e648c3bb 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md @@ -42,7 +42,7 @@ Provides methods that allow the common language runtime (CLR) to interact with I ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md index 9dc302202f8d8..0598631f7727d 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md @@ -51,7 +51,7 @@ HRESULT SetCLRIoCompletionManager ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md index f2aa095e698d0..87a5abf3330c6 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md @@ -52,7 +52,7 @@ HRESULT SetMaxThreads ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md index e167268abe3b5..f9868fc37b451 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md @@ -52,7 +52,7 @@ HRESULT SetMinThreads ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md b/docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md index dc6febbc932cb..635b4b44c49f4 100644 --- a/docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md @@ -60,7 +60,7 @@ HRESULT Alloc ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md b/docs/core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md index 5399ef089601c..438bb3ecadc08 100644 --- a/docs/core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md @@ -68,7 +68,7 @@ HRESULT DebugAlloc ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md b/docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md index 861dae3f9670f..87610bfb8c7d6 100644 --- a/docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md @@ -52,7 +52,7 @@ HRESULT Free ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmalloc-interface.md b/docs/core/unmanaged-api/hosting/ihostmalloc-interface.md index 7e33b1bf0cf93..2a28bc943d762 100644 --- a/docs/core/unmanaged-api/hosting/ihostmalloc-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostmalloc-interface.md @@ -34,7 +34,7 @@ Provides methods that allow the common language runtime (CLR) to request fine-gr ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md b/docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md index 510435aa87f86..bffa236ad3a80 100644 --- a/docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md @@ -30,7 +30,7 @@ Provides the host's implementation of a representation of a manual reset event. ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmanualevent-reset-method.md b/docs/core/unmanaged-api/hosting/ihostmanualevent-reset-method.md index 7eeacf969a76f..62e49ae4606db 100644 --- a/docs/core/unmanaged-api/hosting/ihostmanualevent-reset-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmanualevent-reset-method.md @@ -40,7 +40,7 @@ HRESULT Reset (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md b/docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md index e37ba3e8eb18e..4e0b2b5369c33 100644 --- a/docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md @@ -40,7 +40,7 @@ HRESULT Set (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md b/docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md index df261e912b075..785205a2f938a 100644 --- a/docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md @@ -52,7 +52,7 @@ HRESULT Wait ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md index b549bbba2ec4e..286468b687d08 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md @@ -44,7 +44,7 @@ HRESULT AcquiredVirtualAddressSpace( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md index 6046a11591af0..98ab3e55941b3 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md @@ -56,7 +56,7 @@ HRESULT CreateMalloc ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md index 9d7c62ba3c144..3166aea460359 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md @@ -57,7 +57,7 @@ HRESULT GetMemoryLoad ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md index 496ca36a31a68..e533c8c8d746d 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md @@ -41,7 +41,7 @@ Provides methods that allow the common language runtime (CLR) to make virtual me ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md index 6fb4597066c61..3b5f359f20264 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md @@ -46,7 +46,7 @@ HRESULT NeedsVirtualAddressSpace ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md index b4244f7690709..6593d420e5be9 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md @@ -54,7 +54,7 @@ HRESULT RegisterMemoryNotificationCallback ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md index 5d8eead6209f0..9037faff1326e 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md @@ -40,7 +40,7 @@ HRESULT ReleasedVirtualAddressSpace( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md index 1c23338322273..2bd7934baf921 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md @@ -74,7 +74,7 @@ HRESULT VirtualAlloc ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md index 574909076bece..50d133708fe27 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md @@ -62,7 +62,7 @@ HRESULT VirtualFree ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md index 373d7eedfa581..9e884e7a24a0c 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md @@ -63,7 +63,7 @@ HRESULT VirtualProtect ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md index 319bc13014cce..e4aa8112801b7 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md @@ -66,7 +66,7 @@ HRESULT VirtualQuery ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md b/docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md index 9ac76b87bb798..8387e15924440 100644 --- a/docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md @@ -30,7 +30,7 @@ Provides methods that notify the host of the actions the common language runtime ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md b/docs/core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md index 30ce27fb67779..68e299ac06da7 100644 --- a/docs/core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md +++ b/docs/core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md @@ -51,7 +51,7 @@ HRESULT OnDefaultAction ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md b/docs/core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md index b12757c62610b..850dd392419ec 100644 --- a/docs/core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md +++ b/docs/core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md @@ -51,7 +51,7 @@ HRESULT OnFailure( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md b/docs/core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md index d7c84d16935c0..f3fc1716dfbef 100644 --- a/docs/core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md +++ b/docs/core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md @@ -51,7 +51,7 @@ HRESULT OnTimeout ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md index ab765d40e3ee1..51684c83e37b7 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md @@ -51,7 +51,7 @@ HRESULT Capture ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritycontext-interface.md b/docs/core/unmanaged-api/hosting/ihostsecuritycontext-interface.md index dd6891aaf71d3..c78ac4b4c7b1d 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritycontext-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritycontext-interface.md @@ -32,7 +32,7 @@ Allows the common language runtime (CLR) to maintain security context informatio ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md index ec44a870bbb13..27541347a4abf 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md @@ -55,7 +55,7 @@ HRESULT GetSecurityContext ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md index 74bff93ef58c9..12f43f7262f14 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md @@ -53,7 +53,7 @@ HRESULT ImpersonateLoggedOnUser ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-interface.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-interface.md index 469041376bef0..9bf011e6a586d 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-interface.md @@ -47,7 +47,7 @@ Provides methods that allow access to and control over the security context of t ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md index fb8d49e190fbf..e4ab7786ec7c8 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md @@ -61,7 +61,7 @@ HRESULT OpenThreadToken ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md index 248adae2efe7f..7fd614f38cbeb 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md @@ -44,7 +44,7 @@ HRESULT RevertToSelf (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md index af82fb7c9b07f..7ec33e94eb2fb 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md @@ -57,7 +57,7 @@ HRESULT SetSecurityContext ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md index 82eccc9d768bd..d9f03ce46f6e1 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md @@ -53,7 +53,7 @@ HRESULT SetThreadToken ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md b/docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md index 46539d7ad7f3d..2b60cd0da2dc5 100644 --- a/docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md @@ -29,7 +29,7 @@ Represents the host's implementation of a semaphore for threading. ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md b/docs/core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md index fc6ba454ac13a..5a58bc01bc6e2 100644 --- a/docs/core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md @@ -55,7 +55,7 @@ HRESULT ReleaseSemaphore ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md b/docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md index e8516caed6bbd..d6cf942f6ff68 100644 --- a/docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md @@ -52,7 +52,7 @@ HRESULT Wait ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md index c2cc267add966..8e010a865c4f6 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md @@ -52,7 +52,7 @@ HRESULT CreateAutoEvent ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md index 38bd999bb504f..e7eb1e702de0d 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md @@ -52,7 +52,7 @@ HRESULT CreateCrst ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md index e1da373d744e5..e36d29d664f6c 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md @@ -56,7 +56,7 @@ HRESULT CreateCrstWithSpinCount ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md index 0296a135f1f76..9ede1f1b0addb 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md @@ -56,7 +56,7 @@ HRESULT CreateManualEvent ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md index 50bb1a8e8978f..7be050ffcc97c 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md @@ -58,7 +58,7 @@ HRESULT CreateMonitorEvent ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md index cb4d67f41f5cd..d42e0f41fbdba 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md @@ -60,7 +60,7 @@ HRESULT CreateRWLockReaderEvent ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md index f6148f00aa516..8f28e4b1d7cc7 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md @@ -56,7 +56,7 @@ HRESULT CreateRWLockWriterEvent ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md index 96c3bd14f1064..9984447582779 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md @@ -60,7 +60,7 @@ HRESULT CreateSemaphore ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md index ed889a294d9e9..9dc5917604f0f 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md @@ -40,7 +40,7 @@ Provides methods that allow the common language runtime (CLR) to create synchron ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md index 9a70748f2fa20..ca82266f7b844 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md @@ -51,7 +51,7 @@ HRESULT SetCLRSyncManager ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttask-alert-method.md b/docs/core/unmanaged-api/hosting/ihosttask-alert-method.md index dc4da783ba4cc..df0a60541bd68 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-alert-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-alert-method.md @@ -47,7 +47,7 @@ HRESULT Alert (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md b/docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md index c1686de7339fb..84fc51030a3f9 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md @@ -51,7 +51,7 @@ HRESULT GetPriority ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttask-interface.md b/docs/core/unmanaged-api/hosting/ihosttask-interface.md index e3f8bb48f374f..7b99a79ce2625 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-interface.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-interface.md @@ -37,7 +37,7 @@ Provides methods that allow the common language runtime (CLR) to communicate wit ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttask-join-method.md b/docs/core/unmanaged-api/hosting/ihosttask-join-method.md index 973f76f116cd1..0936f35a319cf 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-join-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-join-method.md @@ -51,7 +51,7 @@ HRESULT Join ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md b/docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md index 30cdb85ca8829..328d57a25b874 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md @@ -51,7 +51,7 @@ HRESULT SetCLRTask ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md b/docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md index 38339d6999b2c..469ae34d36058 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md @@ -72,7 +72,7 @@ HRESULT SetPriority ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttask-start-method.md b/docs/core/unmanaged-api/hosting/ihosttask-start-method.md index 67fcf1ca7a6da..95f004e43aa9e 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-start-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-start-method.md @@ -40,7 +40,7 @@ HRESULT Start (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md index 97adb26488850..353cfff76b8d2 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md @@ -45,7 +45,7 @@ HRESULT BeginDelayAbort (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md index aff2ba4d2c6b8..0ad62b8b29583 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md @@ -44,7 +44,7 @@ HRESULT BeginThreadAffinity (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md index 15f25beee0d3b..d9568319ea557 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md @@ -57,7 +57,7 @@ HRESULT CallNeedsHostHook ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md index 77cac9fb4f794..e79a52c98292e 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md @@ -64,7 +64,7 @@ HRESULT CreateTask ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md index 463f083bfee9f..f82abb366afa9 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md @@ -45,7 +45,7 @@ HRESULT EndDelayAbort (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md index 989ace5baef27..5c20e394559ef 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md @@ -45,7 +45,7 @@ HRESULT EndThreadAffinity (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md index 913726252ac08..929c61233270b 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md @@ -48,7 +48,7 @@ HRESULT EnterRuntime (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md index da5c7afe156e0..12905a8df4ae7 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md @@ -52,7 +52,7 @@ HRESULT GetCurrentTask ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md index bc4225b09f520..89fe7ca78083b 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md @@ -36,7 +36,7 @@ HRESULT GetStackGuarantee( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md index d78df4e114078..c2ea617479b35 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md @@ -49,7 +49,7 @@ Provides methods that allow the common language runtime (CLR) to work with tasks ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md index ae46379cf3b69..4e5714f38bf3e 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md @@ -64,7 +64,7 @@ HRESULT LeaveRuntime ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md index 231e0ee0e1df3..585bd34cfcbdf 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md @@ -48,7 +48,7 @@ HRESULT ReverseEnterRuntime (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md index 4b31053bc8432..ce4ab6a568b1e 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md @@ -45,7 +45,7 @@ HRESULT ReverseLeaveRuntime (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md index a82fc97029603..00c025bf8d727 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md @@ -51,7 +51,7 @@ HRESULT SetCLRTaskManager ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md index fbebea9dd334b..b0f1c53b9095e 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md @@ -52,7 +52,7 @@ HRESULT SetLocale ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md index 48e3c8e772504..9b5639c40fd22 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md @@ -31,7 +31,7 @@ HRESULT SetStackGuarantee( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md index def8bbb53c686..6498ca8336af6 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md @@ -52,7 +52,7 @@ HRESULT SetUILocale ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md index 09e81b678ee41..10d7a966413a6 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md @@ -55,7 +55,7 @@ HRESULT Sleep ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md index f4fe5119a48bc..1dd53d001157f 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md @@ -54,7 +54,7 @@ HRESULT SwitchToTask ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md index af116bd8a7745..4d32c4ff1078d 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md @@ -52,7 +52,7 @@ HRESULT GetAvailableThreads ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md index 0e4e785a92e4a..d5149af2eacac 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md @@ -54,7 +54,7 @@ HRESULT GetMaxThreads ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md index b613e84975928..3a8feac1f8683 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md @@ -52,7 +52,7 @@ HRESULT GetMinThreads ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md index cb82b9766dc71..55f4f89a83b8e 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md @@ -37,7 +37,7 @@ Provides methods that enable the common language runtime (CLR) to configure the ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md index 92f6941dae642..e1e97d40ad497 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md @@ -59,7 +59,7 @@ HRESULT QueueUserWorkItem ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md index 44619b07ee7dc..b568ff52f9ae0 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md @@ -52,7 +52,7 @@ HRESULT SetMaxThreads ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md index f6fcd2859f9e6..22f942a45b433 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md @@ -52,7 +52,7 @@ HRESULT SetMinThreads ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md b/docs/core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md index 13b77328d549f..9b39b13712235 100644 --- a/docs/core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md +++ b/docs/core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md @@ -48,7 +48,7 @@ HRESULT GetObjectIdentity ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md b/docs/core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md index c0aaecd511870..23b337df01959 100644 --- a/docs/core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md +++ b/docs/core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md @@ -40,7 +40,7 @@ HRESULT GetSerializedBuffer ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/imanagedobject-interface.md b/docs/core/unmanaged-api/hosting/imanagedobject-interface.md index e73871cfa055b..8028feef66a08 100644 --- a/docs/core/unmanaged-api/hosting/imanagedobject-interface.md +++ b/docs/core/unmanaged-api/hosting/imanagedobject-interface.md @@ -29,7 +29,7 @@ Provides methods for controlling a managed object. ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iobjecthandle-interface.md b/docs/core/unmanaged-api/hosting/iobjecthandle-interface.md index 45ed96483f626..ab2b9eca842a0 100644 --- a/docs/core/unmanaged-api/hosting/iobjecthandle-interface.md +++ b/docs/core/unmanaged-api/hosting/iobjecthandle-interface.md @@ -28,7 +28,7 @@ Provides a method for unwrapping marshal-by-value objects from indirection. ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md b/docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md index d10fd7e6e0501..7d03465eb4e78 100644 --- a/docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md +++ b/docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md @@ -36,7 +36,7 @@ HRESULT Unwrap ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-getassemblyname-method.md b/docs/core/unmanaged-api/hosting/itypename-getassemblyname-method.md index e653dbeb51638..9d867d6265f4b 100644 --- a/docs/core/unmanaged-api/hosting/itypename-getassemblyname-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-getassemblyname-method.md @@ -31,7 +31,7 @@ HRESULT GetAssemblyName ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-getmodifierlength-method.md b/docs/core/unmanaged-api/hosting/itypename-getmodifierlength-method.md index d9208ba2d4eb8..9c523ee5de7b4 100644 --- a/docs/core/unmanaged-api/hosting/itypename-getmodifierlength-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-getmodifierlength-method.md @@ -31,7 +31,7 @@ HRESULT GetModifierLength ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-getmodifiers-method.md b/docs/core/unmanaged-api/hosting/itypename-getmodifiers-method.md index dc6b34ab2c425..fee42f8abc738 100644 --- a/docs/core/unmanaged-api/hosting/itypename-getmodifiers-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-getmodifiers-method.md @@ -33,7 +33,7 @@ HRESULT GetModifiers ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-getnamecount-method.md b/docs/core/unmanaged-api/hosting/itypename-getnamecount-method.md index efdb4a2fb1c3c..b066130e2fe9c 100644 --- a/docs/core/unmanaged-api/hosting/itypename-getnamecount-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-getnamecount-method.md @@ -31,7 +31,7 @@ HRESULT GetNameCount ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-getnames-method.md b/docs/core/unmanaged-api/hosting/itypename-getnames-method.md index 3deaeb962ecda..0bf4f10a38acb 100644 --- a/docs/core/unmanaged-api/hosting/itypename-getnames-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-getnames-method.md @@ -33,7 +33,7 @@ HRESULT GetNames ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md b/docs/core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md index df7a497f0febf..65cce8c3969a4 100644 --- a/docs/core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md @@ -31,7 +31,7 @@ HRESULT GetTypeArgumentCount ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-gettypearguments-method.md b/docs/core/unmanaged-api/hosting/itypename-gettypearguments-method.md index 038ff4efc727f..9ea7afdfff224 100644 --- a/docs/core/unmanaged-api/hosting/itypename-gettypearguments-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-gettypearguments-method.md @@ -33,7 +33,7 @@ HRESULT GetTypeArguments ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-interface.md b/docs/core/unmanaged-api/hosting/itypename-interface.md index b0b055e987610..664e231005ec0 100644 --- a/docs/core/unmanaged-api/hosting/itypename-interface.md +++ b/docs/core/unmanaged-api/hosting/itypename-interface.md @@ -24,7 +24,7 @@ Provides methods for obtaining type name information. ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md index 94da6a5bfdd46..4dc81cdd12fbf 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md @@ -31,7 +31,7 @@ HRESULT AddArray ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md index f5dad0aad8787..57ac98b87bce0 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md @@ -31,7 +31,7 @@ HRESULT AddAssemblySpec ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md index a492396e0f1aa..76d8f7d10bf66 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md @@ -30,7 +30,7 @@ HRESULT AddByRef ( ); ## Requirements -**Platforms:** See [System Requirements](../../get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addname-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addname-method.md index c06e902fdfc38..8b176eb5fce2f 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addname-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addname-method.md @@ -31,7 +31,7 @@ HRESULT AddName ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md index 4e865dc4f844b..1e03944ed0ee8 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md @@ -29,7 +29,7 @@ HRESULT AddPointer ( ); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md index 63ede89292fe3..9c8ce9d69bd8f 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md @@ -29,7 +29,7 @@ HRESULT AddSzArray ( ); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-clear-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-clear-method.md index 50728006d19ad..94596120e6e81 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-clear-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-clear-method.md @@ -29,7 +29,7 @@ HRESULT Clear ( ); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md index 91f5b04d9ccfa..62ebd63912dff 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md @@ -29,7 +29,7 @@ HRESULT CloseGenericArgument ( ); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md index 66cf552bfa1de..9deae225da514 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md @@ -29,7 +29,7 @@ HRESULT CloseGenericArguments ( ); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md index 8dd3a6621ca95..05a3498dd7386 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md @@ -24,7 +24,7 @@ Provides methods for building a type name. ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md index 341445f00170c..0ea2ba4612ee1 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md @@ -29,7 +29,7 @@ HRESULT OpenGenericArgument ( ); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md index a1b5ab0682ebd..edfe14d0360bf 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md @@ -29,7 +29,7 @@ HRESULT OpenGenericArguments ( ); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md index eb3648beddcc1..c3c71567cb65a 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md @@ -31,7 +31,7 @@ HRESULT ToString ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md b/docs/core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md index ec950109c3a59..cba5334d8d775 100644 --- a/docs/core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md @@ -31,7 +31,7 @@ HRESULT GetTypeNameBuilder ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamefactory-interface.md b/docs/core/unmanaged-api/hosting/itypenamefactory-interface.md index c216aeab8883c..590a8b0631d00 100644 --- a/docs/core/unmanaged-api/hosting/itypenamefactory-interface.md +++ b/docs/core/unmanaged-api/hosting/itypenamefactory-interface.md @@ -24,7 +24,7 @@ Provides methods for deconstructing a type name. ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md b/docs/core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md index 471fee66526ff..1697d0c2c8fd7 100644 --- a/docs/core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md @@ -33,7 +33,7 @@ HRESULT ParseTypeName ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md b/docs/core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md index b6f36658bb921..d11aa6170801b 100644 --- a/docs/core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md +++ b/docs/core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md @@ -52,7 +52,7 @@ HRESULT FormatEventInfo( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h diff --git a/docs/core/unmanaged-api/hosting/ivalidator-interface.md b/docs/core/unmanaged-api/hosting/ivalidator-interface.md index 07404ee94ddd6..34e7af7ef7df6 100644 --- a/docs/core/unmanaged-api/hosting/ivalidator-interface.md +++ b/docs/core/unmanaged-api/hosting/ivalidator-interface.md @@ -29,7 +29,7 @@ Provides methods for validating portable executable (PE) images and reporting va ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h diff --git a/docs/core/unmanaged-api/hosting/ivalidator-validate-method.md b/docs/core/unmanaged-api/hosting/ivalidator-validate-method.md index f98a917cdb9c9..178c776391b21 100644 --- a/docs/core/unmanaged-api/hosting/ivalidator-validate-method.md +++ b/docs/core/unmanaged-api/hosting/ivalidator-validate-method.md @@ -64,7 +64,7 @@ HRESULT Validate ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h diff --git a/docs/core/unmanaged-api/hosting/loadlibraryshim-function.md b/docs/core/unmanaged-api/hosting/loadlibraryshim-function.md index 726c07cb0547e..2d6f54d28d80f 100644 --- a/docs/core/unmanaged-api/hosting/loadlibraryshim-function.md +++ b/docs/core/unmanaged-api/hosting/loadlibraryshim-function.md @@ -66,7 +66,7 @@ HRESULT LoadLibraryShim ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/loadstringrc-function.md b/docs/core/unmanaged-api/hosting/loadstringrc-function.md index 8a2f7c38c0f70..a05dd1a191097 100644 --- a/docs/core/unmanaged-api/hosting/loadstringrc-function.md +++ b/docs/core/unmanaged-api/hosting/loadstringrc-function.md @@ -62,7 +62,7 @@ HRESULT LoadStringRC ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/loadstringrcex-function.md b/docs/core/unmanaged-api/hosting/loadstringrcex-function.md index 78669913b9b17..d6d3311239702 100644 --- a/docs/core/unmanaged-api/hosting/loadstringrcex-function.md +++ b/docs/core/unmanaged-api/hosting/loadstringrcex-function.md @@ -70,7 +70,7 @@ HRESULT LoadStringRCEx ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/lockclrversion-function.md b/docs/core/unmanaged-api/hosting/lockclrversion-function.md index 0fd9540d2c012..ee94de4452a7c 100644 --- a/docs/core/unmanaged-api/hosting/lockclrversion-function.md +++ b/docs/core/unmanaged-api/hosting/lockclrversion-function.md @@ -83,7 +83,7 @@ typedef HRESULT ( __stdcall *FLockClrVersionCallback ) (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md b/docs/core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md index be55c1f77615d..00f40a8ad13ce 100644 --- a/docs/core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md +++ b/docs/core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md @@ -51,7 +51,7 @@ typedef VOID (*LPOVERLAPPED_COMPLETION_ROUTINE) ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md b/docs/core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md index 24bda7a04f1be..d291c669e7fff 100644 --- a/docs/core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md +++ b/docs/core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md @@ -41,7 +41,7 @@ typedef DWORD (__stdcall *LPTHREAD_START_ROUTINE) ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/malloc-type-enumeration.md b/docs/core/unmanaged-api/hosting/malloc-type-enumeration.md index c73d9a728ba12..b817fb45cd64a 100644 --- a/docs/core/unmanaged-api/hosting/malloc-type-enumeration.md +++ b/docs/core/unmanaged-api/hosting/malloc-type-enumeration.md @@ -38,7 +38,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/mdainfo-structure.md b/docs/core/unmanaged-api/hosting/mdainfo-structure.md index 95a838e764892..db91abb7b6e9d 100644 --- a/docs/core/unmanaged-api/hosting/mdainfo-structure.md +++ b/docs/core/unmanaged-api/hosting/mdainfo-structure.md @@ -50,7 +50,7 @@ typedef struct _MDAInfo { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/metahost-config-flags-enumeration.md b/docs/core/unmanaged-api/hosting/metahost-config-flags-enumeration.md index b61054e6a4089..ab4544281d81c 100644 --- a/docs/core/unmanaged-api/hosting/metahost-config-flags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/metahost-config-flags-enumeration.md @@ -44,7 +44,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Metahost.h diff --git a/docs/core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md b/docs/core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md index e9aa7b658ec1b..0236b459919d1 100644 --- a/docs/core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md @@ -51,7 +51,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Metahost.h diff --git a/docs/core/unmanaged-api/hosting/modulebindinfo-structure.md b/docs/core/unmanaged-api/hosting/modulebindinfo-structure.md index 2c6cc88ada98b..61e065bd08662 100644 --- a/docs/core/unmanaged-api/hosting/modulebindinfo-structure.md +++ b/docs/core/unmanaged-api/hosting/modulebindinfo-structure.md @@ -44,7 +44,7 @@ typedef struct _ModuleBindInfo { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/rundll32shimw-function.md b/docs/core/unmanaged-api/hosting/rundll32shimw-function.md index fa08812e21e11..be56c0c43f5de 100644 --- a/docs/core/unmanaged-api/hosting/rundll32shimw-function.md +++ b/docs/core/unmanaged-api/hosting/rundll32shimw-function.md @@ -49,7 +49,7 @@ HRESULT RunDll32ShimW ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/runtime-info-flags-enumeration.md b/docs/core/unmanaged-api/hosting/runtime-info-flags-enumeration.md index 94c9d1d4ca99a..0ef060a76f645 100644 --- a/docs/core/unmanaged-api/hosting/runtime-info-flags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/runtime-info-flags-enumeration.md @@ -62,7 +62,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md b/docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md index 8f6354cd49fef..30324511aae7d 100644 --- a/docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md +++ b/docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md @@ -42,7 +42,7 @@ typedef struct _StackOverflowInfo { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/stackoverflowtype-enumeration.md b/docs/core/unmanaged-api/hosting/stackoverflowtype-enumeration.md index 8fe74531b6fe1..e28cfbfed7819 100644 --- a/docs/core/unmanaged-api/hosting/stackoverflowtype-enumeration.md +++ b/docs/core/unmanaged-api/hosting/stackoverflowtype-enumeration.md @@ -44,7 +44,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/startup-flags-enumeration.md b/docs/core/unmanaged-api/hosting/startup-flags-enumeration.md index 5356440fe38f3..c4a5a01757c93 100644 --- a/docs/core/unmanaged-api/hosting/startup-flags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/startup-flags-enumeration.md @@ -70,7 +70,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md b/docs/core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md index 190ef0cd5c6f7..4bb85c99cf7c6 100644 --- a/docs/core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md +++ b/docs/core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md @@ -82,7 +82,7 @@ HRESULT StrongNameGetPublicKey ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md b/docs/core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md index 7fdb82eccd975..b096586149f36 100644 --- a/docs/core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md +++ b/docs/core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md @@ -55,7 +55,7 @@ HRESULT StrongNameSignatureVerificationEx ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/typenamefactory-coclass.md b/docs/core/unmanaged-api/hosting/typenamefactory-coclass.md index 1b976283ece91..1592117ab5157 100644 --- a/docs/core/unmanaged-api/hosting/typenamefactory-coclass.md +++ b/docs/core/unmanaged-api/hosting/typenamefactory-coclass.md @@ -36,7 +36,7 @@ coclass TypeNameFactory { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/validatorflags-enumeration.md b/docs/core/unmanaged-api/hosting/validatorflags-enumeration.md index 581dc0f4e5841..5053a290b4e23 100644 --- a/docs/core/unmanaged-api/hosting/validatorflags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/validatorflags-enumeration.md @@ -44,7 +44,7 @@ enum ValidatorFlags { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h diff --git a/docs/core/unmanaged-api/hosting/wait-option-enumeration.md b/docs/core/unmanaged-api/hosting/wait-option-enumeration.md index ede3134dc0e3e..08a037e4733f5 100644 --- a/docs/core/unmanaged-api/hosting/wait-option-enumeration.md +++ b/docs/core/unmanaged-api/hosting/wait-option-enumeration.md @@ -44,7 +44,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/waitortimercallback-function-pointer.md b/docs/core/unmanaged-api/hosting/waitortimercallback-function-pointer.md index ecaa39c0b67e3..d81d52da0f759 100644 --- a/docs/core/unmanaged-api/hosting/waitortimercallback-function-pointer.md +++ b/docs/core/unmanaged-api/hosting/waitortimercallback-function-pointer.md @@ -45,7 +45,7 @@ typedef VOID (__stdcall *WAITORTIMERCALLBACK) ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/metadata/assemblyflags-enumeration.md b/docs/core/unmanaged-api/metadata/assemblyflags-enumeration.md index d953c2830f17d..e610545d28f7e 100644 --- a/docs/core/unmanaged-api/metadata/assemblyflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/assemblyflags-enumeration.md @@ -48,7 +48,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** MsCorEE.h diff --git a/docs/core/unmanaged-api/metadata/assemblymetadata-structure.md b/docs/core/unmanaged-api/metadata/assemblymetadata-structure.md index d43fe5a1edb28..fe8b2b86e264d 100644 --- a/docs/core/unmanaged-api/metadata/assemblymetadata-structure.md +++ b/docs/core/unmanaged-api/metadata/assemblymetadata-structure.md @@ -54,7 +54,7 @@ typedef struct { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/assemblyrefflags-enumeration.md b/docs/core/unmanaged-api/metadata/assemblyrefflags-enumeration.md index b8db60190c48e..c84078042e628 100644 --- a/docs/core/unmanaged-api/metadata/assemblyrefflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/assemblyrefflags-enumeration.md @@ -36,7 +36,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/ceesectionattr-enumeration.md b/docs/core/unmanaged-api/metadata/ceesectionattr-enumeration.md index 24f3cc390f8d2..c18a62b4f70d2 100644 --- a/docs/core/unmanaged-api/metadata/ceesectionattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/ceesectionattr-enumeration.md @@ -44,7 +44,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/ceesectionrelocextra-union.md b/docs/core/unmanaged-api/metadata/ceesectionrelocextra-union.md index 011623f89a53e..5e5a20aae7516 100644 --- a/docs/core/unmanaged-api/metadata/ceesectionrelocextra-union.md +++ b/docs/core/unmanaged-api/metadata/ceesectionrelocextra-union.md @@ -36,7 +36,7 @@ typedef union { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/ceesectionreloctype-enumeration.md b/docs/core/unmanaged-api/metadata/ceesectionreloctype-enumeration.md index 621d6a789ba1a..6c69951d79b5b 100644 --- a/docs/core/unmanaged-api/metadata/ceesectionreloctype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/ceesectionreloctype-enumeration.md @@ -66,7 +66,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/coiniticor-enumeration.md b/docs/core/unmanaged-api/metadata/coiniticor-enumeration.md index 6af2bf0a087e7..297264650b1d1 100644 --- a/docs/core/unmanaged-api/metadata/coiniticor-enumeration.md +++ b/docs/core/unmanaged-api/metadata/coiniticor-enumeration.md @@ -37,7 +37,7 @@ typedef enum tagCOINITCOR ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/coinitiee-enumeration.md b/docs/core/unmanaged-api/metadata/coinitiee-enumeration.md index 4a1b8b2b92dff..7696615903773 100644 --- a/docs/core/unmanaged-api/metadata/coinitiee-enumeration.md +++ b/docs/core/unmanaged-api/metadata/coinitiee-enumeration.md @@ -40,7 +40,7 @@ typedef enum tagCOINITEE { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/cor-field-offset-structure.md b/docs/core/unmanaged-api/metadata/cor-field-offset-structure.md index 54bcf1724e5f9..655625640e043 100644 --- a/docs/core/unmanaged-api/metadata/cor-field-offset-structure.md +++ b/docs/core/unmanaged-api/metadata/cor-field-offset-structure.md @@ -42,7 +42,7 @@ typedef struct COR_FIELD_OFFSET { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h, CorProf.idl diff --git a/docs/core/unmanaged-api/metadata/cor-native-link-structure.md b/docs/core/unmanaged-api/metadata/cor-native-link-structure.md index 46bcd987eac92..f5dbac89ca382 100644 --- a/docs/core/unmanaged-api/metadata/cor-native-link-structure.md +++ b/docs/core/unmanaged-api/metadata/cor-native-link-structure.md @@ -41,7 +41,7 @@ typedef struct ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/corargtype-enumeration.md b/docs/core/unmanaged-api/metadata/corargtype-enumeration.md index 5ed7e75e359f5..55ac92ea22b84 100644 --- a/docs/core/unmanaged-api/metadata/corargtype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corargtype-enumeration.md @@ -42,7 +42,7 @@ typedef enum CorArgType { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corassemblyflags-enumeration.md b/docs/core/unmanaged-api/metadata/corassemblyflags-enumeration.md index 0889c95a3c4ea..a08a647167fe9 100644 --- a/docs/core/unmanaged-api/metadata/corassemblyflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corassemblyflags-enumeration.md @@ -74,7 +74,7 @@ typedef enum CorAssemblyFlags { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corattributetargets-enumeration.md b/docs/core/unmanaged-api/metadata/corattributetargets-enumeration.md index ef9e9ea02013e..29bb82e914279 100644 --- a/docs/core/unmanaged-api/metadata/corattributetargets-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corattributetargets-enumeration.md @@ -83,7 +83,7 @@ typedef enum CorAttributeTargets ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corcallingconvention-enumeration.md b/docs/core/unmanaged-api/metadata/corcallingconvention-enumeration.md index 3265933398411..c28fe24ed5e1d 100644 --- a/docs/core/unmanaged-api/metadata/corcallingconvention-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corcallingconvention-enumeration.md @@ -64,7 +64,7 @@ typedef enum CorCallingConvention ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md b/docs/core/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md index b6c7c3f1de26f..0f5715e9ad178 100644 --- a/docs/core/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md @@ -94,7 +94,7 @@ typedef enum CorCheckDuplicatesFor { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cordeclsecurity-enumeration.md b/docs/core/unmanaged-api/metadata/cordeclsecurity-enumeration.md index 0f3b2cbdeea43..5ccb8cf059401 100644 --- a/docs/core/unmanaged-api/metadata/cordeclsecurity-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cordeclsecurity-enumeration.md @@ -78,7 +78,7 @@ typedef enum CorDeclSecurity { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corelementtype-enumeration.md b/docs/core/unmanaged-api/metadata/corelementtype-enumeration.md index 087b612523873..b5517f69e4a18 100644 --- a/docs/core/unmanaged-api/metadata/corelementtype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corelementtype-enumeration.md @@ -135,7 +135,7 @@ 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](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md b/docs/core/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md index b9543ee8e0585..4bea973ed0318 100644 --- a/docs/core/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md @@ -52,7 +52,7 @@ typedef enum CorErrorIfEmitOutOfOrder { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/coreventattr-enumeration.md b/docs/core/unmanaged-api/metadata/coreventattr-enumeration.md index 739c9b7fa33f9..a990dbb118e01 100644 --- a/docs/core/unmanaged-api/metadata/coreventattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/coreventattr-enumeration.md @@ -43,7 +43,7 @@ typedef enum CorEventAttr { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corfieldattr-enumeration.md b/docs/core/unmanaged-api/metadata/corfieldattr-enumeration.md index b8ecd21339fa1..cd299b489f4a9 100644 --- a/docs/core/unmanaged-api/metadata/corfieldattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corfieldattr-enumeration.md @@ -78,7 +78,7 @@ typedef enum CorFieldAttr { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corfileflags-enumeration.md b/docs/core/unmanaged-api/metadata/corfileflags-enumeration.md index a6832b85400af..7237e8f72c130 100644 --- a/docs/core/unmanaged-api/metadata/corfileflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corfileflags-enumeration.md @@ -40,7 +40,7 @@ typedef enum CorFileFlags { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corfilemapping-enumeration.md b/docs/core/unmanaged-api/metadata/corfilemapping-enumeration.md index a2678433bf4cd..8f327c3c9f51a 100644 --- a/docs/core/unmanaged-api/metadata/corfilemapping-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corfilemapping-enumeration.md @@ -40,7 +40,7 @@ typedef enum CorFileMapping { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corgenericparamattr-enumeration.md b/docs/core/unmanaged-api/metadata/corgenericparamattr-enumeration.md index ce5d234517a10..a2a96607c48d4 100644 --- a/docs/core/unmanaged-api/metadata/corgenericparamattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corgenericparamattr-enumeration.md @@ -55,7 +55,7 @@ typedef enum CorGenericParamAttr { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corimportoptions-enumeration.md b/docs/core/unmanaged-api/metadata/corimportoptions-enumeration.md index 8d4f41ce4b3f8..868d7a1c00d44 100644 --- a/docs/core/unmanaged-api/metadata/corimportoptions-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corimportoptions-enumeration.md @@ -54,7 +54,7 @@ typedef enum CorImportOptions { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corlinkeroptions-enumeration.md b/docs/core/unmanaged-api/metadata/corlinkeroptions-enumeration.md index 933a9857b2c9e..062af0563d5ef 100644 --- a/docs/core/unmanaged-api/metadata/corlinkeroptions-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corlinkeroptions-enumeration.md @@ -38,7 +38,7 @@ typedef enum CorLinkerOptions { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md b/docs/core/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md index 35a00d53ee0a2..9a78b443a4a0e 100644 --- a/docs/core/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md @@ -41,7 +41,7 @@ typedef enum CorLocalRefPreservation ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md b/docs/core/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md index a914b0a128616..4c321ebc4d0cd 100644 --- a/docs/core/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md @@ -42,7 +42,7 @@ typedef enum CorManifestResourceFlags { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cormethodattr-enumeration.md b/docs/core/unmanaged-api/metadata/cormethodattr-enumeration.md index 0979c18ec16bb..425140cb47406 100644 --- a/docs/core/unmanaged-api/metadata/cormethodattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cormethodattr-enumeration.md @@ -89,7 +89,7 @@ typedef enum CorMethodAttr { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cormethodimpl-enumeration.md b/docs/core/unmanaged-api/metadata/cormethodimpl-enumeration.md index f487cd450ac27..d4c7f106e9ecf 100644 --- a/docs/core/unmanaged-api/metadata/cormethodimpl-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cormethodimpl-enumeration.md @@ -71,7 +71,7 @@ typedef enum CorMethodImpl { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md b/docs/core/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md index 36034be47d383..287cca8ec1f12 100644 --- a/docs/core/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md @@ -48,7 +48,7 @@ typedef enum CorMethodSemanticsAttr { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cornativelinkflags-enumeration.md b/docs/core/unmanaged-api/metadata/cornativelinkflags-enumeration.md index 34dcdbb172643..81e2d2db03dc0 100644 --- a/docs/core/unmanaged-api/metadata/cornativelinkflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cornativelinkflags-enumeration.md @@ -43,7 +43,7 @@ typedef enum ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/cornativelinktype-enumeration.md b/docs/core/unmanaged-api/metadata/cornativelinktype-enumeration.md index 05f635fed26e9..eb6f096228ce6 100644 --- a/docs/core/unmanaged-api/metadata/cornativelinktype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cornativelinktype-enumeration.md @@ -47,7 +47,7 @@ typedef enum ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/cornativetype-enumeration.md b/docs/core/unmanaged-api/metadata/cornativetype-enumeration.md index 0d7bdbe719a47..f2469d3f9f3ba 100644 --- a/docs/core/unmanaged-api/metadata/cornativetype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cornativetype-enumeration.md @@ -135,7 +135,7 @@ typedef enum CorNativeType { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md b/docs/core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md index 9608402958d92..e4aa25e627487 100644 --- a/docs/core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md @@ -89,7 +89,7 @@ typedef enum CorNotificationForTokenMovement { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/coropenflags-enumeration.md b/docs/core/unmanaged-api/metadata/coropenflags-enumeration.md index 03457c9b0ceee..5019e37509cff 100644 --- a/docs/core/unmanaged-api/metadata/coropenflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/coropenflags-enumeration.md @@ -62,7 +62,7 @@ typedef enum CorOpenFlags ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corparamattr-enumeration.md b/docs/core/unmanaged-api/metadata/corparamattr-enumeration.md index 49f835e74ddef..3ba6f4d99fa18 100644 --- a/docs/core/unmanaged-api/metadata/corparamattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corparamattr-enumeration.md @@ -52,7 +52,7 @@ typedef enum CorParamAttr { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corpekind-enumeration.md b/docs/core/unmanaged-api/metadata/corpekind-enumeration.md index 4a2bfb1267208..f8778ffc899f0 100644 --- a/docs/core/unmanaged-api/metadata/corpekind-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corpekind-enumeration.md @@ -52,7 +52,7 @@ typedef enum CorPEKind { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corpinvokemap-enumeration.md b/docs/core/unmanaged-api/metadata/corpinvokemap-enumeration.md index 8ec4fa5780ab5..0fb47543682bd 100644 --- a/docs/core/unmanaged-api/metadata/corpinvokemap-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corpinvokemap-enumeration.md @@ -86,7 +86,7 @@ typedef enum CorPinvokeMap { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corpropertyattr-enumeration.md b/docs/core/unmanaged-api/metadata/corpropertyattr-enumeration.md index 437b161b09f2a..7705b85c567b1 100644 --- a/docs/core/unmanaged-api/metadata/corpropertyattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corpropertyattr-enumeration.md @@ -46,7 +46,7 @@ typedef enum CorPropertyAttr { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/correftodefcheck-enumeration.md b/docs/core/unmanaged-api/metadata/correftodefcheck-enumeration.md index e4006eda67309..037f47a956f44 100644 --- a/docs/core/unmanaged-api/metadata/correftodefcheck-enumeration.md +++ b/docs/core/unmanaged-api/metadata/correftodefcheck-enumeration.md @@ -44,7 +44,7 @@ typedef enum CorRefToDefCheck { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corregflags-enumeration.md b/docs/core/unmanaged-api/metadata/corregflags-enumeration.md index 4a37c7c0cbf47..6e60e944c5965 100644 --- a/docs/core/unmanaged-api/metadata/corregflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corregflags-enumeration.md @@ -41,7 +41,7 @@ typedef enum ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/corsavesize-enumeration.md b/docs/core/unmanaged-api/metadata/corsavesize-enumeration.md index fdd8f6aaa4dc7..45be98740d5f9 100644 --- a/docs/core/unmanaged-api/metadata/corsavesize-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corsavesize-enumeration.md @@ -40,7 +40,7 @@ typedef enum CorSaveSize { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corserializationtype-enumeration.md b/docs/core/unmanaged-api/metadata/corserializationtype-enumeration.md index 5f0b510eecfa5..a68f6184efbad 100644 --- a/docs/core/unmanaged-api/metadata/corserializationtype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corserializationtype-enumeration.md @@ -76,7 +76,7 @@ typedef enum CorSerializationType { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corsetenc-enumeration.md b/docs/core/unmanaged-api/metadata/corsetenc-enumeration.md index 37f4c50083458..4acb3b0f77e2c 100644 --- a/docs/core/unmanaged-api/metadata/corsetenc-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corsetenc-enumeration.md @@ -53,7 +53,7 @@ typedef enum CorSetENC { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md b/docs/core/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md index 162b6fae57c27..5eeda81711477 100644 --- a/docs/core/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md @@ -41,7 +41,7 @@ typedef enum CorThreadSafetyOptions { ## Requirements -**Platforms:** See [System Requirements](../../get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cortokentype-enumeration.md b/docs/core/unmanaged-api/metadata/cortokentype-enumeration.md index bbfb6d5bd0da9..db83e591a9e19 100644 --- a/docs/core/unmanaged-api/metadata/cortokentype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cortokentype-enumeration.md @@ -92,7 +92,7 @@ typedef enum CorTokenType { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cortypeattr-enumeration.md b/docs/core/unmanaged-api/metadata/cortypeattr-enumeration.md index 3a5f54f6a7f3f..a6ef47f5a675b 100644 --- a/docs/core/unmanaged-api/metadata/cortypeattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cortypeattr-enumeration.md @@ -109,7 +109,7 @@ typedef enum CorTypeAttr { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md b/docs/core/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md index 9b2eb6013d0df..4ddb686f6762b 100644 --- a/docs/core/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md @@ -57,7 +57,7 @@ typedef enum CorUnmanagedCallingConvention { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md b/docs/core/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md index 05daa1dd0a3eb..7dd4bd4d6354f 100644 --- a/docs/core/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md @@ -49,7 +49,7 @@ typedef enum ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/couninitiee-enumeration.md b/docs/core/unmanaged-api/metadata/couninitiee-enumeration.md index 95bae9b6812c2..9b52e959c13da 100644 --- a/docs/core/unmanaged-api/metadata/couninitiee-enumeration.md +++ b/docs/core/unmanaged-api/metadata/couninitiee-enumeration.md @@ -39,7 +39,7 @@ typedef enum tagCOUNINITEE ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/cvstruct-structure.md b/docs/core/unmanaged-api/metadata/cvstruct-structure.md index 16c04fa3f013c..c263e194edc18 100644 --- a/docs/core/unmanaged-api/metadata/cvstruct-structure.md +++ b/docs/core/unmanaged-api/metadata/cvstruct-structure.md @@ -42,7 +42,7 @@ typedef struct { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-addsectionreloc-method.md b/docs/core/unmanaged-api/metadata/iceegen-addsectionreloc-method.md index 95ed816a79473..0bc63f0b57573 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-addsectionreloc-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-addsectionreloc-method.md @@ -50,7 +50,7 @@ HRESULT AddSectionReloc ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md b/docs/core/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md index d145dcd0c7469..8b57f0a6ef786 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md @@ -46,7 +46,7 @@ HRESULT AllocateMethodBuffer ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-computepointer-method.md b/docs/core/unmanaged-api/metadata/iceegen-computepointer-method.md index cdd84f9b56401..e887b91c98292 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-computepointer-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-computepointer-method.md @@ -46,7 +46,7 @@ HRESULT ComputePointer ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-emitstring-method.md b/docs/core/unmanaged-api/metadata/iceegen-emitstring-method.md index ce6cded8f66cb..e696361187582 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-emitstring-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-emitstring-method.md @@ -42,7 +42,7 @@ HRESULT EmitString ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-generateceefile-method.md b/docs/core/unmanaged-api/metadata/iceegen-generateceefile-method.md index 9741153fe9718..24ec25055d303 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-generateceefile-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-generateceefile-method.md @@ -35,7 +35,7 @@ HRESULT GenerateCeeFile (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md b/docs/core/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md index cd14bdc9cb0ed..06b31d294479d 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md @@ -38,7 +38,7 @@ HRESULT GenerateCeeMemoryImage ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getilsection-method.md b/docs/core/unmanaged-api/metadata/iceegen-getilsection-method.md index 0b92b49acbd5c..17d8dd5fb93df 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getilsection-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getilsection-method.md @@ -38,7 +38,7 @@ HRESULT GetIlSection ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md b/docs/core/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md index 7ec1193599ea5..696d02bbf4846 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md @@ -38,7 +38,7 @@ HRESULT GetIMapTokenIface ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md b/docs/core/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md index 9cfdc734eac4c..fbf742b8341e0 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md @@ -42,7 +42,7 @@ HRESULT GetMethodBuffer ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getsectionblock-method.md b/docs/core/unmanaged-api/metadata/iceegen-getsectionblock-method.md index 0107e4834bdfa..56f52fdc93ae8 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getsectionblock-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getsectionblock-method.md @@ -54,7 +54,7 @@ HRESULT GetSectionBlock ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getsectioncreate-method.md b/docs/core/unmanaged-api/metadata/iceegen-getsectioncreate-method.md index 79a9961ce3ea6..4cd45328febdb 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getsectioncreate-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getsectioncreate-method.md @@ -50,7 +50,7 @@ HRESULT GetSectionCreate ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md b/docs/core/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md index 8b60d59982a3b..7ee3f28cc9321 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md @@ -46,7 +46,7 @@ HRESULT GetSectionDataLen ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getstring-method.md b/docs/core/unmanaged-api/metadata/iceegen-getstring-method.md index 2640d223f57b2..52e47d316f306 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getstring-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getstring-method.md @@ -42,7 +42,7 @@ HRESULT GetString ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getstringsection-method.md b/docs/core/unmanaged-api/metadata/iceegen-getstringsection-method.md index 31c9493791cf4..a470723b34a7b 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getstringsection-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getstringsection-method.md @@ -38,7 +38,7 @@ HRESULT GetStringSection ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-interface.md b/docs/core/unmanaged-api/metadata/iceegen-interface.md index 9a57aea738a0f..552b984a17f88 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-interface.md +++ b/docs/core/unmanaged-api/metadata/iceegen-interface.md @@ -44,7 +44,7 @@ Provides methods for dynamic code compilation. ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-truncatesection-method.md b/docs/core/unmanaged-api/metadata/iceegen-truncatesection-method.md index b78fb227397c6..e793625803cda 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-truncatesection-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-truncatesection-method.md @@ -46,7 +46,7 @@ HRESULT TruncateSection ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/ihostfilter-interface.md b/docs/core/unmanaged-api/metadata/ihostfilter-interface.md index b558cd9f51d19..e14a1d33f6719 100644 --- a/docs/core/unmanaged-api/metadata/ihostfilter-interface.md +++ b/docs/core/unmanaged-api/metadata/ihostfilter-interface.md @@ -31,7 +31,7 @@ Provides a method to indicate that a specified token will be processed. ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/ihostfilter-marktoken-method.md b/docs/core/unmanaged-api/metadata/ihostfilter-marktoken-method.md index a4b5935aa33a4..e741296f4a0d9 100644 --- a/docs/core/unmanaged-api/metadata/ihostfilter-marktoken-method.md +++ b/docs/core/unmanaged-api/metadata/ihostfilter-marktoken-method.md @@ -40,7 +40,7 @@ HRESULT MarkToken ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imaptoken-interface.md b/docs/core/unmanaged-api/metadata/imaptoken-interface.md index d2abd681d9655..3f9d2ffdc95dc 100644 --- a/docs/core/unmanaged-api/metadata/imaptoken-interface.md +++ b/docs/core/unmanaged-api/metadata/imaptoken-interface.md @@ -31,7 +31,7 @@ Provides mapping capabilities between assemblies. ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imaptoken-map-method.md b/docs/core/unmanaged-api/metadata/imaptoken-map-method.md index ff2ade05443d0..6c03ae876721c 100644 --- a/docs/core/unmanaged-api/metadata/imaptoken-map-method.md +++ b/docs/core/unmanaged-api/metadata/imaptoken-map-method.md @@ -44,7 +44,7 @@ HRESULT Map ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md index 9900e2721522a..c15446dea1421 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md @@ -64,7 +64,7 @@ HRESULT DefineAssembly ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md index e1eefebe40c34..19836aea1bc40 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md @@ -70,7 +70,7 @@ HRESULT DefineAssemblyRef ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md index f46a48cc58f66..fd96eafde31fb 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md @@ -64,7 +64,7 @@ HRESULT DefineExportedType ( ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md index f2f52e7028b5b..a435180c77cd1 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md @@ -56,7 +56,7 @@ HRESULT DefineFile ( ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md index b0473310d809c..34e34d1ebc685 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md @@ -56,7 +56,7 @@ HRESULT DefineManifestResource ( ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-interface.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-interface.md index 506031f5eba66..cba5ef54f5b72 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-interface.md @@ -39,7 +39,7 @@ Provides methods that support the self-description model used by the common lang ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md index 51690ba20c352..4f7239bbe350d 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md @@ -64,7 +64,7 @@ HRESULT SetAssemblyProps ( ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md index ec2cbb7606ceb..b4dec8f495c69 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md @@ -68,7 +68,7 @@ HRESULT SetAssemblyRefProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md index b045cc5a8454c..700ede929377e 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md @@ -52,7 +52,7 @@ HRESULT SetExportedTypeProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md index f41162aa2258b..963600747677b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md @@ -52,7 +52,7 @@ HRESULT SetFileProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md index f8bd9278b43a9..ca09c5d6b4116 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md @@ -52,7 +52,7 @@ HRESULT SetManifestResourceProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md index 4a523c523f6b2..88eb47dd3355c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md @@ -36,7 +36,7 @@ void CloseEnum ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md index 5cefac1302e16..25585b58c829f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md @@ -55,7 +55,7 @@ HRESULT EnumAssemblyRefs ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md index c1cc80110ceff..b7b3f72c5a7de 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md @@ -55,7 +55,7 @@ HRESULT EnumExportedTypes ( ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md index 022b63045709f..ef3462201d5c6 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md @@ -55,7 +55,7 @@ HRESULT EnumFiles ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md index 65dc2f77f2e77..1798b34fa6a80 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md @@ -55,7 +55,7 @@ HRESULT EnumManifestResources ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md index a3d814c0002c9..c2b49f0f16cc9 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md @@ -73,7 +73,7 @@ HRESULT FindAssembliesByName ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md index 78bd2b297d1fe..67443fdee7d29 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md @@ -48,7 +48,7 @@ HRESULT FindExportedTypeByName ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md index c8670c0dd0a1d..926573f4ef450 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md @@ -44,7 +44,7 @@ HRESULT FindManifestResourceByName ( ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md index d96dfb3d7d321..3060ce9b082eb 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md @@ -36,7 +36,7 @@ HRESULT GetAssemblyFromScope ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md index 6da1e034be8a9..47b0ed7963a3e 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md @@ -68,7 +68,7 @@ HRESULT GetAssemblyProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md index c254dec06a18e..0c95c6ab6023d 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md @@ -76,7 +76,7 @@ HRESULT GetAssemblyRefProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md index 98be4f4c1cba8..e6c8dc3e6753d 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md @@ -60,7 +60,7 @@ HRESULT GetExportedTypeProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md index 134c85235090d..fddd2bf8e3c53 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md @@ -60,7 +60,7 @@ HRESULT GetFileProps ( ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md index b533d4bd3f578..16f4b7219380a 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md @@ -60,7 +60,7 @@ HRESULT GetManifestResourceProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-interface.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-interface.md index 409fcc9df9841..a6db57f4bd37c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-interface.md @@ -41,7 +41,7 @@ Provides methods to access and examine the contents of an assembly manifest. ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md b/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md index 45b8ed119d6db..e58ad2a00ed1a 100644 --- a/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md @@ -40,7 +40,7 @@ HRESULT GetMetaDataFromTypeInfo ( ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md b/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md index 858bae449c47b..505647a5198d1 100644 --- a/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md @@ -40,7 +40,7 @@ HRESULT GetMetaDataFromTypeLib ( ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md b/docs/core/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md index 53d7c77291763..dd30d380f8e8c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md @@ -44,7 +44,7 @@ HRESULT GetTypeLibFromMetaData ( ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataconverter-interface.md b/docs/core/unmanaged-api/metadata/imetadataconverter-interface.md index e44e632210c3a..9b164948a321e 100644 --- a/docs/core/unmanaged-api/metadata/imetadataconverter-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataconverter-interface.md @@ -30,7 +30,7 @@ Provides methods to map type libraries to their metadata signatures, and to conv ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenser-definescope-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenser-definescope-method.md index fb82edb0811d1..e87328472931e 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenser-definescope-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenser-definescope-method.md @@ -56,7 +56,7 @@ HRESULT DefineScope ( ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenser-interface.md b/docs/core/unmanaged-api/metadata/imetadatadispenser-interface.md index 2a1fd2ec0825d..900adf5d2e116 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenser-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenser-interface.md @@ -30,7 +30,7 @@ Provides methods to create a new metadata scope, or open an existing one. ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenser-openscope-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenser-openscope-method.md index f4152cb5a40a0..8836edc7731f4 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenser-openscope-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenser-openscope-method.md @@ -60,7 +60,7 @@ HRESULT OpenScope ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md index 49f287ba57d6d..83995db04a5da 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md @@ -62,7 +62,7 @@ HRESULT OpenScopeOnMemory ( ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md index e9fb8dea7f6d0..a98889fd8cef5 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md @@ -60,7 +60,7 @@ HRESULT FindAssembly( ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md index c51b6f432d2ca..75d385a75e4d0 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md @@ -64,7 +64,7 @@ HRESULT FindAssemblyModule( ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md index 798401d3db367..277816be1d9dd 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md @@ -44,7 +44,7 @@ HRESULT GetCORSystemDirectory ( ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md index d4f04afcbb255..a40118b7083da 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md @@ -58,7 +58,7 @@ HRESULT GetOption ( ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-interface.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-interface.md index 323fed76c0c3e..5a34b08b1177f 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-interface.md @@ -33,7 +33,7 @@ Extends the [IMetaDataDispenser Interface](imetadatadispenser-interface.md) inte ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md index b5136503e5b45..1509e70459ebb 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md @@ -48,7 +48,7 @@ HRESULT OpenScopeOnITypeInfo ( ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md index c282d48d6933d..dca6904c32364 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md @@ -60,7 +60,7 @@ HRESULT SetOption ( ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md index 595db479ea62f..69f7495323caa 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md @@ -38,7 +38,7 @@ HRESULT ApplyEditAndContinue ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md index c678afc2855cc..7a7bf69631205 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md @@ -52,7 +52,7 @@ HRESULT DefineCustomAttribute ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-defineevent-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineevent-method.md index 69073ec070572..cc0ac56416e44 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-defineevent-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineevent-method.md @@ -68,7 +68,7 @@ HRESULT DefineEvent ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definefield-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definefield-method.md index 5420b6c68e907..126af85376038 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definefield-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definefield-method.md @@ -68,7 +68,7 @@ HRESULT DefineField ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md index 8b2650a398d3e..132ebabfaab6d 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md @@ -76,7 +76,7 @@ HRESULT DefineImportMember ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md index 7b29f65a41d2f..086497234026a 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md @@ -64,7 +64,7 @@ HRESULT DefineImportType ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definememberref-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definememberref-method.md index a0eb48064cba7..9299645b039be 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definememberref-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definememberref-method.md @@ -52,7 +52,7 @@ HRESULT DefineMemberRef ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definemethod-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definemethod-method.md index ccaa8aadd1bee..525215bc24a17 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definemethod-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definemethod-method.md @@ -105,7 +105,7 @@ HRESULT DefineMethod ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md index 414ac9f8363c5..30e700f47e640 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md @@ -44,7 +44,7 @@ HRESULT DefineMethodImpl ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md index 5a623a76311a9..af57abd855a69 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md @@ -40,7 +40,7 @@ HRESULT DefineModuleRef ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md index 950927d266bb3..690b85ec5f993 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md @@ -56,7 +56,7 @@ HRESULT DefineNestedType ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-defineparam-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineparam-method.md index 67f497753807c..5838d6726c249 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-defineparam-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineparam-method.md @@ -68,7 +68,7 @@ HRESULT DefineParam ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md index 11f332bcc7f50..6ddd9eb900bb2 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md @@ -52,7 +52,7 @@ HRESULT DefinePermissionSet ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md index 78cbfaa9db1a1..a669561d911c2 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md @@ -48,7 +48,7 @@ HRESULT DefinePinvokeMap ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-defineproperty-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineproperty-method.md index a02008be7ebb3..ed30313161715 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-defineproperty-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineproperty-method.md @@ -80,7 +80,7 @@ HRESULT DefineProperty ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md index 5166df9c1dafb..24bfc5db797fe 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md @@ -48,7 +48,7 @@ HRESULT DefineSecurityAttributeSet ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definetypedef-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definetypedef-method.md index 98aec3ab9867b..7df6dfa580248 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definetypedef-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definetypedef-method.md @@ -60,7 +60,7 @@ HRESULT DefineTypeDef ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md index 6f0a678ca7582..c84e68878be9b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md @@ -54,7 +54,7 @@ HRESULT DefineTypeRefByName ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md index 18e7ff53f07fd..503ff00e45ca2 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md @@ -44,7 +44,7 @@ HRESULT DefineUserString ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md index b1e5f444249c8..dc80098f4dac3 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md @@ -36,7 +36,7 @@ HRESULT DeleteClassLayout ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md index 4fb511e628d50..c20f947454fee 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md @@ -36,7 +36,7 @@ HRESULT DeleteFieldMarshal ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md index 5b0fef36d3fdd..30e70764f4048 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md @@ -36,7 +36,7 @@ HRESULT DeletePinvokeMap ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-deletetoken-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-deletetoken-method.md index 2852b032bdb5d..611c58bd4b020 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-deletetoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-deletetoken-method.md @@ -36,7 +36,7 @@ HRESULT DeleteToken ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-getsavesize-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-getsavesize-method.md index a6471bd3877ee..0d5aba26b17e8 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-getsavesize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-getsavesize-method.md @@ -54,7 +54,7 @@ HRESULT GetSaveSize ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md index 123bf707991fd..fdbc8470493ab 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md @@ -44,7 +44,7 @@ HRESULT GetTokenFromSig ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md index 6998a139cfe23..79928c8388745 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md @@ -44,7 +44,7 @@ HRESULT GetTokenFromTypeSpec ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-interface.md b/docs/core/unmanaged-api/metadata/imetadataemit-interface.md index 1af10de0ad2ac..cd55043b4d841 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-interface.md @@ -76,7 +76,7 @@ Provides methods to create, modify, and save metadata about the assembly in the ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-merge-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-merge-method.md index 54ac2beb11454..56ca75a0e4e11 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-merge-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-merge-method.md @@ -48,7 +48,7 @@ HRESULT Merge ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-mergeend-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-mergeend-method.md index 9f4bcd31b5dbf..a93f6f60d60e6 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-mergeend-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-mergeend-method.md @@ -59,7 +59,7 @@ The following special conditions apply to the merge: ## Requirements -**Platforms:** See [System Requirements](../../get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-save-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-save-method.md index 59ca6c58b08c1..b79329ff35c20 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-save-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-save-method.md @@ -40,7 +40,7 @@ HRESULT Save ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-savetomemory-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-savetomemory-method.md index dcbeee27cf930..d9f2f83fb045a 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-savetomemory-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-savetomemory-method.md @@ -40,7 +40,7 @@ HRESULT SaveToMemory ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-savetostream-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-savetostream-method.md index d85c5bf3b0469..efa7557ab0b98 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-savetostream-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-savetostream-method.md @@ -40,7 +40,7 @@ HRESULT SaveToStream ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md index 14fecc45baeea..324c40a6233ff 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md @@ -58,7 +58,7 @@ HRESULT SetClassLayout ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md index cd4bea2797d25..3aeea94ff0478 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md @@ -44,7 +44,7 @@ HRESULT SetCustomAttributeValue ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-seteventprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-seteventprops-method.md index b9ea937ff0d28..e8f6b730d8982 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-seteventprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-seteventprops-method.md @@ -60,7 +60,7 @@ HRESULT SetEventProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md index 2a65b79c400f1..069e8b266b300 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md @@ -44,7 +44,7 @@ HRESULT SetFieldMarshal ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md index 118f4ebfbcc50..5ab39ecca6424 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md @@ -52,7 +52,7 @@ HRESULT SetFieldProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md index 1a0efb5be1247..0c1c3a5dbb06e 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md @@ -40,7 +40,7 @@ HRESULT SetFieldRVA ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-sethandler-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-sethandler-method.md index b8f8bc357b47b..90d59b0cf1854 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-sethandler-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-sethandler-method.md @@ -42,7 +42,7 @@ HRESULT SetHandler ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md index 64e2bb1b7d091..9c6766e4aeffd 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md @@ -40,7 +40,7 @@ HRESULT SetMethodImplFlags ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md index c4e025e282a70..cf0096160a2b2 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md @@ -48,7 +48,7 @@ HRESULT SetMethodProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md index 6bee43cc3fecf..3cb4f6314f324 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md @@ -36,7 +36,7 @@ HRESULT SetModuleProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setparamprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setparamprops-method.md index 2c36fc862c252..fd357bdc54ae3 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setparamprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setparamprops-method.md @@ -56,7 +56,7 @@ HRESULT SetParamProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setparent-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setparent-method.md index 3f42da6f91465..9eecf639b85c9 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setparent-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setparent-method.md @@ -40,7 +40,7 @@ HRESULT SetParent ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md index 5e61399647dbc..4c3a4b2f8b323 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md @@ -52,7 +52,7 @@ HRESULT SetPermissionSetProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md index 7720ca3fa1935..7bcfc3a7d3f0b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md @@ -48,7 +48,7 @@ HRESULT SetPinvokeMap ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md index 286daea793894..1fc88c11eb3b4 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md @@ -64,7 +64,7 @@ HRESULT SetPropertyProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setrva-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setrva-method.md index 5d95d5202f24f..407563d564bc1 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setrva-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setrva-method.md @@ -40,7 +40,7 @@ HRESULT SetRVA ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md index 631792b3a3492..b1bc512c4f228 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md @@ -48,7 +48,7 @@ HRESULT SetTypeDefProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md index 17db5839d96f1..f2437759032e4 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md @@ -76,7 +76,7 @@ HRESULT TranslateSigWithScope ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md index 28dfc9222b810..6d61aaf089537 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md @@ -60,7 +60,7 @@ HRESULT DefineGenericParam ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md index 603016916eb09..3b9dfd507ea6b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md @@ -48,7 +48,7 @@ HRESULT DefineMethodSpec ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md index f1505f1fa17dd..3abb45b522be3 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md @@ -40,7 +40,7 @@ HRESULT GetDeltaSaveSize ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-interface.md b/docs/core/unmanaged-api/metadata/imetadataemit2-interface.md index f377fae062db8..24d470290041a 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-interface.md @@ -35,7 +35,7 @@ Extends the [IMetaDataEmit](imetadataemit-interface.md) interface primarily to p ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md index ae25f6899956a..1247772fddb3c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md @@ -33,7 +33,7 @@ HRESULT ResetENCLog (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-savedelta-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-savedelta-method.md index fb24a998e3213..cc840042aacf5 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-savedelta-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-savedelta-method.md @@ -40,7 +40,7 @@ HRESULT SaveDelta ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md index 5f40a7c94528d..652a97c9307a9 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md @@ -40,7 +40,7 @@ HRESULT SaveDeltaToMemory ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md index 66abc1d4a8b71..4263ccf50d954 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md @@ -40,7 +40,7 @@ HRESULT SaveDeltaToStream ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md index cdfa59eabd2cc..5cf169a622589 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md @@ -52,7 +52,7 @@ HRESULT SetGenericParamProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataerror-interface.md b/docs/core/unmanaged-api/metadata/imetadataerror-interface.md index f59e99b74b541..5d84b0271e6b1 100644 --- a/docs/core/unmanaged-api/metadata/imetadataerror-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataerror-interface.md @@ -31,7 +31,7 @@ Provides a callback mechanism for reporting errors during the metadata merge. ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataerror-onerror-method.md b/docs/core/unmanaged-api/metadata/imetadataerror-onerror-method.md index f997b97ba5093..e205f71c0b251 100644 --- a/docs/core/unmanaged-api/metadata/imetadataerror-onerror-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataerror-onerror-method.md @@ -40,7 +40,7 @@ HRESULT OnError ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatafilter-interface.md b/docs/core/unmanaged-api/metadata/imetadatafilter-interface.md index 5d32449000750..4a47c77cc323d 100644 --- a/docs/core/unmanaged-api/metadata/imetadatafilter-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatafilter-interface.md @@ -30,7 +30,7 @@ Provides methods for marking and filtering metadata tokens to avoid repeating ac ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md b/docs/core/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md index 6b3660669a071..bd3a90c6c4e42 100644 --- a/docs/core/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md @@ -40,7 +40,7 @@ HRESULT IsTokenMarked ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatafilter-marktoken-method.md b/docs/core/unmanaged-api/metadata/imetadatafilter-marktoken-method.md index 42fa27eb4fd81..157d6271b94c4 100644 --- a/docs/core/unmanaged-api/metadata/imetadatafilter-marktoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatafilter-marktoken-method.md @@ -36,7 +36,7 @@ HRESULT MarkToken ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md b/docs/core/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md index 9e6c007a752cd..163d8444da8be 100644 --- a/docs/core/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md @@ -33,7 +33,7 @@ HRESULT UnmarkAll (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-closeenum-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-closeenum-method.md index fbc1b1ea8c7fb..157a11e888617 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-closeenum-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-closeenum-method.md @@ -40,7 +40,7 @@ void CloseEnum ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-countenum-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-countenum-method.md index dce9f7a021791..dd980d4af9e2a 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-countenum-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-countenum-method.md @@ -44,7 +44,7 @@ HRESULT CountEnum ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md index ad61449d61659..c38358a9b5179 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md @@ -63,7 +63,7 @@ HRESULT EnumCustomAttributes ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumevents-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumevents-method.md index a3b338e35bf1c..e211c7a832a0c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumevents-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumevents-method.md @@ -59,7 +59,7 @@ HRESULT EnumEvents ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumfields-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumfields-method.md index c217a2a83f35b..cd65cee7571b7 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumfields-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumfields-method.md @@ -59,7 +59,7 @@ HRESULT EnumFields ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md index f7f8162b58f29..5760b72f8e062 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md @@ -67,7 +67,7 @@ HRESULT EnumFieldsWithName ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md index 13462c2d232f9..760a4ef3276c8 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md @@ -63,7 +63,7 @@ The enumeration returns a collection of `mdInterfaceImpl` tokens for each interf ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md index fb27d94737e9b..0fd0d0539d755 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md @@ -59,7 +59,7 @@ HRESULT EnumMemberRefs ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummembers-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummembers-method.md index 5f83a98922163..6a483be6571c9 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummembers-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummembers-method.md @@ -65,7 +65,7 @@ HRESULT EnumMembers ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md index 571680083c57e..344da7be8a1de 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md @@ -67,7 +67,7 @@ HRESULT EnumMembersWithName ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md index 7713f0b0b4a1e..6dbbcfe54e9c6 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md @@ -63,7 +63,7 @@ HRESULT EnumMethodImpls ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummethods-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummethods-method.md index c438bdcdb5ee0..8e939bf6952bf 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummethods-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummethods-method.md @@ -59,7 +59,7 @@ HRESULT EnumMethods ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md index 05f81a4ab4cea..1c6f4b4579991 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md @@ -63,7 +63,7 @@ HRESULT EnumMethodSemantics ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md index 0ef59aa363c55..7df67af1b57f0 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md @@ -67,7 +67,7 @@ HRESULT EnumMethodsWithName ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md index 9662ecbeef21c..29f8f39c7cadc 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md @@ -55,7 +55,7 @@ HRESULT EnumModuleRefs ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumparams-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumparams-method.md index 86e59f1ddad50..8dddfdf37b0b7 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumparams-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumparams-method.md @@ -59,7 +59,7 @@ HRESULT EnumParams ( ## Requirements - **Platform:** See [System Requirements](../../get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md index 14b67b814ef17..358402d468ef5 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md @@ -63,7 +63,7 @@ HRESULT EnumPermissionSets ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumproperties-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumproperties-method.md index 54050e2ecfc21..761762ee1a55e 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumproperties-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumproperties-method.md @@ -59,7 +59,7 @@ HRESULT EnumProperties ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md index ccd9a8954896f..bda450b5e734e 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md @@ -59,7 +59,7 @@ HRESULT EnumSignatures ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md index e4367a035d7a1..16a9427db34cf 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md @@ -59,7 +59,7 @@ HRESULT EnumTypeDefs ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md index 92747572be996..80e9dfc2ebacf 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md @@ -59,7 +59,7 @@ HRESULT EnumTypeRefs ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md index 48016dfa633ac..8cb617541bd95 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md @@ -59,7 +59,7 @@ HRESULT EnumTypeSpecs ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md index 35fada596c235..3aa4a75218179 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md @@ -61,7 +61,7 @@ HRESULT EnumUnresolvedMethods ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md index 09e45d6121a21..8080c78091207 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md @@ -59,7 +59,7 @@ HRESULT EnumUserStrings ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-findfield-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findfield-method.md index d4c96ba30ca8e..1277cd89ba51a 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-findfield-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findfield-method.md @@ -60,7 +60,7 @@ HRESULT FindField ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-findmember-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findmember-method.md index fc39a269b14f0..123ce50b92a03 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-findmember-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findmember-method.md @@ -63,7 +63,7 @@ HRESULT FindMember ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-findmemberref-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findmemberref-method.md index ac77570bf732c..67800f289f363 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-findmemberref-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findmemberref-method.md @@ -60,7 +60,7 @@ HRESULT FindMemberRef ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-findmethod-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findmethod-method.md index 71ccc70e71cb1..1656776fac7dd 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-findmethod-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findmethod-method.md @@ -60,7 +60,7 @@ HRESULT FindMethod ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md index 6d43b11f36c9c..cc8717878dc1f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md @@ -44,7 +44,7 @@ HRESULT FindTypeDefByName ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-findtyperef-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findtyperef-method.md index d3c3cc1a4341d..958183515ef70 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-findtyperef-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findtyperef-method.md @@ -44,7 +44,7 @@ HRESULT FindTypeRef ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md index 07bcb580318fe..67fc22b7434af 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md @@ -56,7 +56,7 @@ HRESULT GetClassLayout ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md index 676a8d3abc17c..a8f0f7e73425c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md @@ -52,7 +52,7 @@ HRESULT GetCustomAttributeByName ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md index 84fec52724934..ac82a0b16008f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md @@ -56,7 +56,7 @@ HRESULT GetCustomAttributeProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-geteventprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-geteventprops-method.md index 7bfd0019f048d..26f428bbc90b3 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-geteventprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-geteventprops-method.md @@ -81,7 +81,7 @@ HRESULT GetEventProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md index 753375bf7dc76..d9cceefed061e 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md @@ -44,7 +44,7 @@ HRESULT GetFieldMarshal ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md index 51309a94e7315..288b1f85bf45c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md @@ -76,7 +76,7 @@ HRESULT GetFieldProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md index e89cd583dafb2..b2e830ad32f74 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md @@ -72,7 +72,7 @@ Recall, the token is a 4-byte value: ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md index 23c8feb18313e..3664df4996f13 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md @@ -84,7 +84,7 @@ HRESULT GetMemberProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md index dbc29d5ace13a..0b6ed271c4717 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md @@ -60,7 +60,7 @@ HRESULT GetMemberRefProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md index 97ef619fdd786..6abda83633d56 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md @@ -72,7 +72,7 @@ HRESULT GetMethodProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md index 0e4b80d0dce65..2f95010669a39 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md @@ -48,7 +48,7 @@ HRESULT GetMethodSemantics ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md index 62e6f5efd5204..3ed48c2e3700d 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md @@ -36,7 +36,7 @@ HRESULT GetModuleFromScope ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md index c1ea521e05ec5..40e5cdcc78251 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md @@ -48,7 +48,7 @@ HRESULT GetModuleRefProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md index 1e42ab7bacb52..134173d77b259 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md @@ -44,7 +44,7 @@ HRESULT GetNameFromToken ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md index 56d8df53dcf93..266419821f2f2 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md @@ -44,7 +44,7 @@ HRESULT GetNativeCallConvFromSig ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md index 9b05cd0e99d9d..785be045c3fa0 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md @@ -40,7 +40,7 @@ HRESULT GetNestedClassProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md index d54e67f474cf8..b2267ac9add51 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md @@ -44,7 +44,7 @@ HRESULT GetParamForMethodIndex ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getparamprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getparamprops-method.md index b7148d6115581..20e633748eaa1 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getparamprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getparamprops-method.md @@ -76,7 +76,7 @@ The sequence values in `pulSequence` begin with 1 for parameters. A return value ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md index 5bf7288d0973f..8859f51828b4b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md @@ -48,7 +48,7 @@ HRESULT GetPermissionSetProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md index 04a6031bc66b4..f6b31f7a40e45 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md @@ -56,7 +56,7 @@ HRESULT GetPinvokeMap ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md index 1193da5b0e247..fef39a7e66bf4 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md @@ -96,7 +96,7 @@ HRESULT GetPropertyProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getrva-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getrva-method.md index db9bf020af5ef..6ced13561231c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getrva-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getrva-method.md @@ -44,7 +44,7 @@ HRESULT GetRVA ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md index afd191319d72b..39371dd2869a2 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md @@ -52,7 +52,7 @@ HRESULT GetScopeProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md index 726d628e73de6..39927c67334cc 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md @@ -44,7 +44,7 @@ HRESULT GetSigFromToken ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md index 2de6258251bfb..7b56cd0116819 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md @@ -56,7 +56,7 @@ HRESULT GetTypeDefProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md index 3c1fbd8ccf22c..7f9aa738c660b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md @@ -52,7 +52,7 @@ HRESULT GetTypeRefProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md index 01753d12ee8bb..005f6a934848c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md @@ -48,7 +48,7 @@ HRESULT GetTypeSpecFromToken ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getuserstring-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getuserstring-method.md index 18e5f5c4aa46d..faae0e704c75f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getuserstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getuserstring-method.md @@ -48,7 +48,7 @@ HRESULT GetUserString ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-interface.md b/docs/core/unmanaged-api/metadata/imetadataimport-interface.md index 351dd7b30384f..02640b12515da 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-interface.md @@ -101,7 +101,7 @@ Provides methods for importing and manipulating existing metadata from a portabl ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-isglobal-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-isglobal-method.md index 2b5a351284b95..d08362bc45a90 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-isglobal-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-isglobal-method.md @@ -40,7 +40,7 @@ HRESULT IsGlobal ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md index e7a3975e57691..07e4e2dd5bdef 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md @@ -40,7 +40,7 @@ BOOL IsValidToken ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-resetenum-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-resetenum-method.md index 74eeba355725a..849b884ddeb26 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-resetenum-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-resetenum-method.md @@ -40,7 +40,7 @@ HRESULT ResetEnum ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md index 4c51aadfc1ea5..ed02a897bc8f1 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md @@ -57,7 +57,7 @@ HRESULT ResolveTypeRef ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md index 8c54500b54afe..ed7881b0a9dac 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md @@ -59,7 +59,7 @@ HRESULT EnumGenericParamConstraints ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md index c4c7b45e013d4..bbcf0e1d6bd50 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md @@ -59,7 +59,7 @@ HRESULT EnumGenericParams ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md index aa57c5357c58d..fb963105cbc27 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md @@ -59,7 +59,7 @@ HRESULT EnumMethodSpecs ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md index 7c0298f8865d8..b4b7aa967c603 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md @@ -44,7 +44,7 @@ HRESULT GetGenericParamConstraintProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md index 726e52b61fa85..3e6ec68b50f3c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md @@ -64,7 +64,7 @@ HRESULT GetGenericParamProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md index 5c37ab4e40286..d0dba3850bd3f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md @@ -48,7 +48,7 @@ HRESULT GetMethodSpecProps ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-getpekind-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getpekind-method.md index b039aac041e06..bbd74179d0432 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-getpekind-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-getpekind-method.md @@ -50,7 +50,7 @@ HRESULT GetPEKind ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md index dc4bd3f4597ca..0900c8cce3a61 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md @@ -48,7 +48,7 @@ HRESULT GetVersionString ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-interface.md b/docs/core/unmanaged-api/metadata/imetadataimport2-interface.md index e484c25379eb0..263344719f9d6 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-interface.md @@ -35,7 +35,7 @@ Extends the [IMetaDataImport](imetadataimport-interface.md) interface to provide ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md b/docs/core/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md index 811dde6dcce9c..4430d3cdaa38f 100644 --- a/docs/core/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md @@ -62,7 +62,7 @@ HRESULT GetFileMapping ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatainfo-interface.md b/docs/core/unmanaged-api/metadata/imetadatainfo-interface.md index dda640c08c1d3..60dfd79bd47de 100644 --- a/docs/core/unmanaged-api/metadata/imetadatainfo-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatainfo-interface.md @@ -28,7 +28,7 @@ Provides a method that gets information about the mapping of metadata from an on ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getblob-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getblob-method.md index 253bd6d051b66..c98a62159fa72 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getblob-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getblob-method.md @@ -44,7 +44,7 @@ HRESULT GetBlob ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md index 700b745c92280..5b4651d7a8dee 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md @@ -36,7 +36,7 @@ HRESULT GetBlobHeapSize ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md index 70a2439412d6d..bd932665b7b65 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md @@ -48,7 +48,7 @@ HRESULT GetCodedTokenInfo ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getcolumn-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getcolumn-method.md index ccfbf0936f4b6..0a633514bdbfe 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getcolumn-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getcolumn-method.md @@ -69,7 +69,7 @@ The interpretation of the value returned through `pVal` depends on the column's ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md index b1fd994d525fe..278b2ebfdc2e3 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md @@ -84,7 +84,7 @@ Values that are stored in the *heap* (that is, `IsHeapType == true`) can be read ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getguid-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getguid-method.md index fd8257bd15b4f..aeeeeb0f925cb 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getguid-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getguid-method.md @@ -44,7 +44,7 @@ HRESULT GetGuid ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md index bd676893c715f..ad43a5e2efce2 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md @@ -36,7 +36,7 @@ HRESULT GetGuidHeapSize ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getnextblob-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnextblob-method.md index 60dc3b43114b9..8aa51803fbc11 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getnextblob-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getnextblob-method.md @@ -40,7 +40,7 @@ HRESULT GetNextBlob ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getnextguid-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnextguid-method.md index 23a6a7b22f6cf..dd4748f9aa6f7 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getnextguid-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getnextguid-method.md @@ -44,7 +44,7 @@ HRESULT GetNextGuid ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getnextstring-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnextstring-method.md index 711423b1527e6..1f18950af1219 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getnextstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getnextstring-method.md @@ -40,7 +40,7 @@ HRESULT GetNextString ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md index 54d7859d9d127..f0f3377a5f8f4 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md @@ -44,7 +44,7 @@ HRESULT GetNextUserString ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getnumtables-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnumtables-method.md index 094fb83c404aa..0ccd91b1580a2 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getnumtables-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getnumtables-method.md @@ -36,7 +36,7 @@ HRESULT GetNumTables ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getrow-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getrow-method.md index eca5ba32f9fd0..066fa9da13489 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getrow-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getrow-method.md @@ -48,7 +48,7 @@ HRESULT GetRow ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getstring-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getstring-method.md index 25fe944184bb5..8d38819fb3b52 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getstring-method.md @@ -40,7 +40,7 @@ HRESULT GetString ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md index 1e30225c670e0..077ab4308aac4 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md @@ -36,7 +36,7 @@ HRESULT GetStringHeapSize ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-gettableindex-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-gettableindex-method.md index 351f239bcc087..11891d23970e8 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-gettableindex-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-gettableindex-method.md @@ -44,7 +44,7 @@ HRESULT GetTableIndex ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md index 1944f8fd39e8a..3af2f7bf6484b 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md @@ -56,7 +56,7 @@ HRESULT GetTableInfo ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getuserstring-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getuserstring-method.md index b02ab86034ac8..10fcc1f914ed5 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getuserstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getuserstring-method.md @@ -45,7 +45,7 @@ HRESULT GetUserString ( ## Requirements -**Platforms:** See [System Requirements](../../get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md index 848073e9342cc..44ce0b7985ebb 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md @@ -36,7 +36,7 @@ HRESULT GetUserStringHeapSize ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-interface.md b/docs/core/unmanaged-api/metadata/imetadatatables-interface.md index 692af61bf2309..81a9d80e9187d 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-interface.md @@ -46,7 +46,7 @@ Provides methods for the storage and retrieval of metadata information in tables ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md b/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md index 7a65454655611..4138462e81770 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md @@ -40,7 +40,7 @@ HRESULT GetMetaDataStorage ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md b/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md index 8cb94fcb69046..f853a67e564f4 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md @@ -48,7 +48,7 @@ HRESULT GetMetaDataStreamInfo ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables2-interface.md b/docs/core/unmanaged-api/metadata/imetadatatables2-interface.md index 1977ed9b2cd31..4b89215a07972 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables2-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables2-interface.md @@ -29,7 +29,7 @@ Extends [IMetaDataTables](imetadatatables-interface.md) to include methods for w ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatavalidate-interface.md b/docs/core/unmanaged-api/metadata/imetadatavalidate-interface.md index 4a26e67c91c64..569550c0412f1 100644 --- a/docs/core/unmanaged-api/metadata/imetadatavalidate-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatavalidate-interface.md @@ -29,7 +29,7 @@ Provides methods to validate metadata signatures. ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md b/docs/core/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md index e6ceac4a8dc69..fcea3651a120f 100644 --- a/docs/core/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md @@ -29,7 +29,7 @@ HRESULT ValidateMetaData (); ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md b/docs/core/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md index add825c292b33..e3e5b7ce7ff62 100644 --- a/docs/core/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md @@ -40,7 +40,7 @@ HRESULT ValidatorInit ( ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/osinfo-structure.md b/docs/core/unmanaged-api/metadata/osinfo-structure.md index 540240c8cfb90..141752d7a60c9 100644 --- a/docs/core/unmanaged-api/metadata/osinfo-structure.md +++ b/docs/core/unmanaged-api/metadata/osinfo-structure.md @@ -44,7 +44,7 @@ typedef struct { ## Requirements - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). **Header:** Cor.h From 98c008da01b894b8416e5f6e744bdf1785bc5c77 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 26 Jun 2025 11:55:04 +0000 Subject: [PATCH 06/20] Fix invalid link warnings in all 723 moved API documentation files Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com> --- docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md | 2 +- docs/core/unmanaged-api/hosting/bucketparameters-structure.md | 2 +- docs/core/unmanaged-api/hosting/callfunctionshim-function.md | 2 +- docs/core/unmanaged-api/hosting/clrcreateinstance-function.md | 2 +- .../unmanaged-api/hosting/clrcreatemanagedinstance-function.md | 2 +- docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md | 2 +- .../unmanaged-api/hosting/clsid-resolution-flags-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md | 2 +- docs/core/unmanaged-api/hosting/coinitializeee-function.md | 2 +- docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md | 2 +- .../core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md | 2 +- .../core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md | 2 +- .../hosting/cor-gc-thread-stats-types-enumeration.md | 2 +- .../unmanaged-api/hosting/corbindtocurrentruntime-function.md | 2 +- docs/core/unmanaged-api/hosting/corbindtoruntime-function.md | 2 +- .../unmanaged-api/hosting/corbindtoruntimebycfg-function.md | 2 +- docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md | 2 +- .../core/unmanaged-api/hosting/corbindtoruntimehost-function.md | 2 +- docs/core/unmanaged-api/hosting/cordllmain-function.md | 2 +- docs/core/unmanaged-api/hosting/corexemain-function.md | 2 +- docs/core/unmanaged-api/hosting/corexemain2-function.md | 2 +- docs/core/unmanaged-api/hosting/corexitprocess-function.md | 2 +- docs/core/unmanaged-api/hosting/corimageunloading-function.md | 2 +- .../core/unmanaged-api/hosting/corlaunchapplication-function.md | 2 +- .../unmanaged-api/hosting/cormarkthreadinthreadpool-function.md | 2 +- docs/core/unmanaged-api/hosting/corruntimehost-coclass.md | 2 +- docs/core/unmanaged-api/hosting/corvalidateimage-function.md | 2 +- .../hosting/createdebugginginterfacefromversion-function.md | 2 +- docs/core/unmanaged-api/hosting/createiceefilegen-function.md | 2 +- docs/core/unmanaged-api/hosting/customdumpitem-structure.md | 2 +- docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md | 2 +- docs/core/unmanaged-api/hosting/eapicategories-enumeration.md | 2 +- .../core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md | 2 +- .../hosting/eclrassemblyidentityflags-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/eclrevent-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/eclroperation-enumeration.md | 2 +- .../unmanaged-api/hosting/eclrunhandledexception-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/econtexttype-enumeration.md | 2 +- .../core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md | 2 +- .../unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md | 2 +- .../unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md | 2 +- .../hosting/ehostbindingpolicymodifyflags-enumeration.md | 2 +- .../hosting/einitializenewdomainflags-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md | 2 +- .../unmanaged-api/hosting/ememorycriticallevel-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md | 2 +- .../unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/etasktype-enumeration.md | 2 +- .../hosting/fexecuteinappdomaincallback-function-pointer.md | 2 +- .../hosting/flockclrversioncallback-function-pointer.md | 2 +- .../unmanaged-api/hosting/getclridentitymanager-function.md | 2 +- .../unmanaged-api/hosting/getcorrequiredversion-function.md | 2 +- .../unmanaged-api/hosting/getcorsystemdirectory-function.md | 2 +- docs/core/unmanaged-api/hosting/getcorversion-function.md | 2 +- docs/core/unmanaged-api/hosting/getfileversion-function.md | 2 +- docs/core/unmanaged-api/hosting/getrealprocaddress-function.md | 2 +- .../unmanaged-api/hosting/getrequestedruntimeinfo-function.md | 2 +- .../hosting/getrequestedruntimeversion-function.md | 2 +- .../hosting/getrequestedruntimeversionforclsid-function.md | 2 +- .../unmanaged-api/hosting/getversionfromprocess-function.md | 2 +- docs/core/unmanaged-api/hosting/host-type-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md | 2 +- .../unmanaged-api/hosting/iactiononclrevent-onevent-method.md | 2 +- .../hosting/iapartmentcallback-docallback-method.md | 2 +- docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md | 2 +- docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md | 2 +- .../hosting/iappdomainbinding-onappdomain-method.md | 2 +- docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md | 2 +- docs/core/unmanaged-api/hosting/iceefilegen-class.md | 2 +- .../iclrappdomainresourcemonitor-getcurrentallocated-method.md | 2 +- .../iclrappdomainresourcemonitor-getcurrentcputime-method.md | 2 +- .../iclrappdomainresourcemonitor-getcurrentsurvived-method.md | 2 +- .../hosting/iclrappdomainresourcemonitor-interface.md | 2 +- ...assemblyidentitymanager-getbindingidentityfromfile-method.md | 2 +- ...semblyidentitymanager-getbindingidentityfromstream-method.md | 2 +- ...ssemblyidentitymanager-getclrassemblyreferencelist-method.md | 2 +- ...yidentitymanager-getprobingassembliesfromreference-method.md | 2 +- ...blyidentitymanager-getreferencedassembliesfromfile-method.md | 2 +- ...yidentitymanager-getreferencedassembliesfromstream-method.md | 2 +- .../hosting/iclrassemblyidentitymanager-interface.md | 2 +- .../iclrassemblyidentitymanager-isstronglynamed-method.md | 2 +- .../hosting/iclrassemblyreferencelist-interface.md | 2 +- ...clrassemblyreferencelist-isassemblyreferenceinlist-method.md | 2 +- ...emblyreferencelist-isstringassemblyreferenceinlist-method.md | 2 +- .../unmanaged-api/hosting/iclrcontrol-getclrmanager-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrcontrol-interface.md | 2 +- .../hosting/iclrcontrol-setappdomainmanagertype-method.md | 2 +- .../hosting/iclrdebugmanager-beginconnection-method.md | 2 +- .../hosting/iclrdebugmanager-endconnection-method.md | 2 +- .../unmanaged-api/hosting/iclrdebugmanager-getdacl-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrdebugmanager-interface.md | 2 +- .../hosting/iclrdebugmanager-isdebuggerattached-method.md | 2 +- .../hosting/iclrdebugmanager-setconnectiontasks-method.md | 2 +- .../unmanaged-api/hosting/iclrdebugmanager-setdacl-method.md | 2 +- .../hosting/iclrdebugmanager-setsymbolreadingpolicy-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrdomainmanager-interface.md | 2 +- .../hosting/iclrdomainmanager-setappdomainmanagertype-method.md | 2 +- ...iclrdomainmanager-setpropertiesfordefaultappdomain-method.md | 2 +- .../hosting/iclrerrorreportingmanager-begincustomdump-method.md | 2 +- .../hosting/iclrerrorreportingmanager-endcustomdump-method.md | 2 +- ...tingmanager-getbucketparametersforcurrentexception-method.md | 2 +- .../hosting/iclrerrorreportingmanager-interface.md | 2 +- docs/core/unmanaged-api/hosting/iclrgcmanager-collect-method.md | 2 +- .../core/unmanaged-api/hosting/iclrgcmanager-getstats-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md | 2 +- .../hosting/iclrgcmanager-setgcstartuplimits-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md | 2 +- .../hosting/iclrgcmanager2-setgcstartuplimitsex-method.md | 2 +- .../iclrhostbindingpolicymanager-evaluatepolicy-method.md | 2 +- .../hosting/iclrhostbindingpolicymanager-interface.md | 2 +- ...lrhostbindingpolicymanager-modifyapplicationpolicy-method.md | 2 +- .../hosting/iclrhostprotectionmanager-interface.md | 2 +- ...lrhostprotectionmanager-seteagerserializegrantsets-method.md | 2 +- .../iclrhostprotectionmanager-setprotectedcategories-method.md | 2 +- .../unmanaged-api/hosting/iclriocompletionmanager-interface.md | 2 +- .../hosting/iclriocompletionmanager-oncomplete-method.md | 2 +- .../hosting/iclrmemorynotificationcallback-interface.md | 2 +- ...clrmemorynotificationcallback-onmemorynotification-method.md | 2 +- .../hosting/iclrmetahost-enumerateinstalledruntimes-method.md | 2 +- .../hosting/iclrmetahost-enumerateloadedruntimes-method.md | 2 +- .../unmanaged-api/hosting/iclrmetahost-exitprocess-method.md | 2 +- .../unmanaged-api/hosting/iclrmetahost-getruntime-method.md | 2 +- .../hosting/iclrmetahost-getversionfromfile-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrmetahost-interface.md | 2 +- .../hosting/iclrmetahost-querylegacyv2runtimebinding-method.md | 2 +- .../iclrmetahost-requestruntimeloadednotification-method.md | 2 +- .../hosting/iclrmetahostpolicy-getrequestedruntime-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md | 2 +- docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md | 2 +- .../hosting/iclroneventmanager-registeractiononevent-method.md | 2 +- .../iclroneventmanager-unregisteractiononevent-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md | 2 +- .../hosting/iclrpolicymanager-setactiononfailure-method.md | 2 +- .../hosting/iclrpolicymanager-setactionontimeout-method.md | 2 +- .../hosting/iclrpolicymanager-setdefaultaction-method.md | 2 +- .../hosting/iclrpolicymanager-settimeout-method.md | 2 +- .../hosting/iclrpolicymanager-settimeoutandaction-method.md | 2 +- .../iclrpolicymanager-setunhandledexceptionpolicy-method.md | 2 +- .../unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md | 2 +- .../unmanaged-api/hosting/iclrprobingassemblyenum-interface.md | 2 +- .../hosting/iclrreferenceassemblyenum-get-method.md | 2 +- .../hosting/iclrreferenceassemblyenum-interface.md | 2 +- .../hosting/iclrruntimehost-executeapplication-method.md | 2 +- .../hosting/iclrruntimehost-executeinappdomain-method.md | 2 +- .../hosting/iclrruntimehost-executeindefaultappdomain-method.md | 2 +- .../hosting/iclrruntimehost-getclrcontrol-method.md | 2 +- .../hosting/iclrruntimehost-getcurrentappdomainid-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md | 2 +- .../hosting/iclrruntimehost-sethostcontrol-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md | 2 +- .../hosting/iclrruntimehost-unloadappdomain-method.md | 2 +- .../hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md | 2 +- .../hosting/iclrruntimeinfo-getdefaultstartupflags-method.md | 2 +- .../hosting/iclrruntimeinfo-getinterface-method.md | 2 +- .../hosting/iclrruntimeinfo-getprocaddress-method.md | 2 +- .../hosting/iclrruntimeinfo-getruntimedirectory-method.md | 2 +- .../hosting/iclrruntimeinfo-getversionstring-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md | 2 +- .../unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md | 2 +- .../unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md | 2 +- .../unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md | 2 +- .../hosting/iclrruntimeinfo-loaderrorstring-method.md | 2 +- .../unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md | 2 +- .../hosting/iclrruntimeinfo-setdefaultstartupflags-method.md | 2 +- .../hosting/iclrstrongname-gethashfromassemblyfile-method.md | 2 +- .../hosting/iclrstrongname-gethashfromassemblyfilew-method.md | 2 +- .../hosting/iclrstrongname-gethashfromblob-method.md | 2 +- .../hosting/iclrstrongname-gethashfromfile-method.md | 2 +- .../hosting/iclrstrongname-gethashfromfilew-method.md | 2 +- .../hosting/iclrstrongname-gethashfromhandle-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrstrongname-interface.md | 2 +- .../iclrstrongname-strongnamecompareassemblies-method.md | 2 +- .../hosting/iclrstrongname-strongnamefreebuffer-method.md | 2 +- .../hosting/iclrstrongname-strongnamegetblob-method.md | 2 +- .../hosting/iclrstrongname-strongnamegetblobfromimage-method.md | 2 +- .../hosting/iclrstrongname-strongnamegetpublickey-method.md | 2 +- .../hosting/iclrstrongname-strongnamehashsize-method.md | 2 +- .../hosting/iclrstrongname-strongnamekeydelete-method.md | 2 +- .../hosting/iclrstrongname-strongnamekeygen-method.md | 2 +- .../hosting/iclrstrongname-strongnamekeygenex-method.md | 2 +- .../hosting/iclrstrongname-strongnamekeyinstall-method.md | 2 +- .../iclrstrongname-strongnamesignaturegeneration-method.md | 2 +- .../iclrstrongname-strongnamesignaturegenerationex-method.md | 2 +- .../hosting/iclrstrongname-strongnamesignaturesize-method.md | 2 +- .../iclrstrongname-strongnamesignatureverification-method.md | 2 +- .../iclrstrongname-strongnamesignatureverificationex-method.md | 2 +- ...trongname-strongnamesignatureverificationfromimage-method.md | 2 +- .../iclrstrongname-strongnametokenfromassembly-method.md | 2 +- .../iclrstrongname-strongnametokenfromassemblyex-method.md | 2 +- .../iclrstrongname-strongnametokenfrompublickey-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md | 2 +- .../hosting/iclrsyncmanager-createrwlockowneriterator-method.md | 2 +- .../hosting/iclrsyncmanager-deleterwlockowneriterator-method.md | 2 +- .../hosting/iclrsyncmanager-getmonitorowner-method.md | 2 +- .../hosting/iclrsyncmanager-getrwlockownernext-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-abort-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-interface.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md | 2 +- .../hosting/iclrtask-needspriorityscheduling-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-reset-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md | 2 +- .../unmanaged-api/hosting/iclrtask-settaskidentifier-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md | 2 +- .../hosting/iclrtask2-beginpreventasyncabort-method.md | 2 +- .../hosting/iclrtask2-endpreventasyncabort-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask2-interface.md | 2 +- .../unmanaged-api/hosting/iclrtaskmanager-createtask-method.md | 2 +- .../hosting/iclrtaskmanager-getcurrenttask-method.md | 2 +- .../hosting/iclrtaskmanager-getcurrenttasktype-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md | 2 +- .../unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md | 2 +- .../unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md | 2 +- .../hosting/iclrvalidator-formateventinfo-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrvalidator-interface.md | 2 +- .../core/unmanaged-api/hosting/iclrvalidator-validate-method.md | 2 +- .../icorconfiguration-adddebuggerspecialthread-method.md | 2 +- docs/core/unmanaged-api/hosting/icorconfiguration-interface.md | 2 +- .../icorconfiguration-setdebuggerthreadcontrol-method.md | 2 +- .../hosting/icorconfiguration-setgchostcontrol-method.md | 2 +- .../hosting/icorconfiguration-setgcthreadcontrol-method.md | 2 +- .../unmanaged-api/hosting/icorruntimehost-closeenum-method.md | 2 +- .../hosting/icorruntimehost-createdomain-method.md | 2 +- .../hosting/icorruntimehost-createdomainex-method.md | 2 +- .../hosting/icorruntimehost-createdomainsetup-method.md | 2 +- .../hosting/icorruntimehost-createevidence-method.md | 2 +- .../hosting/icorruntimehost-createlogicalthreadstate-method.md | 2 +- .../hosting/icorruntimehost-currentdomain-method.md | 2 +- .../hosting/icorruntimehost-deletelogicalthreadstate-method.md | 2 +- .../unmanaged-api/hosting/icorruntimehost-enumdomains-method.md | 2 +- .../hosting/icorruntimehost-getconfiguration-method.md | 2 +- .../hosting/icorruntimehost-getdefaultdomain-method.md | 2 +- docs/core/unmanaged-api/hosting/icorruntimehost-interface.md | 2 +- .../hosting/icorruntimehost-locksheldbylogicalthread-method.md | 2 +- .../unmanaged-api/hosting/icorruntimehost-mapfile-method.md | 2 +- .../unmanaged-api/hosting/icorruntimehost-nextdomain-method.md | 2 +- docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md | 2 +- docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md | 2 +- .../icorruntimehost-switchinlogicalthreadstate-method.md | 2 +- .../icorruntimehost-switchoutlogicalthreadstate-method.md | 2 +- .../hosting/icorruntimehost-unloaddomain-method.md | 2 +- .../icorthreadpool-corbindiocompletioncallback-method.md | 2 +- .../hosting/icorthreadpool-corcallorqueueuserworkitem-method.md | 2 +- .../hosting/icorthreadpool-corchangetimer-method.md | 2 +- .../hosting/icorthreadpool-corcreatetimer-method.md | 2 +- .../hosting/icorthreadpool-cordeletetimer-method.md | 2 +- .../hosting/icorthreadpool-corgetavailablethreads-method.md | 2 +- .../hosting/icorthreadpool-corgetmaxthreads-method.md | 2 +- .../hosting/icorthreadpool-corqueueuserworkitem-method.md | 2 +- .../icorthreadpool-corregisterwaitforsingleobject-method.md | 2 +- .../hosting/icorthreadpool-corsetmaxthreads-method.md | 2 +- .../hosting/icorthreadpool-corunregisterwait-method.md | 2 +- docs/core/unmanaged-api/hosting/icorthreadpool-interface.md | 2 +- docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md | 2 +- .../hosting/idebuggerinfo-isdebuggerattached-method.md | 2 +- .../unmanaged-api/hosting/idebuggerthreadcontrol-interface.md | 2 +- .../idebuggerthreadcontrol-releaseallruntimethreads-method.md | 2 +- .../idebuggerthreadcontrol-startblockingfordebugger-method.md | 2 +- ...idebuggerthreadcontrol-threadisblockingfordebugger-method.md | 2 +- docs/core/unmanaged-api/hosting/igchost-collect-method.md | 2 +- docs/core/unmanaged-api/hosting/igchost-getstats-method.md | 2 +- .../core/unmanaged-api/hosting/igchost-getthreadstats-method.md | 2 +- docs/core/unmanaged-api/hosting/igchost-interface.md | 2 +- .../unmanaged-api/hosting/igchost-setgcstartuplimits-method.md | 2 +- .../unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md | 2 +- docs/core/unmanaged-api/hosting/igchost2-interface.md | 2 +- .../hosting/igchost2-setgcstartuplimitsex-method.md | 2 +- docs/core/unmanaged-api/hosting/igchostcontrol-interface.md | 2 +- .../hosting/igchostcontrol-requestvirtualmemlimit-method.md | 2 +- docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md | 2 +- .../hosting/igcthreadcontrol-suspensionending-method.md | 2 +- .../hosting/igcthreadcontrol-suspensionstarting-method.md | 2 +- .../igcthreadcontrol-threadisblockingforsuspension-method.md | 2 +- .../hosting/ihostassemblymanager-getassemblystore-method.md | 2 +- .../ihostassemblymanager-getnonhoststoreassemblies-method.md | 2 +- .../unmanaged-api/hosting/ihostassemblymanager-interface.md | 2 +- docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md | 2 +- .../hosting/ihostassemblystore-provideassembly-method.md | 2 +- .../hosting/ihostassemblystore-providemodule-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostautoevent-interface.md | 2 +- docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md | 2 +- .../unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostcontrol-interface.md | 2 +- .../hosting/ihostcontrol-setappdomainmanager-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostcrst-interface.md | 2 +- docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md | 2 +- .../core/unmanaged-api/hosting/ihostcrst-setspincount-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md | 2 +- .../hosting/ihostgcmanager-suspensionending-method.md | 2 +- .../hosting/ihostgcmanager-suspensionstarting-method.md | 2 +- .../ihostgcmanager-threadisblockingforsuspension-method.md | 2 +- .../hosting/ihostiocompletionmanager-bind-method.md | 2 +- .../ihostiocompletionmanager-closeiocompletionport-method.md | 2 +- .../ihostiocompletionmanager-createiocompletionport-method.md | 2 +- .../ihostiocompletionmanager-getavailablethreads-method.md | 2 +- .../ihostiocompletionmanager-gethostoverlappedsize-method.md | 2 +- .../hosting/ihostiocompletionmanager-getmaxthreads-method.md | 2 +- .../hosting/ihostiocompletionmanager-getminthreads-method.md | 2 +- .../ihostiocompletionmanager-initializehostoverlapped-method.md | 2 +- .../unmanaged-api/hosting/ihostiocompletionmanager-interface.md | 2 +- ...ihostiocompletionmanager-setclriocompletionmanager-method.md | 2 +- .../hosting/ihostiocompletionmanager-setmaxthreads-method.md | 2 +- .../hosting/ihostiocompletionmanager-setminthreads-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md | 2 +- .../core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostmalloc-interface.md | 2 +- docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md | 2 +- .../core/unmanaged-api/hosting/ihostmanualevent-reset-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md | 2 +- .../ihostmemorymanager-acquiredvirtualaddressspace-method.md | 2 +- .../hosting/ihostmemorymanager-createmalloc-method.md | 2 +- .../hosting/ihostmemorymanager-getmemoryload-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md | 2 +- .../ihostmemorymanager-needsvirtualaddressspace-method.md | 2 +- ...stmemorymanager-registermemorynotificationcallback-method.md | 2 +- .../ihostmemorymanager-releasedvirtualaddressspace-method.md | 2 +- .../hosting/ihostmemorymanager-virtualalloc-method.md | 2 +- .../hosting/ihostmemorymanager-virtualfree-method.md | 2 +- .../hosting/ihostmemorymanager-virtualprotect-method.md | 2 +- .../hosting/ihostmemorymanager-virtualquery-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md | 2 +- .../hosting/ihostpolicymanager-ondefaultaction-method.md | 2 +- .../hosting/ihostpolicymanager-onfailure-method.md | 2 +- .../hosting/ihostpolicymanager-ontimeout-method.md | 2 +- .../hosting/ihostsecuritycontext-capture-method.md | 2 +- .../unmanaged-api/hosting/ihostsecuritycontext-interface.md | 2 +- .../hosting/ihostsecuritymanager-getsecuritycontext-method.md | 2 +- .../ihostsecuritymanager-impersonateloggedonuser-method.md | 2 +- .../unmanaged-api/hosting/ihostsecuritymanager-interface.md | 2 +- .../hosting/ihostsecuritymanager-openthreadtoken-method.md | 2 +- .../hosting/ihostsecuritymanager-reverttoself-method.md | 2 +- .../hosting/ihostsecuritymanager-setsecuritycontext-method.md | 2 +- .../hosting/ihostsecuritymanager-setthreadtoken-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md | 2 +- .../hosting/ihostsemaphore-releasesemaphore-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md | 2 +- .../hosting/ihostsyncmanager-createautoevent-method.md | 2 +- .../unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md | 2 +- .../hosting/ihostsyncmanager-createcrstwithspincount-method.md | 2 +- .../hosting/ihostsyncmanager-createmanualevent-method.md | 2 +- .../hosting/ihostsyncmanager-createmonitorevent-method.md | 2 +- .../hosting/ihostsyncmanager-createrwlockreaderevent-method.md | 2 +- .../hosting/ihostsyncmanager-createrwlockwriterevent-method.md | 2 +- .../hosting/ihostsyncmanager-createsemaphore-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md | 2 +- .../hosting/ihostsyncmanager-setclrsyncmanager-method.md | 2 +- docs/core/unmanaged-api/hosting/ihosttask-alert-method.md | 2 +- docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md | 2 +- docs/core/unmanaged-api/hosting/ihosttask-interface.md | 2 +- docs/core/unmanaged-api/hosting/ihosttask-join-method.md | 2 +- docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md | 2 +- docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md | 2 +- docs/core/unmanaged-api/hosting/ihosttask-start-method.md | 2 +- .../hosting/ihosttaskmanager-begindelayabort-method.md | 2 +- .../hosting/ihosttaskmanager-beginthreadaffinity-method.md | 2 +- .../hosting/ihosttaskmanager-callneedshosthook-method.md | 2 +- .../unmanaged-api/hosting/ihosttaskmanager-createtask-method.md | 2 +- .../hosting/ihosttaskmanager-enddelayabort-method.md | 2 +- .../hosting/ihosttaskmanager-endthreadaffinity-method.md | 2 +- .../hosting/ihosttaskmanager-enterruntime-method.md | 2 +- .../hosting/ihosttaskmanager-getcurrenttask-method.md | 2 +- .../hosting/ihosttaskmanager-getstackguarantee-method.md | 2 +- docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md | 2 +- .../hosting/ihosttaskmanager-leaveruntime-method.md | 2 +- .../hosting/ihosttaskmanager-reverseenterruntime-method.md | 2 +- .../hosting/ihosttaskmanager-reverseleaveruntime-method.md | 2 +- .../hosting/ihosttaskmanager-setclrtaskmanager-method.md | 2 +- .../unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md | 2 +- .../hosting/ihosttaskmanager-setstackguarantee-method.md | 2 +- .../hosting/ihosttaskmanager-setuilocale-method.md | 2 +- .../core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md | 2 +- .../hosting/ihosttaskmanager-switchtotask-method.md | 2 +- .../ihostthreadpoolmanager-getavailablethreads-method.md | 2 +- .../hosting/ihostthreadpoolmanager-getmaxthreads-method.md | 2 +- .../hosting/ihostthreadpoolmanager-getminthreads-method.md | 2 +- .../unmanaged-api/hosting/ihostthreadpoolmanager-interface.md | 2 +- .../hosting/ihostthreadpoolmanager-queueuserworkitem-method.md | 2 +- .../hosting/ihostthreadpoolmanager-setmaxthreads-method.md | 2 +- .../hosting/ihostthreadpoolmanager-setminthreads-method.md | 2 +- .../hosting/imanagedobject-getobjectidentity-method.md | 2 +- .../hosting/imanagedobject-getserializedbuffer-method.md | 2 +- docs/core/unmanaged-api/hosting/imanagedobject-interface.md | 2 +- docs/core/unmanaged-api/hosting/iobjecthandle-interface.md | 2 +- docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md | 2 +- .../unmanaged-api/hosting/itypename-getassemblyname-method.md | 2 +- .../unmanaged-api/hosting/itypename-getmodifierlength-method.md | 2 +- .../core/unmanaged-api/hosting/itypename-getmodifiers-method.md | 2 +- .../core/unmanaged-api/hosting/itypename-getnamecount-method.md | 2 +- docs/core/unmanaged-api/hosting/itypename-getnames-method.md | 2 +- .../hosting/itypename-gettypeargumentcount-method.md | 2 +- .../unmanaged-api/hosting/itypename-gettypearguments-method.md | 2 +- docs/core/unmanaged-api/hosting/itypename-interface.md | 2 +- .../unmanaged-api/hosting/itypenamebuilder-addarray-method.md | 2 +- .../hosting/itypenamebuilder-addassemblyspec-method.md | 2 +- .../unmanaged-api/hosting/itypenamebuilder-addbyref-method.md | 2 +- .../unmanaged-api/hosting/itypenamebuilder-addname-method.md | 2 +- .../unmanaged-api/hosting/itypenamebuilder-addpointer-method.md | 2 +- .../unmanaged-api/hosting/itypenamebuilder-addszarray-method.md | 2 +- .../core/unmanaged-api/hosting/itypenamebuilder-clear-method.md | 2 +- .../hosting/itypenamebuilder-closegenericargument-method.md | 2 +- .../hosting/itypenamebuilder-closegenericarguments-method.md | 2 +- docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md | 2 +- .../hosting/itypenamebuilder-opengenericargument-method.md | 2 +- .../hosting/itypenamebuilder-opengenericarguments-method.md | 2 +- .../unmanaged-api/hosting/itypenamebuilder-tostring-method.md | 2 +- .../hosting/itypenamefactory-gettypenamebuilder-method.md | 2 +- docs/core/unmanaged-api/hosting/itypenamefactory-interface.md | 2 +- .../hosting/itypenamefactory-parsetypename-method.md | 2 +- .../unmanaged-api/hosting/ivalidator-formateventinfo-method.md | 2 +- docs/core/unmanaged-api/hosting/ivalidator-interface.md | 2 +- docs/core/unmanaged-api/hosting/ivalidator-validate-method.md | 2 +- docs/core/unmanaged-api/hosting/loadlibraryshim-function.md | 2 +- docs/core/unmanaged-api/hosting/loadstringrc-function.md | 2 +- docs/core/unmanaged-api/hosting/loadstringrcex-function.md | 2 +- docs/core/unmanaged-api/hosting/lockclrversion-function.md | 2 +- .../hosting/lpoverlapped-completion-routine-function-pointer.md | 2 +- .../hosting/lpthread-start-routine-function-pointer.md | 2 +- docs/core/unmanaged-api/hosting/malloc-type-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/mdainfo-structure.md | 2 +- .../unmanaged-api/hosting/metahost-config-flags-enumeration.md | 2 +- .../unmanaged-api/hosting/metahost-policy-flags-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/modulebindinfo-structure.md | 2 +- docs/core/unmanaged-api/hosting/rundll32shimw-function.md | 2 +- .../unmanaged-api/hosting/runtime-info-flags-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md | 2 +- .../core/unmanaged-api/hosting/stackoverflowtype-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/startup-flags-enumeration.md | 2 +- .../unmanaged-api/hosting/strongnamegetpublickeyex-method.md | 2 +- .../hosting/strongnamesignatureverificationex2-method.md | 2 +- docs/core/unmanaged-api/hosting/typenamefactory-coclass.md | 2 +- docs/core/unmanaged-api/hosting/validatorflags-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/wait-option-enumeration.md | 2 +- .../hosting/waitortimercallback-function-pointer.md | 2 +- docs/core/unmanaged-api/metadata/assemblyflags-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/assemblymetadata-structure.md | 2 +- .../core/unmanaged-api/metadata/assemblyrefflags-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/ceesectionattr-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/ceesectionrelocextra-union.md | 2 +- .../unmanaged-api/metadata/ceesectionreloctype-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/coiniticor-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/coinitiee-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/cor-field-offset-structure.md | 2 +- docs/core/unmanaged-api/metadata/cor-native-link-structure.md | 2 +- docs/core/unmanaged-api/metadata/corargtype-enumeration.md | 2 +- .../core/unmanaged-api/metadata/corassemblyflags-enumeration.md | 2 +- .../unmanaged-api/metadata/corattributetargets-enumeration.md | 2 +- .../unmanaged-api/metadata/corcallingconvention-enumeration.md | 2 +- .../unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/cordeclsecurity-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corelementtype-enumeration.md | 2 +- .../metadata/corerrorifemitoutoforder-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/coreventattr-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corfieldattr-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corfileflags-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corfilemapping-enumeration.md | 2 +- .../unmanaged-api/metadata/corgenericparamattr-enumeration.md | 2 +- .../core/unmanaged-api/metadata/corimportoptions-enumeration.md | 2 +- .../core/unmanaged-api/metadata/corlinkeroptions-enumeration.md | 2 +- .../metadata/corlocalrefpreservation-enumeration.md | 2 +- .../metadata/cormanifestresourceflags-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/cormethodattr-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/cormethodimpl-enumeration.md | 2 +- .../metadata/cormethodsemanticsattr-enumeration.md | 2 +- .../unmanaged-api/metadata/cornativelinkflags-enumeration.md | 2 +- .../unmanaged-api/metadata/cornativelinktype-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/cornativetype-enumeration.md | 2 +- .../metadata/cornotificationfortokenmovement-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/coropenflags-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corparamattr-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corpekind-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corpinvokemap-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corpropertyattr-enumeration.md | 2 +- .../core/unmanaged-api/metadata/correftodefcheck-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corregflags-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corsavesize-enumeration.md | 2 +- .../unmanaged-api/metadata/corserializationtype-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corsetenc-enumeration.md | 2 +- .../metadata/corthreadsafetyoptions-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/cortokentype-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/cortypeattr-enumeration.md | 2 +- .../metadata/corunmanagedcallingconvention-enumeration.md | 2 +- .../metadata/corvalidatormoduletype-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/couninitiee-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/cvstruct-structure.md | 2 +- .../unmanaged-api/metadata/iceegen-addsectionreloc-method.md | 2 +- .../metadata/iceegen-allocatemethodbuffer-method.md | 2 +- .../unmanaged-api/metadata/iceegen-computepointer-method.md | 2 +- docs/core/unmanaged-api/metadata/iceegen-emitstring-method.md | 2 +- .../unmanaged-api/metadata/iceegen-generateceefile-method.md | 2 +- .../metadata/iceegen-generateceememoryimage-method.md | 2 +- docs/core/unmanaged-api/metadata/iceegen-getilsection-method.md | 2 +- .../unmanaged-api/metadata/iceegen-getimaptokeniface-method.md | 2 +- .../unmanaged-api/metadata/iceegen-getmethodbuffer-method.md | 2 +- .../unmanaged-api/metadata/iceegen-getsectionblock-method.md | 2 +- .../unmanaged-api/metadata/iceegen-getsectioncreate-method.md | 2 +- .../unmanaged-api/metadata/iceegen-getsectiondatalen-method.md | 2 +- docs/core/unmanaged-api/metadata/iceegen-getstring-method.md | 2 +- .../unmanaged-api/metadata/iceegen-getstringsection-method.md | 2 +- docs/core/unmanaged-api/metadata/iceegen-interface.md | 2 +- .../unmanaged-api/metadata/iceegen-truncatesection-method.md | 2 +- docs/core/unmanaged-api/metadata/ihostfilter-interface.md | 2 +- .../core/unmanaged-api/metadata/ihostfilter-marktoken-method.md | 2 +- docs/core/unmanaged-api/metadata/imaptoken-interface.md | 2 +- docs/core/unmanaged-api/metadata/imaptoken-map-method.md | 2 +- .../metadata/imetadataassemblyemit-defineassembly-method.md | 2 +- .../metadata/imetadataassemblyemit-defineassemblyref-method.md | 2 +- .../metadata/imetadataassemblyemit-defineexportedtype-method.md | 2 +- .../metadata/imetadataassemblyemit-definefile-method.md | 2 +- .../imetadataassemblyemit-definemanifestresource-method.md | 2 +- .../unmanaged-api/metadata/imetadataassemblyemit-interface.md | 2 +- .../metadata/imetadataassemblyemit-setassemblyprops-method.md | 2 +- .../imetadataassemblyemit-setassemblyrefprops-method.md | 2 +- .../imetadataassemblyemit-setexportedtypeprops-method.md | 2 +- .../metadata/imetadataassemblyemit-setfileprops-method.md | 2 +- .../imetadataassemblyemit-setmanifestresourceprops-method.md | 2 +- .../metadata/imetadataassemblyimport-closeenum-method.md | 2 +- .../metadata/imetadataassemblyimport-enumassemblyrefs-method.md | 2 +- .../imetadataassemblyimport-enumexportedtypes-method.md | 2 +- .../metadata/imetadataassemblyimport-enumfiles-method.md | 2 +- .../imetadataassemblyimport-enummanifestresources-method.md | 2 +- .../imetadataassemblyimport-findassembliesbyname-method.md | 2 +- .../imetadataassemblyimport-findexportedtypebyname-method.md | 2 +- ...imetadataassemblyimport-findmanifestresourcebyname-method.md | 2 +- .../imetadataassemblyimport-getassemblyfromscope-method.md | 2 +- .../metadata/imetadataassemblyimport-getassemblyprops-method.md | 2 +- .../imetadataassemblyimport-getassemblyrefprops-method.md | 2 +- .../imetadataassemblyimport-getexportedtypeprops-method.md | 2 +- .../metadata/imetadataassemblyimport-getfileprops-method.md | 2 +- .../imetadataassemblyimport-getmanifestresourceprops-method.md | 2 +- .../unmanaged-api/metadata/imetadataassemblyimport-interface.md | 2 +- .../imetadataconverter-getmetadatafromtypeinfo-method.md | 2 +- .../imetadataconverter-getmetadatafromtypelib-method.md | 2 +- .../imetadataconverter-gettypelibfrommetadata-method.md | 2 +- .../core/unmanaged-api/metadata/imetadataconverter-interface.md | 2 +- .../metadata/imetadatadispenser-definescope-method.md | 2 +- .../core/unmanaged-api/metadata/imetadatadispenser-interface.md | 2 +- .../metadata/imetadatadispenser-openscope-method.md | 2 +- .../metadata/imetadatadispenser-openscopeonmemory-method.md | 2 +- .../metadata/imetadatadispenserex-findassembly-method.md | 2 +- .../metadata/imetadatadispenserex-findassemblymodule-method.md | 2 +- .../imetadatadispenserex-getcorsystemdirectory-method.md | 2 +- .../metadata/imetadatadispenserex-getoption-method.md | 2 +- .../unmanaged-api/metadata/imetadatadispenserex-interface.md | 2 +- .../imetadatadispenserex-openscopeonitypeinfo-method.md | 2 +- .../metadata/imetadatadispenserex-setoption-method.md | 2 +- .../metadata/imetadataemit-applyeditandcontinue-method.md | 2 +- .../metadata/imetadataemit-definecustomattribute-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-defineevent-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-definefield-method.md | 2 +- .../metadata/imetadataemit-defineimportmember-method.md | 2 +- .../metadata/imetadataemit-defineimporttype-method.md | 2 +- .../metadata/imetadataemit-definememberref-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-definemethod-method.md | 2 +- .../metadata/imetadataemit-definemethodimpl-method.md | 2 +- .../metadata/imetadataemit-definemoduleref-method.md | 2 +- .../metadata/imetadataemit-definenestedtype-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-defineparam-method.md | 2 +- .../metadata/imetadataemit-definepermissionset-method.md | 2 +- .../metadata/imetadataemit-definepinvokemap-method.md | 2 +- .../metadata/imetadataemit-defineproperty-method.md | 2 +- .../metadata/imetadataemit-definesecurityattributeset-method.md | 2 +- .../metadata/imetadataemit-definetypedef-method.md | 2 +- .../metadata/imetadataemit-definetyperefbyname-method.md | 2 +- .../metadata/imetadataemit-defineuserstring-method.md | 2 +- .../metadata/imetadataemit-deleteclasslayout-method.md | 2 +- .../metadata/imetadataemit-deletefieldmarshal-method.md | 2 +- .../metadata/imetadataemit-deletepinvokemap-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-deletetoken-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-getsavesize-method.md | 2 +- .../metadata/imetadataemit-gettokenfromsig-method.md | 2 +- .../metadata/imetadataemit-gettokenfromtypespec-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadataemit-interface.md | 2 +- docs/core/unmanaged-api/metadata/imetadataemit-merge-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-mergeend-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadataemit-save-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-savetomemory-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-savetostream-method.md | 2 +- .../metadata/imetadataemit-setclasslayout-method.md | 2 +- .../metadata/imetadataemit-setcustomattributevalue-method.md | 2 +- .../metadata/imetadataemit-seteventprops-method.md | 2 +- .../metadata/imetadataemit-setfieldmarshal-method.md | 2 +- .../metadata/imetadataemit-setfieldprops-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-setfieldrva-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-sethandler-method.md | 2 +- .../metadata/imetadataemit-setmethodimplflags-method.md | 2 +- .../metadata/imetadataemit-setmethodprops-method.md | 2 +- .../metadata/imetadataemit-setmoduleprops-method.md | 2 +- .../metadata/imetadataemit-setparamprops-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-setparent-method.md | 2 +- .../metadata/imetadataemit-setpermissionsetprops-method.md | 2 +- .../metadata/imetadataemit-setpinvokemap-method.md | 2 +- .../metadata/imetadataemit-setpropertyprops-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadataemit-setrva-method.md | 2 +- .../metadata/imetadataemit-settypedefprops-method.md | 2 +- .../metadata/imetadataemit-translatesigwithscope-method.md | 2 +- .../metadata/imetadataemit2-definegenericparam-method.md | 2 +- .../metadata/imetadataemit2-definemethodspec-method.md | 2 +- .../metadata/imetadataemit2-getdeltasavesize-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadataemit2-interface.md | 2 +- .../unmanaged-api/metadata/imetadataemit2-resetenclog-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit2-savedelta-method.md | 2 +- .../metadata/imetadataemit2-savedeltatomemory-method.md | 2 +- .../metadata/imetadataemit2-savedeltatostream-method.md | 2 +- .../metadata/imetadataemit2-setgenericparamprops-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadataerror-interface.md | 2 +- .../unmanaged-api/metadata/imetadataerror-onerror-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadatafilter-interface.md | 2 +- .../metadata/imetadatafilter-istokenmarked-method.md | 2 +- .../unmanaged-api/metadata/imetadatafilter-marktoken-method.md | 2 +- .../unmanaged-api/metadata/imetadatafilter-unmarkall-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport-closeenum-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport-countenum-method.md | 2 +- .../metadata/imetadataimport-enumcustomattributes-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport-enumevents-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport-enumfields-method.md | 2 +- .../metadata/imetadataimport-enumfieldswithname-method.md | 2 +- .../metadata/imetadataimport-enuminterfaceimpls-method.md | 2 +- .../metadata/imetadataimport-enummemberrefs-method.md | 2 +- .../metadata/imetadataimport-enummembers-method.md | 2 +- .../metadata/imetadataimport-enummemberswithname-method.md | 2 +- .../metadata/imetadataimport-enummethodimpls-method.md | 2 +- .../metadata/imetadataimport-enummethods-method.md | 2 +- .../metadata/imetadataimport-enummethodsemantics-method.md | 2 +- .../metadata/imetadataimport-enummethodswithname-method.md | 2 +- .../metadata/imetadataimport-enummodulerefs-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport-enumparams-method.md | 2 +- .../metadata/imetadataimport-enumpermissionsets-method.md | 2 +- .../metadata/imetadataimport-enumproperties-method.md | 2 +- .../metadata/imetadataimport-enumsignatures-method.md | 2 +- .../metadata/imetadataimport-enumtypedefs-method.md | 2 +- .../metadata/imetadataimport-enumtyperefs-method.md | 2 +- .../metadata/imetadataimport-enumtypespecs-method.md | 2 +- .../metadata/imetadataimport-enumunresolvedmethods-method.md | 2 +- .../metadata/imetadataimport-enumuserstrings-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport-findfield-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport-findmember-method.md | 2 +- .../metadata/imetadataimport-findmemberref-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport-findmethod-method.md | 2 +- .../metadata/imetadataimport-findtypedefbyname-method.md | 2 +- .../metadata/imetadataimport-findtyperef-method.md | 2 +- .../metadata/imetadataimport-getclasslayout-method.md | 2 +- .../metadata/imetadataimport-getcustomattributebyname-method.md | 2 +- .../metadata/imetadataimport-getcustomattributeprops-method.md | 2 +- .../metadata/imetadataimport-geteventprops-method.md | 2 +- .../metadata/imetadataimport-getfieldmarshal-method.md | 2 +- .../metadata/imetadataimport-getfieldprops-method.md | 2 +- .../metadata/imetadataimport-getinterfaceimplprops-method.md | 2 +- .../metadata/imetadataimport-getmemberprops-method.md | 2 +- .../metadata/imetadataimport-getmemberrefprops-method.md | 2 +- .../metadata/imetadataimport-getmethodprops-method.md | 2 +- .../metadata/imetadataimport-getmethodsemantics-method.md | 2 +- .../metadata/imetadataimport-getmodulefromscope-method.md | 2 +- .../metadata/imetadataimport-getmodulerefprops-method.md | 2 +- .../metadata/imetadataimport-getnamefromtoken-method.md | 2 +- .../metadata/imetadataimport-getnativecallconvfromsig-method.md | 2 +- .../metadata/imetadataimport-getnestedclassprops-method.md | 2 +- .../metadata/imetadataimport-getparamformethodindex-method.md | 2 +- .../metadata/imetadataimport-getparamprops-method.md | 2 +- .../metadata/imetadataimport-getpermissionsetprops-method.md | 2 +- .../metadata/imetadataimport-getpinvokemap-method.md | 2 +- .../metadata/imetadataimport-getpropertyprops-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport-getrva-method.md | 2 +- .../metadata/imetadataimport-getscopeprops-method.md | 2 +- .../metadata/imetadataimport-getsigfromtoken-method.md | 2 +- .../metadata/imetadataimport-gettypedefprops-method.md | 2 +- .../metadata/imetadataimport-gettyperefprops-method.md | 2 +- .../metadata/imetadataimport-gettypespecfromtoken-method.md | 2 +- .../metadata/imetadataimport-getuserstring-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadataimport-interface.md | 2 +- .../unmanaged-api/metadata/imetadataimport-isglobal-method.md | 2 +- .../metadata/imetadataimport-isvalidtoken-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport-resetenum-method.md | 2 +- .../metadata/imetadataimport-resolvetyperef-method.md | 2 +- .../imetadataimport2-enumgenericparamconstraints-method.md | 2 +- .../metadata/imetadataimport2-enumgenericparams-method.md | 2 +- .../metadata/imetadataimport2-enummethodspecs-method.md | 2 +- .../imetadataimport2-getgenericparamconstraintprops-method.md | 2 +- .../metadata/imetadataimport2-getgenericparamprops-method.md | 2 +- .../metadata/imetadataimport2-getmethodspecprops-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport2-getpekind-method.md | 2 +- .../metadata/imetadataimport2-getversionstring-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadataimport2-interface.md | 2 +- .../metadata/imetadatainfo-getfilemapping-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadatainfo-interface.md | 2 +- .../unmanaged-api/metadata/imetadatatables-getblob-method.md | 2 +- .../metadata/imetadatatables-getblobheapsize-method.md | 2 +- .../metadata/imetadatatables-getcodedtokeninfo-method.md | 2 +- .../unmanaged-api/metadata/imetadatatables-getcolumn-method.md | 2 +- .../metadata/imetadatatables-getcolumninfo-method.md | 2 +- .../unmanaged-api/metadata/imetadatatables-getguid-method.md | 2 +- .../metadata/imetadatatables-getguidheapsize-method.md | 2 +- .../metadata/imetadatatables-getnextblob-method.md | 2 +- .../metadata/imetadatatables-getnextguid-method.md | 2 +- .../metadata/imetadatatables-getnextstring-method.md | 2 +- .../metadata/imetadatatables-getnextuserstring-method.md | 2 +- .../metadata/imetadatatables-getnumtables-method.md | 2 +- .../unmanaged-api/metadata/imetadatatables-getrow-method.md | 2 +- .../unmanaged-api/metadata/imetadatatables-getstring-method.md | 2 +- .../metadata/imetadatatables-getstringheapsize-method.md | 2 +- .../metadata/imetadatatables-gettableindex-method.md | 2 +- .../metadata/imetadatatables-gettableinfo-method.md | 2 +- .../metadata/imetadatatables-getuserstring-method.md | 2 +- .../metadata/imetadatatables-getuserstringheapsize-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadatatables-interface.md | 2 +- .../metadata/imetadatatables2-getmetadatastorage-method.md | 2 +- .../metadata/imetadatatables2-getmetadatastreaminfo-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadatatables2-interface.md | 2 +- docs/core/unmanaged-api/metadata/imetadatavalidate-interface.md | 2 +- .../metadata/imetadatavalidate-validatemetadata-method.md | 2 +- .../metadata/imetadatavalidate-validatorinit-method.md | 2 +- docs/core/unmanaged-api/metadata/osinfo-structure.md | 2 +- 723 files changed, 723 insertions(+), 723 deletions(-) diff --git a/docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md b/docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md index e50d1d6781972..00c939b3686c9 100644 --- a/docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md +++ b/docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md @@ -46,7 +46,7 @@ typedef struct _AssemblyBindInfo { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/bucketparameters-structure.md b/docs/core/unmanaged-api/hosting/bucketparameters-structure.md index e244246bf705d..5a44a5d1ac59e 100644 --- a/docs/core/unmanaged-api/hosting/bucketparameters-structure.md +++ b/docs/core/unmanaged-api/hosting/bucketparameters-structure.md @@ -40,7 +40,7 @@ typedef struct _BucketParameters { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/callfunctionshim-function.md b/docs/core/unmanaged-api/hosting/callfunctionshim-function.md index a6b7f75f0d628..fd8a30d5bddb2 100644 --- a/docs/core/unmanaged-api/hosting/callfunctionshim-function.md +++ b/docs/core/unmanaged-api/hosting/callfunctionshim-function.md @@ -57,7 +57,7 @@ HRESULT CallFunctionShim ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md b/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md index 02008c4442530..0027ec294e2c6 100644 --- a/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md +++ b/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md @@ -95,7 +95,7 @@ hr = createInterface (CLSID_CLRDebugging, IID_ICLRDebugging, (LPVOID*)&pCLRDebu ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md b/docs/core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md index df124bde5738f..2f2e84c40b1d6 100644 --- a/docs/core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md +++ b/docs/core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md @@ -53,7 +53,7 @@ STDAPI ClrCreateManagedInstance ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md b/docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md index 236264b1adfcc..c9599e191edd6 100644 --- a/docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md +++ b/docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md @@ -38,7 +38,7 @@ coclass CLRRuntimeHost { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md b/docs/core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md index 194abb0a38023..9f943b1c24fa5 100644 --- a/docs/core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md @@ -38,7 +38,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md b/docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md index 1ea3bc2ddc2bd..78495d182f412 100644 --- a/docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md +++ b/docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md @@ -41,7 +41,7 @@ void CoEEShutDownCOM (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/hosting/coinitializeee-function.md b/docs/core/unmanaged-api/hosting/coinitializeee-function.md index ac6cc3f5cb1a3..9dd72480f915d 100644 --- a/docs/core/unmanaged-api/hosting/coinitializeee-function.md +++ b/docs/core/unmanaged-api/hosting/coinitializeee-function.md @@ -50,7 +50,7 @@ HRESULT CoInitializeEE ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md b/docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md index 47ab58919b987..46c8f75b9c973 100644 --- a/docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md +++ b/docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md @@ -36,7 +36,7 @@ coclass ComCallUnmarshal { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md b/docs/core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md index f6258624d318f..05560fcd38c84 100644 --- a/docs/core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md +++ b/docs/core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md @@ -42,7 +42,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md b/docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md index b6c2bfd2142a2..6f2a74d638a78 100644 --- a/docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md +++ b/docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md @@ -74,7 +74,7 @@ pCLRGCManager->GetStats(&GCStats); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl diff --git a/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md b/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md index 02cd9db46a14a..8dc2cd4f8d60c 100644 --- a/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md +++ b/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md @@ -42,7 +42,7 @@ typedef struct _COR_GC_THREAD_STATS { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl diff --git a/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md b/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md index 7882f1ac256af..87f41a461d1c2 100644 --- a/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md +++ b/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md @@ -36,7 +36,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/corbindtocurrentruntime-function.md b/docs/core/unmanaged-api/hosting/corbindtocurrentruntime-function.md index 80ff2a9926e73..8e98df33df2e0 100644 --- a/docs/core/unmanaged-api/hosting/corbindtocurrentruntime-function.md +++ b/docs/core/unmanaged-api/hosting/corbindtocurrentruntime-function.md @@ -54,7 +54,7 @@ HRESULT CorBindToCurrentRuntime ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/corbindtoruntime-function.md b/docs/core/unmanaged-api/hosting/corbindtoruntime-function.md index 793968933207c..1e8c2711dbd59 100644 --- a/docs/core/unmanaged-api/hosting/corbindtoruntime-function.md +++ b/docs/core/unmanaged-api/hosting/corbindtoruntime-function.md @@ -84,7 +84,7 @@ HRESULT CorBindToRuntime ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md b/docs/core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md index 769e35b7360c9..9b41a0bb94678 100644 --- a/docs/core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md +++ b/docs/core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md @@ -61,7 +61,7 @@ HRESULT CorBindToRuntimeByCfg ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md b/docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md index b0f516481db6c..30a3fde342592 100644 --- a/docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md +++ b/docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md @@ -127,7 +127,7 @@ HRESULT CorBindToRuntimeEx ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/corbindtoruntimehost-function.md b/docs/core/unmanaged-api/hosting/corbindtoruntimehost-function.md index 1fa17b846fb81..585af96ae73c3 100644 --- a/docs/core/unmanaged-api/hosting/corbindtoruntimehost-function.md +++ b/docs/core/unmanaged-api/hosting/corbindtoruntimehost-function.md @@ -75,7 +75,7 @@ HRESULT CorBindToRuntimeHost ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/cordllmain-function.md b/docs/core/unmanaged-api/hosting/cordllmain-function.md index 3e123e4c3a67f..bbda02bfac5f4 100644 --- a/docs/core/unmanaged-api/hosting/cordllmain-function.md +++ b/docs/core/unmanaged-api/hosting/cordllmain-function.md @@ -57,7 +57,7 @@ The `_CorDllMain` function is called directly by the operating system loader. ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/hosting/corexemain-function.md b/docs/core/unmanaged-api/hosting/corexemain-function.md index b117c582cd494..62dd042d9b584 100644 --- a/docs/core/unmanaged-api/hosting/corexemain-function.md +++ b/docs/core/unmanaged-api/hosting/corexemain-function.md @@ -39,7 +39,7 @@ __int32 STDMETHODCALLTYPE _CorExeMain (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/hosting/corexemain2-function.md b/docs/core/unmanaged-api/hosting/corexemain2-function.md index 9a646ad96a692..76d1e2f5f1f07 100644 --- a/docs/core/unmanaged-api/hosting/corexemain2-function.md +++ b/docs/core/unmanaged-api/hosting/corexemain2-function.md @@ -51,7 +51,7 @@ __int32 STDMETHODCALLTYPE _CorExeMain2 ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/hosting/corexitprocess-function.md b/docs/core/unmanaged-api/hosting/corexitprocess-function.md index 8b503b98b1167..c1780fd78c94d 100644 --- a/docs/core/unmanaged-api/hosting/corexitprocess-function.md +++ b/docs/core/unmanaged-api/hosting/corexitprocess-function.md @@ -46,7 +46,7 @@ void STDMETHODCALLTYPE CorExitProcess ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/corimageunloading-function.md b/docs/core/unmanaged-api/hosting/corimageunloading-function.md index 8bdd225a20683..fa4614dc223c6 100644 --- a/docs/core/unmanaged-api/hosting/corimageunloading-function.md +++ b/docs/core/unmanaged-api/hosting/corimageunloading-function.md @@ -37,7 +37,7 @@ STDAPI (VOID) _CorImageUnloading( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/hosting/corlaunchapplication-function.md b/docs/core/unmanaged-api/hosting/corlaunchapplication-function.md index 28cc855af09eb..98e977d2e564c 100644 --- a/docs/core/unmanaged-api/hosting/corlaunchapplication-function.md +++ b/docs/core/unmanaged-api/hosting/corlaunchapplication-function.md @@ -62,7 +62,7 @@ HRESULT CorLaunchApplication ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md b/docs/core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md index d6555ada34ae3..b7de02f4c610d 100644 --- a/docs/core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md +++ b/docs/core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md @@ -28,7 +28,7 @@ void CorMarkThreadInThreadPool (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/corruntimehost-coclass.md b/docs/core/unmanaged-api/hosting/corruntimehost-coclass.md index ca11d8e66f975..3823341301f48 100644 --- a/docs/core/unmanaged-api/hosting/corruntimehost-coclass.md +++ b/docs/core/unmanaged-api/hosting/corruntimehost-coclass.md @@ -44,7 +44,7 @@ coclass CorRuntimeHost { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/corvalidateimage-function.md b/docs/core/unmanaged-api/hosting/corvalidateimage-function.md index 3ce741a7f5371..658ef05724830 100644 --- a/docs/core/unmanaged-api/hosting/corvalidateimage-function.md +++ b/docs/core/unmanaged-api/hosting/corvalidateimage-function.md @@ -72,7 +72,7 @@ STDAPI _CorValidateImage ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md b/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md index 4deecf7b4a1af..1b32b1a273a46 100644 --- a/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md +++ b/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md @@ -59,7 +59,7 @@ HRESULT CreateDebuggingInterfaceFromVersion ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/createiceefilegen-function.md b/docs/core/unmanaged-api/hosting/createiceefilegen-function.md index b155ccc6bc3d6..432dfc0928649 100644 --- a/docs/core/unmanaged-api/hosting/createiceefilegen-function.md +++ b/docs/core/unmanaged-api/hosting/createiceefilegen-function.md @@ -49,7 +49,7 @@ HRESULT CreateICeeFileGen ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** ICeeFileGen.h diff --git a/docs/core/unmanaged-api/hosting/customdumpitem-structure.md b/docs/core/unmanaged-api/hosting/customdumpitem-structure.md index 55771ff66d029..22f22eeb388f1 100644 --- a/docs/core/unmanaged-api/hosting/customdumpitem-structure.md +++ b/docs/core/unmanaged-api/hosting/customdumpitem-structure.md @@ -44,7 +44,7 @@ struct { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md b/docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md index 2ef702670da99..2e80784f31583 100644 --- a/docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md +++ b/docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md @@ -47,7 +47,7 @@ HRESULT DestroyICeeFileGen ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** ICeeFileGen.h diff --git a/docs/core/unmanaged-api/hosting/eapicategories-enumeration.md b/docs/core/unmanaged-api/hosting/eapicategories-enumeration.md index 18a8bd74eb316..1c26d5cc64b01 100644 --- a/docs/core/unmanaged-api/hosting/eapicategories-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eapicategories-enumeration.md @@ -62,7 +62,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md b/docs/core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md index 5a01c14861673..03975011d753e 100644 --- a/docs/core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md @@ -54,7 +54,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md b/docs/core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md index 3c2a639bb6429..3cb024d4a644e 100644 --- a/docs/core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md @@ -36,7 +36,7 @@ typedef enum _CLRAssemblyIdentityFlags { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/eclrevent-enumeration.md b/docs/core/unmanaged-api/hosting/eclrevent-enumeration.md index 2fb5b50916944..72c96fb34d234 100644 --- a/docs/core/unmanaged-api/hosting/eclrevent-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eclrevent-enumeration.md @@ -50,7 +50,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md b/docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md index 9e143c39102f0..e959b3c3fe625 100644 --- a/docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md @@ -52,7 +52,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/eclroperation-enumeration.md b/docs/core/unmanaged-api/hosting/eclroperation-enumeration.md index 92177f5704217..4de19bf03bc16 100644 --- a/docs/core/unmanaged-api/hosting/eclroperation-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eclroperation-enumeration.md @@ -58,7 +58,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md b/docs/core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md index 739d9cf88dfcc..6dd2a6513a98b 100644 --- a/docs/core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md @@ -42,7 +42,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/econtexttype-enumeration.md b/docs/core/unmanaged-api/hosting/econtexttype-enumeration.md index 4f71166b701f7..8f147bf6ec844 100644 --- a/docs/core/unmanaged-api/hosting/econtexttype-enumeration.md +++ b/docs/core/unmanaged-api/hosting/econtexttype-enumeration.md @@ -42,7 +42,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md b/docs/core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md index 3461796cca4c6..001617ef96ad1 100644 --- a/docs/core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md @@ -42,7 +42,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md b/docs/core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md index c93e8255325f3..c056db876aaaf 100644 --- a/docs/core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md @@ -36,7 +36,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md b/docs/core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md index 0cbc2466b07cd..bc609a183c2fb 100644 --- a/docs/core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md @@ -30,7 +30,7 @@ typedef enum _HostApplicationPolicy { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md b/docs/core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md index 11f18ca491899..a2cc13b0f3a69 100644 --- a/docs/core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md @@ -46,7 +46,7 @@ typedef enum _hostBindingPolicyModifyFlags { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md b/docs/core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md index cfb0ef393cadd..d5ffee5ca85b5 100644 --- a/docs/core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md @@ -40,7 +40,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md b/docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md index bfde1b4656f87..d3473bd27a8e3 100644 --- a/docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md @@ -44,7 +44,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md b/docs/core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md index 4035e03668756..b2e3d3e8ba0b2 100644 --- a/docs/core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md @@ -44,7 +44,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md b/docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md index 8d2cba5d957e9..4b8ec60149604 100644 --- a/docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md +++ b/docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md @@ -58,7 +58,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md b/docs/core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md index 9a9f29afe89fc..a5f2a191155f8 100644 --- a/docs/core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md +++ b/docs/core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md @@ -44,7 +44,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/etasktype-enumeration.md b/docs/core/unmanaged-api/hosting/etasktype-enumeration.md index 1b98ee8166ccd..eb40be9f902f4 100644 --- a/docs/core/unmanaged-api/hosting/etasktype-enumeration.md +++ b/docs/core/unmanaged-api/hosting/etasktype-enumeration.md @@ -56,7 +56,7 @@ typedef enum ETaskType { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md b/docs/core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md index b444c24ef9965..63ce40d9e3c03 100644 --- a/docs/core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md +++ b/docs/core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md @@ -39,7 +39,7 @@ typedef HRESULT (__stdcall *FExecuteInAppDomainCallback) ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md b/docs/core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md index 624e4e62c44fa..62431622c5228 100644 --- a/docs/core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md +++ b/docs/core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md @@ -34,7 +34,7 @@ typedef HRESULT (__stdcall *FLockClrVersionCallback) ( ); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getclridentitymanager-function.md b/docs/core/unmanaged-api/hosting/getclridentitymanager-function.md index 20a72685951f2..f22aab8c0803c 100644 --- a/docs/core/unmanaged-api/hosting/getclridentitymanager-function.md +++ b/docs/core/unmanaged-api/hosting/getclridentitymanager-function.md @@ -45,7 +45,7 @@ STDAPI GetCLRIdentityManager( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getcorrequiredversion-function.md b/docs/core/unmanaged-api/hosting/getcorrequiredversion-function.md index e5b70adca0631..ba0f2899df701 100644 --- a/docs/core/unmanaged-api/hosting/getcorrequiredversion-function.md +++ b/docs/core/unmanaged-api/hosting/getcorrequiredversion-function.md @@ -45,7 +45,7 @@ HRESULT GetCORRequiredVersion ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getcorsystemdirectory-function.md b/docs/core/unmanaged-api/hosting/getcorsystemdirectory-function.md index aa0764b6f331d..ed97b58bf1d6c 100644 --- a/docs/core/unmanaged-api/hosting/getcorsystemdirectory-function.md +++ b/docs/core/unmanaged-api/hosting/getcorsystemdirectory-function.md @@ -51,7 +51,7 @@ HRESULT GetCORSystemDirectory ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getcorversion-function.md b/docs/core/unmanaged-api/hosting/getcorversion-function.md index ba95b85c1917e..eb846f2763a69 100644 --- a/docs/core/unmanaged-api/hosting/getcorversion-function.md +++ b/docs/core/unmanaged-api/hosting/getcorversion-function.md @@ -45,7 +45,7 @@ HRESULT GetCORVersion ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getfileversion-function.md b/docs/core/unmanaged-api/hosting/getfileversion-function.md index efe13b554a702..e04e543ae38c7 100644 --- a/docs/core/unmanaged-api/hosting/getfileversion-function.md +++ b/docs/core/unmanaged-api/hosting/getfileversion-function.md @@ -49,7 +49,7 @@ HRESULT GetFileVersion ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getrealprocaddress-function.md b/docs/core/unmanaged-api/hosting/getrealprocaddress-function.md index f16272a5f20f7..e1f300147c2bf 100644 --- a/docs/core/unmanaged-api/hosting/getrealprocaddress-function.md +++ b/docs/core/unmanaged-api/hosting/getrealprocaddress-function.md @@ -51,7 +51,7 @@ HRESULT GetRealProcAddress ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md b/docs/core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md index e64dca6a1caa7..9b9afa6401d56 100644 --- a/docs/core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md +++ b/docs/core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md @@ -113,7 +113,7 @@ HRESULT GetRequestedRuntimeInfo ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getrequestedruntimeversion-function.md b/docs/core/unmanaged-api/hosting/getrequestedruntimeversion-function.md index c7b5d658929b0..a32bce3fc7b5c 100644 --- a/docs/core/unmanaged-api/hosting/getrequestedruntimeversion-function.md +++ b/docs/core/unmanaged-api/hosting/getrequestedruntimeversion-function.md @@ -60,7 +60,7 @@ HRESULT GetRequestedRuntimeVersion ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md b/docs/core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md index 4e67d4b296433..d92a83793d342 100644 --- a/docs/core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md +++ b/docs/core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md @@ -67,7 +67,7 @@ HRESULT GetRequestedRuntimeVersionForCLSID ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getversionfromprocess-function.md b/docs/core/unmanaged-api/hosting/getversionfromprocess-function.md index e8017118e0f8c..f5f7e85f51775 100644 --- a/docs/core/unmanaged-api/hosting/getversionfromprocess-function.md +++ b/docs/core/unmanaged-api/hosting/getversionfromprocess-function.md @@ -61,7 +61,7 @@ HRESULT GetVersionFromProcess ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/host-type-enumeration.md b/docs/core/unmanaged-api/hosting/host-type-enumeration.md index cfc37602999e4..c0a77fcbed2d9 100644 --- a/docs/core/unmanaged-api/hosting/host-type-enumeration.md +++ b/docs/core/unmanaged-api/hosting/host-type-enumeration.md @@ -40,7 +40,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md b/docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md index d561aa6491dd1..a67faeb12a0bc 100644 --- a/docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md +++ b/docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md @@ -28,7 +28,7 @@ Provides the [IActionOnCLREvent::OnEvent](iactiononclrevent-onevent-method.md) m ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md b/docs/core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md index 9e3b79aec5fc0..a0682ff97f152 100644 --- a/docs/core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md +++ b/docs/core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md @@ -57,7 +57,7 @@ HRESULT OnEvent ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md b/docs/core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md index 9b2bb438e0619..b2961cf493a42 100644 --- a/docs/core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md +++ b/docs/core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md @@ -40,7 +40,7 @@ HRESULT _stdcall DoCallback( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md b/docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md index aad076cf6935a..3f3837394a1d1 100644 --- a/docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md +++ b/docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md @@ -28,7 +28,7 @@ Provides methods for making callbacks within an apartment. An *apartment* is a l ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md b/docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md index d3dff2a5f6ff8..5bd26b5d471ae 100644 --- a/docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md +++ b/docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md @@ -28,7 +28,7 @@ Provides a method that is called by the common language runtime (CLR) to notify ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md b/docs/core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md index aec068edee838..769c40a668656 100644 --- a/docs/core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md +++ b/docs/core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md @@ -36,7 +36,7 @@ HRESULT OnAppDomain ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md b/docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md index e17214786a651..26bb0cd01b072 100644 --- a/docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md +++ b/docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md @@ -43,7 +43,7 @@ Provides properties that allow the host to configure an GetStats(&GCStats); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md index 3ab4b9296c9f0..be8d2f3d8fa72 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md @@ -37,7 +37,7 @@ Provides methods that allow a host to interact with the common language runtime' ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md b/docs/core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md index 10110a7db801f..96bc8471c8846 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md +++ b/docs/core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md @@ -62,7 +62,7 @@ HRESULT SetGCStartupLimits ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md b/docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md index e4e2849e04bf0..bc29aba99ac7d 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md @@ -34,7 +34,7 @@ Provides methods that allow a host to interact with the common language runtime' ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md b/docs/core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md index 5fc8c3289fe71..fbab6f84ee739 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md +++ b/docs/core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md @@ -61,7 +61,7 @@ HRESULT SetGCStartupLimitsEx ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md index 6b8a320823756..cd5130e5518fc 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md +++ b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md @@ -73,7 +73,7 @@ HRESULT EvaluatePolicy ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md index 3bb60d4fc2a65..aae9276d1ab07 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md @@ -29,7 +29,7 @@ Provides methods for the host to evaluate current binding policy and communicate ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md index 5cd62a0ef9a76..86ce63f099249 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md +++ b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md @@ -77,7 +77,7 @@ HRESULT ModifyApplicationPolicy ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md index 61474bc4703df..6566b99ef65a7 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md @@ -29,7 +29,7 @@ Enables the host to block specific managed classes, methods, properties, and fie ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md index 71a81297ae195..a5d5f105ac3fa 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md +++ b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md @@ -40,7 +40,7 @@ HRESULT SetEagerSerializeGrantSets (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md index b8cac3ec4e955..9499cfff680c5 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md +++ b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md @@ -51,7 +51,7 @@ HRESULT SetProtectedCategories ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclriocompletionmanager-interface.md b/docs/core/unmanaged-api/hosting/iclriocompletionmanager-interface.md index 15bd3f1eb6279..3687d9609d8d3 100644 --- a/docs/core/unmanaged-api/hosting/iclriocompletionmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclriocompletionmanager-interface.md @@ -32,7 +32,7 @@ Implements a callback method that allows the host to notify the common language ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md b/docs/core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md index af2c0a3ecab11..aa43d54728308 100644 --- a/docs/core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md +++ b/docs/core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md @@ -65,7 +65,7 @@ HRESULT OnComplete ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md b/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md index 6996e1bfc7463..a02bb8747ce9b 100644 --- a/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md @@ -32,7 +32,7 @@ Allows the host to report memory pressure conditions using an approach similar t ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md b/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md index 51d79b17f9d40..0443bfb0b40df 100644 --- a/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md @@ -54,7 +54,7 @@ HRESULT OnMemoryNotification ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md index c1fdd61cd562b..5a53a9fb04ea5 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md @@ -44,7 +44,7 @@ HRESULT EnumerateInstalledRuntimes ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md index 3c28f3added67..4dc5b5cca59bc 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md @@ -53,7 +53,7 @@ HRESULT EnumerateLoadedRuntimes ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md index db592835796be..4cc6b83cf6c7d 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md @@ -41,7 +41,7 @@ HRESULT ExitProcess ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md index 14fc6d0f794a2..b800274c1978b 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md @@ -62,7 +62,7 @@ HRESULT GetRuntime ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md index b7bc2d9252ce5..8f8b80c4a54fa 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md @@ -59,7 +59,7 @@ HRESULT GetVersionFromFile ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-interface.md b/docs/core/unmanaged-api/hosting/iclrmetahost-interface.md index e6c37a4eea03b..575074dc79f07 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-interface.md @@ -44,7 +44,7 @@ HRESULT hr = CLRCreateInstance(CLSID_CLRMetaHost, ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md index 2c1e677ca343e..adfd91bdcc646 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md @@ -51,7 +51,7 @@ HRESULT QueryLegacyV2RuntimeBinding ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md index 725858644d00f..a20d3289c93ad 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md @@ -88,7 +88,7 @@ typedef void (__stdcall *RuntimeLoadedCallbackFnPtr)( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md b/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md index 2e00238de2499..a63682e7c56ee 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md @@ -79,7 +79,7 @@ This method returns the following specific HRESULTs as well as HRESULT errors th ## Requirements -**Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md b/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md index 607f8935dbc60..0e2d08fe1412f 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md @@ -43,7 +43,7 @@ HRESULT hr = CLRCreateInstance(CLSID_CLRMetaHostPolicy, ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md b/docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md index e227d8b504009..996705d5fb4ea 100644 --- a/docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md @@ -36,7 +36,7 @@ Provides methods that allow the host to register and unregister callbacks for co ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md b/docs/core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md index 3ff0289acfc8f..33012ca126cd9 100644 --- a/docs/core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md +++ b/docs/core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md @@ -58,7 +58,7 @@ HRESULT RegisterActionOnEvent ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md b/docs/core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md index 6c62e8d3efff5..76ab4f9f96523 100644 --- a/docs/core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md +++ b/docs/core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md @@ -51,7 +51,7 @@ HRESULT UnregisterActionOnEvent ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md index 42f4468f68664..be5a0c91486be 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md @@ -33,7 +33,7 @@ Provides methods that allow the host to specify policy actions to be taken in th ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md index 5edfb85592840..79db8f788eaf6 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md @@ -69,7 +69,7 @@ HRESULT SetActionOnFailure ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md index d6a80c9307933..536d2b6513a84 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md @@ -72,7 +72,7 @@ HRESULT SetActionOnTimeout ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md index 25aeaee5e1901..97b53ad860383 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md @@ -65,7 +65,7 @@ HRESULT SetDefaultAction ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md index d412cbf5afcb3..21887ddf0d6a8 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md @@ -60,7 +60,7 @@ HRESULT SetTimeout ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md index 8c054b95730b8..0a2e9a03e2615 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md @@ -71,7 +71,7 @@ HRESULT SetTimeoutAndAction ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md index 2851ceb27ea0d..a3b2fc6620cfb 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md @@ -51,7 +51,7 @@ HRESULT SetUnhandledExceptionPolicy ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md b/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md index be5edfed570e5..102bbea7e8ea3 100644 --- a/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md +++ b/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md @@ -63,7 +63,7 @@ HRESULT Get ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md b/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md index 56606a455ed21..f3d5b27ef8a0e 100644 --- a/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md @@ -32,7 +32,7 @@ Provides methods that enable the host to get the probing identities of an assemb ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md b/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md index 02347831abc00..d70dbdb2ab5e6 100644 --- a/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md +++ b/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md @@ -61,7 +61,7 @@ HRESULT Get ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md b/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md index f6b5c527f846c..d758111d920a3 100644 --- a/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md @@ -28,7 +28,7 @@ Provides methods that allow the host to manipulate the set of assemblies referen ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md index 6e42a9e8db874..75aeb034b2bfc 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md @@ -76,7 +76,7 @@ HRESULT ExecuteApplication( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md index b7b527ad79e4b..50cd51d8dbb38 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md @@ -59,7 +59,7 @@ HRESULT ExecuteInAppDomain( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md index a3d0384e881ef..8867c47808b7c 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md @@ -73,7 +73,7 @@ static int pwzMethodName (String pwzArgument) ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md index 51e7ae5e1c3a6..d4a05cf0a8e0e 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md @@ -52,7 +52,7 @@ HRESULT GetCLRControl( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md index 8abd97ae15344..8bb6c6dc3b4db 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md @@ -51,7 +51,7 @@ HRESULT GetCurrentAppDomainId( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md index 0ee7347364d6c..c83b10b064391 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md @@ -47,7 +47,7 @@ Provides functionality similar to that of the [ICorRuntimeHost](icorruntimehost- ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md index d72c77fc1270e..96c494c79f016 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md @@ -52,7 +52,7 @@ HRESULT SetHostControl( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md index 232a272d8c576..e78045115f33b 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md @@ -44,7 +44,7 @@ HRESULT Start(); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md index c14f7220f4bc9..2b6da40dcf86b 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md @@ -43,7 +43,7 @@ HRESULT Stop(); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md index 7e14e2c9b56c5..9306ee55a4f9f 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md @@ -55,7 +55,7 @@ HRESULT UnloadAppDomain( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md index 8e6b81a1d7d9b..15e4d10aa0221 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md @@ -42,7 +42,7 @@ HRESULT BindAsLegacyV2Runtime (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md index c550e54ef15da..8b54c5286625a 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md @@ -55,7 +55,7 @@ HRESULT GetDefaultStartupFlags( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md index 4d687dec347af..12b40977d7959 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md @@ -72,7 +72,7 @@ HRESULT GetInterface( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md index d616e877ca34d..fb51b4f4d6761 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md @@ -55,7 +55,7 @@ HRESULT GetProcAddress( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md index b3c2dfdd69221..c9cc3d9b9eac6 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md @@ -52,7 +52,7 @@ HRESULT GetRuntimeDirectory( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md index 9dc9ef6b434ce..df4213bbc7252 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md @@ -59,7 +59,7 @@ HRESULT GetVersionString( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md index 7e669b8df1ab2..5b856bc06c821 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md @@ -39,7 +39,7 @@ Provides methods that return information about a specific common language runtim ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md index cb7b99ad79d29..6461c6f694004 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md @@ -50,7 +50,7 @@ HRESULT IsLoadable( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md index 1e82761255d1d..96deff837326d 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md @@ -62,7 +62,7 @@ HRESULT IsLoaded( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md index 48a2113b4f4ce..9374c1f72eb96 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md @@ -50,7 +50,7 @@ HRESULT IsStarted( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md index 80a66807ff591..5bceda98a75b0 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md @@ -63,7 +63,7 @@ HRESULT LoadErrorString( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md index 0ff80511920d7..0efe681335b4c 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md @@ -55,7 +55,7 @@ HRESULT LoadLibrary( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md index fbcb8a1daee4a..d28c12d2ccd13 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md @@ -51,7 +51,7 @@ HRESULT SetDefaultStartupFlags( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md index 91bd5c0f172b1..2047b002e06a4 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md @@ -56,7 +56,7 @@ HRESULT GetHashFromAssemblyFile ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md index a8664014a16f4..ae2ad085e685e 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md @@ -56,7 +56,7 @@ HRESULT GetHashFromAssemblyFileW ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md index ef9bcb0277494..05f434293adf8 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md @@ -60,7 +60,7 @@ HRESULT GetHashFromBlob ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md index 2118945ee4c42..e6b41578fa587 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md @@ -60,7 +60,7 @@ HRESULT GetHashFromFile ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md index 1d4f868a77102..1128d20713df0 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md @@ -60,7 +60,7 @@ HRESULT GetHashFromFileW ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md index d1b9f8761c382..3b3d30a4bd5f9 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md @@ -57,7 +57,7 @@ HRESULT GetHashFromHandle ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-interface.md b/docs/core/unmanaged-api/hosting/iclrstrongname-interface.md index d41dc00106d30..d68da4fe6fbae 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-interface.md @@ -56,7 +56,7 @@ Provides basic global static functions for signing assemblies with strong names. ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md index 550876980e8a3..c8f11c2866986 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md @@ -54,7 +54,7 @@ HRESULT StrongNameCompareAssemblies ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md index f214f82aab181..fcdf9bdd7f0ad 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md @@ -40,7 +40,7 @@ HRESULT StrongNameFreeBuffer ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md index 9d96a6b45342c..1a5109321885a 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md @@ -49,7 +49,7 @@ HRESULT StrongNameGetBlob ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md index 559253c72ce0d..fb689fb1fd8e3 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md @@ -52,7 +52,7 @@ HRESULT StrongNameGetBlobFromImage ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md index 6f67ad578c14d..c4b59ec3cfbc9 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md @@ -64,7 +64,7 @@ HRESULT StrongNameGetPublicKey ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md index 0ccceaa31784f..9984e465a34c8 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md @@ -44,7 +44,7 @@ HRESULT StrongNameHashSize ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md index 47a490d7a2ce1..631c6c7ded595 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md @@ -44,7 +44,7 @@ HRESULT StrongNameKeyDelete ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md index 9f1e1378c409a..6080781ead7fc 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md @@ -60,7 +60,7 @@ HRESULT StrongNameKeyGen ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md index 3bb0eec1a678d..e2c409b39be86 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md @@ -66,7 +66,7 @@ HRESULT StrongNameKeyGenEx ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md index 098e4a47670ef..5fbb4699eb474 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md @@ -52,7 +52,7 @@ HRESULT StrongNameKeyInstall ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md index 86d3592b067d2..e41e582fe3192 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md @@ -74,7 +74,7 @@ HRESULT StrongNameSignatureGeneration ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md index fec6599668aa2..dc0dc5950d0a7 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md @@ -84,7 +84,7 @@ HRESULT StrongNameSignatureGenerationEx ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md index 398bf9cb14fc4..6f9a40b69c396 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md @@ -48,7 +48,7 @@ HRESULT StrongNameSignatureSize ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md index c65fed0c80b5a..0c9d77208fc0d 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md @@ -62,7 +62,7 @@ HRESULT StrongNameSignatureVerification ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md index 5f71f9d72bf44..5d603408787d0 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md @@ -52,7 +52,7 @@ HRESULT StrongNameSignatureVerificationEx ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md index 02663afceae6f..8ae1f94e8eb33 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md @@ -66,7 +66,7 @@ HRESULT StrongNameSignatureVerificationFromImage ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md index 4311054642e12..6e99ff554db64 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md @@ -54,7 +54,7 @@ HRESULT StrongNameTokenFromAssembly ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md index 3bde0c586d1f6..44ff24c532941 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md @@ -62,7 +62,7 @@ HRESULT StrongNameTokenFromAssemblyEx ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md index 9127a37d2c35d..b748421a9c17a 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md @@ -56,7 +56,7 @@ HRESULT StrongNameTokenFromPublicKey ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md b/docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md index 54b4150f7c422..1d4abd8c5dfd8 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md @@ -31,7 +31,7 @@ Provides the ability to create strong names using the SHA-2 group of Secure Hash ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md index 833567b8c226f..18511565c996f 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md +++ b/docs/core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md @@ -63,7 +63,7 @@ HRESULT CreateRWLockOwnerIterator ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md index 2c6b3b61b1db6..fd5aa6bd85d64 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md +++ b/docs/core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md @@ -51,7 +51,7 @@ HRESULT DeleteRWLockOwnerIterator ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md index 3f2e86668ccda..163aa37163ea4 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md +++ b/docs/core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md @@ -60,7 +60,7 @@ HRESULT GetMonitorOwner ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md index e469ad560c28b..5cdad714dc563 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md +++ b/docs/core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md @@ -58,7 +58,7 @@ HRESULT GetRWLockOwnerNext ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md index 16970c0e8277c..96ab0274d2e0b 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md @@ -31,7 +31,7 @@ Defines methods that allow the host to get information about requested tasks and ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-abort-method.md b/docs/core/unmanaged-api/hosting/iclrtask-abort-method.md index 10e3ee10a02c0..2534ab069341a 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-abort-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-abort-method.md @@ -44,7 +44,7 @@ HRESULT Abort (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md b/docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md index 2514fc0e88df1..8332ebe28d64e 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md @@ -44,7 +44,7 @@ HRESULT ExitTask (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md b/docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md index cf5e7edd7479c..bedcf284336ed 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md @@ -47,7 +47,7 @@ HRESULT GetMemStats ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-interface.md b/docs/core/unmanaged-api/hosting/iclrtask-interface.md index c753bec92f492..72ae2c2451725 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-interface.md @@ -44,7 +44,7 @@ Provides methods that allow the host to make requests of the common language run ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md b/docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md index c8f30a3ae6c52..082b7ff6a2c49 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md @@ -47,7 +47,7 @@ HRESULT LocksHeld ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md b/docs/core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md index f892bcd1ef75a..866a86e382a58 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md @@ -51,7 +51,7 @@ HRESULT NeedsPriorityScheduling ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-reset-method.md b/docs/core/unmanaged-api/hosting/iclrtask-reset-method.md index 3eb71ea328e05..cb27d63b4c5bb 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-reset-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-reset-method.md @@ -67,7 +67,7 @@ HRESULT Reset ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md b/docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md index e75646ddc0dbd..ea1b5de8dc349 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md @@ -44,7 +44,7 @@ HRESULT RudeAbort (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md b/docs/core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md index c45ea26eeae04..d37cf0fffb788 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md @@ -51,7 +51,7 @@ HRESULT SetTaskIdentifier ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md b/docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md index 506774ae2e696..b5355c776a696 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md @@ -55,7 +55,7 @@ HRESULT SwitchIn ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md b/docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md index 2733d00466ee3..c1e3fa8ca3ccb 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md @@ -44,7 +44,7 @@ HRESULT SwitchOut (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md b/docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md index 41690ca9346c9..5ca3c84298b3e 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md @@ -44,7 +44,7 @@ HRESULT YieldTask (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md b/docs/core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md index b5c07dd39e796..46d865fed2e23 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md @@ -48,7 +48,7 @@ HRESULT BeginPreventAsyncAbort(); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md b/docs/core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md index 2105a30eeb277..6db16098d1113 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md @@ -46,7 +46,7 @@ HRESULT EndPreventAsyncAbort(); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask2-interface.md b/docs/core/unmanaged-api/hosting/iclrtask2-interface.md index a185a1d784e30..68cb2ded64841 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask2-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrtask2-interface.md @@ -41,7 +41,7 @@ Provides all the functionality of the [ICLRTask](iclrtask-interface.md) interfac ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md index 3c84e88e69a9d..7bba8c7847055 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md @@ -57,7 +57,7 @@ HRESULT CreateTask ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md index f2fef63347312..641e5d6865d23 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md @@ -51,7 +51,7 @@ HRESULT GetCurrentTask ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md index 1ce8a5e1c5f83..834e061ba4fa6 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md @@ -36,7 +36,7 @@ HRESULT GetCurrentTaskType( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md index 4ad3b3582644c..fd08d04ced97a 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md @@ -36,7 +36,7 @@ Provides methods that allow the host to request explicitly that the common langu ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md index d7d447ad7f191..a1dadf06a767e 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md @@ -51,7 +51,7 @@ HRESULT SetLocale ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md index a59e0c6b31201..e66dd64441800 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md @@ -51,7 +51,7 @@ HRESULT SetUILocale ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md b/docs/core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md index 8e52f82fa163b..d0be0cf7f2e6a 100644 --- a/docs/core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md +++ b/docs/core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md @@ -63,7 +63,7 @@ HRESULT FormatEventInfo ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h diff --git a/docs/core/unmanaged-api/hosting/iclrvalidator-interface.md b/docs/core/unmanaged-api/hosting/iclrvalidator-interface.md index fdd4a8f092bb1..bd8152aefa9f1 100644 --- a/docs/core/unmanaged-api/hosting/iclrvalidator-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrvalidator-interface.md @@ -29,7 +29,7 @@ Provides methods for validating portable executable (PE) images and reporting va ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h diff --git a/docs/core/unmanaged-api/hosting/iclrvalidator-validate-method.md b/docs/core/unmanaged-api/hosting/iclrvalidator-validate-method.md index 0cb59bf16c4f8..39d871b33b3fc 100644 --- a/docs/core/unmanaged-api/hosting/iclrvalidator-validate-method.md +++ b/docs/core/unmanaged-api/hosting/iclrvalidator-validate-method.md @@ -75,7 +75,7 @@ HRESULT Validate ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md b/docs/core/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md index 70e001a4c4994..50f54de90e688 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md +++ b/docs/core/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md @@ -40,7 +40,7 @@ HRESULT AddDebuggerSpecialThread ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-interface.md b/docs/core/unmanaged-api/hosting/icorconfiguration-interface.md index ba3d257af776e..b23b63ef6271b 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-interface.md +++ b/docs/core/unmanaged-api/hosting/icorconfiguration-interface.md @@ -31,7 +31,7 @@ Provides methods for configuring the common language runtime (CLR). ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md b/docs/core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md index 3caa66502b631..4689905a95189 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md +++ b/docs/core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md @@ -36,7 +36,7 @@ HRESULT SetDebuggerThreadControl ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md b/docs/core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md index 8045bbaacc788..246bd18e50ed0 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md +++ b/docs/core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md @@ -36,7 +36,7 @@ HRESULT SetGCHostControl ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md b/docs/core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md index b837e37a12ecf..c576147ba6322 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md +++ b/docs/core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md @@ -40,7 +40,7 @@ HRESULT SetGCThreadControl ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md index 66137c8d3d168..a1a138909cb91 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md @@ -45,7 +45,7 @@ HRESULT CloseEnum ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md index 9c6df3bb8473d..6f1cbdc4a9c05 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md @@ -53,7 +53,7 @@ HRESULT CreateDomain ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md index d941fe77f60c7..69dafdc74d2c1 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md @@ -61,7 +61,7 @@ HRESULT CreateDomainEx ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md index 8ec26aadc975e..d22d8e695252f 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md @@ -49,7 +49,7 @@ HRESULT CreateDomainSetup ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md index 7706bed14c501..a74289863f1d1 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md @@ -49,7 +49,7 @@ HRESULT CreateEvidence ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md index d2b008eab5bb1..37503f58c27bd 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md @@ -29,7 +29,7 @@ HRESULT CreateLogicalThreadState ( ); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md index ef96c7e480660..5fe57c7b6dc95 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md @@ -45,7 +45,7 @@ HRESULT CurrentDomain ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md index 836c7ac0e5162..cb9894844afda 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md @@ -29,7 +29,7 @@ HRESULT DeleteLogicalThreadState ( ); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md index 8e8499a666f16..0e8071a8b8e49 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md @@ -45,7 +45,7 @@ HRESULT EnumDomains ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md index 9e12d52673347..847fb3a85be9c 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md @@ -40,7 +40,7 @@ HRESULT GetConfiguration( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md index 17b89fbcc1694..03d28310ece49 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md @@ -47,7 +47,7 @@ HRESULT GetDefaultDomain ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-interface.md b/docs/core/unmanaged-api/hosting/icorruntimehost-interface.md index 8cf70229ab95b..31830fd645253 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-interface.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-interface.md @@ -48,7 +48,7 @@ Provides methods that enable the host to start and stop the common language runt ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md index 870df2039e35d..e473d1dd57e19 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md @@ -38,7 +38,7 @@ HRESULT LocksHeldByLogicalThread( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md index e1f299ba03d1c..dee9ae89e3e1d 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md @@ -40,7 +40,7 @@ HRESULT MapFile( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md index 9ab4ebd86b476..e1b91a76fa694 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md @@ -49,7 +49,7 @@ HRESULT NextDomain ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md index d095c5bcbbca3..f8a7d3b7e4768 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md @@ -42,7 +42,7 @@ HRESULT Start (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md index 917a2c1d0b14c..abe49a62a658c 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md @@ -45,7 +45,7 @@ HRESULT Stop (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md index f074610cc5ac6..8bb55520e6f34 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md @@ -36,7 +36,7 @@ HRESULT SwitchInLogicalThreadState( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md index 6a31090a464d3..694eceb405b17 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md @@ -36,7 +36,7 @@ HRESULT SwitchOutLogicalThreadState( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md index e7f33f213c2bc..f617294881c1b 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md @@ -45,7 +45,7 @@ HRESULT UnloadDomain ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md index 1005b0d61361f..d3f517786af52 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md @@ -32,7 +32,7 @@ HRESULT CorBindIoCompletionCallback ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md index 756a07df3d457..a250991cbc945 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md @@ -33,7 +33,7 @@ HRESULT CorCallOrQueueUserWorkItem ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md index cd2340b66237c..14d5ee547571d 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md @@ -34,7 +34,7 @@ HRESULT CorChangeTimer ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md index 7fa6866e596fa..93197f603bba0 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md @@ -36,7 +36,7 @@ HRESULT CorCreateTimer ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md index 9354888a566d7..658d02e8a89b5 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md @@ -33,7 +33,7 @@ HRESULT CorDeleteTimer ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md index 7f5fabc8e948d..4c2812842af30 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md @@ -32,7 +32,7 @@ HRESULT CorGetAvailableThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md index a7f4c87890386..04f32597d54da 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md @@ -32,7 +32,7 @@ HRESULT CorGetMaxThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md index d2bbdc30794b2..abb075ca00908 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md @@ -34,7 +34,7 @@ HRESULT CorQueueUserWorkItem ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md index 795161956073a..40277449b8abb 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md @@ -37,7 +37,7 @@ HRESULT CorRegisterWaitForSingleObject ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md index 8b96c87dbffd8..5bffa3411f900 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md @@ -32,7 +32,7 @@ HRESULT CorSetMaxThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md index 2a66bc7581533..50c0bc0cac3ff 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md @@ -33,7 +33,7 @@ HRESULT CorUnregisterWait ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-interface.md b/docs/core/unmanaged-api/hosting/icorthreadpool-interface.md index c7978f641f42b..552a0b8099bcc 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-interface.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-interface.md @@ -41,7 +41,7 @@ Provides methods for accessing the thread pool. ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md b/docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md index 0a3de5acbd139..ec0c9275d5e1d 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md +++ b/docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md @@ -28,7 +28,7 @@ Provides methods for obtaining information about the state of the debugging serv ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md b/docs/core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md index 3d6ba659f5e30..9c54d041293ef 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md +++ b/docs/core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md @@ -36,7 +36,7 @@ HRESULT IsDebuggerAttached ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md index 0ef73b678db91..7d8c0e0a46b29 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md +++ b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md @@ -30,7 +30,7 @@ Provides methods for notifying the host about the blocking and unblocking of thr ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md index fd66be8fba876..4c2dbb5d72570 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md +++ b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md @@ -33,7 +33,7 @@ HRESULT ReleaseAllRuntimeThreads ( ); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md index faf825801874b..b50596b9dacc1 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md +++ b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md @@ -40,7 +40,7 @@ HRESULT StartBlockingForDebugger ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md index 93014decc2dcc..52cd6b8a92368 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md +++ b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md @@ -35,7 +35,7 @@ HRESULT ThreadIsBlockingForDebugger ( ); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/igchost-collect-method.md b/docs/core/unmanaged-api/hosting/igchost-collect-method.md index 3628721848af6..5753a24de2a90 100644 --- a/docs/core/unmanaged-api/hosting/igchost-collect-method.md +++ b/docs/core/unmanaged-api/hosting/igchost-collect-method.md @@ -36,7 +36,7 @@ HRESULT Collect ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchost-getstats-method.md b/docs/core/unmanaged-api/hosting/igchost-getstats-method.md index 61ca28a612ce6..2e19cae7fbed6 100644 --- a/docs/core/unmanaged-api/hosting/igchost-getstats-method.md +++ b/docs/core/unmanaged-api/hosting/igchost-getstats-method.md @@ -40,7 +40,7 @@ HRESULT GetStats ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchost-getthreadstats-method.md b/docs/core/unmanaged-api/hosting/igchost-getthreadstats-method.md index 8ce0c8bceaff0..b56df99293447 100644 --- a/docs/core/unmanaged-api/hosting/igchost-getthreadstats-method.md +++ b/docs/core/unmanaged-api/hosting/igchost-getthreadstats-method.md @@ -40,7 +40,7 @@ HRESULT GetThreadStats ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchost-interface.md b/docs/core/unmanaged-api/hosting/igchost-interface.md index f9fc368f8bf77..5e69012ad79ae 100644 --- a/docs/core/unmanaged-api/hosting/igchost-interface.md +++ b/docs/core/unmanaged-api/hosting/igchost-interface.md @@ -38,7 +38,7 @@ Provides methods for obtaining information about the garbage collection system a ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md b/docs/core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md index 84aef10899247..0d539b77c1036 100644 --- a/docs/core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md +++ b/docs/core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md @@ -47,7 +47,7 @@ HRESULT SetGCStartupLimits ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md b/docs/core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md index 3e6e7cf8e80de..aaec71cea5f2d 100644 --- a/docs/core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md +++ b/docs/core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md @@ -40,7 +40,7 @@ HRESULT SetVirtualMemLimit ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchost2-interface.md b/docs/core/unmanaged-api/hosting/igchost2-interface.md index 6867aba88ffc8..80de0ba8a7796 100644 --- a/docs/core/unmanaged-api/hosting/igchost2-interface.md +++ b/docs/core/unmanaged-api/hosting/igchost2-interface.md @@ -31,7 +31,7 @@ Provides methods for obtaining information about the garbage collection system a ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md b/docs/core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md index 57e9a83dfba79..07deb6b7e8779 100644 --- a/docs/core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md +++ b/docs/core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md @@ -44,7 +44,7 @@ HRESULT SetGCStartupLimitsEx ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchostcontrol-interface.md b/docs/core/unmanaged-api/hosting/igchostcontrol-interface.md index faaae2924c5b0..d5e6f75f9deeb 100644 --- a/docs/core/unmanaged-api/hosting/igchostcontrol-interface.md +++ b/docs/core/unmanaged-api/hosting/igchostcontrol-interface.md @@ -28,7 +28,7 @@ Provides a method that allows the garbage collector to request the host to chang ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md b/docs/core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md index 34edd78a77065..4bb6b95a96fe8 100644 --- a/docs/core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md +++ b/docs/core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md @@ -40,7 +40,7 @@ HRESULT RequestVirtualMemLimit ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md b/docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md index 82c1464940513..3f35dc2417b73 100644 --- a/docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md +++ b/docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md @@ -30,7 +30,7 @@ Provides methods for participating in the scheduling of threads that would other ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md b/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md index 1fdb754bdabb1..02bf926d5e2b2 100644 --- a/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md +++ b/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md @@ -40,7 +40,7 @@ HRESULT SuspensionEnding ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md b/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md index 9652f561101bd..4a963d4adbf47 100644 --- a/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md +++ b/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md @@ -33,7 +33,7 @@ HRESULT SuspensionStarting ( ); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md b/docs/core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md index a632e936da4bd..86964e0846de8 100644 --- a/docs/core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md +++ b/docs/core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md @@ -33,7 +33,7 @@ HRESULT ThreadIsBlockingForSuspension ( ); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md b/docs/core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md index 802e258e96755..3c0797d9e4f85 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md @@ -55,7 +55,7 @@ HRESULT GetAssemblyStore ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md b/docs/core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md index 0d8d9467b4479..7deb389c213d0 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md @@ -65,7 +65,7 @@ HRESULT GetNonHostStoreAssemblies ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostassemblymanager-interface.md b/docs/core/unmanaged-api/hosting/ihostassemblymanager-interface.md index 61c4d5793375d..ac98dc0183342 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblymanager-interface.md @@ -35,7 +35,7 @@ Provides methods that allow a host to specify sets of assemblies that should be ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md b/docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md index 598821965aa71..cb22db706dd58 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md @@ -41,7 +41,7 @@ Provides methods that allow a host to load assemblies and modules independently ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md b/docs/core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md index d4cf6ace0818c..4e8872aa9ca65 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md @@ -69,7 +69,7 @@ HRESULT ProvideAssembly ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md b/docs/core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md index d542dbb21bfaf..16b9454f43d05 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md @@ -65,7 +65,7 @@ HRESULT ProvideModule ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostautoevent-interface.md b/docs/core/unmanaged-api/hosting/ihostautoevent-interface.md index f04e24e51315d..a042a9aa22c3f 100644 --- a/docs/core/unmanaged-api/hosting/ihostautoevent-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostautoevent-interface.md @@ -29,7 +29,7 @@ Provides a representation of the host's implementation of an auto-reset event. ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md b/docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md index 1c15d56b85073..18971598aaf85 100644 --- a/docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md +++ b/docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md @@ -40,7 +40,7 @@ HRESULT Set (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md b/docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md index 6fb089c532d00..9bfdfb1f6f2e2 100644 --- a/docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md +++ b/docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md @@ -52,7 +52,7 @@ HRESULT Wait ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md b/docs/core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md index 31395d0e51015..0e9b0bb996a85 100644 --- a/docs/core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md @@ -79,7 +79,7 @@ HRESULT GetHostManager ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcontrol-interface.md b/docs/core/unmanaged-api/hosting/ihostcontrol-interface.md index 44861851bb0a4..f5df8acbd3c01 100644 --- a/docs/core/unmanaged-api/hosting/ihostcontrol-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostcontrol-interface.md @@ -29,7 +29,7 @@ Provides methods for configuring the loading of assemblies, and for determining ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md b/docs/core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md index c39c9ccb83b39..01b65be27bf40 100644 --- a/docs/core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md @@ -57,7 +57,7 @@ HRESULT SetAppDomainManager ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md b/docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md index a4158850f9843..737085f53be73 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md @@ -54,7 +54,7 @@ HRESULT Enter ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-interface.md b/docs/core/unmanaged-api/hosting/ihostcrst-interface.md index da88f96bea59a..cebeba28a7d20 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostcrst-interface.md @@ -35,7 +35,7 @@ Serves as the host's representation of a critical section for threading. ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md b/docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md index 2eaa0c2f0eb55..bdfbd923be323 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md @@ -44,7 +44,7 @@ HRESULT Leave (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-setspincount-method.md b/docs/core/unmanaged-api/hosting/ihostcrst-setspincount-method.md index 76c451e4e14ac..647db7b81806d 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-setspincount-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcrst-setspincount-method.md @@ -53,7 +53,7 @@ HRESULT SetSpinCount ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md b/docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md index 84f75b71a736b..8dea91b5edeb7 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md @@ -55,7 +55,7 @@ HRESULT TryEnter ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md b/docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md index ec3accad6b3d8..51fa832d97dc9 100644 --- a/docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md @@ -30,7 +30,7 @@ Provides methods that notify the host of events in the garbage collection mechan ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md b/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md index 7b3b97b1320a8..75a1f8f54cec3 100644 --- a/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md +++ b/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md @@ -54,7 +54,7 @@ HRESULT SuspensionEnding ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md b/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md index 3f7c7d42edf86..d1b830f2ad710 100644 --- a/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md +++ b/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md @@ -47,7 +47,7 @@ HRESULT SuspensionStarting (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md b/docs/core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md index 4617ccf730c11..d2029678e2036 100644 --- a/docs/core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md +++ b/docs/core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md @@ -47,7 +47,7 @@ HRESULT ThreadIsBlockingForSuspension (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md index 9de4119de1db3..2a08451de148d 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md @@ -58,7 +58,7 @@ HRESULT Bind ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md index 3299964862c96..c3e9241edac71 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md @@ -52,7 +52,7 @@ HRESULT CloseIoCompletionPort ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md index 68047f4a86bbe..9a46149bcde9e 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md @@ -52,7 +52,7 @@ HRESULT CreateIoCompletionPort ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md index 5095c4f6717e3..0ebe2f70f843a 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md @@ -52,7 +52,7 @@ HRESULT GetAvailableThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md index 871c556a8f8cf..a8951f3a15e49 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md @@ -61,7 +61,7 @@ HRESULT GetHostOverlappedSize ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md index d8d112d9691fd..5be5540c7e666 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md @@ -52,7 +52,7 @@ HRESULT GetMaxThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md index 87f8d01a4d5fe..e23b883208a1b 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md @@ -52,7 +52,7 @@ HRESULT GetMinThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md index 792b83b342700..ef415ba394832 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md @@ -57,7 +57,7 @@ HRESULT InitializeHostOverlapped ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md index 84f99e648c3bb..fdaadfb142706 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md @@ -42,7 +42,7 @@ Provides methods that allow the common language runtime (CLR) to interact with I ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md index 0598631f7727d..393f997e1e70c 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md @@ -51,7 +51,7 @@ HRESULT SetCLRIoCompletionManager ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md index 87a5abf3330c6..9e4f4e61bce4e 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md @@ -52,7 +52,7 @@ HRESULT SetMaxThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md index f9868fc37b451..ab21194c6465a 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md @@ -52,7 +52,7 @@ HRESULT SetMinThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md b/docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md index 635b4b44c49f4..d305589a6f00b 100644 --- a/docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md @@ -60,7 +60,7 @@ HRESULT Alloc ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md b/docs/core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md index 438bb3ecadc08..66fc7bf156d23 100644 --- a/docs/core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md @@ -68,7 +68,7 @@ HRESULT DebugAlloc ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md b/docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md index 87610bfb8c7d6..ad301a223ba6b 100644 --- a/docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md @@ -52,7 +52,7 @@ HRESULT Free ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmalloc-interface.md b/docs/core/unmanaged-api/hosting/ihostmalloc-interface.md index 2a28bc943d762..9a4c872f566f6 100644 --- a/docs/core/unmanaged-api/hosting/ihostmalloc-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostmalloc-interface.md @@ -34,7 +34,7 @@ Provides methods that allow the common language runtime (CLR) to request fine-gr ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md b/docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md index bffa236ad3a80..34be3b2165562 100644 --- a/docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md @@ -30,7 +30,7 @@ Provides the host's implementation of a representation of a manual reset event. ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmanualevent-reset-method.md b/docs/core/unmanaged-api/hosting/ihostmanualevent-reset-method.md index 62e49ae4606db..a13d7ca464f76 100644 --- a/docs/core/unmanaged-api/hosting/ihostmanualevent-reset-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmanualevent-reset-method.md @@ -40,7 +40,7 @@ HRESULT Reset (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md b/docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md index 4e0b2b5369c33..4e9a46853fa91 100644 --- a/docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md @@ -40,7 +40,7 @@ HRESULT Set (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md b/docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md index 785205a2f938a..7b48312c68a4c 100644 --- a/docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md @@ -52,7 +52,7 @@ HRESULT Wait ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md index 286468b687d08..4e022591bbef7 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md @@ -44,7 +44,7 @@ HRESULT AcquiredVirtualAddressSpace( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md index 98ab3e55941b3..ed0d7f59a5acb 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md @@ -56,7 +56,7 @@ HRESULT CreateMalloc ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md index 3166aea460359..335a08ef9e324 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md @@ -57,7 +57,7 @@ HRESULT GetMemoryLoad ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md index e533c8c8d746d..415920e2e1d97 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md @@ -41,7 +41,7 @@ Provides methods that allow the common language runtime (CLR) to make virtual me ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md index 3b5f359f20264..8be3738e32756 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md @@ -46,7 +46,7 @@ HRESULT NeedsVirtualAddressSpace ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md index 6593d420e5be9..a3d2a0286821e 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md @@ -54,7 +54,7 @@ HRESULT RegisterMemoryNotificationCallback ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md index 9037faff1326e..6f5285570da95 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md @@ -40,7 +40,7 @@ HRESULT ReleasedVirtualAddressSpace( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md index 2bd7934baf921..8b335951aeb8e 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md @@ -74,7 +74,7 @@ HRESULT VirtualAlloc ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md index 50d133708fe27..8416fdfb3abd4 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md @@ -62,7 +62,7 @@ HRESULT VirtualFree ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md index 9e884e7a24a0c..230620ff4f09d 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md @@ -63,7 +63,7 @@ HRESULT VirtualProtect ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md index e4aa8112801b7..e2ddc3fabe15c 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md @@ -66,7 +66,7 @@ HRESULT VirtualQuery ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md b/docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md index 8387e15924440..5e8392acec22f 100644 --- a/docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md @@ -30,7 +30,7 @@ Provides methods that notify the host of the actions the common language runtime ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md b/docs/core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md index 68e299ac06da7..7d4cbecdd09d2 100644 --- a/docs/core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md +++ b/docs/core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md @@ -51,7 +51,7 @@ HRESULT OnDefaultAction ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md b/docs/core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md index 850dd392419ec..2ecb62056a73b 100644 --- a/docs/core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md +++ b/docs/core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md @@ -51,7 +51,7 @@ HRESULT OnFailure( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md b/docs/core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md index f3fc1716dfbef..a9415780e97e3 100644 --- a/docs/core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md +++ b/docs/core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md @@ -51,7 +51,7 @@ HRESULT OnTimeout ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md index 51684c83e37b7..aa0fc94652f99 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md @@ -51,7 +51,7 @@ HRESULT Capture ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritycontext-interface.md b/docs/core/unmanaged-api/hosting/ihostsecuritycontext-interface.md index c78ac4b4c7b1d..f121f5001038a 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritycontext-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritycontext-interface.md @@ -32,7 +32,7 @@ Allows the common language runtime (CLR) to maintain security context informatio ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md index 27541347a4abf..803cc0428a7c2 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md @@ -55,7 +55,7 @@ HRESULT GetSecurityContext ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md index 12f43f7262f14..1f6397f83fbe1 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md @@ -53,7 +53,7 @@ HRESULT ImpersonateLoggedOnUser ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-interface.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-interface.md index 9bf011e6a586d..3cbc016cbbd1f 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-interface.md @@ -47,7 +47,7 @@ Provides methods that allow access to and control over the security context of t ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md index e4ab7786ec7c8..9285dab15305d 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md @@ -61,7 +61,7 @@ HRESULT OpenThreadToken ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md index 7fd614f38cbeb..2d2c789090b7a 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md @@ -44,7 +44,7 @@ HRESULT RevertToSelf (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md index 7ec33e94eb2fb..bc5b1cbb968e7 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md @@ -57,7 +57,7 @@ HRESULT SetSecurityContext ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md index d9f03ce46f6e1..102ead504466a 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md @@ -53,7 +53,7 @@ HRESULT SetThreadToken ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md b/docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md index 2b60cd0da2dc5..7cd2050f9bd0d 100644 --- a/docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md @@ -29,7 +29,7 @@ Represents the host's implementation of a semaphore for threading. ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md b/docs/core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md index 5a58bc01bc6e2..f2fbee541a50c 100644 --- a/docs/core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md @@ -55,7 +55,7 @@ HRESULT ReleaseSemaphore ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md b/docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md index d6cf942f6ff68..641d3ec4846d6 100644 --- a/docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md @@ -52,7 +52,7 @@ HRESULT Wait ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md index 8e010a865c4f6..ae25e6c91f78b 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md @@ -52,7 +52,7 @@ HRESULT CreateAutoEvent ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md index e7eb1e702de0d..1535f811df3e0 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md @@ -52,7 +52,7 @@ HRESULT CreateCrst ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md index e36d29d664f6c..d1ecc569f5213 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md @@ -56,7 +56,7 @@ HRESULT CreateCrstWithSpinCount ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md index 9ede1f1b0addb..d8bf056e11e54 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md @@ -56,7 +56,7 @@ HRESULT CreateManualEvent ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md index 7be050ffcc97c..e0181b1930074 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md @@ -58,7 +58,7 @@ HRESULT CreateMonitorEvent ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md index d42e0f41fbdba..1301dff3ffba0 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md @@ -60,7 +60,7 @@ HRESULT CreateRWLockReaderEvent ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md index 8f28e4b1d7cc7..4b08c4bc683f6 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md @@ -56,7 +56,7 @@ HRESULT CreateRWLockWriterEvent ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md index 9984447582779..d84a86c908345 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md @@ -60,7 +60,7 @@ HRESULT CreateSemaphore ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md index 9dc5917604f0f..fd293a8c97302 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md @@ -40,7 +40,7 @@ Provides methods that allow the common language runtime (CLR) to create synchron ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md index ca82266f7b844..4d6908b397112 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md @@ -51,7 +51,7 @@ HRESULT SetCLRSyncManager ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttask-alert-method.md b/docs/core/unmanaged-api/hosting/ihosttask-alert-method.md index df0a60541bd68..187d952d01f1e 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-alert-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-alert-method.md @@ -47,7 +47,7 @@ HRESULT Alert (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md b/docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md index 84fc51030a3f9..a373b0d381014 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md @@ -51,7 +51,7 @@ HRESULT GetPriority ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttask-interface.md b/docs/core/unmanaged-api/hosting/ihosttask-interface.md index 7b99a79ce2625..e71ec42dc58a2 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-interface.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-interface.md @@ -37,7 +37,7 @@ Provides methods that allow the common language runtime (CLR) to communicate wit ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttask-join-method.md b/docs/core/unmanaged-api/hosting/ihosttask-join-method.md index 0936f35a319cf..8b3278f0e4878 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-join-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-join-method.md @@ -51,7 +51,7 @@ HRESULT Join ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md b/docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md index 328d57a25b874..756aa2e2956df 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md @@ -51,7 +51,7 @@ HRESULT SetCLRTask ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md b/docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md index 469ae34d36058..212e6a1a79827 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md @@ -72,7 +72,7 @@ HRESULT SetPriority ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttask-start-method.md b/docs/core/unmanaged-api/hosting/ihosttask-start-method.md index 95f004e43aa9e..0c2dc5d96c3ad 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-start-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-start-method.md @@ -40,7 +40,7 @@ HRESULT Start (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md index 353cfff76b8d2..5001cee6f18ed 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md @@ -45,7 +45,7 @@ HRESULT BeginDelayAbort (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md index 0ad62b8b29583..8388cd51944f5 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md @@ -44,7 +44,7 @@ HRESULT BeginThreadAffinity (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md index d9568319ea557..22c8d84f65e2e 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md @@ -57,7 +57,7 @@ HRESULT CallNeedsHostHook ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md index e79a52c98292e..fc1dc9c61b648 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md @@ -64,7 +64,7 @@ HRESULT CreateTask ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md index f82abb366afa9..3458a7b9c3ea0 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md @@ -45,7 +45,7 @@ HRESULT EndDelayAbort (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md index 5c20e394559ef..fe98ac95e1753 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md @@ -45,7 +45,7 @@ HRESULT EndThreadAffinity (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md index 929c61233270b..ddb47b6df3cb4 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md @@ -48,7 +48,7 @@ HRESULT EnterRuntime (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md index 12905a8df4ae7..b990f388f5ab2 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md @@ -52,7 +52,7 @@ HRESULT GetCurrentTask ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md index 89fe7ca78083b..5a66f15f7368f 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md @@ -36,7 +36,7 @@ HRESULT GetStackGuarantee( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md index c2ea617479b35..8ac6b37637a0f 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md @@ -49,7 +49,7 @@ Provides methods that allow the common language runtime (CLR) to work with tasks ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md index 4e5714f38bf3e..deb78a5042281 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md @@ -64,7 +64,7 @@ HRESULT LeaveRuntime ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md index 585bd34cfcbdf..904828f8d78ba 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md @@ -48,7 +48,7 @@ HRESULT ReverseEnterRuntime (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md index ce4ab6a568b1e..70b2806f42678 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md @@ -45,7 +45,7 @@ HRESULT ReverseLeaveRuntime (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md index 00c025bf8d727..677c742d38dcc 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md @@ -51,7 +51,7 @@ HRESULT SetCLRTaskManager ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md index b0f1c53b9095e..8dfd2cd6292c8 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md @@ -52,7 +52,7 @@ HRESULT SetLocale ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md index 9b5639c40fd22..afd2f48b739ee 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md @@ -31,7 +31,7 @@ HRESULT SetStackGuarantee( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md index 6498ca8336af6..4efa8242ce8b2 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md @@ -52,7 +52,7 @@ HRESULT SetUILocale ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md index 10d7a966413a6..e61bb8f79da87 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md @@ -55,7 +55,7 @@ HRESULT Sleep ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md index 1dd53d001157f..4129239c8a1c0 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md @@ -54,7 +54,7 @@ HRESULT SwitchToTask ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md index 4d32c4ff1078d..59f82801f4b6d 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md @@ -52,7 +52,7 @@ HRESULT GetAvailableThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md index d5149af2eacac..073050ae589ed 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md @@ -54,7 +54,7 @@ HRESULT GetMaxThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md index 3a8feac1f8683..58d972fe42bb3 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md @@ -52,7 +52,7 @@ HRESULT GetMinThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md index 55f4f89a83b8e..6f373a2fdf2e1 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md @@ -37,7 +37,7 @@ Provides methods that enable the common language runtime (CLR) to configure the ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md index e1e97d40ad497..c4fb6f393af42 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md @@ -59,7 +59,7 @@ HRESULT QueueUserWorkItem ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md index b568ff52f9ae0..1bb7e2ff86a5d 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md @@ -52,7 +52,7 @@ HRESULT SetMaxThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md index 22f942a45b433..7eab1c4d5a734 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md @@ -52,7 +52,7 @@ HRESULT SetMinThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md b/docs/core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md index 9b39b13712235..f6963e10f2c92 100644 --- a/docs/core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md +++ b/docs/core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md @@ -48,7 +48,7 @@ HRESULT GetObjectIdentity ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md b/docs/core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md index 23b337df01959..efb0af1008281 100644 --- a/docs/core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md +++ b/docs/core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md @@ -40,7 +40,7 @@ HRESULT GetSerializedBuffer ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/imanagedobject-interface.md b/docs/core/unmanaged-api/hosting/imanagedobject-interface.md index 8028feef66a08..b9b78791b66c9 100644 --- a/docs/core/unmanaged-api/hosting/imanagedobject-interface.md +++ b/docs/core/unmanaged-api/hosting/imanagedobject-interface.md @@ -29,7 +29,7 @@ Provides methods for controlling a managed object. ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iobjecthandle-interface.md b/docs/core/unmanaged-api/hosting/iobjecthandle-interface.md index ab2b9eca842a0..80a8f008d8e88 100644 --- a/docs/core/unmanaged-api/hosting/iobjecthandle-interface.md +++ b/docs/core/unmanaged-api/hosting/iobjecthandle-interface.md @@ -28,7 +28,7 @@ Provides a method for unwrapping marshal-by-value objects from indirection. ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md b/docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md index 7d03465eb4e78..1bdf599cd1d1b 100644 --- a/docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md +++ b/docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md @@ -36,7 +36,7 @@ HRESULT Unwrap ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-getassemblyname-method.md b/docs/core/unmanaged-api/hosting/itypename-getassemblyname-method.md index 9d867d6265f4b..3c68bbc193c40 100644 --- a/docs/core/unmanaged-api/hosting/itypename-getassemblyname-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-getassemblyname-method.md @@ -31,7 +31,7 @@ HRESULT GetAssemblyName ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-getmodifierlength-method.md b/docs/core/unmanaged-api/hosting/itypename-getmodifierlength-method.md index 9c523ee5de7b4..1524ccbeb540d 100644 --- a/docs/core/unmanaged-api/hosting/itypename-getmodifierlength-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-getmodifierlength-method.md @@ -31,7 +31,7 @@ HRESULT GetModifierLength ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-getmodifiers-method.md b/docs/core/unmanaged-api/hosting/itypename-getmodifiers-method.md index fee42f8abc738..79613e3ee39b7 100644 --- a/docs/core/unmanaged-api/hosting/itypename-getmodifiers-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-getmodifiers-method.md @@ -33,7 +33,7 @@ HRESULT GetModifiers ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-getnamecount-method.md b/docs/core/unmanaged-api/hosting/itypename-getnamecount-method.md index b066130e2fe9c..02b51293ac6b9 100644 --- a/docs/core/unmanaged-api/hosting/itypename-getnamecount-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-getnamecount-method.md @@ -31,7 +31,7 @@ HRESULT GetNameCount ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-getnames-method.md b/docs/core/unmanaged-api/hosting/itypename-getnames-method.md index 0bf4f10a38acb..e64acc1caba3b 100644 --- a/docs/core/unmanaged-api/hosting/itypename-getnames-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-getnames-method.md @@ -33,7 +33,7 @@ HRESULT GetNames ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md b/docs/core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md index 65cce8c3969a4..40a64014375a5 100644 --- a/docs/core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md @@ -31,7 +31,7 @@ HRESULT GetTypeArgumentCount ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-gettypearguments-method.md b/docs/core/unmanaged-api/hosting/itypename-gettypearguments-method.md index 9ea7afdfff224..d645c88bbaccb 100644 --- a/docs/core/unmanaged-api/hosting/itypename-gettypearguments-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-gettypearguments-method.md @@ -33,7 +33,7 @@ HRESULT GetTypeArguments ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-interface.md b/docs/core/unmanaged-api/hosting/itypename-interface.md index 664e231005ec0..b1005a1b21a2c 100644 --- a/docs/core/unmanaged-api/hosting/itypename-interface.md +++ b/docs/core/unmanaged-api/hosting/itypename-interface.md @@ -24,7 +24,7 @@ Provides methods for obtaining type name information. ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md index 4dc81cdd12fbf..116bd56f2365a 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md @@ -31,7 +31,7 @@ HRESULT AddArray ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md index 57ac98b87bce0..ffb8c29f939ee 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md @@ -31,7 +31,7 @@ HRESULT AddAssemblySpec ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md index 76d8f7d10bf66..91616412d95fa 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md @@ -30,7 +30,7 @@ HRESULT AddByRef ( ); ## Requirements -**Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addname-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addname-method.md index 8b176eb5fce2f..c0071c561614c 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addname-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addname-method.md @@ -31,7 +31,7 @@ HRESULT AddName ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md index 1e03944ed0ee8..24b8a98934df1 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md @@ -29,7 +29,7 @@ HRESULT AddPointer ( ); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md index 9c8ce9d69bd8f..e40ad3d27fbd8 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md @@ -29,7 +29,7 @@ HRESULT AddSzArray ( ); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-clear-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-clear-method.md index 94596120e6e81..509b2a3daad80 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-clear-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-clear-method.md @@ -29,7 +29,7 @@ HRESULT Clear ( ); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md index 62ebd63912dff..0cb8facda2a56 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md @@ -29,7 +29,7 @@ HRESULT CloseGenericArgument ( ); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md index 9deae225da514..e321a2f85a977 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md @@ -29,7 +29,7 @@ HRESULT CloseGenericArguments ( ); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md index 05a3498dd7386..2d0644cfe4b4e 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md @@ -24,7 +24,7 @@ Provides methods for building a type name. ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md index 0ea2ba4612ee1..b9fe7620e1441 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md @@ -29,7 +29,7 @@ HRESULT OpenGenericArgument ( ); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md index edfe14d0360bf..224ecc1ed8280 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md @@ -29,7 +29,7 @@ HRESULT OpenGenericArguments ( ); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md index c3c71567cb65a..6875c6dcb3d4a 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md @@ -31,7 +31,7 @@ HRESULT ToString ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md b/docs/core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md index cba5334d8d775..2f779a541c88f 100644 --- a/docs/core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md @@ -31,7 +31,7 @@ HRESULT GetTypeNameBuilder ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamefactory-interface.md b/docs/core/unmanaged-api/hosting/itypenamefactory-interface.md index 590a8b0631d00..9f072c5132059 100644 --- a/docs/core/unmanaged-api/hosting/itypenamefactory-interface.md +++ b/docs/core/unmanaged-api/hosting/itypenamefactory-interface.md @@ -24,7 +24,7 @@ Provides methods for deconstructing a type name. ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md b/docs/core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md index 1697d0c2c8fd7..cb436f9e56a07 100644 --- a/docs/core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md @@ -33,7 +33,7 @@ HRESULT ParseTypeName ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md b/docs/core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md index d11aa6170801b..17bb6b59a2d4a 100644 --- a/docs/core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md +++ b/docs/core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md @@ -52,7 +52,7 @@ HRESULT FormatEventInfo( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h diff --git a/docs/core/unmanaged-api/hosting/ivalidator-interface.md b/docs/core/unmanaged-api/hosting/ivalidator-interface.md index 34e7af7ef7df6..79b962435d657 100644 --- a/docs/core/unmanaged-api/hosting/ivalidator-interface.md +++ b/docs/core/unmanaged-api/hosting/ivalidator-interface.md @@ -29,7 +29,7 @@ Provides methods for validating portable executable (PE) images and reporting va ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h diff --git a/docs/core/unmanaged-api/hosting/ivalidator-validate-method.md b/docs/core/unmanaged-api/hosting/ivalidator-validate-method.md index 178c776391b21..66dc37f0443a3 100644 --- a/docs/core/unmanaged-api/hosting/ivalidator-validate-method.md +++ b/docs/core/unmanaged-api/hosting/ivalidator-validate-method.md @@ -64,7 +64,7 @@ HRESULT Validate ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h diff --git a/docs/core/unmanaged-api/hosting/loadlibraryshim-function.md b/docs/core/unmanaged-api/hosting/loadlibraryshim-function.md index 2d6f54d28d80f..39cf27c35614d 100644 --- a/docs/core/unmanaged-api/hosting/loadlibraryshim-function.md +++ b/docs/core/unmanaged-api/hosting/loadlibraryshim-function.md @@ -66,7 +66,7 @@ HRESULT LoadLibraryShim ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/loadstringrc-function.md b/docs/core/unmanaged-api/hosting/loadstringrc-function.md index a05dd1a191097..2e99d3aba7fa9 100644 --- a/docs/core/unmanaged-api/hosting/loadstringrc-function.md +++ b/docs/core/unmanaged-api/hosting/loadstringrc-function.md @@ -62,7 +62,7 @@ HRESULT LoadStringRC ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/loadstringrcex-function.md b/docs/core/unmanaged-api/hosting/loadstringrcex-function.md index d6d3311239702..3230047bcf943 100644 --- a/docs/core/unmanaged-api/hosting/loadstringrcex-function.md +++ b/docs/core/unmanaged-api/hosting/loadstringrcex-function.md @@ -70,7 +70,7 @@ HRESULT LoadStringRCEx ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/lockclrversion-function.md b/docs/core/unmanaged-api/hosting/lockclrversion-function.md index ee94de4452a7c..c705d3a46a9ac 100644 --- a/docs/core/unmanaged-api/hosting/lockclrversion-function.md +++ b/docs/core/unmanaged-api/hosting/lockclrversion-function.md @@ -83,7 +83,7 @@ typedef HRESULT ( __stdcall *FLockClrVersionCallback ) (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md b/docs/core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md index 00f40a8ad13ce..997938600e378 100644 --- a/docs/core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md +++ b/docs/core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md @@ -51,7 +51,7 @@ typedef VOID (*LPOVERLAPPED_COMPLETION_ROUTINE) ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md b/docs/core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md index d291c669e7fff..85a4f45cacb5a 100644 --- a/docs/core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md +++ b/docs/core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md @@ -41,7 +41,7 @@ typedef DWORD (__stdcall *LPTHREAD_START_ROUTINE) ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/malloc-type-enumeration.md b/docs/core/unmanaged-api/hosting/malloc-type-enumeration.md index b817fb45cd64a..2d0431b604d6a 100644 --- a/docs/core/unmanaged-api/hosting/malloc-type-enumeration.md +++ b/docs/core/unmanaged-api/hosting/malloc-type-enumeration.md @@ -38,7 +38,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/mdainfo-structure.md b/docs/core/unmanaged-api/hosting/mdainfo-structure.md index db91abb7b6e9d..08c73d48f1488 100644 --- a/docs/core/unmanaged-api/hosting/mdainfo-structure.md +++ b/docs/core/unmanaged-api/hosting/mdainfo-structure.md @@ -50,7 +50,7 @@ typedef struct _MDAInfo { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/metahost-config-flags-enumeration.md b/docs/core/unmanaged-api/hosting/metahost-config-flags-enumeration.md index ab4544281d81c..211d638154f14 100644 --- a/docs/core/unmanaged-api/hosting/metahost-config-flags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/metahost-config-flags-enumeration.md @@ -44,7 +44,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Metahost.h diff --git a/docs/core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md b/docs/core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md index 0236b459919d1..4ea2ea5379017 100644 --- a/docs/core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md @@ -51,7 +51,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Metahost.h diff --git a/docs/core/unmanaged-api/hosting/modulebindinfo-structure.md b/docs/core/unmanaged-api/hosting/modulebindinfo-structure.md index 61e065bd08662..1343a798b6f5a 100644 --- a/docs/core/unmanaged-api/hosting/modulebindinfo-structure.md +++ b/docs/core/unmanaged-api/hosting/modulebindinfo-structure.md @@ -44,7 +44,7 @@ typedef struct _ModuleBindInfo { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/rundll32shimw-function.md b/docs/core/unmanaged-api/hosting/rundll32shimw-function.md index be56c0c43f5de..a4473be581cf1 100644 --- a/docs/core/unmanaged-api/hosting/rundll32shimw-function.md +++ b/docs/core/unmanaged-api/hosting/rundll32shimw-function.md @@ -49,7 +49,7 @@ HRESULT RunDll32ShimW ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/runtime-info-flags-enumeration.md b/docs/core/unmanaged-api/hosting/runtime-info-flags-enumeration.md index 0ef060a76f645..fe5fa42ccee02 100644 --- a/docs/core/unmanaged-api/hosting/runtime-info-flags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/runtime-info-flags-enumeration.md @@ -62,7 +62,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md b/docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md index 30324511aae7d..4ebcc4a9bc85e 100644 --- a/docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md +++ b/docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md @@ -42,7 +42,7 @@ typedef struct _StackOverflowInfo { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/stackoverflowtype-enumeration.md b/docs/core/unmanaged-api/hosting/stackoverflowtype-enumeration.md index e28cfbfed7819..cb35284714412 100644 --- a/docs/core/unmanaged-api/hosting/stackoverflowtype-enumeration.md +++ b/docs/core/unmanaged-api/hosting/stackoverflowtype-enumeration.md @@ -44,7 +44,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/startup-flags-enumeration.md b/docs/core/unmanaged-api/hosting/startup-flags-enumeration.md index c4a5a01757c93..51eb83a89bcb8 100644 --- a/docs/core/unmanaged-api/hosting/startup-flags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/startup-flags-enumeration.md @@ -70,7 +70,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md b/docs/core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md index 4bb85c99cf7c6..d406ab6f80208 100644 --- a/docs/core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md +++ b/docs/core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md @@ -82,7 +82,7 @@ HRESULT StrongNameGetPublicKey ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md b/docs/core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md index b096586149f36..26a94723302f0 100644 --- a/docs/core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md +++ b/docs/core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md @@ -55,7 +55,7 @@ HRESULT StrongNameSignatureVerificationEx ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/typenamefactory-coclass.md b/docs/core/unmanaged-api/hosting/typenamefactory-coclass.md index 1592117ab5157..a4ee43184179a 100644 --- a/docs/core/unmanaged-api/hosting/typenamefactory-coclass.md +++ b/docs/core/unmanaged-api/hosting/typenamefactory-coclass.md @@ -36,7 +36,7 @@ coclass TypeNameFactory { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/validatorflags-enumeration.md b/docs/core/unmanaged-api/hosting/validatorflags-enumeration.md index 5053a290b4e23..9bed99732ee23 100644 --- a/docs/core/unmanaged-api/hosting/validatorflags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/validatorflags-enumeration.md @@ -44,7 +44,7 @@ enum ValidatorFlags { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h diff --git a/docs/core/unmanaged-api/hosting/wait-option-enumeration.md b/docs/core/unmanaged-api/hosting/wait-option-enumeration.md index 08a037e4733f5..bc18095067879 100644 --- a/docs/core/unmanaged-api/hosting/wait-option-enumeration.md +++ b/docs/core/unmanaged-api/hosting/wait-option-enumeration.md @@ -44,7 +44,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/waitortimercallback-function-pointer.md b/docs/core/unmanaged-api/hosting/waitortimercallback-function-pointer.md index d81d52da0f759..429301c6c39c5 100644 --- a/docs/core/unmanaged-api/hosting/waitortimercallback-function-pointer.md +++ b/docs/core/unmanaged-api/hosting/waitortimercallback-function-pointer.md @@ -45,7 +45,7 @@ typedef VOID (__stdcall *WAITORTIMERCALLBACK) ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/metadata/assemblyflags-enumeration.md b/docs/core/unmanaged-api/metadata/assemblyflags-enumeration.md index e610545d28f7e..1a6a5b60cc610 100644 --- a/docs/core/unmanaged-api/metadata/assemblyflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/assemblyflags-enumeration.md @@ -48,7 +48,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** MsCorEE.h diff --git a/docs/core/unmanaged-api/metadata/assemblymetadata-structure.md b/docs/core/unmanaged-api/metadata/assemblymetadata-structure.md index fe8b2b86e264d..8e8e183a63017 100644 --- a/docs/core/unmanaged-api/metadata/assemblymetadata-structure.md +++ b/docs/core/unmanaged-api/metadata/assemblymetadata-structure.md @@ -54,7 +54,7 @@ typedef struct { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/assemblyrefflags-enumeration.md b/docs/core/unmanaged-api/metadata/assemblyrefflags-enumeration.md index c84078042e628..a1ddd325d905b 100644 --- a/docs/core/unmanaged-api/metadata/assemblyrefflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/assemblyrefflags-enumeration.md @@ -36,7 +36,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/ceesectionattr-enumeration.md b/docs/core/unmanaged-api/metadata/ceesectionattr-enumeration.md index c18a62b4f70d2..b8f80879c2d46 100644 --- a/docs/core/unmanaged-api/metadata/ceesectionattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/ceesectionattr-enumeration.md @@ -44,7 +44,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/ceesectionrelocextra-union.md b/docs/core/unmanaged-api/metadata/ceesectionrelocextra-union.md index 5e5a20aae7516..b5c156ece2545 100644 --- a/docs/core/unmanaged-api/metadata/ceesectionrelocextra-union.md +++ b/docs/core/unmanaged-api/metadata/ceesectionrelocextra-union.md @@ -36,7 +36,7 @@ typedef union { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/ceesectionreloctype-enumeration.md b/docs/core/unmanaged-api/metadata/ceesectionreloctype-enumeration.md index 6c69951d79b5b..7b51ab5aeef21 100644 --- a/docs/core/unmanaged-api/metadata/ceesectionreloctype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/ceesectionreloctype-enumeration.md @@ -66,7 +66,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/coiniticor-enumeration.md b/docs/core/unmanaged-api/metadata/coiniticor-enumeration.md index 297264650b1d1..2bd3b142c54bd 100644 --- a/docs/core/unmanaged-api/metadata/coiniticor-enumeration.md +++ b/docs/core/unmanaged-api/metadata/coiniticor-enumeration.md @@ -37,7 +37,7 @@ typedef enum tagCOINITCOR ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/coinitiee-enumeration.md b/docs/core/unmanaged-api/metadata/coinitiee-enumeration.md index 7696615903773..325a0d5806245 100644 --- a/docs/core/unmanaged-api/metadata/coinitiee-enumeration.md +++ b/docs/core/unmanaged-api/metadata/coinitiee-enumeration.md @@ -40,7 +40,7 @@ typedef enum tagCOINITEE { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/cor-field-offset-structure.md b/docs/core/unmanaged-api/metadata/cor-field-offset-structure.md index 655625640e043..6b81f5294ef0f 100644 --- a/docs/core/unmanaged-api/metadata/cor-field-offset-structure.md +++ b/docs/core/unmanaged-api/metadata/cor-field-offset-structure.md @@ -42,7 +42,7 @@ typedef struct COR_FIELD_OFFSET { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h, CorProf.idl diff --git a/docs/core/unmanaged-api/metadata/cor-native-link-structure.md b/docs/core/unmanaged-api/metadata/cor-native-link-structure.md index f5dbac89ca382..fa7c90545ff82 100644 --- a/docs/core/unmanaged-api/metadata/cor-native-link-structure.md +++ b/docs/core/unmanaged-api/metadata/cor-native-link-structure.md @@ -41,7 +41,7 @@ typedef struct ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/corargtype-enumeration.md b/docs/core/unmanaged-api/metadata/corargtype-enumeration.md index 55ac92ea22b84..38ce4f68124f5 100644 --- a/docs/core/unmanaged-api/metadata/corargtype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corargtype-enumeration.md @@ -42,7 +42,7 @@ typedef enum CorArgType { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corassemblyflags-enumeration.md b/docs/core/unmanaged-api/metadata/corassemblyflags-enumeration.md index a08a647167fe9..9a9570dd609b8 100644 --- a/docs/core/unmanaged-api/metadata/corassemblyflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corassemblyflags-enumeration.md @@ -74,7 +74,7 @@ typedef enum CorAssemblyFlags { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corattributetargets-enumeration.md b/docs/core/unmanaged-api/metadata/corattributetargets-enumeration.md index 29bb82e914279..d09a0b7d0ddb0 100644 --- a/docs/core/unmanaged-api/metadata/corattributetargets-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corattributetargets-enumeration.md @@ -83,7 +83,7 @@ typedef enum CorAttributeTargets ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corcallingconvention-enumeration.md b/docs/core/unmanaged-api/metadata/corcallingconvention-enumeration.md index c28fe24ed5e1d..8b5017b199c95 100644 --- a/docs/core/unmanaged-api/metadata/corcallingconvention-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corcallingconvention-enumeration.md @@ -64,7 +64,7 @@ typedef enum CorCallingConvention ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md b/docs/core/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md index 0f5715e9ad178..e28e224824fbe 100644 --- a/docs/core/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md @@ -94,7 +94,7 @@ typedef enum CorCheckDuplicatesFor { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cordeclsecurity-enumeration.md b/docs/core/unmanaged-api/metadata/cordeclsecurity-enumeration.md index 5ccb8cf059401..553f8d8ef9722 100644 --- a/docs/core/unmanaged-api/metadata/cordeclsecurity-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cordeclsecurity-enumeration.md @@ -78,7 +78,7 @@ typedef enum CorDeclSecurity { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corelementtype-enumeration.md b/docs/core/unmanaged-api/metadata/corelementtype-enumeration.md index b5517f69e4a18..522b73321684f 100644 --- a/docs/core/unmanaged-api/metadata/corelementtype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corelementtype-enumeration.md @@ -135,7 +135,7 @@ The type modifiers form the basis for representing more complex types. A `CorEle ## Requirements -**Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md b/docs/core/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md index 4bea973ed0318..2c3ab89902ed4 100644 --- a/docs/core/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md @@ -52,7 +52,7 @@ typedef enum CorErrorIfEmitOutOfOrder { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/coreventattr-enumeration.md b/docs/core/unmanaged-api/metadata/coreventattr-enumeration.md index a990dbb118e01..47a376b7a7f75 100644 --- a/docs/core/unmanaged-api/metadata/coreventattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/coreventattr-enumeration.md @@ -43,7 +43,7 @@ typedef enum CorEventAttr { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corfieldattr-enumeration.md b/docs/core/unmanaged-api/metadata/corfieldattr-enumeration.md index cd299b489f4a9..939287a27cb7d 100644 --- a/docs/core/unmanaged-api/metadata/corfieldattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corfieldattr-enumeration.md @@ -78,7 +78,7 @@ typedef enum CorFieldAttr { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corfileflags-enumeration.md b/docs/core/unmanaged-api/metadata/corfileflags-enumeration.md index 7237e8f72c130..7baceea8f7196 100644 --- a/docs/core/unmanaged-api/metadata/corfileflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corfileflags-enumeration.md @@ -40,7 +40,7 @@ typedef enum CorFileFlags { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corfilemapping-enumeration.md b/docs/core/unmanaged-api/metadata/corfilemapping-enumeration.md index 8f327c3c9f51a..47341d04daa28 100644 --- a/docs/core/unmanaged-api/metadata/corfilemapping-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corfilemapping-enumeration.md @@ -40,7 +40,7 @@ typedef enum CorFileMapping { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corgenericparamattr-enumeration.md b/docs/core/unmanaged-api/metadata/corgenericparamattr-enumeration.md index a2a96607c48d4..e88198c05e03a 100644 --- a/docs/core/unmanaged-api/metadata/corgenericparamattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corgenericparamattr-enumeration.md @@ -55,7 +55,7 @@ typedef enum CorGenericParamAttr { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corimportoptions-enumeration.md b/docs/core/unmanaged-api/metadata/corimportoptions-enumeration.md index 868d7a1c00d44..e8a8cde5bca3f 100644 --- a/docs/core/unmanaged-api/metadata/corimportoptions-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corimportoptions-enumeration.md @@ -54,7 +54,7 @@ typedef enum CorImportOptions { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corlinkeroptions-enumeration.md b/docs/core/unmanaged-api/metadata/corlinkeroptions-enumeration.md index 062af0563d5ef..626fec50fb23c 100644 --- a/docs/core/unmanaged-api/metadata/corlinkeroptions-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corlinkeroptions-enumeration.md @@ -38,7 +38,7 @@ typedef enum CorLinkerOptions { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md b/docs/core/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md index 9a78b443a4a0e..8fecb92536494 100644 --- a/docs/core/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md @@ -41,7 +41,7 @@ typedef enum CorLocalRefPreservation ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md b/docs/core/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md index 4c321ebc4d0cd..4b426e6e66eb1 100644 --- a/docs/core/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md @@ -42,7 +42,7 @@ typedef enum CorManifestResourceFlags { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cormethodattr-enumeration.md b/docs/core/unmanaged-api/metadata/cormethodattr-enumeration.md index 425140cb47406..618eb33366ddf 100644 --- a/docs/core/unmanaged-api/metadata/cormethodattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cormethodattr-enumeration.md @@ -89,7 +89,7 @@ typedef enum CorMethodAttr { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cormethodimpl-enumeration.md b/docs/core/unmanaged-api/metadata/cormethodimpl-enumeration.md index d4c7f106e9ecf..87a7d382357d0 100644 --- a/docs/core/unmanaged-api/metadata/cormethodimpl-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cormethodimpl-enumeration.md @@ -71,7 +71,7 @@ typedef enum CorMethodImpl { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md b/docs/core/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md index 287cca8ec1f12..36d1e64b2cf7d 100644 --- a/docs/core/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md @@ -48,7 +48,7 @@ typedef enum CorMethodSemanticsAttr { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cornativelinkflags-enumeration.md b/docs/core/unmanaged-api/metadata/cornativelinkflags-enumeration.md index 81e2d2db03dc0..b4cdc421f52de 100644 --- a/docs/core/unmanaged-api/metadata/cornativelinkflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cornativelinkflags-enumeration.md @@ -43,7 +43,7 @@ typedef enum ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/cornativelinktype-enumeration.md b/docs/core/unmanaged-api/metadata/cornativelinktype-enumeration.md index eb6f096228ce6..960c2771b2861 100644 --- a/docs/core/unmanaged-api/metadata/cornativelinktype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cornativelinktype-enumeration.md @@ -47,7 +47,7 @@ typedef enum ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/cornativetype-enumeration.md b/docs/core/unmanaged-api/metadata/cornativetype-enumeration.md index f2469d3f9f3ba..003f9783a6f36 100644 --- a/docs/core/unmanaged-api/metadata/cornativetype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cornativetype-enumeration.md @@ -135,7 +135,7 @@ typedef enum CorNativeType { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md b/docs/core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md index e4aa25e627487..6321e66b6dd15 100644 --- a/docs/core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md @@ -89,7 +89,7 @@ typedef enum CorNotificationForTokenMovement { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/coropenflags-enumeration.md b/docs/core/unmanaged-api/metadata/coropenflags-enumeration.md index 5019e37509cff..cedfaf4af6d0e 100644 --- a/docs/core/unmanaged-api/metadata/coropenflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/coropenflags-enumeration.md @@ -62,7 +62,7 @@ typedef enum CorOpenFlags ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corparamattr-enumeration.md b/docs/core/unmanaged-api/metadata/corparamattr-enumeration.md index 3ba6f4d99fa18..223f4b6bf0aa8 100644 --- a/docs/core/unmanaged-api/metadata/corparamattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corparamattr-enumeration.md @@ -52,7 +52,7 @@ typedef enum CorParamAttr { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corpekind-enumeration.md b/docs/core/unmanaged-api/metadata/corpekind-enumeration.md index f8778ffc899f0..c3dba705cce40 100644 --- a/docs/core/unmanaged-api/metadata/corpekind-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corpekind-enumeration.md @@ -52,7 +52,7 @@ typedef enum CorPEKind { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corpinvokemap-enumeration.md b/docs/core/unmanaged-api/metadata/corpinvokemap-enumeration.md index 0fb47543682bd..770cfc5508af1 100644 --- a/docs/core/unmanaged-api/metadata/corpinvokemap-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corpinvokemap-enumeration.md @@ -86,7 +86,7 @@ typedef enum CorPinvokeMap { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corpropertyattr-enumeration.md b/docs/core/unmanaged-api/metadata/corpropertyattr-enumeration.md index 7705b85c567b1..8d1a9af7e3d0f 100644 --- a/docs/core/unmanaged-api/metadata/corpropertyattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corpropertyattr-enumeration.md @@ -46,7 +46,7 @@ typedef enum CorPropertyAttr { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/correftodefcheck-enumeration.md b/docs/core/unmanaged-api/metadata/correftodefcheck-enumeration.md index 037f47a956f44..4d917d5121075 100644 --- a/docs/core/unmanaged-api/metadata/correftodefcheck-enumeration.md +++ b/docs/core/unmanaged-api/metadata/correftodefcheck-enumeration.md @@ -44,7 +44,7 @@ typedef enum CorRefToDefCheck { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corregflags-enumeration.md b/docs/core/unmanaged-api/metadata/corregflags-enumeration.md index 6e60e944c5965..44f97ad9099fe 100644 --- a/docs/core/unmanaged-api/metadata/corregflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corregflags-enumeration.md @@ -41,7 +41,7 @@ typedef enum ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/corsavesize-enumeration.md b/docs/core/unmanaged-api/metadata/corsavesize-enumeration.md index 45be98740d5f9..883d3889a5d24 100644 --- a/docs/core/unmanaged-api/metadata/corsavesize-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corsavesize-enumeration.md @@ -40,7 +40,7 @@ typedef enum CorSaveSize { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corserializationtype-enumeration.md b/docs/core/unmanaged-api/metadata/corserializationtype-enumeration.md index a68f6184efbad..2f493e910d7cd 100644 --- a/docs/core/unmanaged-api/metadata/corserializationtype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corserializationtype-enumeration.md @@ -76,7 +76,7 @@ typedef enum CorSerializationType { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corsetenc-enumeration.md b/docs/core/unmanaged-api/metadata/corsetenc-enumeration.md index 4acb3b0f77e2c..a2afbe57e0923 100644 --- a/docs/core/unmanaged-api/metadata/corsetenc-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corsetenc-enumeration.md @@ -53,7 +53,7 @@ typedef enum CorSetENC { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md b/docs/core/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md index 5eeda81711477..1292f566abe49 100644 --- a/docs/core/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md @@ -41,7 +41,7 @@ typedef enum CorThreadSafetyOptions { ## Requirements -**Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cortokentype-enumeration.md b/docs/core/unmanaged-api/metadata/cortokentype-enumeration.md index db83e591a9e19..b8f3fa1031933 100644 --- a/docs/core/unmanaged-api/metadata/cortokentype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cortokentype-enumeration.md @@ -92,7 +92,7 @@ typedef enum CorTokenType { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cortypeattr-enumeration.md b/docs/core/unmanaged-api/metadata/cortypeattr-enumeration.md index a6ef47f5a675b..00f82e9139a93 100644 --- a/docs/core/unmanaged-api/metadata/cortypeattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cortypeattr-enumeration.md @@ -109,7 +109,7 @@ typedef enum CorTypeAttr { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md b/docs/core/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md index 4ddb686f6762b..e0a720721888e 100644 --- a/docs/core/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md @@ -57,7 +57,7 @@ typedef enum CorUnmanagedCallingConvention { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md b/docs/core/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md index 7dd4bd4d6354f..005f96fc42719 100644 --- a/docs/core/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md @@ -49,7 +49,7 @@ typedef enum ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/couninitiee-enumeration.md b/docs/core/unmanaged-api/metadata/couninitiee-enumeration.md index 9b52e959c13da..7ccab291e872f 100644 --- a/docs/core/unmanaged-api/metadata/couninitiee-enumeration.md +++ b/docs/core/unmanaged-api/metadata/couninitiee-enumeration.md @@ -39,7 +39,7 @@ typedef enum tagCOUNINITEE ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/cvstruct-structure.md b/docs/core/unmanaged-api/metadata/cvstruct-structure.md index c263e194edc18..9d14a1c03d9c4 100644 --- a/docs/core/unmanaged-api/metadata/cvstruct-structure.md +++ b/docs/core/unmanaged-api/metadata/cvstruct-structure.md @@ -42,7 +42,7 @@ typedef struct { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-addsectionreloc-method.md b/docs/core/unmanaged-api/metadata/iceegen-addsectionreloc-method.md index 0bc63f0b57573..a244ac3db8813 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-addsectionreloc-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-addsectionreloc-method.md @@ -50,7 +50,7 @@ HRESULT AddSectionReloc ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md b/docs/core/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md index 8b57f0a6ef786..0e49f9eb9d205 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md @@ -46,7 +46,7 @@ HRESULT AllocateMethodBuffer ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-computepointer-method.md b/docs/core/unmanaged-api/metadata/iceegen-computepointer-method.md index e887b91c98292..7b177247751a9 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-computepointer-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-computepointer-method.md @@ -46,7 +46,7 @@ HRESULT ComputePointer ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-emitstring-method.md b/docs/core/unmanaged-api/metadata/iceegen-emitstring-method.md index e696361187582..f896f8412e41f 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-emitstring-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-emitstring-method.md @@ -42,7 +42,7 @@ HRESULT EmitString ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-generateceefile-method.md b/docs/core/unmanaged-api/metadata/iceegen-generateceefile-method.md index 24ec25055d303..5b596a7fbf737 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-generateceefile-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-generateceefile-method.md @@ -35,7 +35,7 @@ HRESULT GenerateCeeFile (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md b/docs/core/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md index 06b31d294479d..94e603474134d 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md @@ -38,7 +38,7 @@ HRESULT GenerateCeeMemoryImage ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getilsection-method.md b/docs/core/unmanaged-api/metadata/iceegen-getilsection-method.md index 17d8dd5fb93df..61e5efcae88ec 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getilsection-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getilsection-method.md @@ -38,7 +38,7 @@ HRESULT GetIlSection ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md b/docs/core/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md index 696d02bbf4846..6afd8d4c57094 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md @@ -38,7 +38,7 @@ HRESULT GetIMapTokenIface ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md b/docs/core/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md index fbf742b8341e0..b90f0c0eea498 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md @@ -42,7 +42,7 @@ HRESULT GetMethodBuffer ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getsectionblock-method.md b/docs/core/unmanaged-api/metadata/iceegen-getsectionblock-method.md index 56f52fdc93ae8..8715b5e554c01 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getsectionblock-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getsectionblock-method.md @@ -54,7 +54,7 @@ HRESULT GetSectionBlock ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getsectioncreate-method.md b/docs/core/unmanaged-api/metadata/iceegen-getsectioncreate-method.md index 4cd45328febdb..7e8bcad190bfb 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getsectioncreate-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getsectioncreate-method.md @@ -50,7 +50,7 @@ HRESULT GetSectionCreate ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md b/docs/core/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md index 7ee3f28cc9321..97f9799bcf4ab 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md @@ -46,7 +46,7 @@ HRESULT GetSectionDataLen ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getstring-method.md b/docs/core/unmanaged-api/metadata/iceegen-getstring-method.md index 52e47d316f306..e8986bdbd8341 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getstring-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getstring-method.md @@ -42,7 +42,7 @@ HRESULT GetString ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getstringsection-method.md b/docs/core/unmanaged-api/metadata/iceegen-getstringsection-method.md index a470723b34a7b..02aad69fa2fa9 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getstringsection-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getstringsection-method.md @@ -38,7 +38,7 @@ HRESULT GetStringSection ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-interface.md b/docs/core/unmanaged-api/metadata/iceegen-interface.md index 552b984a17f88..3a8271c1d01cf 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-interface.md +++ b/docs/core/unmanaged-api/metadata/iceegen-interface.md @@ -44,7 +44,7 @@ Provides methods for dynamic code compilation. ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-truncatesection-method.md b/docs/core/unmanaged-api/metadata/iceegen-truncatesection-method.md index e793625803cda..c6c7fd84f5408 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-truncatesection-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-truncatesection-method.md @@ -46,7 +46,7 @@ HRESULT TruncateSection ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/ihostfilter-interface.md b/docs/core/unmanaged-api/metadata/ihostfilter-interface.md index e14a1d33f6719..1aee48f23d5d6 100644 --- a/docs/core/unmanaged-api/metadata/ihostfilter-interface.md +++ b/docs/core/unmanaged-api/metadata/ihostfilter-interface.md @@ -31,7 +31,7 @@ Provides a method to indicate that a specified token will be processed. ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/ihostfilter-marktoken-method.md b/docs/core/unmanaged-api/metadata/ihostfilter-marktoken-method.md index e741296f4a0d9..6b4b18b89fbc3 100644 --- a/docs/core/unmanaged-api/metadata/ihostfilter-marktoken-method.md +++ b/docs/core/unmanaged-api/metadata/ihostfilter-marktoken-method.md @@ -40,7 +40,7 @@ HRESULT MarkToken ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imaptoken-interface.md b/docs/core/unmanaged-api/metadata/imaptoken-interface.md index 3f9d2ffdc95dc..18fff8d60e12d 100644 --- a/docs/core/unmanaged-api/metadata/imaptoken-interface.md +++ b/docs/core/unmanaged-api/metadata/imaptoken-interface.md @@ -31,7 +31,7 @@ Provides mapping capabilities between assemblies. ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imaptoken-map-method.md b/docs/core/unmanaged-api/metadata/imaptoken-map-method.md index 6c03ae876721c..07869ba329220 100644 --- a/docs/core/unmanaged-api/metadata/imaptoken-map-method.md +++ b/docs/core/unmanaged-api/metadata/imaptoken-map-method.md @@ -44,7 +44,7 @@ HRESULT Map ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md index c15446dea1421..35951158ac734 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md @@ -64,7 +64,7 @@ HRESULT DefineAssembly ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md index 19836aea1bc40..8ba18fa2bda61 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md @@ -70,7 +70,7 @@ HRESULT DefineAssemblyRef ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md index fd96eafde31fb..1a212cabd14b6 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md @@ -64,7 +64,7 @@ HRESULT DefineExportedType ( ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md index a435180c77cd1..6a328f00e2643 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md @@ -56,7 +56,7 @@ HRESULT DefineFile ( ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md index 34e34d1ebc685..3a160b0019323 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md @@ -56,7 +56,7 @@ HRESULT DefineManifestResource ( ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-interface.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-interface.md index cba5ef54f5b72..0ff08506124ec 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-interface.md @@ -39,7 +39,7 @@ Provides methods that support the self-description model used by the common lang ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md index 4f7239bbe350d..4a82e2622d50f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md @@ -64,7 +64,7 @@ HRESULT SetAssemblyProps ( ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md index b4dec8f495c69..2d1228482420c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md @@ -68,7 +68,7 @@ HRESULT SetAssemblyRefProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md index 700ede929377e..6abaf75bda7fc 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md @@ -52,7 +52,7 @@ HRESULT SetExportedTypeProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md index 963600747677b..d369f4b185075 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md @@ -52,7 +52,7 @@ HRESULT SetFileProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md index ca09c5d6b4116..ab07780c26014 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md @@ -52,7 +52,7 @@ HRESULT SetManifestResourceProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md index 88eb47dd3355c..8c62a5823c6f8 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md @@ -36,7 +36,7 @@ void CloseEnum ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md index 25585b58c829f..efaec4b9f3548 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md @@ -55,7 +55,7 @@ HRESULT EnumAssemblyRefs ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md index b7b3f72c5a7de..ea0578beb314a 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md @@ -55,7 +55,7 @@ HRESULT EnumExportedTypes ( ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md index ef3462201d5c6..55dc9da35dcbb 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md @@ -55,7 +55,7 @@ HRESULT EnumFiles ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md index 1798b34fa6a80..c99ff4fa0193b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md @@ -55,7 +55,7 @@ HRESULT EnumManifestResources ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md index c2b49f0f16cc9..8442a474750c9 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md @@ -73,7 +73,7 @@ HRESULT FindAssembliesByName ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md index 67443fdee7d29..5309d9c5ab739 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md @@ -48,7 +48,7 @@ HRESULT FindExportedTypeByName ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md index 926573f4ef450..4dab405739ae5 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md @@ -44,7 +44,7 @@ HRESULT FindManifestResourceByName ( ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md index 3060ce9b082eb..bdffd13dbebea 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md @@ -36,7 +36,7 @@ HRESULT GetAssemblyFromScope ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md index 47b0ed7963a3e..72cec65737930 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md @@ -68,7 +68,7 @@ HRESULT GetAssemblyProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md index 0c95c6ab6023d..361220ffef766 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md @@ -76,7 +76,7 @@ HRESULT GetAssemblyRefProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md index e6c8dc3e6753d..61c0dc7586606 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md @@ -60,7 +60,7 @@ HRESULT GetExportedTypeProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md index fddd2bf8e3c53..ea5dde041693d 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md @@ -60,7 +60,7 @@ HRESULT GetFileProps ( ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md index 16f4b7219380a..2d4f0bdb8a4a8 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md @@ -60,7 +60,7 @@ HRESULT GetManifestResourceProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-interface.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-interface.md index a6db57f4bd37c..e5c7bd2fd8897 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-interface.md @@ -41,7 +41,7 @@ Provides methods to access and examine the contents of an assembly manifest. ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md b/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md index e58ad2a00ed1a..22e37e27468fa 100644 --- a/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md @@ -40,7 +40,7 @@ HRESULT GetMetaDataFromTypeInfo ( ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md b/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md index 505647a5198d1..20d6e05b5e842 100644 --- a/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md @@ -40,7 +40,7 @@ HRESULT GetMetaDataFromTypeLib ( ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md b/docs/core/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md index dd30d380f8e8c..6ac93524811c9 100644 --- a/docs/core/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md @@ -44,7 +44,7 @@ HRESULT GetTypeLibFromMetaData ( ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataconverter-interface.md b/docs/core/unmanaged-api/metadata/imetadataconverter-interface.md index 9b164948a321e..1ebf34f16a06e 100644 --- a/docs/core/unmanaged-api/metadata/imetadataconverter-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataconverter-interface.md @@ -30,7 +30,7 @@ Provides methods to map type libraries to their metadata signatures, and to conv ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenser-definescope-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenser-definescope-method.md index e87328472931e..cb38714eba4c8 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenser-definescope-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenser-definescope-method.md @@ -56,7 +56,7 @@ HRESULT DefineScope ( ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenser-interface.md b/docs/core/unmanaged-api/metadata/imetadatadispenser-interface.md index 900adf5d2e116..0d349d85f60c8 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenser-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenser-interface.md @@ -30,7 +30,7 @@ Provides methods to create a new metadata scope, or open an existing one. ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenser-openscope-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenser-openscope-method.md index 8836edc7731f4..0a73f9441b2de 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenser-openscope-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenser-openscope-method.md @@ -60,7 +60,7 @@ HRESULT OpenScope ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md index 83995db04a5da..b31c785a4f05e 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md @@ -62,7 +62,7 @@ HRESULT OpenScopeOnMemory ( ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md index a98889fd8cef5..d5669f665659d 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md @@ -60,7 +60,7 @@ HRESULT FindAssembly( ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md index 75d385a75e4d0..f929392238ada 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md @@ -64,7 +64,7 @@ HRESULT FindAssemblyModule( ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md index 277816be1d9dd..69d2722e5dc9c 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md @@ -44,7 +44,7 @@ HRESULT GetCORSystemDirectory ( ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md index a40118b7083da..789ee09e746c3 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md @@ -58,7 +58,7 @@ HRESULT GetOption ( ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-interface.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-interface.md index 5a34b08b1177f..9d42053cce96c 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-interface.md @@ -33,7 +33,7 @@ Extends the [IMetaDataDispenser Interface](imetadatadispenser-interface.md) inte ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md index 1509e70459ebb..0127fd855d0ae 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md @@ -48,7 +48,7 @@ HRESULT OpenScopeOnITypeInfo ( ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md index dca6904c32364..19dc8cbf11b32 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md @@ -60,7 +60,7 @@ HRESULT SetOption ( ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md index 69f7495323caa..4e4b19472da3f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md @@ -38,7 +38,7 @@ HRESULT ApplyEditAndContinue ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md index 7a7bf69631205..cc52e78472a7d 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md @@ -52,7 +52,7 @@ HRESULT DefineCustomAttribute ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-defineevent-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineevent-method.md index cc0ac56416e44..4fffebb9ef1b6 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-defineevent-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineevent-method.md @@ -68,7 +68,7 @@ HRESULT DefineEvent ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definefield-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definefield-method.md index 126af85376038..9ed8855c06c60 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definefield-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definefield-method.md @@ -68,7 +68,7 @@ HRESULT DefineField ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md index 132ebabfaab6d..9478d42bf166d 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md @@ -76,7 +76,7 @@ HRESULT DefineImportMember ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md index 086497234026a..61b8fcbfb1e31 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md @@ -64,7 +64,7 @@ HRESULT DefineImportType ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definememberref-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definememberref-method.md index 9299645b039be..1ca79b9837261 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definememberref-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definememberref-method.md @@ -52,7 +52,7 @@ HRESULT DefineMemberRef ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definemethod-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definemethod-method.md index 525215bc24a17..d0b8052b4a5c3 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definemethod-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definemethod-method.md @@ -105,7 +105,7 @@ HRESULT DefineMethod ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md index 30e700f47e640..240ac78d52aff 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md @@ -44,7 +44,7 @@ HRESULT DefineMethodImpl ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md index af57abd855a69..67ccfdeaca463 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md @@ -40,7 +40,7 @@ HRESULT DefineModuleRef ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md index 690b85ec5f993..3d6d4d66fbd46 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md @@ -56,7 +56,7 @@ HRESULT DefineNestedType ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-defineparam-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineparam-method.md index 5838d6726c249..d17b6cae409a2 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-defineparam-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineparam-method.md @@ -68,7 +68,7 @@ HRESULT DefineParam ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md index 6ddd9eb900bb2..f4aeb44dfe67a 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md @@ -52,7 +52,7 @@ HRESULT DefinePermissionSet ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md index a669561d911c2..64c77623e92bd 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md @@ -48,7 +48,7 @@ HRESULT DefinePinvokeMap ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-defineproperty-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineproperty-method.md index ed30313161715..25e6c2557263b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-defineproperty-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineproperty-method.md @@ -80,7 +80,7 @@ HRESULT DefineProperty ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md index 24bfc5db797fe..804107ee49b37 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md @@ -48,7 +48,7 @@ HRESULT DefineSecurityAttributeSet ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definetypedef-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definetypedef-method.md index 7df6dfa580248..ddb1998f1f7d7 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definetypedef-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definetypedef-method.md @@ -60,7 +60,7 @@ HRESULT DefineTypeDef ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md index c84e68878be9b..14c948aea5bac 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md @@ -54,7 +54,7 @@ HRESULT DefineTypeRefByName ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md index 503ff00e45ca2..8fe0aac27a7b2 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md @@ -44,7 +44,7 @@ HRESULT DefineUserString ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md index dc80098f4dac3..2dd083c93d7e5 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md @@ -36,7 +36,7 @@ HRESULT DeleteClassLayout ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md index c20f947454fee..a63eb4bbb6166 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md @@ -36,7 +36,7 @@ HRESULT DeleteFieldMarshal ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md index 30e70764f4048..f29b20739dbfd 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md @@ -36,7 +36,7 @@ HRESULT DeletePinvokeMap ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-deletetoken-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-deletetoken-method.md index 611c58bd4b020..0b0e7fd720f8d 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-deletetoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-deletetoken-method.md @@ -36,7 +36,7 @@ HRESULT DeleteToken ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-getsavesize-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-getsavesize-method.md index 0d5aba26b17e8..52eb409c83a48 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-getsavesize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-getsavesize-method.md @@ -54,7 +54,7 @@ HRESULT GetSaveSize ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md index fdbc8470493ab..8ebaacebe07d4 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md @@ -44,7 +44,7 @@ HRESULT GetTokenFromSig ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md index 79928c8388745..28e6b1b0ac060 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md @@ -44,7 +44,7 @@ HRESULT GetTokenFromTypeSpec ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-interface.md b/docs/core/unmanaged-api/metadata/imetadataemit-interface.md index cd55043b4d841..055a243492b24 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-interface.md @@ -76,7 +76,7 @@ Provides methods to create, modify, and save metadata about the assembly in the ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-merge-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-merge-method.md index 56ca75a0e4e11..fbd40e592e1ca 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-merge-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-merge-method.md @@ -48,7 +48,7 @@ HRESULT Merge ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-mergeend-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-mergeend-method.md index a93f6f60d60e6..3551d1e5973f7 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-mergeend-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-mergeend-method.md @@ -59,7 +59,7 @@ The following special conditions apply to the merge: ## Requirements -**Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-save-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-save-method.md index b79329ff35c20..022e4a7880d7e 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-save-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-save-method.md @@ -40,7 +40,7 @@ HRESULT Save ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-savetomemory-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-savetomemory-method.md index d9f2f83fb045a..237cdd9ee495d 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-savetomemory-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-savetomemory-method.md @@ -40,7 +40,7 @@ HRESULT SaveToMemory ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-savetostream-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-savetostream-method.md index efa7557ab0b98..a79dac5f3a93c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-savetostream-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-savetostream-method.md @@ -40,7 +40,7 @@ HRESULT SaveToStream ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md index 324c40a6233ff..6d14a36d9ec95 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md @@ -58,7 +58,7 @@ HRESULT SetClassLayout ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md index 3aeea94ff0478..700b4d1bad725 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md @@ -44,7 +44,7 @@ HRESULT SetCustomAttributeValue ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-seteventprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-seteventprops-method.md index e8f6b730d8982..5b722d3de8ae1 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-seteventprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-seteventprops-method.md @@ -60,7 +60,7 @@ HRESULT SetEventProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md index 069e8b266b300..a00b3a9ef7bf6 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md @@ -44,7 +44,7 @@ HRESULT SetFieldMarshal ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md index 5ab39ecca6424..eb5c30e25bbbb 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md @@ -52,7 +52,7 @@ HRESULT SetFieldProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md index 0c1c3a5dbb06e..5586c4be8e6fe 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md @@ -40,7 +40,7 @@ HRESULT SetFieldRVA ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-sethandler-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-sethandler-method.md index 90d59b0cf1854..22ce212c7eb24 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-sethandler-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-sethandler-method.md @@ -42,7 +42,7 @@ HRESULT SetHandler ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md index 9c6766e4aeffd..f322584f4d214 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md @@ -40,7 +40,7 @@ HRESULT SetMethodImplFlags ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md index cf0096160a2b2..44176f85a83bb 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md @@ -48,7 +48,7 @@ HRESULT SetMethodProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md index 3cb4f6314f324..7a0e79d4bdbce 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md @@ -36,7 +36,7 @@ HRESULT SetModuleProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setparamprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setparamprops-method.md index fd357bdc54ae3..1c6880c9b065c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setparamprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setparamprops-method.md @@ -56,7 +56,7 @@ HRESULT SetParamProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setparent-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setparent-method.md index 9eecf639b85c9..c74775e9ee04f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setparent-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setparent-method.md @@ -40,7 +40,7 @@ HRESULT SetParent ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md index 4c3a4b2f8b323..ba99cd624e86e 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md @@ -52,7 +52,7 @@ HRESULT SetPermissionSetProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md index 7bcfc3a7d3f0b..917cef2975738 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md @@ -48,7 +48,7 @@ HRESULT SetPinvokeMap ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md index 1fc88c11eb3b4..5668706a0bd4c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md @@ -64,7 +64,7 @@ HRESULT SetPropertyProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setrva-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setrva-method.md index 407563d564bc1..68a86e3cd24b7 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setrva-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setrva-method.md @@ -40,7 +40,7 @@ HRESULT SetRVA ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md index b1bc512c4f228..e28c859c00e68 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md @@ -48,7 +48,7 @@ HRESULT SetTypeDefProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md index f2437759032e4..2f73ce09ba887 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md @@ -76,7 +76,7 @@ HRESULT TranslateSigWithScope ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md index 6d61aaf089537..dca1b61619718 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md @@ -60,7 +60,7 @@ HRESULT DefineGenericParam ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md index 3b9dfd507ea6b..b2629627b9b39 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md @@ -48,7 +48,7 @@ HRESULT DefineMethodSpec ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md index 3abb45b522be3..cde7794cc307d 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md @@ -40,7 +40,7 @@ HRESULT GetDeltaSaveSize ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-interface.md b/docs/core/unmanaged-api/metadata/imetadataemit2-interface.md index 24d470290041a..b3cf368473c4a 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-interface.md @@ -35,7 +35,7 @@ Extends the [IMetaDataEmit](imetadataemit-interface.md) interface primarily to p ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md index 1247772fddb3c..1e0e448fa09ad 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md @@ -33,7 +33,7 @@ HRESULT ResetENCLog (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-savedelta-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-savedelta-method.md index cc840042aacf5..fef40e57ca9a7 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-savedelta-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-savedelta-method.md @@ -40,7 +40,7 @@ HRESULT SaveDelta ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md index 652a97c9307a9..a4769debbf291 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md @@ -40,7 +40,7 @@ HRESULT SaveDeltaToMemory ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md index 4263ccf50d954..8d973d17e6e6f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md @@ -40,7 +40,7 @@ HRESULT SaveDeltaToStream ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md index 5cf169a622589..1c8da51866b5f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md @@ -52,7 +52,7 @@ HRESULT SetGenericParamProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataerror-interface.md b/docs/core/unmanaged-api/metadata/imetadataerror-interface.md index 5d84b0271e6b1..f8fe327eeb13c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataerror-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataerror-interface.md @@ -31,7 +31,7 @@ Provides a callback mechanism for reporting errors during the metadata merge. ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataerror-onerror-method.md b/docs/core/unmanaged-api/metadata/imetadataerror-onerror-method.md index e205f71c0b251..ded303c77da31 100644 --- a/docs/core/unmanaged-api/metadata/imetadataerror-onerror-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataerror-onerror-method.md @@ -40,7 +40,7 @@ HRESULT OnError ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatafilter-interface.md b/docs/core/unmanaged-api/metadata/imetadatafilter-interface.md index 4a47c77cc323d..011468a31cb6d 100644 --- a/docs/core/unmanaged-api/metadata/imetadatafilter-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatafilter-interface.md @@ -30,7 +30,7 @@ Provides methods for marking and filtering metadata tokens to avoid repeating ac ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md b/docs/core/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md index bd3a90c6c4e42..36309286c8cbf 100644 --- a/docs/core/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md @@ -40,7 +40,7 @@ HRESULT IsTokenMarked ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatafilter-marktoken-method.md b/docs/core/unmanaged-api/metadata/imetadatafilter-marktoken-method.md index 157d6271b94c4..7dcea87eba3aa 100644 --- a/docs/core/unmanaged-api/metadata/imetadatafilter-marktoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatafilter-marktoken-method.md @@ -36,7 +36,7 @@ HRESULT MarkToken ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md b/docs/core/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md index 163d8444da8be..6410c5bdd62d0 100644 --- a/docs/core/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md @@ -33,7 +33,7 @@ HRESULT UnmarkAll (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-closeenum-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-closeenum-method.md index 157a11e888617..9b9c5ecf0114f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-closeenum-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-closeenum-method.md @@ -40,7 +40,7 @@ void CloseEnum ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-countenum-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-countenum-method.md index dd980d4af9e2a..01cc4d3280cb4 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-countenum-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-countenum-method.md @@ -44,7 +44,7 @@ HRESULT CountEnum ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md index c38358a9b5179..16af6384f5007 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md @@ -63,7 +63,7 @@ HRESULT EnumCustomAttributes ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumevents-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumevents-method.md index e211c7a832a0c..f573a264f706d 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumevents-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumevents-method.md @@ -59,7 +59,7 @@ HRESULT EnumEvents ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumfields-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumfields-method.md index cd65cee7571b7..e8c7f9e47e776 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumfields-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumfields-method.md @@ -59,7 +59,7 @@ HRESULT EnumFields ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md index 5760b72f8e062..ec95fc0ff6522 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md @@ -67,7 +67,7 @@ HRESULT EnumFieldsWithName ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md index 760a4ef3276c8..301b2c9c98470 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md @@ -63,7 +63,7 @@ The enumeration returns a collection of `mdInterfaceImpl` tokens for each interf ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md index 0fd0d0539d755..3cb7060abb858 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md @@ -59,7 +59,7 @@ HRESULT EnumMemberRefs ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummembers-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummembers-method.md index 6a483be6571c9..6452d9994ba42 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummembers-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummembers-method.md @@ -65,7 +65,7 @@ HRESULT EnumMembers ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md index 344da7be8a1de..a56bc03681874 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md @@ -67,7 +67,7 @@ HRESULT EnumMembersWithName ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md index 6dbbcfe54e9c6..a69175b616ff6 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md @@ -63,7 +63,7 @@ HRESULT EnumMethodImpls ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummethods-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummethods-method.md index 8e939bf6952bf..a6670a31b9a17 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummethods-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummethods-method.md @@ -59,7 +59,7 @@ HRESULT EnumMethods ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md index 1c6f4b4579991..feec10e06db60 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md @@ -63,7 +63,7 @@ HRESULT EnumMethodSemantics ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md index 7df67af1b57f0..b7c3bcfd83638 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md @@ -67,7 +67,7 @@ HRESULT EnumMethodsWithName ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md index 29f8f39c7cadc..03c1abc044ce7 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md @@ -55,7 +55,7 @@ HRESULT EnumModuleRefs ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumparams-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumparams-method.md index 8dddfdf37b0b7..f529a38e93feb 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumparams-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumparams-method.md @@ -59,7 +59,7 @@ HRESULT EnumParams ( ## Requirements - **Platform:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md index 358402d468ef5..88d32ee7224eb 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md @@ -63,7 +63,7 @@ HRESULT EnumPermissionSets ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumproperties-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumproperties-method.md index 761762ee1a55e..9385b689e6e16 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumproperties-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumproperties-method.md @@ -59,7 +59,7 @@ HRESULT EnumProperties ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md index bda450b5e734e..34eac1280e070 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md @@ -59,7 +59,7 @@ HRESULT EnumSignatures ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md index 16a9427db34cf..38639f854384f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md @@ -59,7 +59,7 @@ HRESULT EnumTypeDefs ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md index 80e9dfc2ebacf..2b18b35d44180 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md @@ -59,7 +59,7 @@ HRESULT EnumTypeRefs ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md index 8cb617541bd95..0557c52f787b9 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md @@ -59,7 +59,7 @@ HRESULT EnumTypeSpecs ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md index 3aa4a75218179..a2e69cb013427 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md @@ -61,7 +61,7 @@ HRESULT EnumUnresolvedMethods ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md index 8080c78091207..cc90143b3083b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md @@ -59,7 +59,7 @@ HRESULT EnumUserStrings ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-findfield-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findfield-method.md index 1277cd89ba51a..d96c36ac7dcf8 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-findfield-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findfield-method.md @@ -60,7 +60,7 @@ HRESULT FindField ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-findmember-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findmember-method.md index 123ce50b92a03..bb930bc1d916d 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-findmember-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findmember-method.md @@ -63,7 +63,7 @@ HRESULT FindMember ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-findmemberref-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findmemberref-method.md index 67800f289f363..938b4235011fe 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-findmemberref-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findmemberref-method.md @@ -60,7 +60,7 @@ HRESULT FindMemberRef ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-findmethod-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findmethod-method.md index 1656776fac7dd..6210d6192db85 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-findmethod-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findmethod-method.md @@ -60,7 +60,7 @@ HRESULT FindMethod ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md index cc8717878dc1f..b47ffd196dfd5 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md @@ -44,7 +44,7 @@ HRESULT FindTypeDefByName ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-findtyperef-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findtyperef-method.md index 958183515ef70..b3dfd110772e6 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-findtyperef-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findtyperef-method.md @@ -44,7 +44,7 @@ HRESULT FindTypeRef ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md index 67fc22b7434af..dff06e734e45f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md @@ -56,7 +56,7 @@ HRESULT GetClassLayout ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md index a8f0f7e73425c..afa7ea28b6d1b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md @@ -52,7 +52,7 @@ HRESULT GetCustomAttributeByName ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md index ac82a0b16008f..e92e6492e5fdd 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md @@ -56,7 +56,7 @@ HRESULT GetCustomAttributeProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-geteventprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-geteventprops-method.md index 26f428bbc90b3..277138f1991de 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-geteventprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-geteventprops-method.md @@ -81,7 +81,7 @@ HRESULT GetEventProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md index d9cceefed061e..3f107b72932e9 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md @@ -44,7 +44,7 @@ HRESULT GetFieldMarshal ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md index 288b1f85bf45c..056bc023a5cb4 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md @@ -76,7 +76,7 @@ HRESULT GetFieldProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md index b2e830ad32f74..1c68744355264 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md @@ -72,7 +72,7 @@ Recall, the token is a 4-byte value: ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md index 3664df4996f13..7310ed83bed6f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md @@ -84,7 +84,7 @@ HRESULT GetMemberProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md index 0b6ed271c4717..e1987eef4c32d 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md @@ -60,7 +60,7 @@ HRESULT GetMemberRefProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md index 6abda83633d56..00bc7bf655e0d 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md @@ -72,7 +72,7 @@ HRESULT GetMethodProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md index 2f95010669a39..bbaf1fc1a8699 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md @@ -48,7 +48,7 @@ HRESULT GetMethodSemantics ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md index 3ed48c2e3700d..c225311635397 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md @@ -36,7 +36,7 @@ HRESULT GetModuleFromScope ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md index 40e5cdcc78251..c7ec8f66ae53c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md @@ -48,7 +48,7 @@ HRESULT GetModuleRefProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md index 134173d77b259..e1e98d8e72c8d 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md @@ -44,7 +44,7 @@ HRESULT GetNameFromToken ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md index 266419821f2f2..5193561f6b49a 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md @@ -44,7 +44,7 @@ HRESULT GetNativeCallConvFromSig ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md index 785be045c3fa0..bcee2a120ce62 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md @@ -40,7 +40,7 @@ HRESULT GetNestedClassProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md index b2267ac9add51..173788e8f7117 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md @@ -44,7 +44,7 @@ HRESULT GetParamForMethodIndex ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getparamprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getparamprops-method.md index 20e633748eaa1..ad5554e9c8ffb 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getparamprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getparamprops-method.md @@ -76,7 +76,7 @@ The sequence values in `pulSequence` begin with 1 for parameters. A return value ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md index 8859f51828b4b..f934d0f20ec34 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md @@ -48,7 +48,7 @@ HRESULT GetPermissionSetProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md index f6b31f7a40e45..d7f143f925c1b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md @@ -56,7 +56,7 @@ HRESULT GetPinvokeMap ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md index fef39a7e66bf4..7434f1126214f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md @@ -96,7 +96,7 @@ HRESULT GetPropertyProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getrva-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getrva-method.md index 6ced13561231c..5c5d5a5aa5295 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getrva-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getrva-method.md @@ -44,7 +44,7 @@ HRESULT GetRVA ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md index 39371dd2869a2..128acce579f32 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md @@ -52,7 +52,7 @@ HRESULT GetScopeProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md index 39927c67334cc..0f0f32ad122fa 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md @@ -44,7 +44,7 @@ HRESULT GetSigFromToken ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md index 7b56cd0116819..6d6dcd815d7fc 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md @@ -56,7 +56,7 @@ HRESULT GetTypeDefProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md index 7f9aa738c660b..74be94d58e583 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md @@ -52,7 +52,7 @@ HRESULT GetTypeRefProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md index 005f6a934848c..57fe7ef411654 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md @@ -48,7 +48,7 @@ HRESULT GetTypeSpecFromToken ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getuserstring-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getuserstring-method.md index faae0e704c75f..bd210776ec6e9 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getuserstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getuserstring-method.md @@ -48,7 +48,7 @@ HRESULT GetUserString ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-interface.md b/docs/core/unmanaged-api/metadata/imetadataimport-interface.md index 02640b12515da..26a0cdae15fc5 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-interface.md @@ -101,7 +101,7 @@ Provides methods for importing and manipulating existing metadata from a portabl ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-isglobal-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-isglobal-method.md index d08362bc45a90..f4e6ba9f2d57b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-isglobal-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-isglobal-method.md @@ -40,7 +40,7 @@ HRESULT IsGlobal ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md index 07e4e2dd5bdef..3068972c9ea5b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md @@ -40,7 +40,7 @@ BOOL IsValidToken ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-resetenum-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-resetenum-method.md index 849b884ddeb26..8f086ab2e8162 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-resetenum-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-resetenum-method.md @@ -40,7 +40,7 @@ HRESULT ResetEnum ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md index ed02a897bc8f1..b7836b366ea93 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md @@ -57,7 +57,7 @@ HRESULT ResolveTypeRef ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md index ed7881b0a9dac..22b89d73f4e55 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md @@ -59,7 +59,7 @@ HRESULT EnumGenericParamConstraints ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md index bbcf0e1d6bd50..40d7ea43d0166 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md @@ -59,7 +59,7 @@ HRESULT EnumGenericParams ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md index fb963105cbc27..2ecdc9261a5ae 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md @@ -59,7 +59,7 @@ HRESULT EnumMethodSpecs ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md index b4b7aa967c603..7eae20dc033ab 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md @@ -44,7 +44,7 @@ HRESULT GetGenericParamConstraintProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md index 3e6ec68b50f3c..b6015d1be5312 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md @@ -64,7 +64,7 @@ HRESULT GetGenericParamProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md index d0dba3850bd3f..bdeb618b99434 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md @@ -48,7 +48,7 @@ HRESULT GetMethodSpecProps ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-getpekind-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getpekind-method.md index bbd74179d0432..4ead32e0fe199 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-getpekind-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-getpekind-method.md @@ -50,7 +50,7 @@ HRESULT GetPEKind ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md index 0900c8cce3a61..1ca8969884dfb 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md @@ -48,7 +48,7 @@ HRESULT GetVersionString ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-interface.md b/docs/core/unmanaged-api/metadata/imetadataimport2-interface.md index 263344719f9d6..af909f2b5323d 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-interface.md @@ -35,7 +35,7 @@ Extends the [IMetaDataImport](imetadataimport-interface.md) interface to provide ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md b/docs/core/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md index 4430d3cdaa38f..656d49cc14369 100644 --- a/docs/core/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md @@ -62,7 +62,7 @@ HRESULT GetFileMapping ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatainfo-interface.md b/docs/core/unmanaged-api/metadata/imetadatainfo-interface.md index 60dfd79bd47de..812fd652e8706 100644 --- a/docs/core/unmanaged-api/metadata/imetadatainfo-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatainfo-interface.md @@ -28,7 +28,7 @@ Provides a method that gets information about the mapping of metadata from an on ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getblob-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getblob-method.md index c98a62159fa72..57be861b6e2f9 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getblob-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getblob-method.md @@ -44,7 +44,7 @@ HRESULT GetBlob ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md index 5b4651d7a8dee..9f9739d03c44b 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md @@ -36,7 +36,7 @@ HRESULT GetBlobHeapSize ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md index bd932665b7b65..208c635285a09 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md @@ -48,7 +48,7 @@ HRESULT GetCodedTokenInfo ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getcolumn-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getcolumn-method.md index 0a633514bdbfe..54885d4ad5f63 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getcolumn-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getcolumn-method.md @@ -69,7 +69,7 @@ The interpretation of the value returned through `pVal` depends on the column's ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md index 278b2ebfdc2e3..4e1b4797a2774 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md @@ -84,7 +84,7 @@ Values that are stored in the *heap* (that is, `IsHeapType == true`) can be read ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getguid-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getguid-method.md index aeeeeb0f925cb..5ea1280130d99 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getguid-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getguid-method.md @@ -44,7 +44,7 @@ HRESULT GetGuid ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md index ad43a5e2efce2..48786aef47602 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md @@ -36,7 +36,7 @@ HRESULT GetGuidHeapSize ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getnextblob-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnextblob-method.md index 8aa51803fbc11..cf1def78a58a1 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getnextblob-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getnextblob-method.md @@ -40,7 +40,7 @@ HRESULT GetNextBlob ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getnextguid-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnextguid-method.md index dd4748f9aa6f7..7c85546295611 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getnextguid-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getnextguid-method.md @@ -44,7 +44,7 @@ HRESULT GetNextGuid ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getnextstring-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnextstring-method.md index 1f18950af1219..cd387ee3a90ef 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getnextstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getnextstring-method.md @@ -40,7 +40,7 @@ HRESULT GetNextString ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md index f0f3377a5f8f4..3a9d54965d6b9 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md @@ -44,7 +44,7 @@ HRESULT GetNextUserString ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getnumtables-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnumtables-method.md index 0ccd91b1580a2..5a7ae2716c8f5 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getnumtables-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getnumtables-method.md @@ -36,7 +36,7 @@ HRESULT GetNumTables ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getrow-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getrow-method.md index 066fa9da13489..cddab6b2870e1 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getrow-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getrow-method.md @@ -48,7 +48,7 @@ HRESULT GetRow ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getstring-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getstring-method.md index 8d38819fb3b52..3fe30697d509c 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getstring-method.md @@ -40,7 +40,7 @@ HRESULT GetString ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md index 077ab4308aac4..7ed3447712683 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md @@ -36,7 +36,7 @@ HRESULT GetStringHeapSize ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-gettableindex-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-gettableindex-method.md index 11891d23970e8..79e4cd351a361 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-gettableindex-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-gettableindex-method.md @@ -44,7 +44,7 @@ HRESULT GetTableIndex ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md index 3af2f7bf6484b..079eed3f6c723 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md @@ -56,7 +56,7 @@ HRESULT GetTableInfo ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getuserstring-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getuserstring-method.md index 10fcc1f914ed5..e9698f4baa5d7 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getuserstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getuserstring-method.md @@ -45,7 +45,7 @@ HRESULT GetUserString ( ## Requirements -**Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md index 44ce0b7985ebb..8d21fa01843b8 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md @@ -36,7 +36,7 @@ HRESULT GetUserStringHeapSize ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-interface.md b/docs/core/unmanaged-api/metadata/imetadatatables-interface.md index 81a9d80e9187d..f545bc2a89c0f 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-interface.md @@ -46,7 +46,7 @@ Provides methods for the storage and retrieval of metadata information in tables ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md b/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md index 4138462e81770..82fed639d7334 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md @@ -40,7 +40,7 @@ HRESULT GetMetaDataStorage ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md b/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md index f853a67e564f4..c8ec34729c84d 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md @@ -48,7 +48,7 @@ HRESULT GetMetaDataStreamInfo ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables2-interface.md b/docs/core/unmanaged-api/metadata/imetadatatables2-interface.md index 4b89215a07972..d6099210f2d95 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables2-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables2-interface.md @@ -29,7 +29,7 @@ Extends [IMetaDataTables](imetadatatables-interface.md) to include methods for w ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatavalidate-interface.md b/docs/core/unmanaged-api/metadata/imetadatavalidate-interface.md index 569550c0412f1..c46dd4aa63f41 100644 --- a/docs/core/unmanaged-api/metadata/imetadatavalidate-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatavalidate-interface.md @@ -29,7 +29,7 @@ Provides methods to validate metadata signatures. ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md b/docs/core/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md index fcea3651a120f..3895f2a4affee 100644 --- a/docs/core/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md @@ -29,7 +29,7 @@ HRESULT ValidateMetaData (); ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md b/docs/core/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md index e3e5b7ce7ff62..c922343e42c7b 100644 --- a/docs/core/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md @@ -40,7 +40,7 @@ HRESULT ValidatorInit ( ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/osinfo-structure.md b/docs/core/unmanaged-api/metadata/osinfo-structure.md index 141752d7a60c9..7d2da576c85cd 100644 --- a/docs/core/unmanaged-api/metadata/osinfo-structure.md +++ b/docs/core/unmanaged-api/metadata/osinfo-structure.md @@ -44,7 +44,7 @@ typedef struct { ## Requirements - **Platforms:** See [System Requirements](../../../docs/framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). **Header:** Cor.h From a6350214ed08dd490a2598b8760c9c750bbb7154 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 26 Jun 2025 12:15:45 +0000 Subject: [PATCH 07/20] Fix invalid file links in moved unmanaged API documentation Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com> --- .../unmanaged-api/hosting/assemblybindinfo-structure.md | 2 +- .../unmanaged-api/hosting/bucketparameters-structure.md | 2 +- .../core/unmanaged-api/hosting/callfunctionshim-function.md | 2 +- .../unmanaged-api/hosting/clrcreateinstance-function.md | 6 +++--- .../hosting/clrcreatemanagedinstance-function.md | 2 +- docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md | 2 +- .../hosting/clsid-resolution-flags-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md | 2 +- docs/core/unmanaged-api/hosting/coinitializeee-function.md | 2 +- docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md | 2 +- .../unmanaged-api/hosting/cor-gc-stat-types-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md | 2 +- .../unmanaged-api/hosting/cor-gc-thread-stats-structure.md | 2 +- .../hosting/cor-gc-thread-stats-types-enumeration.md | 2 +- .../hosting/corbindtocurrentruntime-function.md | 2 +- .../core/unmanaged-api/hosting/corbindtoruntime-function.md | 2 +- .../unmanaged-api/hosting/corbindtoruntimebycfg-function.md | 2 +- .../unmanaged-api/hosting/corbindtoruntimeex-function.md | 2 +- .../unmanaged-api/hosting/corbindtoruntimehost-function.md | 2 +- docs/core/unmanaged-api/hosting/cordllmain-function.md | 2 +- docs/core/unmanaged-api/hosting/corexemain-function.md | 2 +- docs/core/unmanaged-api/hosting/corexemain2-function.md | 2 +- docs/core/unmanaged-api/hosting/corexitprocess-function.md | 2 +- .../unmanaged-api/hosting/corimageunloading-function.md | 2 +- .../unmanaged-api/hosting/corlaunchapplication-function.md | 2 +- .../hosting/cormarkthreadinthreadpool-function.md | 2 +- docs/core/unmanaged-api/hosting/corruntimehost-coclass.md | 2 +- .../core/unmanaged-api/hosting/corvalidateimage-function.md | 2 +- .../hosting/createdebugginginterfacefromversion-function.md | 2 +- .../unmanaged-api/hosting/createiceefilegen-function.md | 2 +- docs/core/unmanaged-api/hosting/customdumpitem-structure.md | 2 +- .../unmanaged-api/hosting/destroyiceefilegen-function.md | 2 +- .../unmanaged-api/hosting/eapicategories-enumeration.md | 2 +- .../unmanaged-api/hosting/ebindpolicylevels-enumeration.md | 2 +- .../hosting/eclrassemblyidentityflags-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/eclrevent-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md | 2 +- .../core/unmanaged-api/hosting/eclroperation-enumeration.md | 2 +- .../hosting/eclrunhandledexception-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/econtexttype-enumeration.md | 2 +- .../unmanaged-api/hosting/ecustomdumpflavor-enumeration.md | 2 +- .../hosting/ecustomdumpitemkind-enumeration.md | 2 +- .../hosting/ehostapplicationpolicy-enumeration.md | 2 +- .../hosting/ehostbindingpolicymodifyflags-enumeration.md | 2 +- .../hosting/einitializenewdomainflags-enumeration.md | 2 +- .../unmanaged-api/hosting/ememoryavailable-enumeration.md | 2 +- .../hosting/ememorycriticallevel-enumeration.md | 2 +- .../core/unmanaged-api/hosting/epolicyaction-enumeration.md | 2 +- .../hosting/esymbolreadingpolicy-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/etasktype-enumeration.md | 2 +- .../hosting/fexecuteinappdomaincallback-function-pointer.md | 2 +- .../hosting/flockclrversioncallback-function-pointer.md | 2 +- .../unmanaged-api/hosting/getclridentitymanager-function.md | 2 +- .../unmanaged-api/hosting/getcorrequiredversion-function.md | 2 +- .../unmanaged-api/hosting/getcorsystemdirectory-function.md | 2 +- docs/core/unmanaged-api/hosting/getcorversion-function.md | 2 +- docs/core/unmanaged-api/hosting/getfileversion-function.md | 2 +- .../unmanaged-api/hosting/getrealprocaddress-function.md | 2 +- .../hosting/getrequestedruntimeinfo-function.md | 2 +- .../hosting/getrequestedruntimeversion-function.md | 2 +- .../hosting/getrequestedruntimeversionforclsid-function.md | 2 +- .../unmanaged-api/hosting/getversionfromprocess-function.md | 2 +- docs/core/unmanaged-api/hosting/host-type-enumeration.md | 2 +- .../unmanaged-api/hosting/iactiononclrevent-interface.md | 2 +- .../hosting/iactiononclrevent-onevent-method.md | 2 +- .../hosting/iapartmentcallback-docallback-method.md | 2 +- .../unmanaged-api/hosting/iapartmentcallback-interface.md | 2 +- .../unmanaged-api/hosting/iappdomainbinding-interface.md | 2 +- .../hosting/iappdomainbinding-onappdomain-method.md | 2 +- .../core/unmanaged-api/hosting/iappdomainsetup-interface.md | 2 +- docs/core/unmanaged-api/hosting/iceefilegen-class.md | 2 +- ...lrappdomainresourcemonitor-getcurrentallocated-method.md | 2 +- ...iclrappdomainresourcemonitor-getcurrentcputime-method.md | 2 +- ...clrappdomainresourcemonitor-getcurrentsurvived-method.md | 2 +- .../hosting/iclrappdomainresourcemonitor-interface.md | 2 +- ...mblyidentitymanager-getbindingidentityfromfile-method.md | 2 +- ...lyidentitymanager-getbindingidentityfromstream-method.md | 2 +- ...blyidentitymanager-getclrassemblyreferencelist-method.md | 2 +- ...ntitymanager-getprobingassembliesfromreference-method.md | 2 +- ...dentitymanager-getreferencedassembliesfromfile-method.md | 2 +- ...ntitymanager-getreferencedassembliesfromstream-method.md | 2 +- .../hosting/iclrassemblyidentitymanager-interface.md | 2 +- .../iclrassemblyidentitymanager-isstronglynamed-method.md | 2 +- .../hosting/iclrassemblyreferencelist-interface.md | 2 +- ...ssemblyreferencelist-isassemblyreferenceinlist-method.md | 2 +- ...yreferencelist-isstringassemblyreferenceinlist-method.md | 2 +- .../hosting/iclrcontrol-getclrmanager-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrcontrol-interface.md | 2 +- .../hosting/iclrcontrol-setappdomainmanagertype-method.md | 2 +- .../hosting/iclrdebugmanager-beginconnection-method.md | 2 +- .../hosting/iclrdebugmanager-endconnection-method.md | 2 +- .../hosting/iclrdebugmanager-getdacl-method.md | 2 +- .../unmanaged-api/hosting/iclrdebugmanager-interface.md | 2 +- .../hosting/iclrdebugmanager-isdebuggerattached-method.md | 2 +- .../hosting/iclrdebugmanager-setconnectiontasks-method.md | 2 +- .../hosting/iclrdebugmanager-setdacl-method.md | 2 +- .../iclrdebugmanager-setsymbolreadingpolicy-method.md | 2 +- .../unmanaged-api/hosting/iclrdomainmanager-interface.md | 2 +- .../iclrdomainmanager-setappdomainmanagertype-method.md | 2 +- ...domainmanager-setpropertiesfordefaultappdomain-method.md | 2 +- .../iclrerrorreportingmanager-begincustomdump-method.md | 2 +- .../iclrerrorreportingmanager-endcustomdump-method.md | 2 +- ...manager-getbucketparametersforcurrentexception-method.md | 2 +- .../hosting/iclrerrorreportingmanager-interface.md | 2 +- .../unmanaged-api/hosting/iclrgcmanager-collect-method.md | 2 +- .../unmanaged-api/hosting/iclrgcmanager-getstats-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md | 2 +- .../hosting/iclrgcmanager-setgcstartuplimits-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md | 2 +- .../hosting/iclrgcmanager2-setgcstartuplimitsex-method.md | 2 +- .../iclrhostbindingpolicymanager-evaluatepolicy-method.md | 2 +- .../hosting/iclrhostbindingpolicymanager-interface.md | 2 +- ...stbindingpolicymanager-modifyapplicationpolicy-method.md | 2 +- .../hosting/iclrhostprotectionmanager-interface.md | 2 +- ...stprotectionmanager-seteagerserializegrantsets-method.md | 2 +- ...lrhostprotectionmanager-setprotectedcategories-method.md | 2 +- .../hosting/iclriocompletionmanager-interface.md | 2 +- .../hosting/iclriocompletionmanager-oncomplete-method.md | 2 +- .../hosting/iclrmemorynotificationcallback-interface.md | 2 +- ...emorynotificationcallback-onmemorynotification-method.md | 2 +- .../iclrmetahost-enumerateinstalledruntimes-method.md | 2 +- .../hosting/iclrmetahost-enumerateloadedruntimes-method.md | 2 +- .../hosting/iclrmetahost-exitprocess-method.md | 2 +- .../unmanaged-api/hosting/iclrmetahost-getruntime-method.md | 2 +- .../hosting/iclrmetahost-getversionfromfile-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrmetahost-interface.md | 2 +- .../iclrmetahost-querylegacyv2runtimebinding-method.md | 2 +- .../iclrmetahost-requestruntimeloadednotification-method.md | 2 +- .../iclrmetahostpolicy-getrequestedruntime-method.md | 2 +- .../unmanaged-api/hosting/iclrmetahostpolicy-interface.md | 2 +- .../unmanaged-api/hosting/iclroneventmanager-interface.md | 2 +- .../iclroneventmanager-registeractiononevent-method.md | 2 +- .../iclroneventmanager-unregisteractiononevent-method.md | 2 +- .../unmanaged-api/hosting/iclrpolicymanager-interface.md | 2 +- .../hosting/iclrpolicymanager-setactiononfailure-method.md | 2 +- .../hosting/iclrpolicymanager-setactionontimeout-method.md | 2 +- .../hosting/iclrpolicymanager-setdefaultaction-method.md | 2 +- .../hosting/iclrpolicymanager-settimeout-method.md | 2 +- .../hosting/iclrpolicymanager-settimeoutandaction-method.md | 2 +- .../iclrpolicymanager-setunhandledexceptionpolicy-method.md | 2 +- .../hosting/iclrprobingassemblyenum-get-method.md | 2 +- .../hosting/iclrprobingassemblyenum-interface.md | 2 +- .../hosting/iclrreferenceassemblyenum-get-method.md | 2 +- .../hosting/iclrreferenceassemblyenum-interface.md | 2 +- .../hosting/iclrruntimehost-executeapplication-method.md | 2 +- .../hosting/iclrruntimehost-executeinappdomain-method.md | 2 +- .../iclrruntimehost-executeindefaultappdomain-method.md | 2 +- .../hosting/iclrruntimehost-getclrcontrol-method.md | 2 +- .../hosting/iclrruntimehost-getcurrentappdomainid-method.md | 2 +- .../core/unmanaged-api/hosting/iclrruntimehost-interface.md | 2 +- .../hosting/iclrruntimehost-sethostcontrol-method.md | 2 +- .../unmanaged-api/hosting/iclrruntimehost-start-method.md | 2 +- .../unmanaged-api/hosting/iclrruntimehost-stop-method.md | 2 +- .../hosting/iclrruntimehost-unloadappdomain-method.md | 2 +- .../hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md | 2 +- .../iclrruntimeinfo-getdefaultstartupflags-method.md | 2 +- .../hosting/iclrruntimeinfo-getinterface-method.md | 2 +- .../hosting/iclrruntimeinfo-getprocaddress-method.md | 2 +- .../hosting/iclrruntimeinfo-getruntimedirectory-method.md | 2 +- .../hosting/iclrruntimeinfo-getversionstring-method.md | 2 +- .../core/unmanaged-api/hosting/iclrruntimeinfo-interface.md | 2 +- .../hosting/iclrruntimeinfo-isloadable-method.md | 2 +- .../hosting/iclrruntimeinfo-isloaded-method.md | 2 +- .../hosting/iclrruntimeinfo-isstarted-method.md | 2 +- .../hosting/iclrruntimeinfo-loaderrorstring-method.md | 2 +- .../hosting/iclrruntimeinfo-loadlibrary-method.md | 2 +- .../iclrruntimeinfo-setdefaultstartupflags-method.md | 2 +- .../iclrstrongname-gethashfromassemblyfile-method.md | 2 +- .../iclrstrongname-gethashfromassemblyfilew-method.md | 2 +- .../hosting/iclrstrongname-gethashfromblob-method.md | 2 +- .../hosting/iclrstrongname-gethashfromfile-method.md | 2 +- .../hosting/iclrstrongname-gethashfromfilew-method.md | 2 +- .../hosting/iclrstrongname-gethashfromhandle-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrstrongname-interface.md | 2 +- .../iclrstrongname-strongnamecompareassemblies-method.md | 2 +- .../hosting/iclrstrongname-strongnamefreebuffer-method.md | 2 +- .../hosting/iclrstrongname-strongnamegetblob-method.md | 2 +- .../iclrstrongname-strongnamegetblobfromimage-method.md | 2 +- .../hosting/iclrstrongname-strongnamegetpublickey-method.md | 2 +- .../hosting/iclrstrongname-strongnamehashsize-method.md | 2 +- .../hosting/iclrstrongname-strongnamekeydelete-method.md | 2 +- .../hosting/iclrstrongname-strongnamekeygen-method.md | 2 +- .../hosting/iclrstrongname-strongnamekeygenex-method.md | 2 +- .../hosting/iclrstrongname-strongnamekeyinstall-method.md | 2 +- .../iclrstrongname-strongnamesignaturegeneration-method.md | 2 +- ...iclrstrongname-strongnamesignaturegenerationex-method.md | 2 +- .../iclrstrongname-strongnamesignaturesize-method.md | 2 +- ...iclrstrongname-strongnamesignatureverification-method.md | 2 +- ...lrstrongname-strongnamesignatureverificationex-method.md | 2 +- ...gname-strongnamesignatureverificationfromimage-method.md | 2 +- .../iclrstrongname-strongnametokenfromassembly-method.md | 2 +- .../iclrstrongname-strongnametokenfromassemblyex-method.md | 2 +- .../iclrstrongname-strongnametokenfrompublickey-method.md | 2 +- .../core/unmanaged-api/hosting/iclrstrongname2-interface.md | 2 +- .../iclrsyncmanager-createrwlockowneriterator-method.md | 2 +- .../iclrsyncmanager-deleterwlockowneriterator-method.md | 2 +- .../hosting/iclrsyncmanager-getmonitorowner-method.md | 2 +- .../hosting/iclrsyncmanager-getrwlockownernext-method.md | 2 +- .../core/unmanaged-api/hosting/iclrsyncmanager-interface.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-abort-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md | 2 +- .../unmanaged-api/hosting/iclrtask-getmemstats-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-interface.md | 2 +- .../core/unmanaged-api/hosting/iclrtask-locksheld-method.md | 2 +- .../hosting/iclrtask-needspriorityscheduling-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-reset-method.md | 2 +- .../core/unmanaged-api/hosting/iclrtask-rudeabort-method.md | 2 +- .../hosting/iclrtask-settaskidentifier-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md | 2 +- .../core/unmanaged-api/hosting/iclrtask-switchout-method.md | 2 +- .../core/unmanaged-api/hosting/iclrtask-yieldtask-method.md | 2 +- .../hosting/iclrtask2-beginpreventasyncabort-method.md | 2 +- .../hosting/iclrtask2-endpreventasyncabort-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrtask2-interface.md | 2 +- .../hosting/iclrtaskmanager-createtask-method.md | 2 +- .../hosting/iclrtaskmanager-getcurrenttask-method.md | 2 +- .../hosting/iclrtaskmanager-getcurrenttasktype-method.md | 2 +- .../core/unmanaged-api/hosting/iclrtaskmanager-interface.md | 2 +- .../hosting/iclrtaskmanager-setlocale-method.md | 2 +- .../hosting/iclrtaskmanager-setuilocale-method.md | 2 +- .../hosting/iclrvalidator-formateventinfo-method.md | 2 +- docs/core/unmanaged-api/hosting/iclrvalidator-interface.md | 2 +- .../unmanaged-api/hosting/iclrvalidator-validate-method.md | 2 +- .../icorconfiguration-adddebuggerspecialthread-method.md | 2 +- .../unmanaged-api/hosting/icorconfiguration-interface.md | 2 +- .../icorconfiguration-setdebuggerthreadcontrol-method.md | 2 +- .../hosting/icorconfiguration-setgchostcontrol-method.md | 2 +- .../hosting/icorconfiguration-setgcthreadcontrol-method.md | 2 +- .../hosting/icorruntimehost-closeenum-method.md | 2 +- .../hosting/icorruntimehost-createdomain-method.md | 2 +- .../hosting/icorruntimehost-createdomainex-method.md | 2 +- .../hosting/icorruntimehost-createdomainsetup-method.md | 2 +- .../hosting/icorruntimehost-createevidence-method.md | 2 +- .../icorruntimehost-createlogicalthreadstate-method.md | 2 +- .../hosting/icorruntimehost-currentdomain-method.md | 2 +- .../icorruntimehost-deletelogicalthreadstate-method.md | 2 +- .../hosting/icorruntimehost-enumdomains-method.md | 2 +- .../hosting/icorruntimehost-getconfiguration-method.md | 2 +- .../hosting/icorruntimehost-getdefaultdomain-method.md | 2 +- .../core/unmanaged-api/hosting/icorruntimehost-interface.md | 2 +- .../icorruntimehost-locksheldbylogicalthread-method.md | 2 +- .../unmanaged-api/hosting/icorruntimehost-mapfile-method.md | 2 +- .../hosting/icorruntimehost-nextdomain-method.md | 2 +- .../unmanaged-api/hosting/icorruntimehost-start-method.md | 2 +- .../unmanaged-api/hosting/icorruntimehost-stop-method.md | 2 +- .../icorruntimehost-switchinlogicalthreadstate-method.md | 2 +- .../icorruntimehost-switchoutlogicalthreadstate-method.md | 2 +- .../hosting/icorruntimehost-unloaddomain-method.md | 2 +- .../icorthreadpool-corbindiocompletioncallback-method.md | 2 +- .../icorthreadpool-corcallorqueueuserworkitem-method.md | 2 +- .../hosting/icorthreadpool-corchangetimer-method.md | 2 +- .../hosting/icorthreadpool-corcreatetimer-method.md | 2 +- .../hosting/icorthreadpool-cordeletetimer-method.md | 2 +- .../hosting/icorthreadpool-corgetavailablethreads-method.md | 2 +- .../hosting/icorthreadpool-corgetmaxthreads-method.md | 2 +- .../hosting/icorthreadpool-corqueueuserworkitem-method.md | 2 +- .../icorthreadpool-corregisterwaitforsingleobject-method.md | 2 +- .../hosting/icorthreadpool-corsetmaxthreads-method.md | 2 +- .../hosting/icorthreadpool-corunregisterwait-method.md | 2 +- docs/core/unmanaged-api/hosting/icorthreadpool-interface.md | 2 +- docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md | 2 +- .../hosting/idebuggerinfo-isdebuggerattached-method.md | 2 +- .../hosting/idebuggerthreadcontrol-interface.md | 2 +- ...debuggerthreadcontrol-releaseallruntimethreads-method.md | 2 +- ...debuggerthreadcontrol-startblockingfordebugger-method.md | 2 +- ...uggerthreadcontrol-threadisblockingfordebugger-method.md | 2 +- docs/core/unmanaged-api/hosting/igchost-collect-method.md | 2 +- docs/core/unmanaged-api/hosting/igchost-getstats-method.md | 2 +- .../unmanaged-api/hosting/igchost-getthreadstats-method.md | 2 +- docs/core/unmanaged-api/hosting/igchost-interface.md | 2 +- .../hosting/igchost-setgcstartuplimits-method.md | 2 +- .../hosting/igchost-setvirtualmemlimit-method.md | 2 +- docs/core/unmanaged-api/hosting/igchost2-interface.md | 2 +- .../hosting/igchost2-setgcstartuplimitsex-method.md | 2 +- docs/core/unmanaged-api/hosting/igchostcontrol-interface.md | 2 +- .../hosting/igchostcontrol-requestvirtualmemlimit-method.md | 2 +- .../unmanaged-api/hosting/igcthreadcontrol-interface.md | 2 +- .../hosting/igcthreadcontrol-suspensionending-method.md | 2 +- .../hosting/igcthreadcontrol-suspensionstarting-method.md | 2 +- ...igcthreadcontrol-threadisblockingforsuspension-method.md | 2 +- .../hosting/ihostassemblymanager-getassemblystore-method.md | 2 +- ...ihostassemblymanager-getnonhoststoreassemblies-method.md | 2 +- .../unmanaged-api/hosting/ihostassemblymanager-interface.md | 2 +- .../unmanaged-api/hosting/ihostassemblystore-interface.md | 2 +- .../hosting/ihostassemblystore-provideassembly-method.md | 2 +- .../hosting/ihostassemblystore-providemodule-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostautoevent-interface.md | 2 +- .../core/unmanaged-api/hosting/ihostautoevent-set-method.md | 2 +- .../unmanaged-api/hosting/ihostautoevent-wait-method.md | 2 +- .../hosting/ihostcontrol-gethostmanager-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostcontrol-interface.md | 2 +- .../hosting/ihostcontrol-setappdomainmanager-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostcrst-interface.md | 2 +- docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md | 2 +- .../unmanaged-api/hosting/ihostcrst-setspincount-method.md | 2 +- .../core/unmanaged-api/hosting/ihostcrst-tryenter-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md | 2 +- .../hosting/ihostgcmanager-suspensionending-method.md | 2 +- .../hosting/ihostgcmanager-suspensionstarting-method.md | 2 +- .../ihostgcmanager-threadisblockingforsuspension-method.md | 2 +- .../hosting/ihostiocompletionmanager-bind-method.md | 2 +- ...ihostiocompletionmanager-closeiocompletionport-method.md | 2 +- ...hostiocompletionmanager-createiocompletionport-method.md | 2 +- .../ihostiocompletionmanager-getavailablethreads-method.md | 2 +- ...ihostiocompletionmanager-gethostoverlappedsize-method.md | 2 +- .../ihostiocompletionmanager-getmaxthreads-method.md | 2 +- .../ihostiocompletionmanager-getminthreads-method.md | 2 +- ...stiocompletionmanager-initializehostoverlapped-method.md | 2 +- .../hosting/ihostiocompletionmanager-interface.md | 2 +- ...tiocompletionmanager-setclriocompletionmanager-method.md | 2 +- .../ihostiocompletionmanager-setmaxthreads-method.md | 2 +- .../ihostiocompletionmanager-setminthreads-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md | 2 +- .../unmanaged-api/hosting/ihostmalloc-debugalloc-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostmalloc-interface.md | 2 +- .../unmanaged-api/hosting/ihostmanualevent-interface.md | 2 +- .../unmanaged-api/hosting/ihostmanualevent-reset-method.md | 2 +- .../unmanaged-api/hosting/ihostmanualevent-set-method.md | 2 +- .../unmanaged-api/hosting/ihostmanualevent-wait-method.md | 2 +- ...ihostmemorymanager-acquiredvirtualaddressspace-method.md | 2 +- .../hosting/ihostmemorymanager-createmalloc-method.md | 2 +- .../hosting/ihostmemorymanager-getmemoryload-method.md | 2 +- .../unmanaged-api/hosting/ihostmemorymanager-interface.md | 2 +- .../ihostmemorymanager-needsvirtualaddressspace-method.md | 2 +- ...morymanager-registermemorynotificationcallback-method.md | 2 +- ...ihostmemorymanager-releasedvirtualaddressspace-method.md | 2 +- .../hosting/ihostmemorymanager-virtualalloc-method.md | 2 +- .../hosting/ihostmemorymanager-virtualfree-method.md | 2 +- .../hosting/ihostmemorymanager-virtualprotect-method.md | 2 +- .../hosting/ihostmemorymanager-virtualquery-method.md | 2 +- .../unmanaged-api/hosting/ihostpolicymanager-interface.md | 2 +- .../hosting/ihostpolicymanager-ondefaultaction-method.md | 2 +- .../hosting/ihostpolicymanager-onfailure-method.md | 2 +- .../hosting/ihostpolicymanager-ontimeout-method.md | 2 +- .../hosting/ihostsecuritycontext-capture-method.md | 2 +- .../unmanaged-api/hosting/ihostsecuritycontext-interface.md | 2 +- .../ihostsecuritymanager-getsecuritycontext-method.md | 2 +- .../ihostsecuritymanager-impersonateloggedonuser-method.md | 2 +- .../unmanaged-api/hosting/ihostsecuritymanager-interface.md | 2 +- .../hosting/ihostsecuritymanager-openthreadtoken-method.md | 2 +- .../hosting/ihostsecuritymanager-reverttoself-method.md | 2 +- .../ihostsecuritymanager-setsecuritycontext-method.md | 2 +- .../hosting/ihostsecuritymanager-setthreadtoken-method.md | 2 +- docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md | 2 +- .../hosting/ihostsemaphore-releasesemaphore-method.md | 2 +- .../unmanaged-api/hosting/ihostsemaphore-wait-method.md | 2 +- .../hosting/ihostsyncmanager-createautoevent-method.md | 2 +- .../hosting/ihostsyncmanager-createcrst-method.md | 2 +- .../ihostsyncmanager-createcrstwithspincount-method.md | 2 +- .../hosting/ihostsyncmanager-createmanualevent-method.md | 2 +- .../hosting/ihostsyncmanager-createmonitorevent-method.md | 2 +- .../ihostsyncmanager-createrwlockreaderevent-method.md | 2 +- .../ihostsyncmanager-createrwlockwriterevent-method.md | 2 +- .../hosting/ihostsyncmanager-createsemaphore-method.md | 2 +- .../unmanaged-api/hosting/ihostsyncmanager-interface.md | 2 +- .../hosting/ihostsyncmanager-setclrsyncmanager-method.md | 2 +- docs/core/unmanaged-api/hosting/ihosttask-alert-method.md | 2 +- .../unmanaged-api/hosting/ihosttask-getpriority-method.md | 2 +- docs/core/unmanaged-api/hosting/ihosttask-interface.md | 2 +- docs/core/unmanaged-api/hosting/ihosttask-join-method.md | 2 +- .../unmanaged-api/hosting/ihosttask-setclrtask-method.md | 2 +- .../unmanaged-api/hosting/ihosttask-setpriority-method.md | 2 +- docs/core/unmanaged-api/hosting/ihosttask-start-method.md | 2 +- .../hosting/ihosttaskmanager-begindelayabort-method.md | 2 +- .../hosting/ihosttaskmanager-beginthreadaffinity-method.md | 2 +- .../hosting/ihosttaskmanager-callneedshosthook-method.md | 2 +- .../hosting/ihosttaskmanager-createtask-method.md | 2 +- .../hosting/ihosttaskmanager-enddelayabort-method.md | 2 +- .../hosting/ihosttaskmanager-endthreadaffinity-method.md | 2 +- .../hosting/ihosttaskmanager-enterruntime-method.md | 2 +- .../hosting/ihosttaskmanager-getcurrenttask-method.md | 2 +- .../hosting/ihosttaskmanager-getstackguarantee-method.md | 2 +- .../unmanaged-api/hosting/ihosttaskmanager-interface.md | 2 +- .../hosting/ihosttaskmanager-leaveruntime-method.md | 2 +- .../hosting/ihosttaskmanager-reverseenterruntime-method.md | 2 +- .../hosting/ihosttaskmanager-reverseleaveruntime-method.md | 2 +- .../hosting/ihosttaskmanager-setclrtaskmanager-method.md | 2 +- .../hosting/ihosttaskmanager-setlocale-method.md | 2 +- .../hosting/ihosttaskmanager-setstackguarantee-method.md | 2 +- .../hosting/ihosttaskmanager-setuilocale-method.md | 2 +- .../unmanaged-api/hosting/ihosttaskmanager-sleep-method.md | 2 +- .../hosting/ihosttaskmanager-switchtotask-method.md | 2 +- .../ihostthreadpoolmanager-getavailablethreads-method.md | 2 +- .../hosting/ihostthreadpoolmanager-getmaxthreads-method.md | 2 +- .../hosting/ihostthreadpoolmanager-getminthreads-method.md | 2 +- .../hosting/ihostthreadpoolmanager-interface.md | 2 +- .../ihostthreadpoolmanager-queueuserworkitem-method.md | 2 +- .../hosting/ihostthreadpoolmanager-setmaxthreads-method.md | 2 +- .../hosting/ihostthreadpoolmanager-setminthreads-method.md | 2 +- .../hosting/imanagedobject-getobjectidentity-method.md | 2 +- .../hosting/imanagedobject-getserializedbuffer-method.md | 2 +- docs/core/unmanaged-api/hosting/imanagedobject-interface.md | 2 +- docs/core/unmanaged-api/hosting/iobjecthandle-interface.md | 2 +- .../unmanaged-api/hosting/iobjecthandle-unwrap-method.md | 2 +- .../hosting/itypename-getassemblyname-method.md | 2 +- .../hosting/itypename-getmodifierlength-method.md | 2 +- .../unmanaged-api/hosting/itypename-getmodifiers-method.md | 2 +- .../unmanaged-api/hosting/itypename-getnamecount-method.md | 2 +- .../core/unmanaged-api/hosting/itypename-getnames-method.md | 2 +- .../hosting/itypename-gettypeargumentcount-method.md | 2 +- .../hosting/itypename-gettypearguments-method.md | 2 +- docs/core/unmanaged-api/hosting/itypename-interface.md | 2 +- .../hosting/itypenamebuilder-addarray-method.md | 2 +- .../hosting/itypenamebuilder-addassemblyspec-method.md | 2 +- .../hosting/itypenamebuilder-addbyref-method.md | 2 +- .../hosting/itypenamebuilder-addname-method.md | 2 +- .../hosting/itypenamebuilder-addpointer-method.md | 2 +- .../hosting/itypenamebuilder-addszarray-method.md | 2 +- .../unmanaged-api/hosting/itypenamebuilder-clear-method.md | 2 +- .../hosting/itypenamebuilder-closegenericargument-method.md | 2 +- .../itypenamebuilder-closegenericarguments-method.md | 2 +- .../unmanaged-api/hosting/itypenamebuilder-interface.md | 2 +- .../hosting/itypenamebuilder-opengenericargument-method.md | 2 +- .../hosting/itypenamebuilder-opengenericarguments-method.md | 2 +- .../hosting/itypenamebuilder-tostring-method.md | 2 +- .../hosting/itypenamefactory-gettypenamebuilder-method.md | 2 +- .../unmanaged-api/hosting/itypenamefactory-interface.md | 2 +- .../hosting/itypenamefactory-parsetypename-method.md | 2 +- .../hosting/ivalidator-formateventinfo-method.md | 2 +- docs/core/unmanaged-api/hosting/ivalidator-interface.md | 2 +- .../unmanaged-api/hosting/ivalidator-validate-method.md | 2 +- docs/core/unmanaged-api/hosting/loadlibraryshim-function.md | 2 +- docs/core/unmanaged-api/hosting/loadstringrc-function.md | 2 +- docs/core/unmanaged-api/hosting/loadstringrcex-function.md | 2 +- docs/core/unmanaged-api/hosting/lockclrversion-function.md | 2 +- .../lpoverlapped-completion-routine-function-pointer.md | 2 +- .../hosting/lpthread-start-routine-function-pointer.md | 2 +- docs/core/unmanaged-api/hosting/malloc-type-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/mdainfo-structure.md | 2 +- .../hosting/metahost-config-flags-enumeration.md | 2 +- .../hosting/metahost-policy-flags-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/modulebindinfo-structure.md | 2 +- .../net-framework-4-hosting-global-static-functions.md | 2 +- docs/core/unmanaged-api/hosting/rundll32shimw-function.md | 2 +- .../unmanaged-api/hosting/runtime-info-flags-enumeration.md | 2 +- .../unmanaged-api/hosting/stackoverflowinfo-structure.md | 2 +- .../unmanaged-api/hosting/stackoverflowtype-enumeration.md | 2 +- .../core/unmanaged-api/hosting/startup-flags-enumeration.md | 2 +- .../hosting/strongnamegetpublickeyex-method.md | 2 +- .../hosting/strongnamesignatureverificationex2-method.md | 2 +- docs/core/unmanaged-api/hosting/typenamefactory-coclass.md | 2 +- .../unmanaged-api/hosting/validatorflags-enumeration.md | 2 +- docs/core/unmanaged-api/hosting/wait-option-enumeration.md | 2 +- .../hosting/waitortimercallback-function-pointer.md | 2 +- .../unmanaged-api/metadata/assemblyflags-enumeration.md | 2 +- .../unmanaged-api/metadata/assemblymetadata-structure.md | 2 +- .../unmanaged-api/metadata/assemblyrefflags-enumeration.md | 2 +- .../unmanaged-api/metadata/ceesectionattr-enumeration.md | 2 +- .../unmanaged-api/metadata/ceesectionrelocextra-union.md | 2 +- .../metadata/ceesectionreloctype-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/coiniticor-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/coinitiee-enumeration.md | 2 +- .../unmanaged-api/metadata/cor-field-offset-structure.md | 2 +- .../unmanaged-api/metadata/cor-native-link-structure.md | 2 +- docs/core/unmanaged-api/metadata/corargtype-enumeration.md | 2 +- .../unmanaged-api/metadata/corassemblyflags-enumeration.md | 2 +- .../metadata/corattributetargets-enumeration.md | 2 +- .../metadata/corcallingconvention-enumeration.md | 2 +- .../metadata/corcheckduplicatesfor-enumeration.md | 2 +- .../unmanaged-api/metadata/cordeclsecurity-enumeration.md | 2 +- .../unmanaged-api/metadata/corelementtype-enumeration.md | 2 +- .../metadata/corerrorifemitoutoforder-enumeration.md | 2 +- .../core/unmanaged-api/metadata/coreventattr-enumeration.md | 2 +- .../core/unmanaged-api/metadata/corfieldattr-enumeration.md | 2 +- .../core/unmanaged-api/metadata/corfileflags-enumeration.md | 2 +- .../unmanaged-api/metadata/corfilemapping-enumeration.md | 2 +- .../metadata/corgenericparamattr-enumeration.md | 2 +- .../unmanaged-api/metadata/corimportoptions-enumeration.md | 2 +- .../unmanaged-api/metadata/corlinkeroptions-enumeration.md | 2 +- .../metadata/corlocalrefpreservation-enumeration.md | 2 +- .../metadata/cormanifestresourceflags-enumeration.md | 2 +- .../unmanaged-api/metadata/cormethodattr-enumeration.md | 2 +- .../unmanaged-api/metadata/cormethodimpl-enumeration.md | 2 +- .../metadata/cormethodsemanticsattr-enumeration.md | 2 +- .../metadata/cornativelinkflags-enumeration.md | 2 +- .../unmanaged-api/metadata/cornativelinktype-enumeration.md | 2 +- .../unmanaged-api/metadata/cornativetype-enumeration.md | 2 +- .../metadata/cornotificationfortokenmovement-enumeration.md | 2 +- .../core/unmanaged-api/metadata/coropenflags-enumeration.md | 2 +- .../core/unmanaged-api/metadata/corparamattr-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corpekind-enumeration.md | 2 +- .../unmanaged-api/metadata/corpinvokemap-enumeration.md | 2 +- .../unmanaged-api/metadata/corpropertyattr-enumeration.md | 2 +- .../unmanaged-api/metadata/correftodefcheck-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corregflags-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corsavesize-enumeration.md | 2 +- .../metadata/corserializationtype-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/corsetenc-enumeration.md | 2 +- .../metadata/corthreadsafetyoptions-enumeration.md | 2 +- .../core/unmanaged-api/metadata/cortokentype-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/cortypeattr-enumeration.md | 2 +- .../metadata/corunmanagedcallingconvention-enumeration.md | 2 +- .../metadata/corvalidatormoduletype-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/couninitiee-enumeration.md | 2 +- docs/core/unmanaged-api/metadata/cvstruct-structure.md | 2 +- .../metadata/iceegen-addsectionreloc-method.md | 2 +- .../metadata/iceegen-allocatemethodbuffer-method.md | 2 +- .../unmanaged-api/metadata/iceegen-computepointer-method.md | 2 +- .../unmanaged-api/metadata/iceegen-emitstring-method.md | 2 +- .../metadata/iceegen-generateceefile-method.md | 2 +- .../metadata/iceegen-generateceememoryimage-method.md | 2 +- .../unmanaged-api/metadata/iceegen-getilsection-method.md | 2 +- .../metadata/iceegen-getimaptokeniface-method.md | 2 +- .../metadata/iceegen-getmethodbuffer-method.md | 2 +- .../metadata/iceegen-getsectionblock-method.md | 2 +- .../metadata/iceegen-getsectioncreate-method.md | 2 +- .../metadata/iceegen-getsectiondatalen-method.md | 2 +- .../core/unmanaged-api/metadata/iceegen-getstring-method.md | 2 +- .../metadata/iceegen-getstringsection-method.md | 2 +- docs/core/unmanaged-api/metadata/iceegen-interface.md | 2 +- .../metadata/iceegen-truncatesection-method.md | 2 +- docs/core/unmanaged-api/metadata/ihostfilter-interface.md | 2 +- .../unmanaged-api/metadata/ihostfilter-marktoken-method.md | 2 +- docs/core/unmanaged-api/metadata/imaptoken-interface.md | 2 +- docs/core/unmanaged-api/metadata/imaptoken-map-method.md | 2 +- .../metadata/imetadataassemblyemit-defineassembly-method.md | 2 +- .../imetadataassemblyemit-defineassemblyref-method.md | 2 +- .../imetadataassemblyemit-defineexportedtype-method.md | 2 +- .../metadata/imetadataassemblyemit-definefile-method.md | 2 +- .../imetadataassemblyemit-definemanifestresource-method.md | 2 +- .../metadata/imetadataassemblyemit-interface.md | 2 +- .../imetadataassemblyemit-setassemblyprops-method.md | 2 +- .../imetadataassemblyemit-setassemblyrefprops-method.md | 2 +- .../imetadataassemblyemit-setexportedtypeprops-method.md | 2 +- .../metadata/imetadataassemblyemit-setfileprops-method.md | 2 +- ...imetadataassemblyemit-setmanifestresourceprops-method.md | 2 +- .../metadata/imetadataassemblyimport-closeenum-method.md | 2 +- .../imetadataassemblyimport-enumassemblyrefs-method.md | 2 +- .../imetadataassemblyimport-enumexportedtypes-method.md | 2 +- .../metadata/imetadataassemblyimport-enumfiles-method.md | 2 +- .../imetadataassemblyimport-enummanifestresources-method.md | 2 +- .../imetadataassemblyimport-findassembliesbyname-method.md | 2 +- ...imetadataassemblyimport-findexportedtypebyname-method.md | 2 +- ...adataassemblyimport-findmanifestresourcebyname-method.md | 2 +- .../imetadataassemblyimport-getassemblyfromscope-method.md | 2 +- .../imetadataassemblyimport-getassemblyprops-method.md | 2 +- .../imetadataassemblyimport-getassemblyrefprops-method.md | 2 +- .../imetadataassemblyimport-getexportedtypeprops-method.md | 2 +- .../metadata/imetadataassemblyimport-getfileprops-method.md | 2 +- ...etadataassemblyimport-getmanifestresourceprops-method.md | 2 +- .../metadata/imetadataassemblyimport-interface.md | 2 +- .../imetadataconverter-getmetadatafromtypeinfo-method.md | 2 +- .../imetadataconverter-getmetadatafromtypelib-method.md | 2 +- .../imetadataconverter-gettypelibfrommetadata-method.md | 2 +- .../unmanaged-api/metadata/imetadataconverter-interface.md | 2 +- .../metadata/imetadatadispenser-definescope-method.md | 2 +- .../unmanaged-api/metadata/imetadatadispenser-interface.md | 2 +- .../metadata/imetadatadispenser-openscope-method.md | 2 +- .../metadata/imetadatadispenser-openscopeonmemory-method.md | 2 +- .../metadata/imetadatadispenserex-findassembly-method.md | 2 +- .../imetadatadispenserex-findassemblymodule-method.md | 2 +- .../imetadatadispenserex-getcorsystemdirectory-method.md | 2 +- .../metadata/imetadatadispenserex-getoption-method.md | 2 +- .../metadata/imetadatadispenserex-interface.md | 2 +- .../imetadatadispenserex-openscopeonitypeinfo-method.md | 2 +- .../metadata/imetadatadispenserex-setoption-method.md | 2 +- .../metadata/imetadataemit-applyeditandcontinue-method.md | 2 +- .../metadata/imetadataemit-definecustomattribute-method.md | 2 +- .../metadata/imetadataemit-defineevent-method.md | 2 +- .../metadata/imetadataemit-definefield-method.md | 2 +- .../metadata/imetadataemit-defineimportmember-method.md | 2 +- .../metadata/imetadataemit-defineimporttype-method.md | 2 +- .../metadata/imetadataemit-definememberref-method.md | 2 +- .../metadata/imetadataemit-definemethod-method.md | 2 +- .../metadata/imetadataemit-definemethodimpl-method.md | 2 +- .../metadata/imetadataemit-definemoduleref-method.md | 2 +- .../metadata/imetadataemit-definenestedtype-method.md | 2 +- .../metadata/imetadataemit-defineparam-method.md | 2 +- .../metadata/imetadataemit-definepermissionset-method.md | 2 +- .../metadata/imetadataemit-definepinvokemap-method.md | 2 +- .../metadata/imetadataemit-defineproperty-method.md | 2 +- .../imetadataemit-definesecurityattributeset-method.md | 2 +- .../metadata/imetadataemit-definetypedef-method.md | 2 +- .../metadata/imetadataemit-definetyperefbyname-method.md | 2 +- .../metadata/imetadataemit-defineuserstring-method.md | 2 +- .../metadata/imetadataemit-deleteclasslayout-method.md | 2 +- .../metadata/imetadataemit-deletefieldmarshal-method.md | 2 +- .../metadata/imetadataemit-deletepinvokemap-method.md | 2 +- .../metadata/imetadataemit-deletetoken-method.md | 2 +- .../metadata/imetadataemit-getsavesize-method.md | 2 +- .../metadata/imetadataemit-gettokenfromsig-method.md | 2 +- .../metadata/imetadataemit-gettokenfromtypespec-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadataemit-interface.md | 2 +- .../unmanaged-api/metadata/imetadataemit-merge-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-mergeend-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-save-method.md | 2 +- .../metadata/imetadataemit-savetomemory-method.md | 2 +- .../metadata/imetadataemit-savetostream-method.md | 2 +- .../metadata/imetadataemit-setclasslayout-method.md | 2 +- .../imetadataemit-setcustomattributevalue-method.md | 2 +- .../metadata/imetadataemit-seteventprops-method.md | 2 +- .../metadata/imetadataemit-setfieldmarshal-method.md | 2 +- .../metadata/imetadataemit-setfieldprops-method.md | 2 +- .../metadata/imetadataemit-setfieldrva-method.md | 2 +- .../metadata/imetadataemit-sethandler-method.md | 2 +- .../metadata/imetadataemit-setmethodimplflags-method.md | 2 +- .../metadata/imetadataemit-setmethodprops-method.md | 2 +- .../metadata/imetadataemit-setmoduleprops-method.md | 2 +- .../metadata/imetadataemit-setparamprops-method.md | 2 +- .../metadata/imetadataemit-setparent-method.md | 2 +- .../metadata/imetadataemit-setpermissionsetprops-method.md | 2 +- .../metadata/imetadataemit-setpinvokemap-method.md | 2 +- .../metadata/imetadataemit-setpropertyprops-method.md | 2 +- .../unmanaged-api/metadata/imetadataemit-setrva-method.md | 2 +- .../metadata/imetadataemit-settypedefprops-method.md | 2 +- .../metadata/imetadataemit-translatesigwithscope-method.md | 2 +- .../metadata/imetadataemit2-definegenericparam-method.md | 2 +- .../metadata/imetadataemit2-definemethodspec-method.md | 2 +- .../metadata/imetadataemit2-getdeltasavesize-method.md | 2 +- .../core/unmanaged-api/metadata/imetadataemit2-interface.md | 2 +- .../metadata/imetadataemit2-resetenclog-method.md | 2 +- .../metadata/imetadataemit2-savedelta-method.md | 2 +- .../metadata/imetadataemit2-savedeltatomemory-method.md | 2 +- .../metadata/imetadataemit2-savedeltatostream-method.md | 2 +- .../metadata/imetadataemit2-setgenericparamprops-method.md | 2 +- .../core/unmanaged-api/metadata/imetadataerror-interface.md | 2 +- .../unmanaged-api/metadata/imetadataerror-onerror-method.md | 2 +- .../unmanaged-api/metadata/imetadatafilter-interface.md | 2 +- .../metadata/imetadatafilter-istokenmarked-method.md | 2 +- .../metadata/imetadatafilter-marktoken-method.md | 2 +- .../metadata/imetadatafilter-unmarkall-method.md | 2 +- .../metadata/imetadataimport-closeenum-method.md | 2 +- .../metadata/imetadataimport-countenum-method.md | 2 +- .../metadata/imetadataimport-enumcustomattributes-method.md | 2 +- .../metadata/imetadataimport-enumevents-method.md | 2 +- .../metadata/imetadataimport-enumfields-method.md | 2 +- .../metadata/imetadataimport-enumfieldswithname-method.md | 2 +- .../metadata/imetadataimport-enuminterfaceimpls-method.md | 2 +- .../metadata/imetadataimport-enummemberrefs-method.md | 2 +- .../metadata/imetadataimport-enummembers-method.md | 2 +- .../metadata/imetadataimport-enummemberswithname-method.md | 2 +- .../metadata/imetadataimport-enummethodimpls-method.md | 2 +- .../metadata/imetadataimport-enummethods-method.md | 2 +- .../metadata/imetadataimport-enummethodsemantics-method.md | 2 +- .../metadata/imetadataimport-enummethodswithname-method.md | 2 +- .../metadata/imetadataimport-enummodulerefs-method.md | 2 +- .../metadata/imetadataimport-enumparams-method.md | 2 +- .../metadata/imetadataimport-enumpermissionsets-method.md | 2 +- .../metadata/imetadataimport-enumproperties-method.md | 2 +- .../metadata/imetadataimport-enumsignatures-method.md | 2 +- .../metadata/imetadataimport-enumtypedefs-method.md | 2 +- .../metadata/imetadataimport-enumtyperefs-method.md | 2 +- .../metadata/imetadataimport-enumtypespecs-method.md | 2 +- .../imetadataimport-enumunresolvedmethods-method.md | 2 +- .../metadata/imetadataimport-enumuserstrings-method.md | 2 +- .../metadata/imetadataimport-findfield-method.md | 2 +- .../metadata/imetadataimport-findmember-method.md | 2 +- .../metadata/imetadataimport-findmemberref-method.md | 2 +- .../metadata/imetadataimport-findmethod-method.md | 2 +- .../metadata/imetadataimport-findtypedefbyname-method.md | 2 +- .../metadata/imetadataimport-findtyperef-method.md | 2 +- .../metadata/imetadataimport-getclasslayout-method.md | 2 +- .../imetadataimport-getcustomattributebyname-method.md | 2 +- .../imetadataimport-getcustomattributeprops-method.md | 2 +- .../metadata/imetadataimport-geteventprops-method.md | 2 +- .../metadata/imetadataimport-getfieldmarshal-method.md | 2 +- .../metadata/imetadataimport-getfieldprops-method.md | 2 +- .../imetadataimport-getinterfaceimplprops-method.md | 2 +- .../metadata/imetadataimport-getmemberprops-method.md | 2 +- .../metadata/imetadataimport-getmemberrefprops-method.md | 2 +- .../metadata/imetadataimport-getmethodprops-method.md | 2 +- .../metadata/imetadataimport-getmethodsemantics-method.md | 2 +- .../metadata/imetadataimport-getmodulefromscope-method.md | 2 +- .../metadata/imetadataimport-getmodulerefprops-method.md | 2 +- .../metadata/imetadataimport-getnamefromtoken-method.md | 2 +- .../imetadataimport-getnativecallconvfromsig-method.md | 2 +- .../metadata/imetadataimport-getnestedclassprops-method.md | 2 +- .../imetadataimport-getparamformethodindex-method.md | 2 +- .../metadata/imetadataimport-getparamprops-method.md | 2 +- .../imetadataimport-getpermissionsetprops-method.md | 2 +- .../metadata/imetadataimport-getpinvokemap-method.md | 2 +- .../metadata/imetadataimport-getpropertyprops-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport-getrva-method.md | 2 +- .../metadata/imetadataimport-getscopeprops-method.md | 2 +- .../metadata/imetadataimport-getsigfromtoken-method.md | 2 +- .../metadata/imetadataimport-gettypedefprops-method.md | 2 +- .../metadata/imetadataimport-gettyperefprops-method.md | 2 +- .../metadata/imetadataimport-gettypespecfromtoken-method.md | 2 +- .../metadata/imetadataimport-getuserstring-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport-interface.md | 2 +- .../metadata/imetadataimport-isglobal-method.md | 2 +- .../metadata/imetadataimport-isvalidtoken-method.md | 2 +- .../metadata/imetadataimport-resetenum-method.md | 2 +- .../metadata/imetadataimport-resolvetyperef-method.md | 2 +- .../imetadataimport2-enumgenericparamconstraints-method.md | 2 +- .../metadata/imetadataimport2-enumgenericparams-method.md | 2 +- .../metadata/imetadataimport2-enummethodspecs-method.md | 2 +- ...metadataimport2-getgenericparamconstraintprops-method.md | 2 +- .../imetadataimport2-getgenericparamprops-method.md | 2 +- .../metadata/imetadataimport2-getmethodspecprops-method.md | 2 +- .../metadata/imetadataimport2-getpekind-method.md | 2 +- .../metadata/imetadataimport2-getversionstring-method.md | 2 +- .../unmanaged-api/metadata/imetadataimport2-interface.md | 2 +- .../metadata/imetadatainfo-getfilemapping-method.md | 2 +- docs/core/unmanaged-api/metadata/imetadatainfo-interface.md | 2 +- .../metadata/imetadatatables-getblob-method.md | 2 +- .../metadata/imetadatatables-getblobheapsize-method.md | 2 +- .../metadata/imetadatatables-getcodedtokeninfo-method.md | 2 +- .../metadata/imetadatatables-getcolumn-method.md | 2 +- .../metadata/imetadatatables-getcolumninfo-method.md | 2 +- .../metadata/imetadatatables-getguid-method.md | 2 +- .../metadata/imetadatatables-getguidheapsize-method.md | 2 +- .../metadata/imetadatatables-getnextblob-method.md | 2 +- .../metadata/imetadatatables-getnextguid-method.md | 2 +- .../metadata/imetadatatables-getnextstring-method.md | 2 +- .../metadata/imetadatatables-getnextuserstring-method.md | 2 +- .../metadata/imetadatatables-getnumtables-method.md | 2 +- .../unmanaged-api/metadata/imetadatatables-getrow-method.md | 2 +- .../metadata/imetadatatables-getstring-method.md | 2 +- .../metadata/imetadatatables-getstringheapsize-method.md | 2 +- .../metadata/imetadatatables-gettableindex-method.md | 2 +- .../metadata/imetadatatables-gettableinfo-method.md | 2 +- .../metadata/imetadatatables-getuserstring-method.md | 2 +- .../imetadatatables-getuserstringheapsize-method.md | 2 +- .../unmanaged-api/metadata/imetadatatables-interface.md | 2 +- .../metadata/imetadatatables2-getmetadatastorage-method.md | 2 +- .../imetadatatables2-getmetadatastreaminfo-method.md | 2 +- .../unmanaged-api/metadata/imetadatatables2-interface.md | 2 +- .../unmanaged-api/metadata/imetadatavalidate-interface.md | 2 +- .../metadata/imetadatavalidate-validatemetadata-method.md | 2 +- .../metadata/imetadatavalidate-validatorinit-method.md | 2 +- docs/core/unmanaged-api/metadata/osinfo-structure.md | 2 +- 724 files changed, 726 insertions(+), 726 deletions(-) diff --git a/docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md b/docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md index 00c939b3686c9..b8f3b61aa7777 100644 --- a/docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md +++ b/docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md @@ -46,7 +46,7 @@ typedef struct _AssemblyBindInfo { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/bucketparameters-structure.md b/docs/core/unmanaged-api/hosting/bucketparameters-structure.md index 5a44a5d1ac59e..98ff600b1ddd1 100644 --- a/docs/core/unmanaged-api/hosting/bucketparameters-structure.md +++ b/docs/core/unmanaged-api/hosting/bucketparameters-structure.md @@ -40,7 +40,7 @@ typedef struct _BucketParameters { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/callfunctionshim-function.md b/docs/core/unmanaged-api/hosting/callfunctionshim-function.md index fd8a30d5bddb2..4f9843dd55798 100644 --- a/docs/core/unmanaged-api/hosting/callfunctionshim-function.md +++ b/docs/core/unmanaged-api/hosting/callfunctionshim-function.md @@ -57,7 +57,7 @@ HRESULT CallFunctionShim ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md b/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md index 0027ec294e2c6..9a36bef39a805 100644 --- a/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md +++ b/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md @@ -22,7 +22,7 @@ topic_type: --- # CLRCreateInstance Function (.NET Framework) -Provides one of three interfaces: [ICLRMetaHost](iclrmetahost-interface.md), [ICLRMetaHostPolicy](iclrmetahostpolicy-interface.md), or [ICLRDebugging](../debugging/iclrdebugging-interface.md). +Provides one of three interfaces: [ICLRMetaHost](iclrmetahost-interface.md), [ICLRMetaHostPolicy](iclrmetahostpolicy-interface.md), or [ICLRDebugging](../../../framework/unmanaged-api/debugging/iclrdebugging-interface.md). ## Syntax @@ -43,7 +43,7 @@ HRESULT CLRCreateInstance( [in] One of three interface identifiers (IIDs): IID_ICLRMetaHost, IID_ICLRMetaHostPolicy, or IID_ICLRDebugging. `ppInterface`\ - [out] One of three interfaces: [ICLRMetaHost](iclrmetahost-interface.md), [ICLRMetaHostPolicy](iclrmetahostpolicy-interface.md), or [ICLRDebugging](../debugging/iclrdebugging-interface.md). + [out] One of three interfaces: [ICLRMetaHost](iclrmetahost-interface.md), [ICLRMetaHostPolicy](iclrmetahostpolicy-interface.md), or [ICLRDebugging](../../../framework/unmanaged-api/debugging/iclrdebugging-interface.md). ## Return Value @@ -95,7 +95,7 @@ hr = createInterface (CLSID_CLRDebugging, IID_ICLRDebugging, (LPVOID*)&pCLRDebu ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md b/docs/core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md index 2f2e84c40b1d6..eaef7259a8b94 100644 --- a/docs/core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md +++ b/docs/core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md @@ -53,7 +53,7 @@ STDAPI ClrCreateManagedInstance ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md b/docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md index c9599e191edd6..b10e944ea5746 100644 --- a/docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md +++ b/docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md @@ -38,7 +38,7 @@ coclass CLRRuntimeHost { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md b/docs/core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md index 9f943b1c24fa5..1dd1685fcb1e3 100644 --- a/docs/core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md @@ -38,7 +38,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md b/docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md index 78495d182f412..9dc089672c3da 100644 --- a/docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md +++ b/docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md @@ -41,7 +41,7 @@ void CoEEShutDownCOM (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/hosting/coinitializeee-function.md b/docs/core/unmanaged-api/hosting/coinitializeee-function.md index 9dd72480f915d..de696434b9ba0 100644 --- a/docs/core/unmanaged-api/hosting/coinitializeee-function.md +++ b/docs/core/unmanaged-api/hosting/coinitializeee-function.md @@ -50,7 +50,7 @@ HRESULT CoInitializeEE ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md b/docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md index 46c8f75b9c973..ae324d66cd8f9 100644 --- a/docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md +++ b/docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md @@ -36,7 +36,7 @@ coclass ComCallUnmarshal { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md b/docs/core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md index 05560fcd38c84..d91b380b18cf1 100644 --- a/docs/core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md +++ b/docs/core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md @@ -42,7 +42,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md b/docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md index 6f2a74d638a78..5def3e9ce26c7 100644 --- a/docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md +++ b/docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md @@ -74,7 +74,7 @@ pCLRGCManager->GetStats(&GCStats); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl diff --git a/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md b/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md index 8dc2cd4f8d60c..ff3440275e92f 100644 --- a/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md +++ b/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md @@ -42,7 +42,7 @@ typedef struct _COR_GC_THREAD_STATS { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl diff --git a/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md b/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md index 87f41a461d1c2..e04703a2976d4 100644 --- a/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md +++ b/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md @@ -36,7 +36,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/corbindtocurrentruntime-function.md b/docs/core/unmanaged-api/hosting/corbindtocurrentruntime-function.md index 8e98df33df2e0..d9bf77250fc8f 100644 --- a/docs/core/unmanaged-api/hosting/corbindtocurrentruntime-function.md +++ b/docs/core/unmanaged-api/hosting/corbindtocurrentruntime-function.md @@ -54,7 +54,7 @@ HRESULT CorBindToCurrentRuntime ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/corbindtoruntime-function.md b/docs/core/unmanaged-api/hosting/corbindtoruntime-function.md index 1e8c2711dbd59..a6c8fd19b77be 100644 --- a/docs/core/unmanaged-api/hosting/corbindtoruntime-function.md +++ b/docs/core/unmanaged-api/hosting/corbindtoruntime-function.md @@ -84,7 +84,7 @@ HRESULT CorBindToRuntime ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md b/docs/core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md index 9b41a0bb94678..86a52b24c7fc1 100644 --- a/docs/core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md +++ b/docs/core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md @@ -61,7 +61,7 @@ HRESULT CorBindToRuntimeByCfg ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md b/docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md index 30a3fde342592..f0d0dfbbe81b2 100644 --- a/docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md +++ b/docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md @@ -127,7 +127,7 @@ HRESULT CorBindToRuntimeEx ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/corbindtoruntimehost-function.md b/docs/core/unmanaged-api/hosting/corbindtoruntimehost-function.md index 585af96ae73c3..88e58744e20db 100644 --- a/docs/core/unmanaged-api/hosting/corbindtoruntimehost-function.md +++ b/docs/core/unmanaged-api/hosting/corbindtoruntimehost-function.md @@ -75,7 +75,7 @@ HRESULT CorBindToRuntimeHost ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/cordllmain-function.md b/docs/core/unmanaged-api/hosting/cordllmain-function.md index bbda02bfac5f4..069ecb4a2ef61 100644 --- a/docs/core/unmanaged-api/hosting/cordllmain-function.md +++ b/docs/core/unmanaged-api/hosting/cordllmain-function.md @@ -57,7 +57,7 @@ The `_CorDllMain` function is called directly by the operating system loader. ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/hosting/corexemain-function.md b/docs/core/unmanaged-api/hosting/corexemain-function.md index 62dd042d9b584..4fb9ffdbc83ae 100644 --- a/docs/core/unmanaged-api/hosting/corexemain-function.md +++ b/docs/core/unmanaged-api/hosting/corexemain-function.md @@ -39,7 +39,7 @@ __int32 STDMETHODCALLTYPE _CorExeMain (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/hosting/corexemain2-function.md b/docs/core/unmanaged-api/hosting/corexemain2-function.md index 76d1e2f5f1f07..c3fb3608a8e3e 100644 --- a/docs/core/unmanaged-api/hosting/corexemain2-function.md +++ b/docs/core/unmanaged-api/hosting/corexemain2-function.md @@ -51,7 +51,7 @@ __int32 STDMETHODCALLTYPE _CorExeMain2 ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/hosting/corexitprocess-function.md b/docs/core/unmanaged-api/hosting/corexitprocess-function.md index c1780fd78c94d..15b4521def77b 100644 --- a/docs/core/unmanaged-api/hosting/corexitprocess-function.md +++ b/docs/core/unmanaged-api/hosting/corexitprocess-function.md @@ -46,7 +46,7 @@ void STDMETHODCALLTYPE CorExitProcess ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/corimageunloading-function.md b/docs/core/unmanaged-api/hosting/corimageunloading-function.md index fa4614dc223c6..6651a7bccbd3c 100644 --- a/docs/core/unmanaged-api/hosting/corimageunloading-function.md +++ b/docs/core/unmanaged-api/hosting/corimageunloading-function.md @@ -37,7 +37,7 @@ STDAPI (VOID) _CorImageUnloading( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/hosting/corlaunchapplication-function.md b/docs/core/unmanaged-api/hosting/corlaunchapplication-function.md index 98e977d2e564c..3eb72010458fc 100644 --- a/docs/core/unmanaged-api/hosting/corlaunchapplication-function.md +++ b/docs/core/unmanaged-api/hosting/corlaunchapplication-function.md @@ -62,7 +62,7 @@ HRESULT CorLaunchApplication ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md b/docs/core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md index b7de02f4c610d..b36529b4e1746 100644 --- a/docs/core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md +++ b/docs/core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md @@ -28,7 +28,7 @@ void CorMarkThreadInThreadPool (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/corruntimehost-coclass.md b/docs/core/unmanaged-api/hosting/corruntimehost-coclass.md index 3823341301f48..25b6f01907d37 100644 --- a/docs/core/unmanaged-api/hosting/corruntimehost-coclass.md +++ b/docs/core/unmanaged-api/hosting/corruntimehost-coclass.md @@ -44,7 +44,7 @@ coclass CorRuntimeHost { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/corvalidateimage-function.md b/docs/core/unmanaged-api/hosting/corvalidateimage-function.md index 658ef05724830..3425763d064a8 100644 --- a/docs/core/unmanaged-api/hosting/corvalidateimage-function.md +++ b/docs/core/unmanaged-api/hosting/corvalidateimage-function.md @@ -72,7 +72,7 @@ STDAPI _CorValidateImage ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md b/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md index 1b32b1a273a46..374871908eb75 100644 --- a/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md +++ b/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md @@ -59,7 +59,7 @@ HRESULT CreateDebuggingInterfaceFromVersion ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/createiceefilegen-function.md b/docs/core/unmanaged-api/hosting/createiceefilegen-function.md index 432dfc0928649..23a2da9fd3ad9 100644 --- a/docs/core/unmanaged-api/hosting/createiceefilegen-function.md +++ b/docs/core/unmanaged-api/hosting/createiceefilegen-function.md @@ -49,7 +49,7 @@ HRESULT CreateICeeFileGen ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** ICeeFileGen.h diff --git a/docs/core/unmanaged-api/hosting/customdumpitem-structure.md b/docs/core/unmanaged-api/hosting/customdumpitem-structure.md index 22f22eeb388f1..bc881f30389cc 100644 --- a/docs/core/unmanaged-api/hosting/customdumpitem-structure.md +++ b/docs/core/unmanaged-api/hosting/customdumpitem-structure.md @@ -44,7 +44,7 @@ struct { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md b/docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md index 2e80784f31583..44ae2ffdb3974 100644 --- a/docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md +++ b/docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md @@ -47,7 +47,7 @@ HRESULT DestroyICeeFileGen ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** ICeeFileGen.h diff --git a/docs/core/unmanaged-api/hosting/eapicategories-enumeration.md b/docs/core/unmanaged-api/hosting/eapicategories-enumeration.md index 1c26d5cc64b01..782b61f2e039f 100644 --- a/docs/core/unmanaged-api/hosting/eapicategories-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eapicategories-enumeration.md @@ -62,7 +62,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md b/docs/core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md index 03975011d753e..31578a4d5668c 100644 --- a/docs/core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md @@ -54,7 +54,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md b/docs/core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md index 3cb024d4a644e..1f83cb7dd0e64 100644 --- a/docs/core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md @@ -36,7 +36,7 @@ typedef enum _CLRAssemblyIdentityFlags { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/eclrevent-enumeration.md b/docs/core/unmanaged-api/hosting/eclrevent-enumeration.md index 72c96fb34d234..17ead968a6a67 100644 --- a/docs/core/unmanaged-api/hosting/eclrevent-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eclrevent-enumeration.md @@ -50,7 +50,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md b/docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md index e959b3c3fe625..c275684004b38 100644 --- a/docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md @@ -52,7 +52,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/eclroperation-enumeration.md b/docs/core/unmanaged-api/hosting/eclroperation-enumeration.md index 4de19bf03bc16..9186b85f06e48 100644 --- a/docs/core/unmanaged-api/hosting/eclroperation-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eclroperation-enumeration.md @@ -58,7 +58,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md b/docs/core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md index 6dd2a6513a98b..e625ef52fc637 100644 --- a/docs/core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md @@ -42,7 +42,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/econtexttype-enumeration.md b/docs/core/unmanaged-api/hosting/econtexttype-enumeration.md index 8f147bf6ec844..d5ddeb33d9eb2 100644 --- a/docs/core/unmanaged-api/hosting/econtexttype-enumeration.md +++ b/docs/core/unmanaged-api/hosting/econtexttype-enumeration.md @@ -42,7 +42,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md b/docs/core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md index 001617ef96ad1..11030aeb3d2bb 100644 --- a/docs/core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md @@ -42,7 +42,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md b/docs/core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md index c056db876aaaf..8df86d9f65135 100644 --- a/docs/core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md @@ -36,7 +36,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md b/docs/core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md index bc609a183c2fb..14f729ab3542c 100644 --- a/docs/core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md @@ -30,7 +30,7 @@ typedef enum _HostApplicationPolicy { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md b/docs/core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md index a2cc13b0f3a69..ac1398521c9d7 100644 --- a/docs/core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md @@ -46,7 +46,7 @@ typedef enum _hostBindingPolicyModifyFlags { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md b/docs/core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md index d5ffee5ca85b5..508ebeb14378a 100644 --- a/docs/core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md @@ -40,7 +40,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md b/docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md index d3473bd27a8e3..117dc39e3b661 100644 --- a/docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md @@ -44,7 +44,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md b/docs/core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md index b2e3d3e8ba0b2..45c616f4695bc 100644 --- a/docs/core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md @@ -44,7 +44,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md b/docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md index 4b8ec60149604..2adc72cb45664 100644 --- a/docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md +++ b/docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md @@ -58,7 +58,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md b/docs/core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md index a5f2a191155f8..fc925601aa779 100644 --- a/docs/core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md +++ b/docs/core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md @@ -44,7 +44,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/etasktype-enumeration.md b/docs/core/unmanaged-api/hosting/etasktype-enumeration.md index eb40be9f902f4..bf93adfe72e18 100644 --- a/docs/core/unmanaged-api/hosting/etasktype-enumeration.md +++ b/docs/core/unmanaged-api/hosting/etasktype-enumeration.md @@ -56,7 +56,7 @@ typedef enum ETaskType { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md b/docs/core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md index 63ce40d9e3c03..f7b8b87538440 100644 --- a/docs/core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md +++ b/docs/core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md @@ -39,7 +39,7 @@ typedef HRESULT (__stdcall *FExecuteInAppDomainCallback) ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md b/docs/core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md index 62431622c5228..742d743442d4d 100644 --- a/docs/core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md +++ b/docs/core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md @@ -34,7 +34,7 @@ typedef HRESULT (__stdcall *FLockClrVersionCallback) ( ); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getclridentitymanager-function.md b/docs/core/unmanaged-api/hosting/getclridentitymanager-function.md index f22aab8c0803c..0ecc37da75ee1 100644 --- a/docs/core/unmanaged-api/hosting/getclridentitymanager-function.md +++ b/docs/core/unmanaged-api/hosting/getclridentitymanager-function.md @@ -45,7 +45,7 @@ STDAPI GetCLRIdentityManager( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getcorrequiredversion-function.md b/docs/core/unmanaged-api/hosting/getcorrequiredversion-function.md index ba0f2899df701..41c15b94fa142 100644 --- a/docs/core/unmanaged-api/hosting/getcorrequiredversion-function.md +++ b/docs/core/unmanaged-api/hosting/getcorrequiredversion-function.md @@ -45,7 +45,7 @@ HRESULT GetCORRequiredVersion ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getcorsystemdirectory-function.md b/docs/core/unmanaged-api/hosting/getcorsystemdirectory-function.md index ed97b58bf1d6c..ec5376431e013 100644 --- a/docs/core/unmanaged-api/hosting/getcorsystemdirectory-function.md +++ b/docs/core/unmanaged-api/hosting/getcorsystemdirectory-function.md @@ -51,7 +51,7 @@ HRESULT GetCORSystemDirectory ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getcorversion-function.md b/docs/core/unmanaged-api/hosting/getcorversion-function.md index eb846f2763a69..4ee8d9520d935 100644 --- a/docs/core/unmanaged-api/hosting/getcorversion-function.md +++ b/docs/core/unmanaged-api/hosting/getcorversion-function.md @@ -45,7 +45,7 @@ HRESULT GetCORVersion ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getfileversion-function.md b/docs/core/unmanaged-api/hosting/getfileversion-function.md index e04e543ae38c7..0c87e07a67b8d 100644 --- a/docs/core/unmanaged-api/hosting/getfileversion-function.md +++ b/docs/core/unmanaged-api/hosting/getfileversion-function.md @@ -49,7 +49,7 @@ HRESULT GetFileVersion ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getrealprocaddress-function.md b/docs/core/unmanaged-api/hosting/getrealprocaddress-function.md index e1f300147c2bf..ba090a280b23a 100644 --- a/docs/core/unmanaged-api/hosting/getrealprocaddress-function.md +++ b/docs/core/unmanaged-api/hosting/getrealprocaddress-function.md @@ -51,7 +51,7 @@ HRESULT GetRealProcAddress ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md b/docs/core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md index 9b9afa6401d56..58b36386af799 100644 --- a/docs/core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md +++ b/docs/core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md @@ -113,7 +113,7 @@ HRESULT GetRequestedRuntimeInfo ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getrequestedruntimeversion-function.md b/docs/core/unmanaged-api/hosting/getrequestedruntimeversion-function.md index a32bce3fc7b5c..e68bad607b80d 100644 --- a/docs/core/unmanaged-api/hosting/getrequestedruntimeversion-function.md +++ b/docs/core/unmanaged-api/hosting/getrequestedruntimeversion-function.md @@ -60,7 +60,7 @@ HRESULT GetRequestedRuntimeVersion ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md b/docs/core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md index d92a83793d342..347b7cd78daa6 100644 --- a/docs/core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md +++ b/docs/core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md @@ -67,7 +67,7 @@ HRESULT GetRequestedRuntimeVersionForCLSID ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/getversionfromprocess-function.md b/docs/core/unmanaged-api/hosting/getversionfromprocess-function.md index f5f7e85f51775..110c5285a49f7 100644 --- a/docs/core/unmanaged-api/hosting/getversionfromprocess-function.md +++ b/docs/core/unmanaged-api/hosting/getversionfromprocess-function.md @@ -61,7 +61,7 @@ HRESULT GetVersionFromProcess ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/host-type-enumeration.md b/docs/core/unmanaged-api/hosting/host-type-enumeration.md index c0a77fcbed2d9..9c5e8b9a31bf1 100644 --- a/docs/core/unmanaged-api/hosting/host-type-enumeration.md +++ b/docs/core/unmanaged-api/hosting/host-type-enumeration.md @@ -40,7 +40,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md b/docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md index a67faeb12a0bc..cb6ffc62f9884 100644 --- a/docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md +++ b/docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md @@ -28,7 +28,7 @@ Provides the [IActionOnCLREvent::OnEvent](iactiononclrevent-onevent-method.md) m ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md b/docs/core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md index a0682ff97f152..05c6f867cdf7f 100644 --- a/docs/core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md +++ b/docs/core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md @@ -57,7 +57,7 @@ HRESULT OnEvent ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md b/docs/core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md index b2961cf493a42..eaf6f5e24889b 100644 --- a/docs/core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md +++ b/docs/core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md @@ -40,7 +40,7 @@ HRESULT _stdcall DoCallback( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md b/docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md index 3f3837394a1d1..864b320594f0a 100644 --- a/docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md +++ b/docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md @@ -28,7 +28,7 @@ Provides methods for making callbacks within an apartment. An *apartment* is a l ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md b/docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md index 5bd26b5d471ae..b3520290d72b1 100644 --- a/docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md +++ b/docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md @@ -28,7 +28,7 @@ Provides a method that is called by the common language runtime (CLR) to notify ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md b/docs/core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md index 769c40a668656..39a044ab6a2dc 100644 --- a/docs/core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md +++ b/docs/core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md @@ -36,7 +36,7 @@ HRESULT OnAppDomain ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md b/docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md index 26bb0cd01b072..08c6fed1f5128 100644 --- a/docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md +++ b/docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md @@ -43,7 +43,7 @@ Provides properties that allow the host to configure an GetStats(&GCStats); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md index be8d2f3d8fa72..5ec8c13a602bc 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md @@ -37,7 +37,7 @@ Provides methods that allow a host to interact with the common language runtime' ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md b/docs/core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md index 96bc8471c8846..2082a60cf1c55 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md +++ b/docs/core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md @@ -62,7 +62,7 @@ HRESULT SetGCStartupLimits ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md b/docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md index bc29aba99ac7d..ca0091740804b 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md @@ -34,7 +34,7 @@ Provides methods that allow a host to interact with the common language runtime' ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md b/docs/core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md index fbab6f84ee739..7f6f938a38be9 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md +++ b/docs/core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md @@ -61,7 +61,7 @@ HRESULT SetGCStartupLimitsEx ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md index cd5130e5518fc..528b3d77f55e1 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md +++ b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md @@ -73,7 +73,7 @@ HRESULT EvaluatePolicy ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md index aae9276d1ab07..1884a784cdc51 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md @@ -29,7 +29,7 @@ Provides methods for the host to evaluate current binding policy and communicate ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md index 86ce63f099249..edcf45c4c75ba 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md +++ b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md @@ -77,7 +77,7 @@ HRESULT ModifyApplicationPolicy ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md index 6566b99ef65a7..2461be6d6ce45 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md @@ -29,7 +29,7 @@ Enables the host to block specific managed classes, methods, properties, and fie ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md index a5d5f105ac3fa..dab749ac96d2b 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md +++ b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md @@ -40,7 +40,7 @@ HRESULT SetEagerSerializeGrantSets (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md index 9499cfff680c5..fbb07bf93a7f9 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md +++ b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md @@ -51,7 +51,7 @@ HRESULT SetProtectedCategories ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclriocompletionmanager-interface.md b/docs/core/unmanaged-api/hosting/iclriocompletionmanager-interface.md index 3687d9609d8d3..86756ff949825 100644 --- a/docs/core/unmanaged-api/hosting/iclriocompletionmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclriocompletionmanager-interface.md @@ -32,7 +32,7 @@ Implements a callback method that allows the host to notify the common language ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md b/docs/core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md index aa43d54728308..d5a7e09652bd4 100644 --- a/docs/core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md +++ b/docs/core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md @@ -65,7 +65,7 @@ HRESULT OnComplete ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md b/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md index a02bb8747ce9b..fc266f7eee08d 100644 --- a/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md @@ -32,7 +32,7 @@ Allows the host to report memory pressure conditions using an approach similar t ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md b/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md index 0443bfb0b40df..a0f9dc258b9d2 100644 --- a/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md @@ -54,7 +54,7 @@ HRESULT OnMemoryNotification ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md index 5a53a9fb04ea5..5aa5706fe4520 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md @@ -44,7 +44,7 @@ HRESULT EnumerateInstalledRuntimes ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md index 4dc5b5cca59bc..64475f5d22510 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md @@ -53,7 +53,7 @@ HRESULT EnumerateLoadedRuntimes ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md index 4cc6b83cf6c7d..d8a05d54a1615 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md @@ -41,7 +41,7 @@ HRESULT ExitProcess ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md index b800274c1978b..f57b4f3566614 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md @@ -62,7 +62,7 @@ HRESULT GetRuntime ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md index 8f8b80c4a54fa..fbaabf4eccdfa 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md @@ -59,7 +59,7 @@ HRESULT GetVersionFromFile ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-interface.md b/docs/core/unmanaged-api/hosting/iclrmetahost-interface.md index 575074dc79f07..97efc8d478285 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-interface.md @@ -44,7 +44,7 @@ HRESULT hr = CLRCreateInstance(CLSID_CLRMetaHost, ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md index adfd91bdcc646..9d5c7592e163e 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md @@ -51,7 +51,7 @@ HRESULT QueryLegacyV2RuntimeBinding ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md index a20d3289c93ad..e346bd1441da3 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md @@ -88,7 +88,7 @@ typedef void (__stdcall *RuntimeLoadedCallbackFnPtr)( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md b/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md index a63682e7c56ee..258907cb76f86 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md @@ -79,7 +79,7 @@ This method returns the following specific HRESULTs as well as HRESULT errors th ## Requirements -**Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md b/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md index 0e2d08fe1412f..e424e4214bf2c 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md @@ -43,7 +43,7 @@ HRESULT hr = CLRCreateInstance(CLSID_CLRMetaHostPolicy, ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md b/docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md index 996705d5fb4ea..5072c3700c275 100644 --- a/docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md @@ -36,7 +36,7 @@ Provides methods that allow the host to register and unregister callbacks for co ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md b/docs/core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md index 33012ca126cd9..e10712aefa53d 100644 --- a/docs/core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md +++ b/docs/core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md @@ -58,7 +58,7 @@ HRESULT RegisterActionOnEvent ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md b/docs/core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md index 76ab4f9f96523..20bf70126abb4 100644 --- a/docs/core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md +++ b/docs/core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md @@ -51,7 +51,7 @@ HRESULT UnregisterActionOnEvent ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md index be5a0c91486be..3c3b2ea56e4f0 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md @@ -33,7 +33,7 @@ Provides methods that allow the host to specify policy actions to be taken in th ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md index 79db8f788eaf6..ff8afdca34e60 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md @@ -69,7 +69,7 @@ HRESULT SetActionOnFailure ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md index 536d2b6513a84..806bd414922f2 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md @@ -72,7 +72,7 @@ HRESULT SetActionOnTimeout ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md index 97b53ad860383..a96156141c4e6 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md @@ -65,7 +65,7 @@ HRESULT SetDefaultAction ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md index 21887ddf0d6a8..09e4dc8acec1c 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md @@ -60,7 +60,7 @@ HRESULT SetTimeout ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md index 0a2e9a03e2615..d66843645e915 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md @@ -71,7 +71,7 @@ HRESULT SetTimeoutAndAction ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md index a3b2fc6620cfb..678fe70009ce4 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md @@ -51,7 +51,7 @@ HRESULT SetUnhandledExceptionPolicy ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md b/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md index 102bbea7e8ea3..298806cfab8c5 100644 --- a/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md +++ b/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md @@ -63,7 +63,7 @@ HRESULT Get ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md b/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md index f3d5b27ef8a0e..031316c81ed25 100644 --- a/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md @@ -32,7 +32,7 @@ Provides methods that enable the host to get the probing identities of an assemb ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md b/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md index d70dbdb2ab5e6..4a2ad69eb84be 100644 --- a/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md +++ b/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md @@ -61,7 +61,7 @@ HRESULT Get ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md b/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md index d758111d920a3..3b613b3237b30 100644 --- a/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md @@ -28,7 +28,7 @@ Provides methods that allow the host to manipulate the set of assemblies referen ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md index 75aeb034b2bfc..ae1ee8c7ca9b6 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md @@ -76,7 +76,7 @@ HRESULT ExecuteApplication( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md index 50cd51d8dbb38..95b2992b2fb94 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md @@ -59,7 +59,7 @@ HRESULT ExecuteInAppDomain( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md index 8867c47808b7c..b7f13bbb8cb90 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md @@ -73,7 +73,7 @@ static int pwzMethodName (String pwzArgument) ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md index d4a05cf0a8e0e..e18c8296f859a 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md @@ -52,7 +52,7 @@ HRESULT GetCLRControl( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md index 8bb6c6dc3b4db..e5671b742597e 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md @@ -51,7 +51,7 @@ HRESULT GetCurrentAppDomainId( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md index c83b10b064391..411cc86455b1e 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md @@ -47,7 +47,7 @@ Provides functionality similar to that of the [ICorRuntimeHost](icorruntimehost- ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md index 96c494c79f016..1ddbf5392761d 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md @@ -52,7 +52,7 @@ HRESULT SetHostControl( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md index e78045115f33b..5059f7c01710d 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md @@ -44,7 +44,7 @@ HRESULT Start(); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md index 2b6da40dcf86b..5842ca44f9490 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md @@ -43,7 +43,7 @@ HRESULT Stop(); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md index 9306ee55a4f9f..6c44c6b239ae2 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md @@ -55,7 +55,7 @@ HRESULT UnloadAppDomain( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md index 15e4d10aa0221..ee579aa6b59fa 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md @@ -42,7 +42,7 @@ HRESULT BindAsLegacyV2Runtime (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md index 8b54c5286625a..c9c416b3d3a72 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md @@ -55,7 +55,7 @@ HRESULT GetDefaultStartupFlags( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md index 12b40977d7959..4e85f2095d5cd 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md @@ -72,7 +72,7 @@ HRESULT GetInterface( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md index fb51b4f4d6761..e2fc2bb4cc718 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md @@ -55,7 +55,7 @@ HRESULT GetProcAddress( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md index c9cc3d9b9eac6..0e1aebfe24860 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md @@ -52,7 +52,7 @@ HRESULT GetRuntimeDirectory( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md index df4213bbc7252..fd11a402bc7ce 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md @@ -59,7 +59,7 @@ HRESULT GetVersionString( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md index 5b856bc06c821..b486815968599 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md @@ -39,7 +39,7 @@ Provides methods that return information about a specific common language runtim ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md index 6461c6f694004..0ae7f453f8dc7 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md @@ -50,7 +50,7 @@ HRESULT IsLoadable( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md index 96deff837326d..265eb243e9224 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md @@ -62,7 +62,7 @@ HRESULT IsLoaded( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md index 9374c1f72eb96..348df3cfdaa85 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md @@ -50,7 +50,7 @@ HRESULT IsStarted( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md index 5bceda98a75b0..2ba57a467add5 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md @@ -63,7 +63,7 @@ HRESULT LoadErrorString( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md index 0efe681335b4c..aab39430bc0d3 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md @@ -55,7 +55,7 @@ HRESULT LoadLibrary( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md index d28c12d2ccd13..0da48f7ce78f0 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md @@ -51,7 +51,7 @@ HRESULT SetDefaultStartupFlags( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md index 2047b002e06a4..0c8116fafefbc 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md @@ -56,7 +56,7 @@ HRESULT GetHashFromAssemblyFile ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md index ae2ad085e685e..47232a21dad66 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md @@ -56,7 +56,7 @@ HRESULT GetHashFromAssemblyFileW ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md index 05f434293adf8..56e8b56aae06e 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md @@ -60,7 +60,7 @@ HRESULT GetHashFromBlob ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md index e6b41578fa587..ba167c6fbad16 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md @@ -60,7 +60,7 @@ HRESULT GetHashFromFile ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md index 1128d20713df0..537475f850e54 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md @@ -60,7 +60,7 @@ HRESULT GetHashFromFileW ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md index 3b3d30a4bd5f9..8e4d20c79cd20 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md @@ -57,7 +57,7 @@ HRESULT GetHashFromHandle ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-interface.md b/docs/core/unmanaged-api/hosting/iclrstrongname-interface.md index d68da4fe6fbae..efdcba6b889d6 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-interface.md @@ -56,7 +56,7 @@ Provides basic global static functions for signing assemblies with strong names. ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md index c8f11c2866986..04d8ee8546f91 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md @@ -54,7 +54,7 @@ HRESULT StrongNameCompareAssemblies ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md index fcdf9bdd7f0ad..3aca5f5ef5306 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md @@ -40,7 +40,7 @@ HRESULT StrongNameFreeBuffer ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md index 1a5109321885a..6c3f3b0c14ba2 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md @@ -49,7 +49,7 @@ HRESULT StrongNameGetBlob ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md index fb689fb1fd8e3..aa2aa338e9d8a 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md @@ -52,7 +52,7 @@ HRESULT StrongNameGetBlobFromImage ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md index c4b59ec3cfbc9..61059242c299c 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md @@ -64,7 +64,7 @@ HRESULT StrongNameGetPublicKey ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md index 9984e465a34c8..8186db739c476 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md @@ -44,7 +44,7 @@ HRESULT StrongNameHashSize ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md index 631c6c7ded595..811ec4dc63598 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md @@ -44,7 +44,7 @@ HRESULT StrongNameKeyDelete ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md index 6080781ead7fc..b60af767293ef 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md @@ -60,7 +60,7 @@ HRESULT StrongNameKeyGen ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md index e2c409b39be86..a3d2da1890d74 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md @@ -66,7 +66,7 @@ HRESULT StrongNameKeyGenEx ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md index 5fbb4699eb474..45039d76231d8 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md @@ -52,7 +52,7 @@ HRESULT StrongNameKeyInstall ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md index e41e582fe3192..bcbc73e7bda17 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md @@ -74,7 +74,7 @@ HRESULT StrongNameSignatureGeneration ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md index dc0dc5950d0a7..9ce7e8e367ce2 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md @@ -84,7 +84,7 @@ HRESULT StrongNameSignatureGenerationEx ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md index 6f9a40b69c396..5e68c04580ea2 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md @@ -48,7 +48,7 @@ HRESULT StrongNameSignatureSize ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md index 0c9d77208fc0d..f9573607a30f7 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md @@ -62,7 +62,7 @@ HRESULT StrongNameSignatureVerification ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md index 5d603408787d0..66088aa1777f5 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md @@ -52,7 +52,7 @@ HRESULT StrongNameSignatureVerificationEx ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md index 8ae1f94e8eb33..fbe13dc31e788 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md @@ -66,7 +66,7 @@ HRESULT StrongNameSignatureVerificationFromImage ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md index 6e99ff554db64..15e357cc6fc1f 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md @@ -54,7 +54,7 @@ HRESULT StrongNameTokenFromAssembly ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md index 44ff24c532941..ed6385ebcbbe7 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md @@ -62,7 +62,7 @@ HRESULT StrongNameTokenFromAssemblyEx ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md index b748421a9c17a..2e87400225c39 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md @@ -56,7 +56,7 @@ HRESULT StrongNameTokenFromPublicKey ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md b/docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md index 1d4abd8c5dfd8..e6e0540e02d29 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md @@ -31,7 +31,7 @@ Provides the ability to create strong names using the SHA-2 group of Secure Hash ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md index 18511565c996f..2e250d88a1809 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md +++ b/docs/core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md @@ -63,7 +63,7 @@ HRESULT CreateRWLockOwnerIterator ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md index fd5aa6bd85d64..3ff11fe0bc4f5 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md +++ b/docs/core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md @@ -51,7 +51,7 @@ HRESULT DeleteRWLockOwnerIterator ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md index 163aa37163ea4..d77a7886f5b64 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md +++ b/docs/core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md @@ -60,7 +60,7 @@ HRESULT GetMonitorOwner ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md index 5cdad714dc563..a89a38e04b9f1 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md +++ b/docs/core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md @@ -58,7 +58,7 @@ HRESULT GetRWLockOwnerNext ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md index 96ab0274d2e0b..7dd4517c81b60 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md @@ -31,7 +31,7 @@ Defines methods that allow the host to get information about requested tasks and ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-abort-method.md b/docs/core/unmanaged-api/hosting/iclrtask-abort-method.md index 2534ab069341a..69b2c6eb8604d 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-abort-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-abort-method.md @@ -44,7 +44,7 @@ HRESULT Abort (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md b/docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md index 8332ebe28d64e..aefecbd748cc1 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md @@ -44,7 +44,7 @@ HRESULT ExitTask (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md b/docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md index bedcf284336ed..f598edc568482 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md @@ -47,7 +47,7 @@ HRESULT GetMemStats ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-interface.md b/docs/core/unmanaged-api/hosting/iclrtask-interface.md index 72ae2c2451725..7aae80d23f6b1 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-interface.md @@ -44,7 +44,7 @@ Provides methods that allow the host to make requests of the common language run ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md b/docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md index 082b7ff6a2c49..2e70a904da78a 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md @@ -47,7 +47,7 @@ HRESULT LocksHeld ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md b/docs/core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md index 866a86e382a58..16b873671f468 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md @@ -51,7 +51,7 @@ HRESULT NeedsPriorityScheduling ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-reset-method.md b/docs/core/unmanaged-api/hosting/iclrtask-reset-method.md index cb27d63b4c5bb..55bcdf41282fd 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-reset-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-reset-method.md @@ -67,7 +67,7 @@ HRESULT Reset ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md b/docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md index ea1b5de8dc349..89a4a4d1b0aaa 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md @@ -44,7 +44,7 @@ HRESULT RudeAbort (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md b/docs/core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md index d37cf0fffb788..86b87f1e6e4a8 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md @@ -51,7 +51,7 @@ HRESULT SetTaskIdentifier ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md b/docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md index b5355c776a696..145d2763913e3 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md @@ -55,7 +55,7 @@ HRESULT SwitchIn ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md b/docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md index c1e3fa8ca3ccb..b37b508ab30de 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md @@ -44,7 +44,7 @@ HRESULT SwitchOut (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md b/docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md index 5ca3c84298b3e..e5d8285d33fb5 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md @@ -44,7 +44,7 @@ HRESULT YieldTask (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md b/docs/core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md index 46d865fed2e23..ed69060c5d0b4 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md @@ -48,7 +48,7 @@ HRESULT BeginPreventAsyncAbort(); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md b/docs/core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md index 6db16098d1113..66b1ffa2c626c 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md @@ -46,7 +46,7 @@ HRESULT EndPreventAsyncAbort(); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtask2-interface.md b/docs/core/unmanaged-api/hosting/iclrtask2-interface.md index 68cb2ded64841..5d8d8ba2c26c5 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask2-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrtask2-interface.md @@ -41,7 +41,7 @@ Provides all the functionality of the [ICLRTask](iclrtask-interface.md) interfac ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md index 7bba8c7847055..c8f9aaa8446a8 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md @@ -57,7 +57,7 @@ HRESULT CreateTask ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md index 641e5d6865d23..936c0a96e47c6 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md @@ -51,7 +51,7 @@ HRESULT GetCurrentTask ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md index 834e061ba4fa6..86620740376cb 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md @@ -36,7 +36,7 @@ HRESULT GetCurrentTaskType( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md index fd08d04ced97a..4ebf059edec36 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md @@ -36,7 +36,7 @@ Provides methods that allow the host to request explicitly that the common langu ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md index a1dadf06a767e..15cd845eda5da 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md @@ -51,7 +51,7 @@ HRESULT SetLocale ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md index e66dd64441800..ab7be24bdae22 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md @@ -51,7 +51,7 @@ HRESULT SetUILocale ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md b/docs/core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md index d0be0cf7f2e6a..27959d39b248c 100644 --- a/docs/core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md +++ b/docs/core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md @@ -63,7 +63,7 @@ HRESULT FormatEventInfo ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h diff --git a/docs/core/unmanaged-api/hosting/iclrvalidator-interface.md b/docs/core/unmanaged-api/hosting/iclrvalidator-interface.md index bd8152aefa9f1..38eac0621b34e 100644 --- a/docs/core/unmanaged-api/hosting/iclrvalidator-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrvalidator-interface.md @@ -29,7 +29,7 @@ Provides methods for validating portable executable (PE) images and reporting va ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h diff --git a/docs/core/unmanaged-api/hosting/iclrvalidator-validate-method.md b/docs/core/unmanaged-api/hosting/iclrvalidator-validate-method.md index 39d871b33b3fc..39838eb5d8686 100644 --- a/docs/core/unmanaged-api/hosting/iclrvalidator-validate-method.md +++ b/docs/core/unmanaged-api/hosting/iclrvalidator-validate-method.md @@ -75,7 +75,7 @@ HRESULT Validate ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md b/docs/core/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md index 50f54de90e688..3941e39688c29 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md +++ b/docs/core/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md @@ -40,7 +40,7 @@ HRESULT AddDebuggerSpecialThread ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-interface.md b/docs/core/unmanaged-api/hosting/icorconfiguration-interface.md index b23b63ef6271b..a63e430aab317 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-interface.md +++ b/docs/core/unmanaged-api/hosting/icorconfiguration-interface.md @@ -31,7 +31,7 @@ Provides methods for configuring the common language runtime (CLR). ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md b/docs/core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md index 4689905a95189..02d64d44fe775 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md +++ b/docs/core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md @@ -36,7 +36,7 @@ HRESULT SetDebuggerThreadControl ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md b/docs/core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md index 246bd18e50ed0..d23c42ef2234b 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md +++ b/docs/core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md @@ -36,7 +36,7 @@ HRESULT SetGCHostControl ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md b/docs/core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md index c576147ba6322..455b9d07563b9 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md +++ b/docs/core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md @@ -40,7 +40,7 @@ HRESULT SetGCThreadControl ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md index a1a138909cb91..e8498251637eb 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md @@ -45,7 +45,7 @@ HRESULT CloseEnum ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md index 6f1cbdc4a9c05..8a5fbf851086a 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md @@ -53,7 +53,7 @@ HRESULT CreateDomain ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md index 69dafdc74d2c1..7cc138ad9be00 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md @@ -61,7 +61,7 @@ HRESULT CreateDomainEx ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md index d22d8e695252f..b9302e92beace 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md @@ -49,7 +49,7 @@ HRESULT CreateDomainSetup ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md index a74289863f1d1..7307b87334ef1 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md @@ -49,7 +49,7 @@ HRESULT CreateEvidence ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md index 37503f58c27bd..fa06adc5aa06c 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md @@ -29,7 +29,7 @@ HRESULT CreateLogicalThreadState ( ); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md index 5fe57c7b6dc95..aaedb46ef19f5 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md @@ -45,7 +45,7 @@ HRESULT CurrentDomain ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md index cb9894844afda..2aa19be5d7612 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md @@ -29,7 +29,7 @@ HRESULT DeleteLogicalThreadState ( ); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md index 0e8071a8b8e49..3552ba9e60b5d 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md @@ -45,7 +45,7 @@ HRESULT EnumDomains ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md index 847fb3a85be9c..499e7beebb99b 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md @@ -40,7 +40,7 @@ HRESULT GetConfiguration( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md index 03d28310ece49..5ee29050c8bd2 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md @@ -47,7 +47,7 @@ HRESULT GetDefaultDomain ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-interface.md b/docs/core/unmanaged-api/hosting/icorruntimehost-interface.md index 31830fd645253..f6f7e59d099fc 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-interface.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-interface.md @@ -48,7 +48,7 @@ Provides methods that enable the host to start and stop the common language runt ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md index e473d1dd57e19..9e5afa11be3a1 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md @@ -38,7 +38,7 @@ HRESULT LocksHeldByLogicalThread( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md index dee9ae89e3e1d..d8bd759c99b4a 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md @@ -40,7 +40,7 @@ HRESULT MapFile( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md index e1b91a76fa694..2d8485fbf5163 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md @@ -49,7 +49,7 @@ HRESULT NextDomain ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md index f8a7d3b7e4768..95d3313fadd92 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md @@ -42,7 +42,7 @@ HRESULT Start (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md index abe49a62a658c..4e40f550129af 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md @@ -45,7 +45,7 @@ HRESULT Stop (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md index 8bb55520e6f34..3db3ce4a83435 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md @@ -36,7 +36,7 @@ HRESULT SwitchInLogicalThreadState( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md index 694eceb405b17..8784e9301e70c 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md @@ -36,7 +36,7 @@ HRESULT SwitchOutLogicalThreadState( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md index f617294881c1b..c347ac66fafa3 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md @@ -45,7 +45,7 @@ HRESULT UnloadDomain ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md index d3f517786af52..bc25b0e40cedc 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md @@ -32,7 +32,7 @@ HRESULT CorBindIoCompletionCallback ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md index a250991cbc945..3df9f06b4f641 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md @@ -33,7 +33,7 @@ HRESULT CorCallOrQueueUserWorkItem ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md index 14d5ee547571d..982782247c33c 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md @@ -34,7 +34,7 @@ HRESULT CorChangeTimer ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md index 93197f603bba0..e8256d5575635 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md @@ -36,7 +36,7 @@ HRESULT CorCreateTimer ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md index 658d02e8a89b5..5925ceb5b6bd6 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md @@ -33,7 +33,7 @@ HRESULT CorDeleteTimer ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md index 4c2812842af30..31a8243ab82b1 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md @@ -32,7 +32,7 @@ HRESULT CorGetAvailableThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md index 04f32597d54da..33d9754440ffa 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md @@ -32,7 +32,7 @@ HRESULT CorGetMaxThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md index abb075ca00908..4093398dad747 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md @@ -34,7 +34,7 @@ HRESULT CorQueueUserWorkItem ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md index 40277449b8abb..c1e20b17592ed 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md @@ -37,7 +37,7 @@ HRESULT CorRegisterWaitForSingleObject ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md index 5bffa3411f900..57974eb76c6ba 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md @@ -32,7 +32,7 @@ HRESULT CorSetMaxThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md index 50c0bc0cac3ff..c69ab656fdb46 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md @@ -33,7 +33,7 @@ HRESULT CorUnregisterWait ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-interface.md b/docs/core/unmanaged-api/hosting/icorthreadpool-interface.md index 552a0b8099bcc..fb552ae35aede 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-interface.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-interface.md @@ -41,7 +41,7 @@ Provides methods for accessing the thread pool. ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md b/docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md index ec0c9275d5e1d..9e4c333dda9fa 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md +++ b/docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md @@ -28,7 +28,7 @@ Provides methods for obtaining information about the state of the debugging serv ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md b/docs/core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md index 9c54d041293ef..b42c74f8da20b 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md +++ b/docs/core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md @@ -36,7 +36,7 @@ HRESULT IsDebuggerAttached ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md index 7d8c0e0a46b29..611af58734a61 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md +++ b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md @@ -30,7 +30,7 @@ Provides methods for notifying the host about the blocking and unblocking of thr ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md index 4c2dbb5d72570..5f523073b913e 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md +++ b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md @@ -33,7 +33,7 @@ HRESULT ReleaseAllRuntimeThreads ( ); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md index b50596b9dacc1..e12cba1997362 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md +++ b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md @@ -40,7 +40,7 @@ HRESULT StartBlockingForDebugger ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md index 52cd6b8a92368..b284ff205850b 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md +++ b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md @@ -35,7 +35,7 @@ HRESULT ThreadIsBlockingForDebugger ( ); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/igchost-collect-method.md b/docs/core/unmanaged-api/hosting/igchost-collect-method.md index 5753a24de2a90..98a46f854636b 100644 --- a/docs/core/unmanaged-api/hosting/igchost-collect-method.md +++ b/docs/core/unmanaged-api/hosting/igchost-collect-method.md @@ -36,7 +36,7 @@ HRESULT Collect ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchost-getstats-method.md b/docs/core/unmanaged-api/hosting/igchost-getstats-method.md index 2e19cae7fbed6..c8c919d8443d3 100644 --- a/docs/core/unmanaged-api/hosting/igchost-getstats-method.md +++ b/docs/core/unmanaged-api/hosting/igchost-getstats-method.md @@ -40,7 +40,7 @@ HRESULT GetStats ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchost-getthreadstats-method.md b/docs/core/unmanaged-api/hosting/igchost-getthreadstats-method.md index b56df99293447..fb3aa500286c1 100644 --- a/docs/core/unmanaged-api/hosting/igchost-getthreadstats-method.md +++ b/docs/core/unmanaged-api/hosting/igchost-getthreadstats-method.md @@ -40,7 +40,7 @@ HRESULT GetThreadStats ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchost-interface.md b/docs/core/unmanaged-api/hosting/igchost-interface.md index 5e69012ad79ae..4d1024ce85f73 100644 --- a/docs/core/unmanaged-api/hosting/igchost-interface.md +++ b/docs/core/unmanaged-api/hosting/igchost-interface.md @@ -38,7 +38,7 @@ Provides methods for obtaining information about the garbage collection system a ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md b/docs/core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md index 0d539b77c1036..6db23d7c0e941 100644 --- a/docs/core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md +++ b/docs/core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md @@ -47,7 +47,7 @@ HRESULT SetGCStartupLimits ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md b/docs/core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md index aaec71cea5f2d..196f3827b24d3 100644 --- a/docs/core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md +++ b/docs/core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md @@ -40,7 +40,7 @@ HRESULT SetVirtualMemLimit ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchost2-interface.md b/docs/core/unmanaged-api/hosting/igchost2-interface.md index 80de0ba8a7796..d3fa86ee4443f 100644 --- a/docs/core/unmanaged-api/hosting/igchost2-interface.md +++ b/docs/core/unmanaged-api/hosting/igchost2-interface.md @@ -31,7 +31,7 @@ Provides methods for obtaining information about the garbage collection system a ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md b/docs/core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md index 07deb6b7e8779..c79e2d508e631 100644 --- a/docs/core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md +++ b/docs/core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md @@ -44,7 +44,7 @@ HRESULT SetGCStartupLimitsEx ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** GCHost.idl, GCHost.h diff --git a/docs/core/unmanaged-api/hosting/igchostcontrol-interface.md b/docs/core/unmanaged-api/hosting/igchostcontrol-interface.md index d5e6f75f9deeb..e054868425e5a 100644 --- a/docs/core/unmanaged-api/hosting/igchostcontrol-interface.md +++ b/docs/core/unmanaged-api/hosting/igchostcontrol-interface.md @@ -28,7 +28,7 @@ Provides a method that allows the garbage collector to request the host to chang ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md b/docs/core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md index 4bb6b95a96fe8..e5a3bd65674c5 100644 --- a/docs/core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md +++ b/docs/core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md @@ -40,7 +40,7 @@ HRESULT RequestVirtualMemLimit ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md b/docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md index 3f35dc2417b73..5c7d7ca35d31c 100644 --- a/docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md +++ b/docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md @@ -30,7 +30,7 @@ Provides methods for participating in the scheduling of threads that would other ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md b/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md index 02bf926d5e2b2..1935736a53c99 100644 --- a/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md +++ b/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md @@ -40,7 +40,7 @@ HRESULT SuspensionEnding ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md b/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md index 4a963d4adbf47..6cae9e72379af 100644 --- a/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md +++ b/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md @@ -33,7 +33,7 @@ HRESULT SuspensionStarting ( ); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md b/docs/core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md index 86964e0846de8..2a1f5109e85bf 100644 --- a/docs/core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md +++ b/docs/core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md @@ -33,7 +33,7 @@ HRESULT ThreadIsBlockingForSuspension ( ); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md b/docs/core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md index 3c0797d9e4f85..35e1f1cc6ef7c 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md @@ -55,7 +55,7 @@ HRESULT GetAssemblyStore ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md b/docs/core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md index 7deb389c213d0..d28d57d91c507 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md @@ -65,7 +65,7 @@ HRESULT GetNonHostStoreAssemblies ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostassemblymanager-interface.md b/docs/core/unmanaged-api/hosting/ihostassemblymanager-interface.md index ac98dc0183342..d0f694f7b4aa7 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblymanager-interface.md @@ -35,7 +35,7 @@ Provides methods that allow a host to specify sets of assemblies that should be ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md b/docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md index cb22db706dd58..4fa91aff836ac 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md @@ -41,7 +41,7 @@ Provides methods that allow a host to load assemblies and modules independently ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md b/docs/core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md index 4e8872aa9ca65..349f0c74253bf 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md @@ -69,7 +69,7 @@ HRESULT ProvideAssembly ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md b/docs/core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md index 16b9454f43d05..0bd00b1db5f38 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md @@ -65,7 +65,7 @@ HRESULT ProvideModule ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostautoevent-interface.md b/docs/core/unmanaged-api/hosting/ihostautoevent-interface.md index a042a9aa22c3f..2f4b0c3c088db 100644 --- a/docs/core/unmanaged-api/hosting/ihostautoevent-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostautoevent-interface.md @@ -29,7 +29,7 @@ Provides a representation of the host's implementation of an auto-reset event. ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md b/docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md index 18971598aaf85..a0323c37c01ea 100644 --- a/docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md +++ b/docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md @@ -40,7 +40,7 @@ HRESULT Set (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md b/docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md index 9bfdfb1f6f2e2..ca23493a2229a 100644 --- a/docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md +++ b/docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md @@ -52,7 +52,7 @@ HRESULT Wait ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md b/docs/core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md index 0e9b0bb996a85..3df163daf77c5 100644 --- a/docs/core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md @@ -79,7 +79,7 @@ HRESULT GetHostManager ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcontrol-interface.md b/docs/core/unmanaged-api/hosting/ihostcontrol-interface.md index f5df8acbd3c01..ca31d0412f528 100644 --- a/docs/core/unmanaged-api/hosting/ihostcontrol-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostcontrol-interface.md @@ -29,7 +29,7 @@ Provides methods for configuring the loading of assemblies, and for determining ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md b/docs/core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md index 01b65be27bf40..d4ffcbcf468c8 100644 --- a/docs/core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md @@ -57,7 +57,7 @@ HRESULT SetAppDomainManager ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md b/docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md index 737085f53be73..7b1e96aa8935c 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md @@ -54,7 +54,7 @@ HRESULT Enter ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-interface.md b/docs/core/unmanaged-api/hosting/ihostcrst-interface.md index cebeba28a7d20..5e86185351650 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostcrst-interface.md @@ -35,7 +35,7 @@ Serves as the host's representation of a critical section for threading. ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md b/docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md index bdfbd923be323..9a7ee7ce9e954 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md @@ -44,7 +44,7 @@ HRESULT Leave (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-setspincount-method.md b/docs/core/unmanaged-api/hosting/ihostcrst-setspincount-method.md index 647db7b81806d..1cc5a71a5789d 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-setspincount-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcrst-setspincount-method.md @@ -53,7 +53,7 @@ HRESULT SetSpinCount ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md b/docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md index 8dea91b5edeb7..4d5a8ac256326 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md @@ -55,7 +55,7 @@ HRESULT TryEnter ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md b/docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md index 51fa832d97dc9..785db21f068df 100644 --- a/docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md @@ -30,7 +30,7 @@ Provides methods that notify the host of events in the garbage collection mechan ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md b/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md index 75a1f8f54cec3..7fae9657e62b3 100644 --- a/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md +++ b/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md @@ -54,7 +54,7 @@ HRESULT SuspensionEnding ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md b/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md index d1b830f2ad710..4e6e865907c15 100644 --- a/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md +++ b/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md @@ -47,7 +47,7 @@ HRESULT SuspensionStarting (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md b/docs/core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md index d2029678e2036..f82010ee1fef4 100644 --- a/docs/core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md +++ b/docs/core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md @@ -47,7 +47,7 @@ HRESULT ThreadIsBlockingForSuspension (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md index 2a08451de148d..8c18682ef5028 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md @@ -58,7 +58,7 @@ HRESULT Bind ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md index c3e9241edac71..c99a2c7ce9594 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md @@ -52,7 +52,7 @@ HRESULT CloseIoCompletionPort ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md index 9a46149bcde9e..0fa2f6dc3bbd0 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md @@ -52,7 +52,7 @@ HRESULT CreateIoCompletionPort ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md index 0ebe2f70f843a..0802562ad168c 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md @@ -52,7 +52,7 @@ HRESULT GetAvailableThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md index a8951f3a15e49..47d038b794855 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md @@ -61,7 +61,7 @@ HRESULT GetHostOverlappedSize ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md index 5be5540c7e666..eb21ac96c97c6 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md @@ -52,7 +52,7 @@ HRESULT GetMaxThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md index e23b883208a1b..3417ac46ad984 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md @@ -52,7 +52,7 @@ HRESULT GetMinThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md index ef415ba394832..d049d60cb2c7c 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md @@ -57,7 +57,7 @@ HRESULT InitializeHostOverlapped ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md index fdaadfb142706..480d47a17596f 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md @@ -42,7 +42,7 @@ Provides methods that allow the common language runtime (CLR) to interact with I ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md index 393f997e1e70c..b944bfcd5fdeb 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md @@ -51,7 +51,7 @@ HRESULT SetCLRIoCompletionManager ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md index 9e4f4e61bce4e..b927a6ec18c5e 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md @@ -52,7 +52,7 @@ HRESULT SetMaxThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md index ab21194c6465a..60cba0252b1ed 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md @@ -52,7 +52,7 @@ HRESULT SetMinThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md b/docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md index d305589a6f00b..8150518a080e7 100644 --- a/docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md @@ -60,7 +60,7 @@ HRESULT Alloc ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md b/docs/core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md index 66fc7bf156d23..12cc32da18538 100644 --- a/docs/core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md @@ -68,7 +68,7 @@ HRESULT DebugAlloc ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md b/docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md index ad301a223ba6b..4ee5f138adcb9 100644 --- a/docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md @@ -52,7 +52,7 @@ HRESULT Free ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmalloc-interface.md b/docs/core/unmanaged-api/hosting/ihostmalloc-interface.md index 9a4c872f566f6..5f2884c3c7964 100644 --- a/docs/core/unmanaged-api/hosting/ihostmalloc-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostmalloc-interface.md @@ -34,7 +34,7 @@ Provides methods that allow the common language runtime (CLR) to request fine-gr ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md b/docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md index 34be3b2165562..39a316a63fadc 100644 --- a/docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md @@ -30,7 +30,7 @@ Provides the host's implementation of a representation of a manual reset event. ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmanualevent-reset-method.md b/docs/core/unmanaged-api/hosting/ihostmanualevent-reset-method.md index a13d7ca464f76..789aab112a6cc 100644 --- a/docs/core/unmanaged-api/hosting/ihostmanualevent-reset-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmanualevent-reset-method.md @@ -40,7 +40,7 @@ HRESULT Reset (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md b/docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md index 4e9a46853fa91..67c0e163c3a35 100644 --- a/docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md @@ -40,7 +40,7 @@ HRESULT Set (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md b/docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md index 7b48312c68a4c..1f743fb2ae155 100644 --- a/docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md @@ -52,7 +52,7 @@ HRESULT Wait ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md index 4e022591bbef7..604d89abb577c 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md @@ -44,7 +44,7 @@ HRESULT AcquiredVirtualAddressSpace( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md index ed0d7f59a5acb..6f62333fb3878 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md @@ -56,7 +56,7 @@ HRESULT CreateMalloc ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md index 335a08ef9e324..93a7213cf31e3 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md @@ -57,7 +57,7 @@ HRESULT GetMemoryLoad ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md index 415920e2e1d97..037be976a06d5 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md @@ -41,7 +41,7 @@ Provides methods that allow the common language runtime (CLR) to make virtual me ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md index 8be3738e32756..53f980cc5e959 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md @@ -46,7 +46,7 @@ HRESULT NeedsVirtualAddressSpace ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md index a3d2a0286821e..c4b95b225fc96 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md @@ -54,7 +54,7 @@ HRESULT RegisterMemoryNotificationCallback ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md index 6f5285570da95..807e5f217ee4a 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md @@ -40,7 +40,7 @@ HRESULT ReleasedVirtualAddressSpace( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md index 8b335951aeb8e..6a00f702e7412 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md @@ -74,7 +74,7 @@ HRESULT VirtualAlloc ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md index 8416fdfb3abd4..aea2df6b076b4 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md @@ -62,7 +62,7 @@ HRESULT VirtualFree ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md index 230620ff4f09d..5324405f18c5b 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md @@ -63,7 +63,7 @@ HRESULT VirtualProtect ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md index e2ddc3fabe15c..fe719e878a11a 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md @@ -66,7 +66,7 @@ HRESULT VirtualQuery ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md b/docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md index 5e8392acec22f..c038a6900b50b 100644 --- a/docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md @@ -30,7 +30,7 @@ Provides methods that notify the host of the actions the common language runtime ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md b/docs/core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md index 7d4cbecdd09d2..d9f4db0455df5 100644 --- a/docs/core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md +++ b/docs/core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md @@ -51,7 +51,7 @@ HRESULT OnDefaultAction ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md b/docs/core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md index 2ecb62056a73b..1f2790373c96b 100644 --- a/docs/core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md +++ b/docs/core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md @@ -51,7 +51,7 @@ HRESULT OnFailure( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md b/docs/core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md index a9415780e97e3..c86aae7bd30b7 100644 --- a/docs/core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md +++ b/docs/core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md @@ -51,7 +51,7 @@ HRESULT OnTimeout ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md index aa0fc94652f99..bfc57fc7ced2f 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md @@ -51,7 +51,7 @@ HRESULT Capture ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritycontext-interface.md b/docs/core/unmanaged-api/hosting/ihostsecuritycontext-interface.md index f121f5001038a..08e0f00b1e4e4 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritycontext-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritycontext-interface.md @@ -32,7 +32,7 @@ Allows the common language runtime (CLR) to maintain security context informatio ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md index 803cc0428a7c2..2950f4852b354 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md @@ -55,7 +55,7 @@ HRESULT GetSecurityContext ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md index 1f6397f83fbe1..3de2021a56adf 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md @@ -53,7 +53,7 @@ HRESULT ImpersonateLoggedOnUser ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-interface.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-interface.md index 3cbc016cbbd1f..ae7c590184bf6 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-interface.md @@ -47,7 +47,7 @@ Provides methods that allow access to and control over the security context of t ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md index 9285dab15305d..ac07a83770305 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md @@ -61,7 +61,7 @@ HRESULT OpenThreadToken ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md index 2d2c789090b7a..64f4d071e8d9d 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md @@ -44,7 +44,7 @@ HRESULT RevertToSelf (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md index bc5b1cbb968e7..972a8af4487ea 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md @@ -57,7 +57,7 @@ HRESULT SetSecurityContext ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md index 102ead504466a..306cd682e52e7 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md @@ -53,7 +53,7 @@ HRESULT SetThreadToken ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md b/docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md index 7cd2050f9bd0d..aa6d0819f906f 100644 --- a/docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md @@ -29,7 +29,7 @@ Represents the host's implementation of a semaphore for threading. ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md b/docs/core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md index f2fbee541a50c..fce2a1cc7d768 100644 --- a/docs/core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md @@ -55,7 +55,7 @@ HRESULT ReleaseSemaphore ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md b/docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md index 641d3ec4846d6..6ad669c91ff7c 100644 --- a/docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md @@ -52,7 +52,7 @@ HRESULT Wait ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md index ae25e6c91f78b..2a5c8599916e1 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md @@ -52,7 +52,7 @@ HRESULT CreateAutoEvent ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md index 1535f811df3e0..032c1f232f1f2 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md @@ -52,7 +52,7 @@ HRESULT CreateCrst ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md index d1ecc569f5213..6d3b2cbf2adef 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md @@ -56,7 +56,7 @@ HRESULT CreateCrstWithSpinCount ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md index d8bf056e11e54..dad90d29b9fa6 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md @@ -56,7 +56,7 @@ HRESULT CreateManualEvent ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md index e0181b1930074..54dbc120eb7f1 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md @@ -58,7 +58,7 @@ HRESULT CreateMonitorEvent ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md index 1301dff3ffba0..8a7e07e7678c7 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md @@ -60,7 +60,7 @@ HRESULT CreateRWLockReaderEvent ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md index 4b08c4bc683f6..1e1ce26e0bacb 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md @@ -56,7 +56,7 @@ HRESULT CreateRWLockWriterEvent ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md index d84a86c908345..5c4e9912e59b2 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md @@ -60,7 +60,7 @@ HRESULT CreateSemaphore ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md index fd293a8c97302..c45eb23d00b7b 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md @@ -40,7 +40,7 @@ Provides methods that allow the common language runtime (CLR) to create synchron ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md index 4d6908b397112..4ecc6d59bad1f 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md @@ -51,7 +51,7 @@ HRESULT SetCLRSyncManager ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttask-alert-method.md b/docs/core/unmanaged-api/hosting/ihosttask-alert-method.md index 187d952d01f1e..82d3e7c34c0b7 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-alert-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-alert-method.md @@ -47,7 +47,7 @@ HRESULT Alert (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md b/docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md index a373b0d381014..2f3a72081d6de 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md @@ -51,7 +51,7 @@ HRESULT GetPriority ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttask-interface.md b/docs/core/unmanaged-api/hosting/ihosttask-interface.md index e71ec42dc58a2..93a7308a61149 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-interface.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-interface.md @@ -37,7 +37,7 @@ Provides methods that allow the common language runtime (CLR) to communicate wit ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttask-join-method.md b/docs/core/unmanaged-api/hosting/ihosttask-join-method.md index 8b3278f0e4878..374e63ef755fb 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-join-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-join-method.md @@ -51,7 +51,7 @@ HRESULT Join ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md b/docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md index 756aa2e2956df..1c0b9b5120d91 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md @@ -51,7 +51,7 @@ HRESULT SetCLRTask ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md b/docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md index 212e6a1a79827..98fa504ab5fe1 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md @@ -72,7 +72,7 @@ HRESULT SetPriority ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttask-start-method.md b/docs/core/unmanaged-api/hosting/ihosttask-start-method.md index 0c2dc5d96c3ad..bf70ae371a8b3 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-start-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-start-method.md @@ -40,7 +40,7 @@ HRESULT Start (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md index 5001cee6f18ed..ed60995564b1c 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md @@ -45,7 +45,7 @@ HRESULT BeginDelayAbort (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md index 8388cd51944f5..d5b947cbe2c7f 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md @@ -44,7 +44,7 @@ HRESULT BeginThreadAffinity (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md index 22c8d84f65e2e..cc12189060d81 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md @@ -57,7 +57,7 @@ HRESULT CallNeedsHostHook ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md index fc1dc9c61b648..dad9cf5450f62 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md @@ -64,7 +64,7 @@ HRESULT CreateTask ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md index 3458a7b9c3ea0..19636f3c1c560 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md @@ -45,7 +45,7 @@ HRESULT EndDelayAbort (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md index fe98ac95e1753..86e740b6b92f1 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md @@ -45,7 +45,7 @@ HRESULT EndThreadAffinity (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md index ddb47b6df3cb4..1aaa22971ec69 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md @@ -48,7 +48,7 @@ HRESULT EnterRuntime (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md index b990f388f5ab2..e4a0018181352 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md @@ -52,7 +52,7 @@ HRESULT GetCurrentTask ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md index 5a66f15f7368f..987e65df512a4 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md @@ -36,7 +36,7 @@ HRESULT GetStackGuarantee( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md index 8ac6b37637a0f..b732cb0a69430 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md @@ -49,7 +49,7 @@ Provides methods that allow the common language runtime (CLR) to work with tasks ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md index deb78a5042281..b1ffb45448007 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md @@ -64,7 +64,7 @@ HRESULT LeaveRuntime ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md index 904828f8d78ba..9448412700906 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md @@ -48,7 +48,7 @@ HRESULT ReverseEnterRuntime (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md index 70b2806f42678..bcb352deb0d4e 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md @@ -45,7 +45,7 @@ HRESULT ReverseLeaveRuntime (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md index 677c742d38dcc..5451bdcde1384 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md @@ -51,7 +51,7 @@ HRESULT SetCLRTaskManager ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md index 8dfd2cd6292c8..6576b514332c2 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md @@ -52,7 +52,7 @@ HRESULT SetLocale ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md index afd2f48b739ee..26d5a2bcf0cab 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md @@ -31,7 +31,7 @@ HRESULT SetStackGuarantee( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md index 4efa8242ce8b2..e3adc557af3e0 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md @@ -52,7 +52,7 @@ HRESULT SetUILocale ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md index e61bb8f79da87..ae34955b61573 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md @@ -55,7 +55,7 @@ HRESULT Sleep ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md index 4129239c8a1c0..b1fa8eb8fe056 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md @@ -54,7 +54,7 @@ HRESULT SwitchToTask ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md index 59f82801f4b6d..53322b8b4fb34 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md @@ -52,7 +52,7 @@ HRESULT GetAvailableThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md index 073050ae589ed..56d148b442265 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md @@ -54,7 +54,7 @@ HRESULT GetMaxThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md index 58d972fe42bb3..0f9b514c557ce 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md @@ -52,7 +52,7 @@ HRESULT GetMinThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md index 6f373a2fdf2e1..6b772b5ea6660 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md @@ -37,7 +37,7 @@ Provides methods that enable the common language runtime (CLR) to configure the ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md index c4fb6f393af42..994ad0f978dc6 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md @@ -59,7 +59,7 @@ HRESULT QueueUserWorkItem ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md index 1bb7e2ff86a5d..03a5d3c1de9c1 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md @@ -52,7 +52,7 @@ HRESULT SetMaxThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md index 7eab1c4d5a734..5c34c17fd3330 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md @@ -52,7 +52,7 @@ HRESULT SetMinThreads ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md b/docs/core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md index f6963e10f2c92..d9ae77e89741b 100644 --- a/docs/core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md +++ b/docs/core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md @@ -48,7 +48,7 @@ HRESULT GetObjectIdentity ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md b/docs/core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md index efb0af1008281..109a2fcbc0440 100644 --- a/docs/core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md +++ b/docs/core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md @@ -40,7 +40,7 @@ HRESULT GetSerializedBuffer ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/imanagedobject-interface.md b/docs/core/unmanaged-api/hosting/imanagedobject-interface.md index b9b78791b66c9..3c087294f926c 100644 --- a/docs/core/unmanaged-api/hosting/imanagedobject-interface.md +++ b/docs/core/unmanaged-api/hosting/imanagedobject-interface.md @@ -29,7 +29,7 @@ Provides methods for controlling a managed object. ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iobjecthandle-interface.md b/docs/core/unmanaged-api/hosting/iobjecthandle-interface.md index 80a8f008d8e88..0568dfc1cb7ea 100644 --- a/docs/core/unmanaged-api/hosting/iobjecthandle-interface.md +++ b/docs/core/unmanaged-api/hosting/iobjecthandle-interface.md @@ -28,7 +28,7 @@ Provides a method for unwrapping marshal-by-value objects from indirection. ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md b/docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md index 1bdf599cd1d1b..be6d6529f91dd 100644 --- a/docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md +++ b/docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md @@ -36,7 +36,7 @@ HRESULT Unwrap ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-getassemblyname-method.md b/docs/core/unmanaged-api/hosting/itypename-getassemblyname-method.md index 3c68bbc193c40..0dc092d3be320 100644 --- a/docs/core/unmanaged-api/hosting/itypename-getassemblyname-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-getassemblyname-method.md @@ -31,7 +31,7 @@ HRESULT GetAssemblyName ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-getmodifierlength-method.md b/docs/core/unmanaged-api/hosting/itypename-getmodifierlength-method.md index 1524ccbeb540d..8c4215f0716dd 100644 --- a/docs/core/unmanaged-api/hosting/itypename-getmodifierlength-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-getmodifierlength-method.md @@ -31,7 +31,7 @@ HRESULT GetModifierLength ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-getmodifiers-method.md b/docs/core/unmanaged-api/hosting/itypename-getmodifiers-method.md index 79613e3ee39b7..912d1e0b31212 100644 --- a/docs/core/unmanaged-api/hosting/itypename-getmodifiers-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-getmodifiers-method.md @@ -33,7 +33,7 @@ HRESULT GetModifiers ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-getnamecount-method.md b/docs/core/unmanaged-api/hosting/itypename-getnamecount-method.md index 02b51293ac6b9..a74155f16cdca 100644 --- a/docs/core/unmanaged-api/hosting/itypename-getnamecount-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-getnamecount-method.md @@ -31,7 +31,7 @@ HRESULT GetNameCount ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-getnames-method.md b/docs/core/unmanaged-api/hosting/itypename-getnames-method.md index e64acc1caba3b..b9b2a392c4252 100644 --- a/docs/core/unmanaged-api/hosting/itypename-getnames-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-getnames-method.md @@ -33,7 +33,7 @@ HRESULT GetNames ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md b/docs/core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md index 40a64014375a5..be9cbb40f5600 100644 --- a/docs/core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md @@ -31,7 +31,7 @@ HRESULT GetTypeArgumentCount ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-gettypearguments-method.md b/docs/core/unmanaged-api/hosting/itypename-gettypearguments-method.md index d645c88bbaccb..115a2fd3a63e8 100644 --- a/docs/core/unmanaged-api/hosting/itypename-gettypearguments-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-gettypearguments-method.md @@ -33,7 +33,7 @@ HRESULT GetTypeArguments ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypename-interface.md b/docs/core/unmanaged-api/hosting/itypename-interface.md index b1005a1b21a2c..e694d7909cfff 100644 --- a/docs/core/unmanaged-api/hosting/itypename-interface.md +++ b/docs/core/unmanaged-api/hosting/itypename-interface.md @@ -24,7 +24,7 @@ Provides methods for obtaining type name information. ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md index 116bd56f2365a..fb8440d599122 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md @@ -31,7 +31,7 @@ HRESULT AddArray ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md index ffb8c29f939ee..29929290e1ece 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md @@ -31,7 +31,7 @@ HRESULT AddAssemblySpec ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md index 91616412d95fa..44d1ed57cc6cb 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md @@ -30,7 +30,7 @@ HRESULT AddByRef ( ); ## Requirements -**Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addname-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addname-method.md index c0071c561614c..1bbc18b5c67f8 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addname-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addname-method.md @@ -31,7 +31,7 @@ HRESULT AddName ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md index 24b8a98934df1..d2a296b818be4 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md @@ -29,7 +29,7 @@ HRESULT AddPointer ( ); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md index e40ad3d27fbd8..e6d9a75c5348b 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md @@ -29,7 +29,7 @@ HRESULT AddSzArray ( ); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-clear-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-clear-method.md index 509b2a3daad80..5b30b8b8d239e 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-clear-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-clear-method.md @@ -29,7 +29,7 @@ HRESULT Clear ( ); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md index 0cb8facda2a56..39a03ede52789 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md @@ -29,7 +29,7 @@ HRESULT CloseGenericArgument ( ); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md index e321a2f85a977..7db67267ff123 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md @@ -29,7 +29,7 @@ HRESULT CloseGenericArguments ( ); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md index 2d0644cfe4b4e..a7cefca6697d3 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md @@ -24,7 +24,7 @@ Provides methods for building a type name. ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md index b9fe7620e1441..e21eaf477ec7b 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md @@ -29,7 +29,7 @@ HRESULT OpenGenericArgument ( ); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md index 224ecc1ed8280..84ae6ec3187fa 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md @@ -29,7 +29,7 @@ HRESULT OpenGenericArguments ( ); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md index 6875c6dcb3d4a..27448fb55c365 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md @@ -31,7 +31,7 @@ HRESULT ToString ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md b/docs/core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md index 2f779a541c88f..e844d20f5c844 100644 --- a/docs/core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md @@ -31,7 +31,7 @@ HRESULT GetTypeNameBuilder ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamefactory-interface.md b/docs/core/unmanaged-api/hosting/itypenamefactory-interface.md index 9f072c5132059..47480bab54d99 100644 --- a/docs/core/unmanaged-api/hosting/itypenamefactory-interface.md +++ b/docs/core/unmanaged-api/hosting/itypenamefactory-interface.md @@ -24,7 +24,7 @@ Provides methods for deconstructing a type name. ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md b/docs/core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md index cb436f9e56a07..c0c7e4f083a36 100644 --- a/docs/core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md @@ -33,7 +33,7 @@ HRESULT ParseTypeName ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md b/docs/core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md index 17bb6b59a2d4a..bcf15de1ed930 100644 --- a/docs/core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md +++ b/docs/core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md @@ -52,7 +52,7 @@ HRESULT FormatEventInfo( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h diff --git a/docs/core/unmanaged-api/hosting/ivalidator-interface.md b/docs/core/unmanaged-api/hosting/ivalidator-interface.md index 79b962435d657..7d2bcdf87bd46 100644 --- a/docs/core/unmanaged-api/hosting/ivalidator-interface.md +++ b/docs/core/unmanaged-api/hosting/ivalidator-interface.md @@ -29,7 +29,7 @@ Provides methods for validating portable executable (PE) images and reporting va ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h diff --git a/docs/core/unmanaged-api/hosting/ivalidator-validate-method.md b/docs/core/unmanaged-api/hosting/ivalidator-validate-method.md index 66dc37f0443a3..13cedb52a936e 100644 --- a/docs/core/unmanaged-api/hosting/ivalidator-validate-method.md +++ b/docs/core/unmanaged-api/hosting/ivalidator-validate-method.md @@ -64,7 +64,7 @@ HRESULT Validate ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h diff --git a/docs/core/unmanaged-api/hosting/loadlibraryshim-function.md b/docs/core/unmanaged-api/hosting/loadlibraryshim-function.md index 39cf27c35614d..a223a9bd0ca8b 100644 --- a/docs/core/unmanaged-api/hosting/loadlibraryshim-function.md +++ b/docs/core/unmanaged-api/hosting/loadlibraryshim-function.md @@ -66,7 +66,7 @@ HRESULT LoadLibraryShim ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/loadstringrc-function.md b/docs/core/unmanaged-api/hosting/loadstringrc-function.md index 2e99d3aba7fa9..6168c4802785c 100644 --- a/docs/core/unmanaged-api/hosting/loadstringrc-function.md +++ b/docs/core/unmanaged-api/hosting/loadstringrc-function.md @@ -62,7 +62,7 @@ HRESULT LoadStringRC ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/loadstringrcex-function.md b/docs/core/unmanaged-api/hosting/loadstringrcex-function.md index 3230047bcf943..dbe6c266995e2 100644 --- a/docs/core/unmanaged-api/hosting/loadstringrcex-function.md +++ b/docs/core/unmanaged-api/hosting/loadstringrcex-function.md @@ -70,7 +70,7 @@ HRESULT LoadStringRCEx ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/lockclrversion-function.md b/docs/core/unmanaged-api/hosting/lockclrversion-function.md index c705d3a46a9ac..55506e4fc4545 100644 --- a/docs/core/unmanaged-api/hosting/lockclrversion-function.md +++ b/docs/core/unmanaged-api/hosting/lockclrversion-function.md @@ -83,7 +83,7 @@ typedef HRESULT ( __stdcall *FLockClrVersionCallback ) (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md b/docs/core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md index 997938600e378..658dd6ac1f2a0 100644 --- a/docs/core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md +++ b/docs/core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md @@ -51,7 +51,7 @@ typedef VOID (*LPOVERLAPPED_COMPLETION_ROUTINE) ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md b/docs/core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md index 85a4f45cacb5a..2660244843c87 100644 --- a/docs/core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md +++ b/docs/core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md @@ -41,7 +41,7 @@ typedef DWORD (__stdcall *LPTHREAD_START_ROUTINE) ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/malloc-type-enumeration.md b/docs/core/unmanaged-api/hosting/malloc-type-enumeration.md index 2d0431b604d6a..7be9ef6d77d87 100644 --- a/docs/core/unmanaged-api/hosting/malloc-type-enumeration.md +++ b/docs/core/unmanaged-api/hosting/malloc-type-enumeration.md @@ -38,7 +38,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/mdainfo-structure.md b/docs/core/unmanaged-api/hosting/mdainfo-structure.md index 08c73d48f1488..80debb4ec21c3 100644 --- a/docs/core/unmanaged-api/hosting/mdainfo-structure.md +++ b/docs/core/unmanaged-api/hosting/mdainfo-structure.md @@ -50,7 +50,7 @@ typedef struct _MDAInfo { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/metahost-config-flags-enumeration.md b/docs/core/unmanaged-api/hosting/metahost-config-flags-enumeration.md index 211d638154f14..ee6d95395de87 100644 --- a/docs/core/unmanaged-api/hosting/metahost-config-flags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/metahost-config-flags-enumeration.md @@ -44,7 +44,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Metahost.h diff --git a/docs/core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md b/docs/core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md index 4ea2ea5379017..debebef50f8db 100644 --- a/docs/core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md @@ -51,7 +51,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Metahost.h diff --git a/docs/core/unmanaged-api/hosting/modulebindinfo-structure.md b/docs/core/unmanaged-api/hosting/modulebindinfo-structure.md index 1343a798b6f5a..0c6af7c05236e 100644 --- a/docs/core/unmanaged-api/hosting/modulebindinfo-structure.md +++ b/docs/core/unmanaged-api/hosting/modulebindinfo-structure.md @@ -44,7 +44,7 @@ typedef struct _ModuleBindInfo { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/net-framework-4-hosting-global-static-functions.md b/docs/core/unmanaged-api/hosting/net-framework-4-hosting-global-static-functions.md index 1608cf357d7cb..e5376a63e5d71 100644 --- a/docs/core/unmanaged-api/hosting/net-framework-4-hosting-global-static-functions.md +++ b/docs/core/unmanaged-api/hosting/net-framework-4-hosting-global-static-functions.md @@ -15,7 +15,7 @@ The .NET Framework 4 introduces one new exported method in MSCorEE.dll: [CLRCrea ## In This Section [CLRCreateInstance Function](clrcreateinstance-function.md) - Provides one of three interfaces: [ICLRMetaHost](iclrmetahost-interface.md), [ICLRMetaHostPolicy](iclrmetahostpolicy-interface.md), or [ICLRDebugging](../debugging/iclrdebugging-interface.md). + Provides one of three interfaces: [ICLRMetaHost](iclrmetahost-interface.md), [ICLRMetaHostPolicy](iclrmetahostpolicy-interface.md), or [ICLRDebugging](../../../framework/unmanaged-api/debugging/iclrdebugging-interface.md). ## See also diff --git a/docs/core/unmanaged-api/hosting/rundll32shimw-function.md b/docs/core/unmanaged-api/hosting/rundll32shimw-function.md index a4473be581cf1..91fc3839333e0 100644 --- a/docs/core/unmanaged-api/hosting/rundll32shimw-function.md +++ b/docs/core/unmanaged-api/hosting/rundll32shimw-function.md @@ -49,7 +49,7 @@ HRESULT RunDll32ShimW ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/runtime-info-flags-enumeration.md b/docs/core/unmanaged-api/hosting/runtime-info-flags-enumeration.md index fe5fa42ccee02..f3c75080fb55d 100644 --- a/docs/core/unmanaged-api/hosting/runtime-info-flags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/runtime-info-flags-enumeration.md @@ -62,7 +62,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md b/docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md index 4ebcc4a9bc85e..139a991cb8fb1 100644 --- a/docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md +++ b/docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md @@ -42,7 +42,7 @@ typedef struct _StackOverflowInfo { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/stackoverflowtype-enumeration.md b/docs/core/unmanaged-api/hosting/stackoverflowtype-enumeration.md index cb35284714412..8afe571b46e15 100644 --- a/docs/core/unmanaged-api/hosting/stackoverflowtype-enumeration.md +++ b/docs/core/unmanaged-api/hosting/stackoverflowtype-enumeration.md @@ -44,7 +44,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/startup-flags-enumeration.md b/docs/core/unmanaged-api/hosting/startup-flags-enumeration.md index 51eb83a89bcb8..3be8f64353d1e 100644 --- a/docs/core/unmanaged-api/hosting/startup-flags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/startup-flags-enumeration.md @@ -70,7 +70,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md b/docs/core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md index d406ab6f80208..b75c50ffb3805 100644 --- a/docs/core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md +++ b/docs/core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md @@ -82,7 +82,7 @@ HRESULT StrongNameGetPublicKey ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md b/docs/core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md index 26a94723302f0..3b145ee93ef05 100644 --- a/docs/core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md +++ b/docs/core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md @@ -55,7 +55,7 @@ HRESULT StrongNameSignatureVerificationEx ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MetaHost.h diff --git a/docs/core/unmanaged-api/hosting/typenamefactory-coclass.md b/docs/core/unmanaged-api/hosting/typenamefactory-coclass.md index a4ee43184179a..3c08bddf86281 100644 --- a/docs/core/unmanaged-api/hosting/typenamefactory-coclass.md +++ b/docs/core/unmanaged-api/hosting/typenamefactory-coclass.md @@ -36,7 +36,7 @@ coclass TypeNameFactory { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.idl diff --git a/docs/core/unmanaged-api/hosting/validatorflags-enumeration.md b/docs/core/unmanaged-api/hosting/validatorflags-enumeration.md index 9bed99732ee23..af26a394d4e61 100644 --- a/docs/core/unmanaged-api/hosting/validatorflags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/validatorflags-enumeration.md @@ -44,7 +44,7 @@ enum ValidatorFlags { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h diff --git a/docs/core/unmanaged-api/hosting/wait-option-enumeration.md b/docs/core/unmanaged-api/hosting/wait-option-enumeration.md index bc18095067879..975b72c598a83 100644 --- a/docs/core/unmanaged-api/hosting/wait-option-enumeration.md +++ b/docs/core/unmanaged-api/hosting/wait-option-enumeration.md @@ -44,7 +44,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/hosting/waitortimercallback-function-pointer.md b/docs/core/unmanaged-api/hosting/waitortimercallback-function-pointer.md index 429301c6c39c5..b528971fc54e7 100644 --- a/docs/core/unmanaged-api/hosting/waitortimercallback-function-pointer.md +++ b/docs/core/unmanaged-api/hosting/waitortimercallback-function-pointer.md @@ -45,7 +45,7 @@ typedef VOID (__stdcall *WAITORTIMERCALLBACK) ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MSCorEE.h diff --git a/docs/core/unmanaged-api/metadata/assemblyflags-enumeration.md b/docs/core/unmanaged-api/metadata/assemblyflags-enumeration.md index 1a6a5b60cc610..c01132cb5faaf 100644 --- a/docs/core/unmanaged-api/metadata/assemblyflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/assemblyflags-enumeration.md @@ -48,7 +48,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** MsCorEE.h diff --git a/docs/core/unmanaged-api/metadata/assemblymetadata-structure.md b/docs/core/unmanaged-api/metadata/assemblymetadata-structure.md index 8e8e183a63017..adbeb1af3920c 100644 --- a/docs/core/unmanaged-api/metadata/assemblymetadata-structure.md +++ b/docs/core/unmanaged-api/metadata/assemblymetadata-structure.md @@ -54,7 +54,7 @@ typedef struct { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/assemblyrefflags-enumeration.md b/docs/core/unmanaged-api/metadata/assemblyrefflags-enumeration.md index a1ddd325d905b..22cd9ebfeb14c 100644 --- a/docs/core/unmanaged-api/metadata/assemblyrefflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/assemblyrefflags-enumeration.md @@ -36,7 +36,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/ceesectionattr-enumeration.md b/docs/core/unmanaged-api/metadata/ceesectionattr-enumeration.md index b8f80879c2d46..c12205a82764e 100644 --- a/docs/core/unmanaged-api/metadata/ceesectionattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/ceesectionattr-enumeration.md @@ -44,7 +44,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/ceesectionrelocextra-union.md b/docs/core/unmanaged-api/metadata/ceesectionrelocextra-union.md index b5c156ece2545..4dfad73e11cec 100644 --- a/docs/core/unmanaged-api/metadata/ceesectionrelocextra-union.md +++ b/docs/core/unmanaged-api/metadata/ceesectionrelocextra-union.md @@ -36,7 +36,7 @@ typedef union { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/ceesectionreloctype-enumeration.md b/docs/core/unmanaged-api/metadata/ceesectionreloctype-enumeration.md index 7b51ab5aeef21..91187e12efbc8 100644 --- a/docs/core/unmanaged-api/metadata/ceesectionreloctype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/ceesectionreloctype-enumeration.md @@ -66,7 +66,7 @@ typedef enum { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/coiniticor-enumeration.md b/docs/core/unmanaged-api/metadata/coiniticor-enumeration.md index 2bd3b142c54bd..c8a3aa75125dd 100644 --- a/docs/core/unmanaged-api/metadata/coiniticor-enumeration.md +++ b/docs/core/unmanaged-api/metadata/coiniticor-enumeration.md @@ -37,7 +37,7 @@ typedef enum tagCOINITCOR ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/coinitiee-enumeration.md b/docs/core/unmanaged-api/metadata/coinitiee-enumeration.md index 325a0d5806245..6543611acf6b8 100644 --- a/docs/core/unmanaged-api/metadata/coinitiee-enumeration.md +++ b/docs/core/unmanaged-api/metadata/coinitiee-enumeration.md @@ -40,7 +40,7 @@ typedef enum tagCOINITEE { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/cor-field-offset-structure.md b/docs/core/unmanaged-api/metadata/cor-field-offset-structure.md index 6b81f5294ef0f..70a5ca9161441 100644 --- a/docs/core/unmanaged-api/metadata/cor-field-offset-structure.md +++ b/docs/core/unmanaged-api/metadata/cor-field-offset-structure.md @@ -42,7 +42,7 @@ typedef struct COR_FIELD_OFFSET { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h, CorProf.idl diff --git a/docs/core/unmanaged-api/metadata/cor-native-link-structure.md b/docs/core/unmanaged-api/metadata/cor-native-link-structure.md index fa7c90545ff82..3473142f596ce 100644 --- a/docs/core/unmanaged-api/metadata/cor-native-link-structure.md +++ b/docs/core/unmanaged-api/metadata/cor-native-link-structure.md @@ -41,7 +41,7 @@ typedef struct ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/corargtype-enumeration.md b/docs/core/unmanaged-api/metadata/corargtype-enumeration.md index 38ce4f68124f5..0540d8910a0bf 100644 --- a/docs/core/unmanaged-api/metadata/corargtype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corargtype-enumeration.md @@ -42,7 +42,7 @@ typedef enum CorArgType { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corassemblyflags-enumeration.md b/docs/core/unmanaged-api/metadata/corassemblyflags-enumeration.md index 9a9570dd609b8..c3a38f5ab3bdb 100644 --- a/docs/core/unmanaged-api/metadata/corassemblyflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corassemblyflags-enumeration.md @@ -74,7 +74,7 @@ typedef enum CorAssemblyFlags { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corattributetargets-enumeration.md b/docs/core/unmanaged-api/metadata/corattributetargets-enumeration.md index d09a0b7d0ddb0..946a1f9f4bfa5 100644 --- a/docs/core/unmanaged-api/metadata/corattributetargets-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corattributetargets-enumeration.md @@ -83,7 +83,7 @@ typedef enum CorAttributeTargets ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corcallingconvention-enumeration.md b/docs/core/unmanaged-api/metadata/corcallingconvention-enumeration.md index 8b5017b199c95..c1a48ee2b7f50 100644 --- a/docs/core/unmanaged-api/metadata/corcallingconvention-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corcallingconvention-enumeration.md @@ -64,7 +64,7 @@ typedef enum CorCallingConvention ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md b/docs/core/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md index e28e224824fbe..a40023a0252b4 100644 --- a/docs/core/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md @@ -94,7 +94,7 @@ typedef enum CorCheckDuplicatesFor { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cordeclsecurity-enumeration.md b/docs/core/unmanaged-api/metadata/cordeclsecurity-enumeration.md index 553f8d8ef9722..d108457952890 100644 --- a/docs/core/unmanaged-api/metadata/cordeclsecurity-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cordeclsecurity-enumeration.md @@ -78,7 +78,7 @@ typedef enum CorDeclSecurity { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corelementtype-enumeration.md b/docs/core/unmanaged-api/metadata/corelementtype-enumeration.md index 522b73321684f..991ce638770d9 100644 --- a/docs/core/unmanaged-api/metadata/corelementtype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corelementtype-enumeration.md @@ -135,7 +135,7 @@ The type modifiers form the basis for representing more complex types. A `CorEle ## Requirements -**Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md b/docs/core/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md index 2c3ab89902ed4..d8451ea6c6013 100644 --- a/docs/core/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md @@ -52,7 +52,7 @@ typedef enum CorErrorIfEmitOutOfOrder { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/coreventattr-enumeration.md b/docs/core/unmanaged-api/metadata/coreventattr-enumeration.md index 47a376b7a7f75..0df491778d0ee 100644 --- a/docs/core/unmanaged-api/metadata/coreventattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/coreventattr-enumeration.md @@ -43,7 +43,7 @@ typedef enum CorEventAttr { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corfieldattr-enumeration.md b/docs/core/unmanaged-api/metadata/corfieldattr-enumeration.md index 939287a27cb7d..981ddd7e24b81 100644 --- a/docs/core/unmanaged-api/metadata/corfieldattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corfieldattr-enumeration.md @@ -78,7 +78,7 @@ typedef enum CorFieldAttr { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corfileflags-enumeration.md b/docs/core/unmanaged-api/metadata/corfileflags-enumeration.md index 7baceea8f7196..40a7fe6f8ef67 100644 --- a/docs/core/unmanaged-api/metadata/corfileflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corfileflags-enumeration.md @@ -40,7 +40,7 @@ typedef enum CorFileFlags { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corfilemapping-enumeration.md b/docs/core/unmanaged-api/metadata/corfilemapping-enumeration.md index 47341d04daa28..d4880780f88bd 100644 --- a/docs/core/unmanaged-api/metadata/corfilemapping-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corfilemapping-enumeration.md @@ -40,7 +40,7 @@ typedef enum CorFileMapping { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corgenericparamattr-enumeration.md b/docs/core/unmanaged-api/metadata/corgenericparamattr-enumeration.md index e88198c05e03a..d731b2e4a8728 100644 --- a/docs/core/unmanaged-api/metadata/corgenericparamattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corgenericparamattr-enumeration.md @@ -55,7 +55,7 @@ typedef enum CorGenericParamAttr { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corimportoptions-enumeration.md b/docs/core/unmanaged-api/metadata/corimportoptions-enumeration.md index e8a8cde5bca3f..149599545d939 100644 --- a/docs/core/unmanaged-api/metadata/corimportoptions-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corimportoptions-enumeration.md @@ -54,7 +54,7 @@ typedef enum CorImportOptions { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corlinkeroptions-enumeration.md b/docs/core/unmanaged-api/metadata/corlinkeroptions-enumeration.md index 626fec50fb23c..c361b85e7a7a5 100644 --- a/docs/core/unmanaged-api/metadata/corlinkeroptions-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corlinkeroptions-enumeration.md @@ -38,7 +38,7 @@ typedef enum CorLinkerOptions { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md b/docs/core/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md index 8fecb92536494..aee6ffe13b9b0 100644 --- a/docs/core/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md @@ -41,7 +41,7 @@ typedef enum CorLocalRefPreservation ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md b/docs/core/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md index 4b426e6e66eb1..d937ef0c35e56 100644 --- a/docs/core/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md @@ -42,7 +42,7 @@ typedef enum CorManifestResourceFlags { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cormethodattr-enumeration.md b/docs/core/unmanaged-api/metadata/cormethodattr-enumeration.md index 618eb33366ddf..3d021472a9b15 100644 --- a/docs/core/unmanaged-api/metadata/cormethodattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cormethodattr-enumeration.md @@ -89,7 +89,7 @@ typedef enum CorMethodAttr { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cormethodimpl-enumeration.md b/docs/core/unmanaged-api/metadata/cormethodimpl-enumeration.md index 87a7d382357d0..e9c3145952678 100644 --- a/docs/core/unmanaged-api/metadata/cormethodimpl-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cormethodimpl-enumeration.md @@ -71,7 +71,7 @@ typedef enum CorMethodImpl { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md b/docs/core/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md index 36d1e64b2cf7d..5b486bc39e1df 100644 --- a/docs/core/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md @@ -48,7 +48,7 @@ typedef enum CorMethodSemanticsAttr { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cornativelinkflags-enumeration.md b/docs/core/unmanaged-api/metadata/cornativelinkflags-enumeration.md index b4cdc421f52de..06ec772538c37 100644 --- a/docs/core/unmanaged-api/metadata/cornativelinkflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cornativelinkflags-enumeration.md @@ -43,7 +43,7 @@ typedef enum ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/cornativelinktype-enumeration.md b/docs/core/unmanaged-api/metadata/cornativelinktype-enumeration.md index 960c2771b2861..f817fd6aab035 100644 --- a/docs/core/unmanaged-api/metadata/cornativelinktype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cornativelinktype-enumeration.md @@ -47,7 +47,7 @@ typedef enum ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/cornativetype-enumeration.md b/docs/core/unmanaged-api/metadata/cornativetype-enumeration.md index 003f9783a6f36..e3f5c970f9f11 100644 --- a/docs/core/unmanaged-api/metadata/cornativetype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cornativetype-enumeration.md @@ -135,7 +135,7 @@ typedef enum CorNativeType { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md b/docs/core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md index 6321e66b6dd15..f647ceb3f55ae 100644 --- a/docs/core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md @@ -89,7 +89,7 @@ typedef enum CorNotificationForTokenMovement { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/coropenflags-enumeration.md b/docs/core/unmanaged-api/metadata/coropenflags-enumeration.md index cedfaf4af6d0e..9bab4f7d4c1d2 100644 --- a/docs/core/unmanaged-api/metadata/coropenflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/coropenflags-enumeration.md @@ -62,7 +62,7 @@ typedef enum CorOpenFlags ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corparamattr-enumeration.md b/docs/core/unmanaged-api/metadata/corparamattr-enumeration.md index 223f4b6bf0aa8..46cbd666b1c8f 100644 --- a/docs/core/unmanaged-api/metadata/corparamattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corparamattr-enumeration.md @@ -52,7 +52,7 @@ typedef enum CorParamAttr { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corpekind-enumeration.md b/docs/core/unmanaged-api/metadata/corpekind-enumeration.md index c3dba705cce40..b77b74ab45ca6 100644 --- a/docs/core/unmanaged-api/metadata/corpekind-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corpekind-enumeration.md @@ -52,7 +52,7 @@ typedef enum CorPEKind { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corpinvokemap-enumeration.md b/docs/core/unmanaged-api/metadata/corpinvokemap-enumeration.md index 770cfc5508af1..606543ccb4e4b 100644 --- a/docs/core/unmanaged-api/metadata/corpinvokemap-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corpinvokemap-enumeration.md @@ -86,7 +86,7 @@ typedef enum CorPinvokeMap { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corpropertyattr-enumeration.md b/docs/core/unmanaged-api/metadata/corpropertyattr-enumeration.md index 8d1a9af7e3d0f..2963ed87fde98 100644 --- a/docs/core/unmanaged-api/metadata/corpropertyattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corpropertyattr-enumeration.md @@ -46,7 +46,7 @@ typedef enum CorPropertyAttr { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/correftodefcheck-enumeration.md b/docs/core/unmanaged-api/metadata/correftodefcheck-enumeration.md index 4d917d5121075..867e85335ec8a 100644 --- a/docs/core/unmanaged-api/metadata/correftodefcheck-enumeration.md +++ b/docs/core/unmanaged-api/metadata/correftodefcheck-enumeration.md @@ -44,7 +44,7 @@ typedef enum CorRefToDefCheck { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corregflags-enumeration.md b/docs/core/unmanaged-api/metadata/corregflags-enumeration.md index 44f97ad9099fe..1648f23b1e9c9 100644 --- a/docs/core/unmanaged-api/metadata/corregflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corregflags-enumeration.md @@ -41,7 +41,7 @@ typedef enum ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/corsavesize-enumeration.md b/docs/core/unmanaged-api/metadata/corsavesize-enumeration.md index 883d3889a5d24..9270dbdeadd88 100644 --- a/docs/core/unmanaged-api/metadata/corsavesize-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corsavesize-enumeration.md @@ -40,7 +40,7 @@ typedef enum CorSaveSize { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corserializationtype-enumeration.md b/docs/core/unmanaged-api/metadata/corserializationtype-enumeration.md index 2f493e910d7cd..208374dc59761 100644 --- a/docs/core/unmanaged-api/metadata/corserializationtype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corserializationtype-enumeration.md @@ -76,7 +76,7 @@ typedef enum CorSerializationType { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corsetenc-enumeration.md b/docs/core/unmanaged-api/metadata/corsetenc-enumeration.md index a2afbe57e0923..39e4c40c1a863 100644 --- a/docs/core/unmanaged-api/metadata/corsetenc-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corsetenc-enumeration.md @@ -53,7 +53,7 @@ typedef enum CorSetENC { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md b/docs/core/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md index 1292f566abe49..ff66a94517d38 100644 --- a/docs/core/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md @@ -41,7 +41,7 @@ typedef enum CorThreadSafetyOptions { ## Requirements -**Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cortokentype-enumeration.md b/docs/core/unmanaged-api/metadata/cortokentype-enumeration.md index b8f3fa1031933..20452fd89e32b 100644 --- a/docs/core/unmanaged-api/metadata/cortokentype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cortokentype-enumeration.md @@ -92,7 +92,7 @@ typedef enum CorTokenType { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/cortypeattr-enumeration.md b/docs/core/unmanaged-api/metadata/cortypeattr-enumeration.md index 00f82e9139a93..088551786904b 100644 --- a/docs/core/unmanaged-api/metadata/cortypeattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cortypeattr-enumeration.md @@ -109,7 +109,7 @@ typedef enum CorTypeAttr { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md b/docs/core/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md index e0a720721888e..479a285553eaf 100644 --- a/docs/core/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md @@ -57,7 +57,7 @@ typedef enum CorUnmanagedCallingConvention { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** CorHdr.h diff --git a/docs/core/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md b/docs/core/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md index 005f96fc42719..c083e5e85610d 100644 --- a/docs/core/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md @@ -49,7 +49,7 @@ typedef enum ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/couninitiee-enumeration.md b/docs/core/unmanaged-api/metadata/couninitiee-enumeration.md index 7ccab291e872f..bec1b070362f5 100644 --- a/docs/core/unmanaged-api/metadata/couninitiee-enumeration.md +++ b/docs/core/unmanaged-api/metadata/couninitiee-enumeration.md @@ -39,7 +39,7 @@ typedef enum tagCOUNINITEE ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/cvstruct-structure.md b/docs/core/unmanaged-api/metadata/cvstruct-structure.md index 9d14a1c03d9c4..be6640d56e228 100644 --- a/docs/core/unmanaged-api/metadata/cvstruct-structure.md +++ b/docs/core/unmanaged-api/metadata/cvstruct-structure.md @@ -42,7 +42,7 @@ typedef struct { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-addsectionreloc-method.md b/docs/core/unmanaged-api/metadata/iceegen-addsectionreloc-method.md index a244ac3db8813..e863ae36fcb7d 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-addsectionreloc-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-addsectionreloc-method.md @@ -50,7 +50,7 @@ HRESULT AddSectionReloc ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md b/docs/core/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md index 0e49f9eb9d205..2512931d4b4c1 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md @@ -46,7 +46,7 @@ HRESULT AllocateMethodBuffer ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-computepointer-method.md b/docs/core/unmanaged-api/metadata/iceegen-computepointer-method.md index 7b177247751a9..0dfaebbf6907b 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-computepointer-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-computepointer-method.md @@ -46,7 +46,7 @@ HRESULT ComputePointer ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-emitstring-method.md b/docs/core/unmanaged-api/metadata/iceegen-emitstring-method.md index f896f8412e41f..896fb50f96ff0 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-emitstring-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-emitstring-method.md @@ -42,7 +42,7 @@ HRESULT EmitString ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-generateceefile-method.md b/docs/core/unmanaged-api/metadata/iceegen-generateceefile-method.md index 5b596a7fbf737..e8759fa9daf49 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-generateceefile-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-generateceefile-method.md @@ -35,7 +35,7 @@ HRESULT GenerateCeeFile (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md b/docs/core/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md index 94e603474134d..5768d4e3dda9d 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md @@ -38,7 +38,7 @@ HRESULT GenerateCeeMemoryImage ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getilsection-method.md b/docs/core/unmanaged-api/metadata/iceegen-getilsection-method.md index 61e5efcae88ec..654acee9a616b 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getilsection-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getilsection-method.md @@ -38,7 +38,7 @@ HRESULT GetIlSection ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md b/docs/core/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md index 6afd8d4c57094..55b87b9d9dc33 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md @@ -38,7 +38,7 @@ HRESULT GetIMapTokenIface ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md b/docs/core/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md index b90f0c0eea498..332728bb2bbeb 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md @@ -42,7 +42,7 @@ HRESULT GetMethodBuffer ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getsectionblock-method.md b/docs/core/unmanaged-api/metadata/iceegen-getsectionblock-method.md index 8715b5e554c01..e2d7b163d33d3 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getsectionblock-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getsectionblock-method.md @@ -54,7 +54,7 @@ HRESULT GetSectionBlock ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getsectioncreate-method.md b/docs/core/unmanaged-api/metadata/iceegen-getsectioncreate-method.md index 7e8bcad190bfb..15b797f020af4 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getsectioncreate-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getsectioncreate-method.md @@ -50,7 +50,7 @@ HRESULT GetSectionCreate ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md b/docs/core/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md index 97f9799bcf4ab..aebdc46fcde21 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md @@ -46,7 +46,7 @@ HRESULT GetSectionDataLen ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getstring-method.md b/docs/core/unmanaged-api/metadata/iceegen-getstring-method.md index e8986bdbd8341..2ab4c8ea98141 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getstring-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getstring-method.md @@ -42,7 +42,7 @@ HRESULT GetString ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-getstringsection-method.md b/docs/core/unmanaged-api/metadata/iceegen-getstringsection-method.md index 02aad69fa2fa9..800aa0449551e 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getstringsection-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getstringsection-method.md @@ -38,7 +38,7 @@ HRESULT GetStringSection ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-interface.md b/docs/core/unmanaged-api/metadata/iceegen-interface.md index 3a8271c1d01cf..99a5181b6fb89 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-interface.md +++ b/docs/core/unmanaged-api/metadata/iceegen-interface.md @@ -44,7 +44,7 @@ Provides methods for dynamic code compilation. ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/iceegen-truncatesection-method.md b/docs/core/unmanaged-api/metadata/iceegen-truncatesection-method.md index c6c7fd84f5408..952a23d2c2ae9 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-truncatesection-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-truncatesection-method.md @@ -46,7 +46,7 @@ HRESULT TruncateSection ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/ihostfilter-interface.md b/docs/core/unmanaged-api/metadata/ihostfilter-interface.md index 1aee48f23d5d6..ad0ae8cc72372 100644 --- a/docs/core/unmanaged-api/metadata/ihostfilter-interface.md +++ b/docs/core/unmanaged-api/metadata/ihostfilter-interface.md @@ -31,7 +31,7 @@ Provides a method to indicate that a specified token will be processed. ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/ihostfilter-marktoken-method.md b/docs/core/unmanaged-api/metadata/ihostfilter-marktoken-method.md index 6b4b18b89fbc3..7efe010288417 100644 --- a/docs/core/unmanaged-api/metadata/ihostfilter-marktoken-method.md +++ b/docs/core/unmanaged-api/metadata/ihostfilter-marktoken-method.md @@ -40,7 +40,7 @@ HRESULT MarkToken ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imaptoken-interface.md b/docs/core/unmanaged-api/metadata/imaptoken-interface.md index 18fff8d60e12d..bb3530e9ed719 100644 --- a/docs/core/unmanaged-api/metadata/imaptoken-interface.md +++ b/docs/core/unmanaged-api/metadata/imaptoken-interface.md @@ -31,7 +31,7 @@ Provides mapping capabilities between assemblies. ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imaptoken-map-method.md b/docs/core/unmanaged-api/metadata/imaptoken-map-method.md index 07869ba329220..d15dcb574795d 100644 --- a/docs/core/unmanaged-api/metadata/imaptoken-map-method.md +++ b/docs/core/unmanaged-api/metadata/imaptoken-map-method.md @@ -44,7 +44,7 @@ HRESULT Map ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md index 35951158ac734..3be8042415cca 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md @@ -64,7 +64,7 @@ HRESULT DefineAssembly ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md index 8ba18fa2bda61..39aa20a8c58fc 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md @@ -70,7 +70,7 @@ HRESULT DefineAssemblyRef ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md index 1a212cabd14b6..97ea5f0ac692f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md @@ -64,7 +64,7 @@ HRESULT DefineExportedType ( ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md index 6a328f00e2643..faa77906e6b14 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md @@ -56,7 +56,7 @@ HRESULT DefineFile ( ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md index 3a160b0019323..edc3c3f7d3920 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md @@ -56,7 +56,7 @@ HRESULT DefineManifestResource ( ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-interface.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-interface.md index 0ff08506124ec..07f0c06448022 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-interface.md @@ -39,7 +39,7 @@ Provides methods that support the self-description model used by the common lang ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md index 4a82e2622d50f..3e596075d324c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md @@ -64,7 +64,7 @@ HRESULT SetAssemblyProps ( ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md index 2d1228482420c..fa4fed4b2b6de 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md @@ -68,7 +68,7 @@ HRESULT SetAssemblyRefProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md index 6abaf75bda7fc..fe3855a240c73 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md @@ -52,7 +52,7 @@ HRESULT SetExportedTypeProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md index d369f4b185075..ccbf786f88848 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md @@ -52,7 +52,7 @@ HRESULT SetFileProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md index ab07780c26014..cac93a67abe4b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md @@ -52,7 +52,7 @@ HRESULT SetManifestResourceProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md index 8c62a5823c6f8..fbc4ca7a83691 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md @@ -36,7 +36,7 @@ void CloseEnum ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md index efaec4b9f3548..d2a7b4413e8d2 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md @@ -55,7 +55,7 @@ HRESULT EnumAssemblyRefs ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md index ea0578beb314a..1c7ff80140be1 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md @@ -55,7 +55,7 @@ HRESULT EnumExportedTypes ( ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md index 55dc9da35dcbb..0954d8a946c2c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md @@ -55,7 +55,7 @@ HRESULT EnumFiles ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md index c99ff4fa0193b..73109b651b005 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md @@ -55,7 +55,7 @@ HRESULT EnumManifestResources ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md index 8442a474750c9..548f120048943 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md @@ -73,7 +73,7 @@ HRESULT FindAssembliesByName ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md index 5309d9c5ab739..277b76cfd6580 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md @@ -48,7 +48,7 @@ HRESULT FindExportedTypeByName ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md index 4dab405739ae5..c7c67144ec387 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md @@ -44,7 +44,7 @@ HRESULT FindManifestResourceByName ( ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md index bdffd13dbebea..e82159b1a74f4 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md @@ -36,7 +36,7 @@ HRESULT GetAssemblyFromScope ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md index 72cec65737930..df331ffa41519 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md @@ -68,7 +68,7 @@ HRESULT GetAssemblyProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md index 361220ffef766..4d7a0cb291bb7 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md @@ -76,7 +76,7 @@ HRESULT GetAssemblyRefProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md index 61c0dc7586606..9aab811958c47 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md @@ -60,7 +60,7 @@ HRESULT GetExportedTypeProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md index ea5dde041693d..704f473744aba 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md @@ -60,7 +60,7 @@ HRESULT GetFileProps ( ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md index 2d4f0bdb8a4a8..671c412d6e382 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md @@ -60,7 +60,7 @@ HRESULT GetManifestResourceProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-interface.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-interface.md index e5c7bd2fd8897..9cf4d6faaf74e 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-interface.md @@ -41,7 +41,7 @@ Provides methods to access and examine the contents of an assembly manifest. ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md b/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md index 22e37e27468fa..140d52f89e675 100644 --- a/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md @@ -40,7 +40,7 @@ HRESULT GetMetaDataFromTypeInfo ( ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md b/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md index 20d6e05b5e842..bdd4128bf9b20 100644 --- a/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md @@ -40,7 +40,7 @@ HRESULT GetMetaDataFromTypeLib ( ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md b/docs/core/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md index 6ac93524811c9..71222108f377c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md @@ -44,7 +44,7 @@ HRESULT GetTypeLibFromMetaData ( ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataconverter-interface.md b/docs/core/unmanaged-api/metadata/imetadataconverter-interface.md index 1ebf34f16a06e..045b7214de1d6 100644 --- a/docs/core/unmanaged-api/metadata/imetadataconverter-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataconverter-interface.md @@ -30,7 +30,7 @@ Provides methods to map type libraries to their metadata signatures, and to conv ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenser-definescope-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenser-definescope-method.md index cb38714eba4c8..a68994637274c 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenser-definescope-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenser-definescope-method.md @@ -56,7 +56,7 @@ HRESULT DefineScope ( ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenser-interface.md b/docs/core/unmanaged-api/metadata/imetadatadispenser-interface.md index 0d349d85f60c8..b9439155cf0d6 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenser-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenser-interface.md @@ -30,7 +30,7 @@ Provides methods to create a new metadata scope, or open an existing one. ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenser-openscope-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenser-openscope-method.md index 0a73f9441b2de..1d646c19dcaf6 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenser-openscope-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenser-openscope-method.md @@ -60,7 +60,7 @@ HRESULT OpenScope ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md index b31c785a4f05e..9f3a999425de7 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md @@ -62,7 +62,7 @@ HRESULT OpenScopeOnMemory ( ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md index d5669f665659d..1f28d011b5b94 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md @@ -60,7 +60,7 @@ HRESULT FindAssembly( ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md index f929392238ada..c6aededd82ad6 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md @@ -64,7 +64,7 @@ HRESULT FindAssemblyModule( ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md index 69d2722e5dc9c..837a545ebcf94 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md @@ -44,7 +44,7 @@ HRESULT GetCORSystemDirectory ( ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md index 789ee09e746c3..ed312439dd7bb 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md @@ -58,7 +58,7 @@ HRESULT GetOption ( ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-interface.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-interface.md index 9d42053cce96c..30848a997cd67 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-interface.md @@ -33,7 +33,7 @@ Extends the [IMetaDataDispenser Interface](imetadatadispenser-interface.md) inte ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md index 0127fd855d0ae..1919a9de29cc6 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md @@ -48,7 +48,7 @@ HRESULT OpenScopeOnITypeInfo ( ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md index 19dc8cbf11b32..7f26a6778128a 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md @@ -60,7 +60,7 @@ HRESULT SetOption ( ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md index 4e4b19472da3f..6dcad6f118449 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md @@ -38,7 +38,7 @@ HRESULT ApplyEditAndContinue ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md index cc52e78472a7d..471cc35e1edd7 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md @@ -52,7 +52,7 @@ HRESULT DefineCustomAttribute ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-defineevent-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineevent-method.md index 4fffebb9ef1b6..7114304c9f72e 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-defineevent-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineevent-method.md @@ -68,7 +68,7 @@ HRESULT DefineEvent ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definefield-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definefield-method.md index 9ed8855c06c60..a681468bba886 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definefield-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definefield-method.md @@ -68,7 +68,7 @@ HRESULT DefineField ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md index 9478d42bf166d..40262c31712f1 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md @@ -76,7 +76,7 @@ HRESULT DefineImportMember ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md index 61b8fcbfb1e31..e80f02a100793 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md @@ -64,7 +64,7 @@ HRESULT DefineImportType ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definememberref-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definememberref-method.md index 1ca79b9837261..f9e9dd54b867a 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definememberref-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definememberref-method.md @@ -52,7 +52,7 @@ HRESULT DefineMemberRef ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definemethod-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definemethod-method.md index d0b8052b4a5c3..3d6cf476365ad 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definemethod-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definemethod-method.md @@ -105,7 +105,7 @@ HRESULT DefineMethod ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md index 240ac78d52aff..c73cc7290fa7b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md @@ -44,7 +44,7 @@ HRESULT DefineMethodImpl ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md index 67ccfdeaca463..43bd80893b414 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md @@ -40,7 +40,7 @@ HRESULT DefineModuleRef ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md index 3d6d4d66fbd46..2b883dcc6409f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md @@ -56,7 +56,7 @@ HRESULT DefineNestedType ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-defineparam-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineparam-method.md index d17b6cae409a2..9a9c7492c7d5e 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-defineparam-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineparam-method.md @@ -68,7 +68,7 @@ HRESULT DefineParam ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md index f4aeb44dfe67a..44b4a4c7733d2 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md @@ -52,7 +52,7 @@ HRESULT DefinePermissionSet ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md index 64c77623e92bd..f43e205eb4c05 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md @@ -48,7 +48,7 @@ HRESULT DefinePinvokeMap ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-defineproperty-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineproperty-method.md index 25e6c2557263b..207027bc4a275 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-defineproperty-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineproperty-method.md @@ -80,7 +80,7 @@ HRESULT DefineProperty ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md index 804107ee49b37..d5cc8759ff6c6 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md @@ -48,7 +48,7 @@ HRESULT DefineSecurityAttributeSet ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definetypedef-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definetypedef-method.md index ddb1998f1f7d7..99f2af435b520 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definetypedef-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definetypedef-method.md @@ -60,7 +60,7 @@ HRESULT DefineTypeDef ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md index 14c948aea5bac..db27db9b45988 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md @@ -54,7 +54,7 @@ HRESULT DefineTypeRefByName ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md index 8fe0aac27a7b2..a73dfd39c78fa 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md @@ -44,7 +44,7 @@ HRESULT DefineUserString ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md index 2dd083c93d7e5..7d034888a2e09 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md @@ -36,7 +36,7 @@ HRESULT DeleteClassLayout ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md index a63eb4bbb6166..8b87f180a53b6 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md @@ -36,7 +36,7 @@ HRESULT DeleteFieldMarshal ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md index f29b20739dbfd..6dcce1ac1a7d2 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md @@ -36,7 +36,7 @@ HRESULT DeletePinvokeMap ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-deletetoken-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-deletetoken-method.md index 0b0e7fd720f8d..385c992a9ca2b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-deletetoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-deletetoken-method.md @@ -36,7 +36,7 @@ HRESULT DeleteToken ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-getsavesize-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-getsavesize-method.md index 52eb409c83a48..2fa3c8f111df2 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-getsavesize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-getsavesize-method.md @@ -54,7 +54,7 @@ HRESULT GetSaveSize ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md index 8ebaacebe07d4..d1a539d5c21a0 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md @@ -44,7 +44,7 @@ HRESULT GetTokenFromSig ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md index 28e6b1b0ac060..8774806e21621 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md @@ -44,7 +44,7 @@ HRESULT GetTokenFromTypeSpec ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-interface.md b/docs/core/unmanaged-api/metadata/imetadataemit-interface.md index 055a243492b24..bf88000dabf1d 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-interface.md @@ -76,7 +76,7 @@ Provides methods to create, modify, and save metadata about the assembly in the ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-merge-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-merge-method.md index fbd40e592e1ca..d11b8b13178e6 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-merge-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-merge-method.md @@ -48,7 +48,7 @@ HRESULT Merge ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-mergeend-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-mergeend-method.md index 3551d1e5973f7..0001ccf11ea4b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-mergeend-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-mergeend-method.md @@ -59,7 +59,7 @@ The following special conditions apply to the merge: ## Requirements -**Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-save-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-save-method.md index 022e4a7880d7e..68dc7be102c77 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-save-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-save-method.md @@ -40,7 +40,7 @@ HRESULT Save ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-savetomemory-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-savetomemory-method.md index 237cdd9ee495d..dbf6c4a788324 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-savetomemory-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-savetomemory-method.md @@ -40,7 +40,7 @@ HRESULT SaveToMemory ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-savetostream-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-savetostream-method.md index a79dac5f3a93c..534777ecc6e8b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-savetostream-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-savetostream-method.md @@ -40,7 +40,7 @@ HRESULT SaveToStream ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md index 6d14a36d9ec95..5f3e9e2b0470a 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md @@ -58,7 +58,7 @@ HRESULT SetClassLayout ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md index 700b4d1bad725..3aba824f50849 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md @@ -44,7 +44,7 @@ HRESULT SetCustomAttributeValue ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-seteventprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-seteventprops-method.md index 5b722d3de8ae1..9c4e80470a7e3 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-seteventprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-seteventprops-method.md @@ -60,7 +60,7 @@ HRESULT SetEventProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md index a00b3a9ef7bf6..008a76f20ccee 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md @@ -44,7 +44,7 @@ HRESULT SetFieldMarshal ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md index eb5c30e25bbbb..9209cf7204107 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md @@ -52,7 +52,7 @@ HRESULT SetFieldProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md index 5586c4be8e6fe..37c89a476b041 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md @@ -40,7 +40,7 @@ HRESULT SetFieldRVA ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-sethandler-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-sethandler-method.md index 22ce212c7eb24..02431d893d8a7 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-sethandler-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-sethandler-method.md @@ -42,7 +42,7 @@ HRESULT SetHandler ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md index f322584f4d214..191721e39564c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md @@ -40,7 +40,7 @@ HRESULT SetMethodImplFlags ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md index 44176f85a83bb..11b3e4a753bf8 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md @@ -48,7 +48,7 @@ HRESULT SetMethodProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md index 7a0e79d4bdbce..a1ffdb94f8912 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md @@ -36,7 +36,7 @@ HRESULT SetModuleProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setparamprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setparamprops-method.md index 1c6880c9b065c..c3e95e1dae0e2 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setparamprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setparamprops-method.md @@ -56,7 +56,7 @@ HRESULT SetParamProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setparent-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setparent-method.md index c74775e9ee04f..40803fcdcd311 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setparent-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setparent-method.md @@ -40,7 +40,7 @@ HRESULT SetParent ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md index ba99cd624e86e..d09ee5f4cf4bc 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md @@ -52,7 +52,7 @@ HRESULT SetPermissionSetProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md index 917cef2975738..6ac9c33ba0123 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md @@ -48,7 +48,7 @@ HRESULT SetPinvokeMap ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md index 5668706a0bd4c..3102d9e291a20 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md @@ -64,7 +64,7 @@ HRESULT SetPropertyProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setrva-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setrva-method.md index 68a86e3cd24b7..5333c35bbda6b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setrva-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setrva-method.md @@ -40,7 +40,7 @@ HRESULT SetRVA ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md index e28c859c00e68..67256db45ee20 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md @@ -48,7 +48,7 @@ HRESULT SetTypeDefProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md index 2f73ce09ba887..8eedf1ef092dc 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md @@ -76,7 +76,7 @@ HRESULT TranslateSigWithScope ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md index dca1b61619718..7240b4ae3d63f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md @@ -60,7 +60,7 @@ HRESULT DefineGenericParam ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md index b2629627b9b39..95138e12c69af 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md @@ -48,7 +48,7 @@ HRESULT DefineMethodSpec ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md index cde7794cc307d..e9aa65c773baf 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md @@ -40,7 +40,7 @@ HRESULT GetDeltaSaveSize ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-interface.md b/docs/core/unmanaged-api/metadata/imetadataemit2-interface.md index b3cf368473c4a..c791c2b20a0aa 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-interface.md @@ -35,7 +35,7 @@ Extends the [IMetaDataEmit](imetadataemit-interface.md) interface primarily to p ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md index 1e0e448fa09ad..68672882910f6 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md @@ -33,7 +33,7 @@ HRESULT ResetENCLog (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-savedelta-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-savedelta-method.md index fef40e57ca9a7..925b9452f9596 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-savedelta-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-savedelta-method.md @@ -40,7 +40,7 @@ HRESULT SaveDelta ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md index a4769debbf291..8265de019bf07 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md @@ -40,7 +40,7 @@ HRESULT SaveDeltaToMemory ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md index 8d973d17e6e6f..ccbf8cf797376 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md @@ -40,7 +40,7 @@ HRESULT SaveDeltaToStream ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md index 1c8da51866b5f..a3d29bad6a4a1 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md @@ -52,7 +52,7 @@ HRESULT SetGenericParamProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataerror-interface.md b/docs/core/unmanaged-api/metadata/imetadataerror-interface.md index f8fe327eeb13c..e1dd0c9b15d1c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataerror-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataerror-interface.md @@ -31,7 +31,7 @@ Provides a callback mechanism for reporting errors during the metadata merge. ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataerror-onerror-method.md b/docs/core/unmanaged-api/metadata/imetadataerror-onerror-method.md index ded303c77da31..ed0f20ae26d0e 100644 --- a/docs/core/unmanaged-api/metadata/imetadataerror-onerror-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataerror-onerror-method.md @@ -40,7 +40,7 @@ HRESULT OnError ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatafilter-interface.md b/docs/core/unmanaged-api/metadata/imetadatafilter-interface.md index 011468a31cb6d..1140d3c51c26a 100644 --- a/docs/core/unmanaged-api/metadata/imetadatafilter-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatafilter-interface.md @@ -30,7 +30,7 @@ Provides methods for marking and filtering metadata tokens to avoid repeating ac ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md b/docs/core/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md index 36309286c8cbf..82baa90640551 100644 --- a/docs/core/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md @@ -40,7 +40,7 @@ HRESULT IsTokenMarked ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatafilter-marktoken-method.md b/docs/core/unmanaged-api/metadata/imetadatafilter-marktoken-method.md index 7dcea87eba3aa..50b9172e9883e 100644 --- a/docs/core/unmanaged-api/metadata/imetadatafilter-marktoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatafilter-marktoken-method.md @@ -36,7 +36,7 @@ HRESULT MarkToken ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md b/docs/core/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md index 6410c5bdd62d0..fc64f947e8a2a 100644 --- a/docs/core/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md @@ -33,7 +33,7 @@ HRESULT UnmarkAll (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-closeenum-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-closeenum-method.md index 9b9c5ecf0114f..7a96d30313d0a 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-closeenum-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-closeenum-method.md @@ -40,7 +40,7 @@ void CloseEnum ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-countenum-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-countenum-method.md index 01cc4d3280cb4..bfbf2f01029bf 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-countenum-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-countenum-method.md @@ -44,7 +44,7 @@ HRESULT CountEnum ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md index 16af6384f5007..0c708d122f449 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md @@ -63,7 +63,7 @@ HRESULT EnumCustomAttributes ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumevents-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumevents-method.md index f573a264f706d..48da8dd284dd1 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumevents-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumevents-method.md @@ -59,7 +59,7 @@ HRESULT EnumEvents ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumfields-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumfields-method.md index e8c7f9e47e776..6caf1dbc85416 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumfields-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumfields-method.md @@ -59,7 +59,7 @@ HRESULT EnumFields ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md index ec95fc0ff6522..d62635b8c6723 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md @@ -67,7 +67,7 @@ HRESULT EnumFieldsWithName ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md index 301b2c9c98470..39abd97be698e 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md @@ -63,7 +63,7 @@ The enumeration returns a collection of `mdInterfaceImpl` tokens for each interf ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md index 3cb7060abb858..fa50607bd6219 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md @@ -59,7 +59,7 @@ HRESULT EnumMemberRefs ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummembers-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummembers-method.md index 6452d9994ba42..94383bbbab42a 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummembers-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummembers-method.md @@ -65,7 +65,7 @@ HRESULT EnumMembers ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md index a56bc03681874..ff7f34416ed26 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md @@ -67,7 +67,7 @@ HRESULT EnumMembersWithName ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md index a69175b616ff6..132960b9f04f0 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md @@ -63,7 +63,7 @@ HRESULT EnumMethodImpls ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummethods-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummethods-method.md index a6670a31b9a17..4f669ca2cf1c1 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummethods-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummethods-method.md @@ -59,7 +59,7 @@ HRESULT EnumMethods ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md index feec10e06db60..eb129454fef80 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md @@ -63,7 +63,7 @@ HRESULT EnumMethodSemantics ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md index b7c3bcfd83638..15173b826b4a1 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md @@ -67,7 +67,7 @@ HRESULT EnumMethodsWithName ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md index 03c1abc044ce7..ac910b4503cff 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md @@ -55,7 +55,7 @@ HRESULT EnumModuleRefs ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumparams-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumparams-method.md index f529a38e93feb..0415403b0b319 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumparams-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumparams-method.md @@ -59,7 +59,7 @@ HRESULT EnumParams ( ## Requirements - **Platform:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platform:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md index 88d32ee7224eb..bacf455a50bb5 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md @@ -63,7 +63,7 @@ HRESULT EnumPermissionSets ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumproperties-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumproperties-method.md index 9385b689e6e16..94d84df26898a 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumproperties-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumproperties-method.md @@ -59,7 +59,7 @@ HRESULT EnumProperties ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md index 34eac1280e070..2be348bd36260 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md @@ -59,7 +59,7 @@ HRESULT EnumSignatures ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md index 38639f854384f..14e479016eb48 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md @@ -59,7 +59,7 @@ HRESULT EnumTypeDefs ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md index 2b18b35d44180..24c26f3d6cbb4 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md @@ -59,7 +59,7 @@ HRESULT EnumTypeRefs ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md index 0557c52f787b9..9dda93b75ec31 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md @@ -59,7 +59,7 @@ HRESULT EnumTypeSpecs ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md index a2e69cb013427..40d4142570ad4 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md @@ -61,7 +61,7 @@ HRESULT EnumUnresolvedMethods ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md index cc90143b3083b..a9a134a0a1b0b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md @@ -59,7 +59,7 @@ HRESULT EnumUserStrings ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-findfield-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findfield-method.md index d96c36ac7dcf8..f10c375070972 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-findfield-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findfield-method.md @@ -60,7 +60,7 @@ HRESULT FindField ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-findmember-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findmember-method.md index bb930bc1d916d..834c7cb1a6c8e 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-findmember-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findmember-method.md @@ -63,7 +63,7 @@ HRESULT FindMember ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-findmemberref-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findmemberref-method.md index 938b4235011fe..3b7e723563cd7 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-findmemberref-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findmemberref-method.md @@ -60,7 +60,7 @@ HRESULT FindMemberRef ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-findmethod-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findmethod-method.md index 6210d6192db85..ac3703bdabcfc 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-findmethod-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findmethod-method.md @@ -60,7 +60,7 @@ HRESULT FindMethod ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md index b47ffd196dfd5..3067394f73551 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md @@ -44,7 +44,7 @@ HRESULT FindTypeDefByName ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-findtyperef-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findtyperef-method.md index b3dfd110772e6..5b18e1bba035c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-findtyperef-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findtyperef-method.md @@ -44,7 +44,7 @@ HRESULT FindTypeRef ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md index dff06e734e45f..0a1bd9fa87261 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md @@ -56,7 +56,7 @@ HRESULT GetClassLayout ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md index afa7ea28b6d1b..acdcba2c7b430 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md @@ -52,7 +52,7 @@ HRESULT GetCustomAttributeByName ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md index e92e6492e5fdd..555f907be2441 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md @@ -56,7 +56,7 @@ HRESULT GetCustomAttributeProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-geteventprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-geteventprops-method.md index 277138f1991de..5ec12493b8e9f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-geteventprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-geteventprops-method.md @@ -81,7 +81,7 @@ HRESULT GetEventProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md index 3f107b72932e9..4eb7118f436ff 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md @@ -44,7 +44,7 @@ HRESULT GetFieldMarshal ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md index 056bc023a5cb4..cd4937e429321 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md @@ -76,7 +76,7 @@ HRESULT GetFieldProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md index 1c68744355264..40f66b56bcf27 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md @@ -72,7 +72,7 @@ Recall, the token is a 4-byte value: ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md index 7310ed83bed6f..869567c50b50b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md @@ -84,7 +84,7 @@ HRESULT GetMemberProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md index e1987eef4c32d..be9297b882737 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md @@ -60,7 +60,7 @@ HRESULT GetMemberRefProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md index 00bc7bf655e0d..b669bfd8e808e 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md @@ -72,7 +72,7 @@ HRESULT GetMethodProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md index bbaf1fc1a8699..5ce36343a7796 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md @@ -48,7 +48,7 @@ HRESULT GetMethodSemantics ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md index c225311635397..2421c14343a9d 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md @@ -36,7 +36,7 @@ HRESULT GetModuleFromScope ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md index c7ec8f66ae53c..845702597f5ba 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md @@ -48,7 +48,7 @@ HRESULT GetModuleRefProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md index e1e98d8e72c8d..88766b1a36af3 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md @@ -44,7 +44,7 @@ HRESULT GetNameFromToken ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md index 5193561f6b49a..e9676c7c8244f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md @@ -44,7 +44,7 @@ HRESULT GetNativeCallConvFromSig ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md index bcee2a120ce62..77b3fe0f7b689 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md @@ -40,7 +40,7 @@ HRESULT GetNestedClassProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md index 173788e8f7117..661e432f52a78 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md @@ -44,7 +44,7 @@ HRESULT GetParamForMethodIndex ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getparamprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getparamprops-method.md index ad5554e9c8ffb..3fbef4898df9c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getparamprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getparamprops-method.md @@ -76,7 +76,7 @@ The sequence values in `pulSequence` begin with 1 for parameters. A return value ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md index f934d0f20ec34..b1f2bd6eae208 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md @@ -48,7 +48,7 @@ HRESULT GetPermissionSetProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md index d7f143f925c1b..48b8708da920b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md @@ -56,7 +56,7 @@ HRESULT GetPinvokeMap ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md index 7434f1126214f..c8d172e32f17b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md @@ -96,7 +96,7 @@ HRESULT GetPropertyProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getrva-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getrva-method.md index 5c5d5a5aa5295..d8092954eed92 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getrva-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getrva-method.md @@ -44,7 +44,7 @@ HRESULT GetRVA ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md index 128acce579f32..265868650a35a 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md @@ -52,7 +52,7 @@ HRESULT GetScopeProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md index 0f0f32ad122fa..2ce9ca1c4a875 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md @@ -44,7 +44,7 @@ HRESULT GetSigFromToken ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md index 6d6dcd815d7fc..d638a6c928668 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md @@ -56,7 +56,7 @@ HRESULT GetTypeDefProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md index 74be94d58e583..7cfd1b7a4e3fa 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md @@ -52,7 +52,7 @@ HRESULT GetTypeRefProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md index 57fe7ef411654..98b179f31e82f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md @@ -48,7 +48,7 @@ HRESULT GetTypeSpecFromToken ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getuserstring-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getuserstring-method.md index bd210776ec6e9..b5fe0eec88be6 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getuserstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getuserstring-method.md @@ -48,7 +48,7 @@ HRESULT GetUserString ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-interface.md b/docs/core/unmanaged-api/metadata/imetadataimport-interface.md index 26a0cdae15fc5..7e24a139a106e 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-interface.md @@ -101,7 +101,7 @@ Provides methods for importing and manipulating existing metadata from a portabl ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-isglobal-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-isglobal-method.md index f4e6ba9f2d57b..1af50c8589fd6 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-isglobal-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-isglobal-method.md @@ -40,7 +40,7 @@ HRESULT IsGlobal ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md index 3068972c9ea5b..3d061824dda1a 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md @@ -40,7 +40,7 @@ BOOL IsValidToken ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-resetenum-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-resetenum-method.md index 8f086ab2e8162..ee089fdb618e9 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-resetenum-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-resetenum-method.md @@ -40,7 +40,7 @@ HRESULT ResetEnum ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md index b7836b366ea93..9a5471f3afcbc 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md @@ -57,7 +57,7 @@ HRESULT ResolveTypeRef ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md index 22b89d73f4e55..d768d63bb8813 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md @@ -59,7 +59,7 @@ HRESULT EnumGenericParamConstraints ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md index 40d7ea43d0166..837a8d660b4f2 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md @@ -59,7 +59,7 @@ HRESULT EnumGenericParams ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md index 2ecdc9261a5ae..5dfd47e307767 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md @@ -59,7 +59,7 @@ HRESULT EnumMethodSpecs ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md index 7eae20dc033ab..c152f7171c6bd 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md @@ -44,7 +44,7 @@ HRESULT GetGenericParamConstraintProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md index b6015d1be5312..a41d207a8aebe 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md @@ -64,7 +64,7 @@ HRESULT GetGenericParamProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md index bdeb618b99434..417628b02d084 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md @@ -48,7 +48,7 @@ HRESULT GetMethodSpecProps ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-getpekind-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getpekind-method.md index 4ead32e0fe199..1fc494903a433 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-getpekind-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-getpekind-method.md @@ -50,7 +50,7 @@ HRESULT GetPEKind ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md index 1ca8969884dfb..b6a49db8d97b7 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md @@ -48,7 +48,7 @@ HRESULT GetVersionString ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-interface.md b/docs/core/unmanaged-api/metadata/imetadataimport2-interface.md index af909f2b5323d..cf8ef6b96a03c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-interface.md @@ -35,7 +35,7 @@ Extends the [IMetaDataImport](imetadataimport-interface.md) interface to provide ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md b/docs/core/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md index 656d49cc14369..49eae99531d45 100644 --- a/docs/core/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md @@ -62,7 +62,7 @@ HRESULT GetFileMapping ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatainfo-interface.md b/docs/core/unmanaged-api/metadata/imetadatainfo-interface.md index 812fd652e8706..b5cf3a873e2cd 100644 --- a/docs/core/unmanaged-api/metadata/imetadatainfo-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatainfo-interface.md @@ -28,7 +28,7 @@ Provides a method that gets information about the mapping of metadata from an on ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getblob-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getblob-method.md index 57be861b6e2f9..49a1bc1e14276 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getblob-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getblob-method.md @@ -44,7 +44,7 @@ HRESULT GetBlob ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md index 9f9739d03c44b..aa387827afa3b 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md @@ -36,7 +36,7 @@ HRESULT GetBlobHeapSize ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md index 208c635285a09..e287250832104 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md @@ -48,7 +48,7 @@ HRESULT GetCodedTokenInfo ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getcolumn-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getcolumn-method.md index 54885d4ad5f63..3085acef2e336 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getcolumn-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getcolumn-method.md @@ -69,7 +69,7 @@ The interpretation of the value returned through `pVal` depends on the column's ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md index 4e1b4797a2774..1d63282d513eb 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md @@ -84,7 +84,7 @@ Values that are stored in the *heap* (that is, `IsHeapType == true`) can be read ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getguid-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getguid-method.md index 5ea1280130d99..f54e3c5e46969 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getguid-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getguid-method.md @@ -44,7 +44,7 @@ HRESULT GetGuid ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md index 48786aef47602..09ce5de51d6c7 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md @@ -36,7 +36,7 @@ HRESULT GetGuidHeapSize ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getnextblob-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnextblob-method.md index cf1def78a58a1..5916660a904a4 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getnextblob-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getnextblob-method.md @@ -40,7 +40,7 @@ HRESULT GetNextBlob ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getnextguid-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnextguid-method.md index 7c85546295611..cb8693888066d 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getnextguid-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getnextguid-method.md @@ -44,7 +44,7 @@ HRESULT GetNextGuid ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getnextstring-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnextstring-method.md index cd387ee3a90ef..7a0cf75eb3b00 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getnextstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getnextstring-method.md @@ -40,7 +40,7 @@ HRESULT GetNextString ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md index 3a9d54965d6b9..eadf88c2f7ccc 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md @@ -44,7 +44,7 @@ HRESULT GetNextUserString ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getnumtables-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnumtables-method.md index 5a7ae2716c8f5..442120bc2130f 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getnumtables-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getnumtables-method.md @@ -36,7 +36,7 @@ HRESULT GetNumTables ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getrow-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getrow-method.md index cddab6b2870e1..5efee3c92d26b 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getrow-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getrow-method.md @@ -48,7 +48,7 @@ HRESULT GetRow ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getstring-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getstring-method.md index 3fe30697d509c..f08f6ee90ac01 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getstring-method.md @@ -40,7 +40,7 @@ HRESULT GetString ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md index 7ed3447712683..ce6a28e6b19eb 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md @@ -36,7 +36,7 @@ HRESULT GetStringHeapSize ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-gettableindex-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-gettableindex-method.md index 79e4cd351a361..f53d202f94c1b 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-gettableindex-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-gettableindex-method.md @@ -44,7 +44,7 @@ HRESULT GetTableIndex ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md index 079eed3f6c723..4f4a27963fd96 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md @@ -56,7 +56,7 @@ HRESULT GetTableInfo ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getuserstring-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getuserstring-method.md index e9698f4baa5d7..5980fec7aee68 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getuserstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getuserstring-method.md @@ -45,7 +45,7 @@ HRESULT GetUserString ( ## Requirements -**Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md index 8d21fa01843b8..92db01cd44741 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md @@ -36,7 +36,7 @@ HRESULT GetUserStringHeapSize ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-interface.md b/docs/core/unmanaged-api/metadata/imetadatatables-interface.md index f545bc2a89c0f..63464acf6e45e 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-interface.md @@ -46,7 +46,7 @@ Provides methods for the storage and retrieval of metadata information in tables ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md b/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md index 82fed639d7334..6c543c98bd181 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md @@ -40,7 +40,7 @@ HRESULT GetMetaDataStorage ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md b/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md index c8ec34729c84d..a527f37380a92 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md @@ -48,7 +48,7 @@ HRESULT GetMetaDataStreamInfo ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatatables2-interface.md b/docs/core/unmanaged-api/metadata/imetadatatables2-interface.md index d6099210f2d95..861302e685ddf 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables2-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables2-interface.md @@ -29,7 +29,7 @@ Extends [IMetaDataTables](imetadatatables-interface.md) to include methods for w ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatavalidate-interface.md b/docs/core/unmanaged-api/metadata/imetadatavalidate-interface.md index c46dd4aa63f41..58c94701ec723 100644 --- a/docs/core/unmanaged-api/metadata/imetadatavalidate-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadatavalidate-interface.md @@ -29,7 +29,7 @@ Provides methods to validate metadata signatures. ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md b/docs/core/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md index 3895f2a4affee..5df8b6efeccb0 100644 --- a/docs/core/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md @@ -29,7 +29,7 @@ HRESULT ValidateMetaData (); ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md b/docs/core/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md index c922343e42c7b..72b8103da5d17 100644 --- a/docs/core/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md @@ -40,7 +40,7 @@ HRESULT ValidatorInit ( ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h diff --git a/docs/core/unmanaged-api/metadata/osinfo-structure.md b/docs/core/unmanaged-api/metadata/osinfo-structure.md index 7d2da576c85cd..dcbc1ec9701ab 100644 --- a/docs/core/unmanaged-api/metadata/osinfo-structure.md +++ b/docs/core/unmanaged-api/metadata/osinfo-structure.md @@ -44,7 +44,7 @@ typedef struct { ## Requirements - **Platforms:** See [System Requirements](../../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). **Header:** Cor.h From 987c709b77a9db95407bd582277713d70501da18 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Thu, 26 Jun 2025 16:12:55 +0200 Subject: [PATCH 08/20] human edits --- .../debugging/closeclrenumeration-function.md | 1 - .../debugging/closeresumehandle-function.md | 1 - .../debugging/clrcreateinstance-function.md | 1 - ...edebugginginterfacefromversion-function.md | 1 - ...debugginginterfacefromversion2-function.md | 1 - ...debugginginterfacefromversion3-function.md | 1 - ...ebugginginterfacefromversionex-function.md | 1 - .../createprocessforlaunch-function.md | 1 - .../createversionstringfrommodule-function.md | 1 - .../debugging/enumerateclrs-function.md | 1 - .../getstartupnotificationevent-function.md | 1 - ...iclrdebugginglibraryprovider2-interface.md | 1 - ...libraryprovider2-providelibrary2-method.md | 1 - ...iclrdebugginglibraryprovider3-interface.md | 1 - ...raryprovider3-provideunixlibrary-method.md | 1 - ...yprovider3-providewindowslibrary-method.md | 1 - .../libraryproviderindextype-enumeration.md | 1 - .../registerforruntimestartup-function.md | 1 - .../registerforruntimestartup3-function.md | 1 - .../registerforruntimestartupex-function.md | 1 - .../debugging/resumeprocess-function.md | 1 - .../unregisterforruntimestartup-function.md | 1 - .../hosting/assemblybindinfo-structure.md | 81 +- .../hosting/bucketparameters-structure.md | 63 +- .../hosting/callfunctionshim-function.md | 107 +- ...es-added-in-the-net-framework-4-and-4-5.md | 99 +- .../hosting/clr-hosting-interfaces.md | 357 ++-- .../hosting/clrcreateinstance-function.md | 3 +- .../clrcreatemanagedinstance-function.md | 87 +- .../hosting/clrruntimehost-coclass.md | 69 +- .../clsid-resolution-flags-enumeration.md | 65 +- .../hosting/coeeshutdowncom-function.md | 65 +- .../hosting/coinitializecor-function.md | 49 +- .../hosting/coinitializeee-function.md | 91 +- .../hosting/comcallunmarshal-coclass.md | 65 +- .../hosting/cor-gc-stat-types-enumeration.md | 73 +- .../hosting/cor-gc-stats-structure.md | 137 +- .../hosting/cor-gc-thread-stats-structure.md | 73 +- .../cor-gc-thread-stats-types-enumeration.md | 61 +- .../corbindtocurrentruntime-function.md | 99 +- .../hosting/corbindtoruntime-function.md | 151 +- .../hosting/corbindtoruntimebycfg-function.md | 113 +- .../hosting/corbindtoruntimeex-function.md | 233 ++- .../hosting/corbindtoruntimehost-function.md | 116 +- .../hosting/cordllmain-function.md | 105 +- .../hosting/corexemain-function.md | 63 +- .../hosting/corexemain2-function.md | 95 +- .../hosting/corexitprocess-function.md | 73 +- .../hosting/corimageunloading-function.md | 65 +- .../hosting/corlaunchapplication-function.md | 115 +- .../cormarkthreadinthreadpool-function.md | 49 +- .../hosting/corruntimehost-coclass.md | 81 +- .../hosting/corvalidateimage-function.md | 135 +- .../hosting/couninitializecor-function.md | 35 +- .../hosting/couninitializeee-function.md | 39 +- ...edebugginginterfacefromversion-function.md | 7 +- .../hosting/createiceefilegen-function.md | 87 +- .../hosting/customdumpitem-structure.md | 79 +- .../deprecated-clr-hosting-functions.md | 293 ++- ...ed-clr-hosting-interfaces-and-coclasses.md | 31 +- .../hosting/destroyiceefilegen-function.md | 83 +- .../hosting/eapicategories-enumeration.md | 113 +- .../hosting/ebindpolicylevels-enumeration.md | 97 +- .../eclrassemblyidentityflags-enumeration.md | 61 +- .../hosting/eclrevent-enumeration.md | 93 +- .../hosting/eclrfailure-enumeration.md | 93 +- .../hosting/eclroperation-enumeration.md | 109 +- .../eclrunhandledexception-enumeration.md | 77 +- .../hosting/econtexttype-enumeration.md | 77 +- .../hosting/ecustomdumpflavor-enumeration.md | 77 +- .../ecustomdumpitemkind-enumeration.md | 65 +- .../ehostapplicationpolicy-enumeration.md | 53 +- ...ostbindingpolicymodifyflags-enumeration.md | 85 +- .../einitializenewdomainflags-enumeration.md | 75 +- .../hosting/ememoryavailable-enumeration.md | 79 +- .../ememorycriticallevel-enumeration.md | 81 +- .../hosting/epolicyaction-enumeration.md | 105 +- .../esymbolreadingpolicy-enumeration.md | 81 +- .../hosting/etasktype-enumeration.md | 103 +- ...uteinappdomaincallback-function-pointer.md | 71 +- ...lockclrversioncallback-function-pointer.md | 61 +- .../hosting/getclridentitymanager-function.md | 83 +- .../hosting/getcorrequiredversion-function.md | 83 +- .../hosting/getcorsystemdirectory-function.md | 83 +- .../hosting/getcorversion-function.md | 66 +- .../hosting/getfileversion-function.md | 81 +- .../hosting/getrealprocaddress-function.md | 93 +- .../getrequestedruntimeinfo-function.md | 197 +- .../getrequestedruntimeversion-function.md | 105 +- ...equestedruntimeversionforclsid-function.md | 115 +- .../hosting/getversionfromprocess-function.md | 107 +- .../hosting/host-type-enumeration.md | 73 +- .../hosting/hosting-coclasses.md | 51 +- .../hosting/hosting-enumerations.md | 207 ++- .../hosting-global-static-functions.md | 35 +- .../hosting/hosting-interfaces.md | 63 +- .../hosting/hosting-structures.md | 75 +- .../hosting/iactiononclrevent-interface.md | 49 +- .../iactiononclrevent-onevent-method.md | 107 +- .../iapartmentcallback-docallback-method.md | 71 +- .../hosting/iapartmentcallback-interface.md | 49 +- .../hosting/iappdomainbinding-interface.md | 49 +- .../iappdomainbinding-onappdomain-method.md | 63 +- .../hosting/iappdomainsetup-interface.md | 79 +- .../icatalogservices-autodone-method.md | 29 +- .../hosting/icatalogservices-interface.md | 35 +- .../icatalogservices-notautodone-method.md | 29 +- .../hosting/iceefilegen-class.md | 449 +++-- ...ourcemonitor-getcurrentallocated-method.md | 93 +- ...esourcemonitor-getcurrentcputime-method.md | 91 +- ...sourcemonitor-getcurrentsurvived-method.md | 107 +- .../iclrappdomainresourcemonitor-interface.md | 83 +- ...nager-getbindingidentityfromfile-method.md | 121 +- ...ger-getbindingidentityfromstream-method.md | 113 +- ...ager-getclrassemblyreferencelist-method.md | 101 +- ...etprobingassembliesfromreference-method.md | 109 +- ...-getreferencedassembliesfromfile-method.md | 117 +- ...etreferencedassembliesfromstream-method.md | 117 +- .../iclrassemblyidentitymanager-interface.md | 69 +- ...yidentitymanager-isstronglynamed-method.md | 89 +- .../iclrassemblyreferencelist-interface.md | 59 +- ...celist-isassemblyreferenceinlist-method.md | 79 +- ...-isstringassemblyreferenceinlist-method.md | 79 +- .../iclrcontrol-getclrmanager-method.md | 123 +- .../hosting/iclrcontrol-interface.md | 51 +- ...rcontrol-setappdomainmanagertype-method.md | 89 +- ...iclrdebugmanager-beginconnection-method.md | 109 +- .../iclrdebugmanager-endconnection-method.md | 99 +- .../iclrdebugmanager-getdacl-method.md | 75 +- .../hosting/iclrdebugmanager-interface.md | 77 +- ...rdebugmanager-isdebuggerattached-method.md | 93 +- ...rdebugmanager-setconnectiontasks-method.md | 115 +- .../iclrdebugmanager-setdacl-method.md | 75 +- ...ugmanager-setsymbolreadingpolicy-method.md | 79 +- .../hosting/iclrdomainmanager-interface.md | 57 +- ...nmanager-setappdomainmanagertype-method.md | 111 +- ...setpropertiesfordefaultappdomain-method.md | 103 +- ...reportingmanager-begincustomdump-method.md | 121 +- ...orreportingmanager-endcustomdump-method.md | 83 +- ...ketparametersforcurrentexception-method.md | 67 +- .../iclrerrorreportingmanager-interface.md | 65 +- .../hosting/iclrgcmanager-collect-method.md | 93 +- .../hosting/iclrgcmanager-getstats-method.md | 113 +- .../hosting/iclrgcmanager-interface.md | 65 +- ...iclrgcmanager-setgcstartuplimits-method.md | 111 +- .../hosting/iclrgcmanager2-interface.md | 61 +- ...rgcmanager2-setgcstartuplimitsex-method.md | 111 +- ...dingpolicymanager-evaluatepolicy-method.md | 137 +- .../iclrhostbindingpolicymanager-interface.md | 51 +- ...ymanager-modifyapplicationpolicy-method.md | 141 +- .../iclrhostprotectionmanager-interface.md | 51 +- ...nager-seteagerserializegrantsets-method.md | 71 +- ...onmanager-setprotectedcategories-method.md | 93 +- .../iclriocompletionmanager-interface.md | 57 +- ...lriocompletionmanager-oncomplete-method.md | 121 +- ...clrmemorynotificationcallback-interface.md | 57 +- ...ioncallback-onmemorynotification-method.md | 97 +- ...ahost-enumerateinstalledruntimes-method.md | 79 +- ...metahost-enumerateloadedruntimes-method.md | 97 +- .../iclrmetahost-exitprocess-method.md | 73 +- .../hosting/iclrmetahost-getruntime-method.md | 113 +- .../iclrmetahost-getversionfromfile-method.md | 107 +- .../hosting/iclrmetahost-interface.md | 81 +- ...host-querylegacyv2runtimebinding-method.md | 93 +- ...requestruntimeloadednotification-method.md | 165 +- ...tahostpolicy-getrequestedruntime-method.md | 5 +- .../hosting/iclrmetahostpolicy-interface.md | 77 +- .../hosting/iclroneventmanager-interface.md | 63 +- ...entmanager-registeractiononevent-method.md | 105 +- ...tmanager-unregisteractiononevent-method.md | 89 +- .../hosting/iclrpolicymanager-interface.md | 59 +- ...policymanager-setactiononfailure-method.md | 83 +- ...policymanager-setactionontimeout-method.md | 135 +- ...lrpolicymanager-setdefaultaction-method.md | 121 +- .../iclrpolicymanager-settimeout-method.md | 111 +- ...olicymanager-settimeoutandaction-method.md | 131 +- ...ager-setunhandledexceptionpolicy-method.md | 93 +- .../iclrprobingassemblyenum-get-method.md | 3 +- .../iclrprobingassemblyenum-interface.md | 57 +- .../iclrreferenceassemblyenum-get-method.md | 113 +- .../iclrreferenceassemblyenum-interface.md | 49 +- ...lrruntimehost-executeapplication-method.md | 141 +- ...lrruntimehost-executeinappdomain-method.md | 105 +- ...mehost-executeindefaultappdomain-method.md | 135 +- .../iclrruntimehost-getclrcontrol-method.md | 95 +- ...untimehost-getcurrentappdomainid-method.md | 93 +- .../hosting/iclrruntimehost-interface.md | 81 +- .../iclrruntimehost-sethostcontrol-method.md | 95 +- .../hosting/iclrruntimehost-start-method.md | 79 +- .../hosting/iclrruntimehost-stop-method.md | 75 +- .../iclrruntimehost-unloadappdomain-method.md | 101 +- ...untimeinfo-bindaslegacyv2runtime-method.md | 77 +- ...ntimeinfo-getdefaultstartupflags-method.md | 101 +- .../iclrruntimeinfo-getinterface-method.md | 133 +- .../iclrruntimeinfo-getprocaddress-method.md | 101 +- ...rruntimeinfo-getruntimedirectory-method.md | 95 +- ...iclrruntimeinfo-getversionstring-method.md | 107 +- .../hosting/iclrruntimeinfo-interface.md | 71 +- .../iclrruntimeinfo-isloadable-method.md | 91 +- .../iclrruntimeinfo-isloaded-method.md | 115 +- .../iclrruntimeinfo-isstarted-method.md | 93 +- .../iclrruntimeinfo-loaderrorstring-method.md | 117 +- .../iclrruntimeinfo-loadlibrary-method.md | 101 +- ...ntimeinfo-setdefaultstartupflags-method.md | 93 +- ...rongname-gethashfromassemblyfile-method.md | 103 +- ...ongname-gethashfromassemblyfilew-method.md | 103 +- .../iclrstrongname-gethashfromblob-method.md | 111 +- .../iclrstrongname-gethashfromfile-method.md | 105 +- .../iclrstrongname-gethashfromfilew-method.md | 107 +- ...iclrstrongname-gethashfromhandle-method.md | 103 +- .../hosting/iclrstrongname-interface.md | 101 +- ...name-strongnamecompareassemblies-method.md | 107 +- ...rstrongname-strongnamefreebuffer-method.md | 69 +- ...iclrstrongname-strongnamegetblob-method.md | 87 +- ...gname-strongnamegetblobfromimage-method.md | 95 +- ...trongname-strongnamegetpublickey-method.md | 119 +- ...clrstrongname-strongnamehashsize-method.md | 79 +- ...lrstrongname-strongnamekeydelete-method.md | 79 +- .../iclrstrongname-strongnamekeygen-method.md | 111 +- ...clrstrongname-strongnamekeygenex-method.md | 123 +- ...rstrongname-strongnamekeyinstall-method.md | 95 +- ...me-strongnamesignaturegeneration-method.md | 137 +- ...-strongnamesignaturegenerationex-method.md | 157 +- ...rongname-strongnamesignaturesize-method.md | 81 +- ...-strongnamesignatureverification-method.md | 115 +- ...trongnamesignatureverificationex-method.md | 95 +- ...mesignatureverificationfromimage-method.md | 123 +- ...name-strongnametokenfromassembly-method.md | 99 +- ...me-strongnametokenfromassemblyex-method.md | 115 +- ...ame-strongnametokenfrompublickey-method.md | 103 +- .../hosting/iclrstrongname2-interface.md | 53 +- ...anager-createrwlockowneriterator-method.md | 115 +- ...anager-deleterwlockowneriterator-method.md | 93 +- .../iclrsyncmanager-getmonitorowner-method.md | 109 +- ...lrsyncmanager-getrwlockownernext-method.md | 103 +- .../hosting/iclrsyncmanager-interface.md | 55 +- .../hosting/iclrtask-abort-method.md | 79 +- .../hosting/iclrtask-exittask-method.md | 79 +- .../hosting/iclrtask-getmemstats-method.md | 85 +- .../hosting/iclrtask-interface.md | 81 +- .../hosting/iclrtask-locksheld-method.md | 85 +- ...iclrtask-needspriorityscheduling-method.md | 93 +- .../hosting/iclrtask-reset-method.md | 125 +- .../hosting/iclrtask-rudeabort-method.md | 77 +- .../iclrtask-settaskidentifier-method.md | 93 +- .../hosting/iclrtask-switchin-method.md | 99 +- .../hosting/iclrtask-switchout-method.md | 79 +- .../hosting/iclrtask-yieldtask-method.md | 79 +- ...iclrtask2-beginpreventasyncabort-method.md | 87 +- .../iclrtask2-endpreventasyncabort-method.md | 83 +- .../hosting/iclrtask2-interface.md | 75 +- .../iclrtaskmanager-createtask-method.md | 103 +- .../iclrtaskmanager-getcurrenttask-method.md | 93 +- ...lrtaskmanager-getcurrenttasktype-method.md | 63 +- .../hosting/iclrtaskmanager-interface.md | 65 +- .../iclrtaskmanager-setlocale-method.md | 93 +- .../iclrtaskmanager-setuilocale-method.md | 93 +- .../iclrvalidator-formateventinfo-method.md | 117 +- .../hosting/iclrvalidator-interface.md | 3 +- .../hosting/iclrvalidator-validate-method.md | 3 +- ...uration-adddebuggerspecialthread-method.md | 71 +- .../hosting/icorconfiguration-interface.md | 55 +- ...uration-setdebuggerthreadcontrol-method.md | 63 +- ...orconfiguration-setgchostcontrol-method.md | 63 +- ...configuration-setgcthreadcontrol-method.md | 71 +- .../icorruntimehost-closeenum-method.md | 81 +- .../icorruntimehost-createdomain-method.md | 97 +- .../icorruntimehost-createdomainex-method.md | 113 +- ...corruntimehost-createdomainsetup-method.md | 89 +- .../icorruntimehost-createevidence-method.md | 89 +- ...imehost-createlogicalthreadstate-method.md | 49 +- .../icorruntimehost-currentdomain-method.md | 81 +- ...imehost-deletelogicalthreadstate-method.md | 49 +- .../icorruntimehost-enumdomains-method.md | 81 +- ...icorruntimehost-getconfiguration-method.md | 71 +- ...icorruntimehost-getdefaultdomain-method.md | 85 +- .../hosting/icorruntimehost-interface.md | 87 +- ...imehost-locksheldbylogicalthread-method.md | 67 +- .../hosting/icorruntimehost-mapfile-method.md | 71 +- .../icorruntimehost-nextdomain-method.md | 85 +- .../hosting/icorruntimehost-start-method.md | 75 +- .../hosting/icorruntimehost-stop-method.md | 79 +- ...ehost-switchinlogicalthreadstate-method.md | 63 +- ...host-switchoutlogicalthreadstate-method.md | 63 +- .../icorruntimehost-unloaddomain-method.md | 81 +- ...pool-corbindiocompletioncallback-method.md | 55 +- ...dpool-corcallorqueueuserworkitem-method.md | 57 +- .../icorthreadpool-corchangetimer-method.md | 55 +- .../icorthreadpool-corcreatetimer-method.md | 63 +- .../icorthreadpool-cordeletetimer-method.md | 57 +- ...hreadpool-corgetavailablethreads-method.md | 55 +- .../icorthreadpool-corgetmaxthreads-method.md | 55 +- ...rthreadpool-corqueueuserworkitem-method.md | 59 +- ...l-corregisterwaitforsingleobject-method.md | 65 +- .../icorthreadpool-corsetmaxthreads-method.md | 55 +- ...icorthreadpool-corunregisterwait-method.md | 57 +- .../hosting/icorthreadpool-interface.md | 73 +- .../hosting/idebuggerinfo-interface.md | 49 +- ...idebuggerinfo-isdebuggerattached-method.md | 63 +- .../idebuggerthreadcontrol-interface.md | 53 +- ...control-releaseallruntimethreads-method.md | 57 +- ...control-startblockingfordebugger-method.md | 71 +- ...trol-threadisblockingfordebugger-method.md | 61 +- .../hosting/igchost-collect-method.md | 63 +- .../hosting/igchost-getstats-method.md | 71 +- .../hosting/igchost-getthreadstats-method.md | 71 +- .../hosting/igchost-interface.md | 65 +- .../igchost-setgcstartuplimits-method.md | 83 +- .../igchost-setvirtualmemlimit-method.md | 71 +- .../hosting/igchost2-interface.md | 53 +- .../igchost2-setgcstartuplimitsex-method.md | 79 +- .../hosting/igchostcontrol-interface.md | 49 +- ...stcontrol-requestvirtualmemlimit-method.md | 71 +- .../hosting/igcthreadcontrol-interface.md | 53 +- ...gcthreadcontrol-suspensionending-method.md | 71 +- ...threadcontrol-suspensionstarting-method.md | 57 +- ...ol-threadisblockingforsuspension-method.md | 57 +- ...assemblymanager-getassemblystore-method.md | 99 +- ...anager-getnonhoststoreassemblies-method.md | 119 +- .../hosting/ihostassemblymanager-interface.md | 63 +- .../hosting/ihostassemblystore-interface.md | 71 +- ...ostassemblystore-provideassembly-method.md | 129 +- ...ihostassemblystore-providemodule-method.md | 121 +- .../hosting/ihostautoevent-interface.md | 51 +- .../hosting/ihostautoevent-set-method.md | 71 +- .../hosting/ihostautoevent-wait-method.md | 91 +- .../ihostcontrol-gethostmanager-method.md | 149 +- .../hosting/ihostcontrol-interface.md | 51 +- ...ihostcontrol-setappdomainmanager-method.md | 105 +- .../hosting/ihostcrst-enter-method.md | 97 +- .../hosting/ihostcrst-interface.md | 63 +- .../hosting/ihostcrst-leave-method.md | 79 +- .../hosting/ihostcrst-setspincount-method.md | 97 +- .../hosting/ihostcrst-tryenter-method.md | 101 +- .../hosting/ihostgcmanager-interface.md | 53 +- .../ihostgcmanager-suspensionending-method.md | 97 +- ...hostgcmanager-suspensionstarting-method.md | 79 +- ...er-threadisblockingforsuspension-method.md | 79 +- .../ihostiocompletionmanager-bind-method.md | 105 +- ...ionmanager-closeiocompletionport-method.md | 95 +- ...onmanager-createiocompletionport-method.md | 95 +- ...etionmanager-getavailablethreads-method.md | 95 +- ...ionmanager-gethostoverlappedsize-method.md | 109 +- ...ocompletionmanager-getmaxthreads-method.md | 95 +- ...ocompletionmanager-getminthreads-method.md | 95 +- ...manager-initializehostoverlapped-method.md | 103 +- .../ihostiocompletionmanager-interface.md | 77 +- ...anager-setclriocompletionmanager-method.md | 93 +- ...ocompletionmanager-setmaxthreads-method.md | 95 +- ...ocompletionmanager-setminthreads-method.md | 95 +- .../hosting/ihostmalloc-alloc-method.md | 107 +- .../hosting/ihostmalloc-debugalloc-method.md | 119 +- .../hosting/ihostmalloc-free-method.md | 95 +- .../hosting/ihostmalloc-interface.md | 61 +- .../hosting/ihostmanualevent-interface.md | 53 +- .../hosting/ihostmanualevent-reset-method.md | 71 +- .../hosting/ihostmanualevent-set-method.md | 71 +- .../hosting/ihostmanualevent-wait-method.md | 91 +- ...ager-acquiredvirtualaddressspace-method.md | 79 +- .../ihostmemorymanager-createmalloc-method.md | 103 +- ...ihostmemorymanager-getmemoryload-method.md | 103 +- .../hosting/ihostmemorymanager-interface.md | 75 +- ...manager-needsvirtualaddressspace-method.md | 83 +- ...gistermemorynotificationcallback-method.md | 97 +- ...ager-releasedvirtualaddressspace-method.md | 71 +- .../ihostmemorymanager-virtualalloc-method.md | 139 +- .../ihostmemorymanager-virtualfree-method.md | 115 +- ...hostmemorymanager-virtualprotect-method.md | 117 +- .../ihostmemorymanager-virtualquery-method.md | 121 +- .../hosting/ihostpolicymanager-interface.md | 53 +- ...ostpolicymanager-ondefaultaction-method.md | 87 +- .../ihostpolicymanager-onfailure-method.md | 89 +- .../ihostpolicymanager-ontimeout-method.md | 87 +- .../ihostsecuritycontext-capture-method.md | 91 +- .../hosting/ihostsecuritycontext-interface.md | 57 +- ...curitymanager-getsecuritycontext-method.md | 97 +- ...ymanager-impersonateloggedonuser-method.md | 97 +- .../hosting/ihostsecuritymanager-interface.md | 87 +- ...tsecuritymanager-openthreadtoken-method.md | 109 +- ...hostsecuritymanager-reverttoself-method.md | 79 +- ...curitymanager-setsecuritycontext-method.md | 105 +- ...stsecuritymanager-setthreadtoken-method.md | 97 +- .../hosting/ihostsemaphore-interface.md | 51 +- .../ihostsemaphore-releasesemaphore-method.md | 101 +- .../hosting/ihostsemaphore-wait-method.md | 91 +- ...ihostsyncmanager-createautoevent-method.md | 95 +- .../ihostsyncmanager-createcrst-method.md | 95 +- ...cmanager-createcrstwithspincount-method.md | 103 +- ...ostsyncmanager-createmanualevent-method.md | 103 +- ...stsyncmanager-createmonitorevent-method.md | 107 +- ...cmanager-createrwlockreaderevent-method.md | 111 +- ...cmanager-createrwlockwriterevent-method.md | 103 +- ...ihostsyncmanager-createsemaphore-method.md | 111 +- .../hosting/ihostsyncmanager-interface.md | 73 +- ...ostsyncmanager-setclrsyncmanager-method.md | 93 +- .../hosting/ihosttask-alert-method.md | 83 +- .../hosting/ihosttask-getpriority-method.md | 93 +- .../hosting/ihosttask-interface.md | 67 +- .../hosting/ihosttask-join-method.md | 89 +- .../hosting/ihosttask-setclrtask-method.md | 93 +- .../hosting/ihosttask-setpriority-method.md | 133 +- .../hosting/ihosttask-start-method.md | 71 +- ...ihosttaskmanager-begindelayabort-method.md | 81 +- ...ttaskmanager-beginthreadaffinity-method.md | 79 +- ...osttaskmanager-callneedshosthook-method.md | 103 +- .../ihosttaskmanager-createtask-method.md | 117 +- .../ihosttaskmanager-enddelayabort-method.md | 81 +- ...osttaskmanager-endthreadaffinity-method.md | 81 +- .../ihosttaskmanager-enterruntime-method.md | 81 +- .../ihosttaskmanager-getcurrenttask-method.md | 95 +- ...osttaskmanager-getstackguarantee-method.md | 63 +- .../hosting/ihosttaskmanager-interface.md | 87 +- .../ihosttaskmanager-leaveruntime-method.md | 117 +- ...ttaskmanager-reverseenterruntime-method.md | 81 +- ...ttaskmanager-reverseleaveruntime-method.md | 77 +- ...osttaskmanager-setclrtaskmanager-method.md | 93 +- .../ihosttaskmanager-setlocale-method.md | 95 +- ...osttaskmanager-setstackguarantee-method.md | 53 +- .../ihosttaskmanager-setuilocale-method.md | 95 +- .../hosting/ihosttaskmanager-sleep-method.md | 101 +- .../ihosttaskmanager-switchtotask-method.md | 97 +- ...dpoolmanager-getavailablethreads-method.md | 95 +- ...tthreadpoolmanager-getmaxthreads-method.md | 99 +- ...tthreadpoolmanager-getminthreads-method.md | 95 +- .../ihostthreadpoolmanager-interface.md | 67 +- ...eadpoolmanager-queueuserworkitem-method.md | 109 +- ...tthreadpoolmanager-setmaxthreads-method.md | 95 +- ...tthreadpoolmanager-setminthreads-method.md | 95 +- ...imanagedobject-getobjectidentity-method.md | 87 +- ...anagedobject-getserializedbuffer-method.md | 71 +- .../hosting/imanagedobject-interface.md | 51 +- docs/core/unmanaged-api/hosting/index.md | 47 +- .../hosting/iobjecthandle-interface.md | 49 +- .../hosting/iobjecthandle-unwrap-method.md | 61 +- .../itypename-getassemblyname-method.md | 53 +- .../itypename-getmodifierlength-method.md | 53 +- .../hosting/itypename-getmodifiers-method.md | 57 +- .../hosting/itypename-getnamecount-method.md | 53 +- .../hosting/itypename-getnames-method.md | 57 +- .../itypename-gettypeargumentcount-method.md | 53 +- .../itypename-gettypearguments-method.md | 57 +- .../hosting/itypename-interface.md | 41 +- .../itypenamebuilder-addarray-method.md | 53 +- ...itypenamebuilder-addassemblyspec-method.md | 53 +- .../itypenamebuilder-addbyref-method.md | 3 +- .../itypenamebuilder-addname-method.md | 53 +- .../itypenamebuilder-addpointer-method.md | 49 +- .../itypenamebuilder-addszarray-method.md | 49 +- .../hosting/itypenamebuilder-clear-method.md | 49 +- ...namebuilder-closegenericargument-method.md | 49 +- ...amebuilder-closegenericarguments-method.md | 49 +- .../hosting/itypenamebuilder-interface.md | 41 +- ...enamebuilder-opengenericargument-method.md | 49 +- ...namebuilder-opengenericarguments-method.md | 49 +- .../itypenamebuilder-tostring-method.md | 53 +- ...penamefactory-gettypenamebuilder-method.md | 53 +- .../hosting/itypenamefactory-interface.md | 41 +- .../itypenamefactory-parsetypename-method.md | 57 +- .../ivalidator-formateventinfo-method.md | 93 +- .../hosting/ivalidator-interface.md | 3 +- .../hosting/ivalidator-validate-method.md | 3 +- .../hosting/loadlibraryshim-function.md | 117 +- .../hosting/loadstringrc-function.md | 111 +- .../hosting/loadstringrcex-function.md | 123 +- .../hosting/lockclrversion-function.md | 157 +- ...ped-completion-routine-function-pointer.md | 95 +- ...lpthread-start-routine-function-pointer.md | 75 +- .../hosting/malloc-type-enumeration.md | 69 +- .../hosting/mdainfo-structure.md | 95 +- .../metahost-config-flags-enumeration.md | 83 +- .../metahost-policy-flags-enumeration.md | 93 +- .../hosting/modulebindinfo-structure.md | 81 +- ...ework-4-hosting-global-static-functions.md | 15 +- .../hosting/rundll32shimw-function.md | 91 +- .../hosting/runtime-info-flags-enumeration.md | 117 +- .../hosting/stackoverflowinfo-structure.md | 77 +- .../hosting/stackoverflowtype-enumeration.md | 81 +- .../hosting/startup-flags-enumeration.md | 133 +- .../strongnamegetpublickeyex-method.md | 155 +- ...rongnamesignatureverificationex2-method.md | 101 +- docs/core/unmanaged-api/hosting/toc.yml | 1000 ----------- .../hosting/typenamefactory-coclass.md | 65 +- .../hosting/validatorflags-enumeration.md | 3 +- .../hosting/wait-option-enumeration.md | 81 +- .../waitortimercallback-function-pointer.md | 83 +- .../metadata/assemblyflags-enumeration.md | 89 +- .../metadata/assemblymetadata-structure.md | 99 +- .../metadata/assemblyrefflags-enumeration.md | 61 +- .../metadata/ceesectionattr-enumeration.md | 81 +- .../metadata/ceesectionrelocextra-union.md | 65 +- .../ceesectionreloctype-enumeration.md | 121 +- .../metadata/coiniticor-enumeration.md | 67 +- .../metadata/coinitiee-enumeration.md | 73 +- .../metadata/cor-field-offset-structure.md | 73 +- .../metadata/cor-native-link-structure.md | 73 +- .../metadata/corargtype-enumeration.md | 73 +- .../metadata/corassemblyflags-enumeration.md | 135 +- .../corattributetargets-enumeration.md | 141 +- .../corcallingconvention-enumeration.md | 115 +- .../corcheckduplicatesfor-enumeration.md | 171 +- .../metadata/cordeclsecurity-enumeration.md | 143 +- .../metadata/corelementtype-enumeration.md | 3 +- .../corerrorifemitoutoforder-enumeration.md | 93 +- .../metadata/coreventattr-enumeration.md | 75 +- .../metadata/corfieldattr-enumeration.md | 145 +- .../metadata/corfileflags-enumeration.md | 69 +- .../metadata/corfilemapping-enumeration.md | 69 +- .../corgenericparamattr-enumeration.md | 93 +- .../metadata/corimportoptions-enumeration.md | 95 +- .../metadata/corlinkeroptions-enumeration.md | 65 +- .../corlocalrefpreservation-enumeration.md | 71 +- .../cormanifestresourceflags-enumeration.md | 73 +- .../metadata/cormethodattr-enumeration.md | 167 +- .../metadata/cormethodimpl-enumeration.md | 3 +- .../cormethodsemanticsattr-enumeration.md | 85 +- .../cornativelinkflags-enumeration.md | 79 +- .../metadata/cornativelinktype-enumeration.md | 85 +- .../metadata/cornativetype-enumeration.md | 257 ++- ...otificationfortokenmovement-enumeration.md | 167 +- .../metadata/coropenflags-enumeration.md | 111 +- .../metadata/corparamattr-enumeration.md | 93 +- .../metadata/corpekind-enumeration.md | 93 +- .../metadata/corpinvokemap-enumeration.md | 159 +- .../metadata/corpropertyattr-enumeration.md | 79 +- .../metadata/correftodefcheck-enumeration.md | 77 +- .../metadata/corregflags-enumeration.md | 73 +- .../metadata/corsavesize-enumeration.md | 69 +- .../corserializationtype-enumeration.md | 139 +- .../metadata/corsetenc-enumeration.md | 93 +- .../corthreadsafetyoptions-enumeration.md | 3 +- .../metadata/cortokentype-enumeration.md | 169 +- .../metadata/cortypeattr-enumeration.md | 207 ++- ...runmanagedcallingconvention-enumeration.md | 103 +- .../corvalidatormoduletype-enumeration.md | 91 +- .../metadata/couninitiee-enumeration.md | 69 +- .../metadata/cvstruct-structure.md | 77 +- .../iceegen-addsectionreloc-method.md | 89 +- .../iceegen-allocatemethodbuffer-method.md | 79 +- .../metadata/iceegen-computepointer-method.md | 81 +- .../metadata/iceegen-emitstring-method.md | 75 +- .../iceegen-generateceefile-method.md | 61 +- .../iceegen-generateceememoryimage-method.md | 67 +- .../metadata/iceegen-getilsection-method.md | 67 +- .../iceegen-getimaptokeniface-method.md | 67 +- .../iceegen-getmethodbuffer-method.md | 75 +- .../iceegen-getsectionblock-method.md | 95 +- .../iceegen-getsectioncreate-method.md | 91 +- .../iceegen-getsectiondatalen-method.md | 83 +- .../metadata/iceegen-getstring-method.md | 73 +- .../iceegen-getstringsection-method.md | 67 +- .../metadata/iceegen-interface.md | 81 +- .../iceegen-truncatesection-method.md | 83 +- .../metadata/ihostfilter-interface.md | 53 +- .../metadata/ihostfilter-marktoken-method.md | 71 +- .../metadata/imaptoken-interface.md | 53 +- .../metadata/imaptoken-map-method.md | 77 +- ...adataassemblyemit-defineassembly-method.md | 117 +- ...taassemblyemit-defineassemblyref-method.md | 131 +- ...aassemblyemit-defineexportedtype-method.md | 117 +- ...imetadataassemblyemit-definefile-method.md | 99 +- ...emblyemit-definemanifestresource-method.md | 97 +- .../imetadataassemblyemit-interface.md | 71 +- ...ataassemblyemit-setassemblyprops-method.md | 119 +- ...assemblyemit-setassemblyrefprops-method.md | 123 +- ...ssemblyemit-setexportedtypeprops-method.md | 93 +- ...etadataassemblyemit-setfileprops-method.md | 93 +- ...blyemit-setmanifestresourceprops-method.md | 93 +- ...metadataassemblyimport-closeenum-method.md | 63 +- ...aassemblyimport-enumassemblyrefs-method.md | 95 +- ...assemblyimport-enumexportedtypes-method.md | 95 +- ...metadataassemblyimport-enumfiles-method.md | 95 +- ...mblyimport-enummanifestresources-method.md | 93 +- ...emblyimport-findassembliesbyname-method.md | 127 +- ...blyimport-findexportedtypebyname-method.md | 83 +- ...mport-findmanifestresourcebyname-method.md | 73 +- ...emblyimport-getassemblyfromscope-method.md | 63 +- ...aassemblyimport-getassemblyprops-method.md | 125 +- ...semblyimport-getassemblyrefprops-method.md | 125 +- ...emblyimport-getexportedtypeprops-method.md | 99 +- ...adataassemblyimport-getfileprops-method.md | 99 +- ...yimport-getmanifestresourceprops-method.md | 99 +- .../imetadataassemblyimport-interface.md | 75 +- ...onverter-getmetadatafromtypeinfo-method.md | 71 +- ...converter-getmetadatafromtypelib-method.md | 69 +- ...converter-gettypelibfrommetadata-method.md | 75 +- .../metadata/imetadataconverter-interface.md | 53 +- .../imetadatadispenser-definescope-method.md | 101 +- .../metadata/imetadatadispenser-interface.md | 53 +- .../imetadatadispenser-openscope-method.md | 105 +- ...adatadispenser-openscopeonmemory-method.md | 107 +- ...metadatadispenserex-findassembly-method.md | 111 +- ...tadispenserex-findassemblymodule-method.md | 119 +- ...ispenserex-getcorsystemdirectory-method.md | 75 +- .../imetadatadispenserex-getoption-method.md | 105 +- .../imetadatadispenserex-interface.md | 59 +- ...dispenserex-openscopeonitypeinfo-method.md | 87 +- .../imetadatadispenserex-setoption-method.md | 109 +- ...etadataemit-applyeditandcontinue-method.md | 61 +- ...tadataemit-definecustomattribute-method.md | 83 +- .../imetadataemit-defineevent-method.md | 107 +- .../imetadataemit-definefield-method.md | 107 +- ...imetadataemit-defineimportmember-method.md | 127 +- .../imetadataemit-defineimporttype-method.md | 105 +- .../imetadataemit-definememberref-method.md | 83 +- .../imetadataemit-definemethod-method.md | 183 +- .../imetadataemit-definemethodimpl-method.md | 73 +- .../imetadataemit-definemoduleref-method.md | 65 +- .../imetadataemit-definenestedtype-method.md | 93 +- .../imetadataemit-defineparam-method.md | 113 +- ...metadataemit-definepermissionset-method.md | 85 +- .../imetadataemit-definepinvokemap-method.md | 77 +- .../imetadataemit-defineproperty-method.md | 125 +- ...aemit-definesecurityattributeset-method.md | 77 +- .../imetadataemit-definetypedef-method.md | 101 +- ...metadataemit-definetyperefbyname-method.md | 91 +- .../imetadataemit-defineuserstring-method.md | 71 +- .../imetadataemit-deleteclasslayout-method.md | 63 +- ...imetadataemit-deletefieldmarshal-method.md | 63 +- .../imetadataemit-deletepinvokemap-method.md | 59 +- .../imetadataemit-deletetoken-method.md | 59 +- .../imetadataemit-getsavesize-method.md | 99 +- .../imetadataemit-gettokenfromsig-method.md | 71 +- ...etadataemit-gettokenfromtypespec-method.md | 71 +- .../metadata/imetadataemit-interface.md | 143 +- .../metadata/imetadataemit-merge-method.md | 79 +- .../metadata/imetadataemit-mergeend-method.md | 3 +- .../metadata/imetadataemit-save-method.md | 67 +- .../imetadataemit-savetomemory-method.md | 65 +- .../imetadataemit-savetostream-method.md | 69 +- .../imetadataemit-setclasslayout-method.md | 99 +- ...dataemit-setcustomattributevalue-method.md | 71 +- .../imetadataemit-seteventprops-method.md | 97 +- .../imetadataemit-setfieldmarshal-method.md | 73 +- .../imetadataemit-setfieldprops-method.md | 85 +- .../imetadataemit-setfieldrva-method.md | 65 +- .../imetadataemit-sethandler-method.md | 73 +- ...imetadataemit-setmethodimplflags-method.md | 65 +- .../imetadataemit-setmethodprops-method.md | 79 +- .../imetadataemit-setmoduleprops-method.md | 61 +- .../imetadataemit-setparamprops-method.md | 89 +- .../imetadataemit-setparent-method.md | 65 +- ...tadataemit-setpermissionsetprops-method.md | 83 +- .../imetadataemit-setpinvokemap-method.md | 79 +- .../imetadataemit-setpropertyprops-method.md | 101 +- .../metadata/imetadataemit-setrva-method.md | 67 +- .../imetadataemit-settypedefprops-method.md | 79 +- ...tadataemit-translatesigwithscope-method.md | 121 +- ...metadataemit2-definegenericparam-method.md | 97 +- .../imetadataemit2-definemethodspec-method.md | 81 +- .../imetadataemit2-getdeltasavesize-method.md | 71 +- .../metadata/imetadataemit2-interface.md | 63 +- .../imetadataemit2-resetenclog-method.md | 57 +- .../imetadataemit2-savedelta-method.md | 69 +- ...imetadataemit2-savedeltatomemory-method.md | 69 +- ...imetadataemit2-savedeltatostream-method.md | 69 +- ...tadataemit2-setgenericparamprops-method.md | 87 +- .../metadata/imetadataerror-interface.md | 53 +- .../metadata/imetadataerror-onerror-method.md | 69 +- .../metadata/imetadatafilter-interface.md | 53 +- .../imetadatafilter-istokenmarked-method.md | 69 +- .../imetadatafilter-marktoken-method.md | 63 +- .../imetadatafilter-unmarkall-method.md | 57 +- .../imetadataimport-closeenum-method.md | 71 +- .../imetadataimport-countenum-method.md | 77 +- ...adataimport-enumcustomattributes-method.md | 109 +- .../imetadataimport-enumevents-method.md | 101 +- .../imetadataimport-enumfields-method.md | 99 +- ...etadataimport-enumfieldswithname-method.md | 113 +- ...etadataimport-enuminterfaceimpls-method.md | 103 +- .../imetadataimport-enummemberrefs-method.md | 101 +- .../imetadataimport-enummembers-method.md | 103 +- ...tadataimport-enummemberswithname-method.md | 115 +- .../imetadataimport-enummethodimpls-method.md | 107 +- .../imetadataimport-enummethods-method.md | 101 +- ...tadataimport-enummethodsemantics-method.md | 115 +- ...tadataimport-enummethodswithname-method.md | 125 +- .../imetadataimport-enummodulerefs-method.md | 101 +- .../imetadataimport-enumparams-method.md | 109 +- ...etadataimport-enumpermissionsets-method.md | 113 +- .../imetadataimport-enumproperties-method.md | 109 +- .../imetadataimport-enumsignatures-method.md | 109 +- .../imetadataimport-enumtypedefs-method.md | 105 +- .../imetadataimport-enumtyperefs-method.md | 105 +- .../imetadataimport-enumtypespecs-method.md | 109 +- ...dataimport-enumunresolvedmethods-method.md | 113 +- .../imetadataimport-enumuserstrings-method.md | 109 +- .../imetadataimport-findfield-method.md | 111 +- .../imetadataimport-findmember-method.md | 109 +- .../imetadataimport-findmemberref-method.md | 105 +- .../imetadataimport-findmethod-method.md | 105 +- ...metadataimport-findtypedefbyname-method.md | 79 +- .../imetadataimport-findtyperef-method.md | 79 +- .../imetadataimport-getclasslayout-method.md | 99 +- ...aimport-getcustomattributebyname-method.md | 95 +- ...taimport-getcustomattributeprops-method.md | 103 +- .../imetadataimport-geteventprops-method.md | 137 +- .../imetadataimport-getfieldmarshal-method.md | 75 +- .../imetadataimport-getfieldprops-method.md | 133 +- ...dataimport-getinterfaceimplprops-method.md | 77 +- .../imetadataimport-getmemberprops-method.md | 137 +- ...metadataimport-getmemberrefprops-method.md | 97 +- .../imetadataimport-getmethodprops-method.md | 135 +- ...etadataimport-getmethodsemantics-method.md | 87 +- ...etadataimport-getmodulefromscope-method.md | 63 +- ...metadataimport-getmodulerefprops-method.md | 81 +- ...imetadataimport-getnamefromtoken-method.md | 79 +- ...aimport-getnativecallconvfromsig-method.md | 79 +- ...tadataimport-getnestedclassprops-method.md | 71 +- ...ataimport-getparamformethodindex-method.md | 79 +- .../imetadataimport-getparamprops-method.md | 133 +- ...dataimport-getpermissionsetprops-method.md | 83 +- .../imetadataimport-getpinvokemap-method.md | 103 +- ...imetadataimport-getpropertyprops-method.md | 159 +- .../metadata/imetadataimport-getrva-method.md | 75 +- .../imetadataimport-getscopeprops-method.md | 95 +- .../imetadataimport-getsigfromtoken-method.md | 71 +- .../imetadataimport-gettypedefprops-method.md | 103 +- .../imetadataimport-gettyperefprops-method.md | 95 +- ...adataimport-gettypespecfromtoken-method.md | 81 +- .../imetadataimport-getuserstring-method.md | 87 +- .../metadata/imetadataimport-interface.md | 195 +- .../imetadataimport-isglobal-method.md | 71 +- .../imetadataimport-isvalidtoken-method.md | 71 +- .../imetadataimport-resetenum-method.md | 69 +- .../imetadataimport-resolvetyperef-method.md | 103 +- ...ort2-enumgenericparamconstraints-method.md | 109 +- ...etadataimport2-enumgenericparams-method.md | 101 +- ...imetadataimport2-enummethodspecs-method.md | 105 +- ...2-getgenericparamconstraintprops-method.md | 79 +- ...dataimport2-getgenericparamprops-method.md | 119 +- ...tadataimport2-getmethodspecprops-method.md | 83 +- .../imetadataimport2-getpekind-method.md | 91 +- ...metadataimport2-getversionstring-method.md | 87 +- .../metadata/imetadataimport2-interface.md | 63 +- .../imetadatainfo-getfilemapping-method.md | 111 +- .../metadata/imetadatainfo-interface.md | 49 +- .../imetadatatables-getblob-method.md | 79 +- .../imetadatatables-getblobheapsize-method.md | 61 +- ...metadatatables-getcodedtokeninfo-method.md | 85 +- .../imetadatatables-getcolumn-method.md | 81 +- .../imetadatatables-getcolumninfo-method.md | 93 +- .../imetadatatables-getguid-method.md | 3 +- .../imetadatatables-getguidheapsize-method.md | 63 +- .../imetadatatables-getnextblob-method.md | 71 +- .../imetadatatables-getnextguid-method.md | 3 +- .../imetadatatables-getnextstring-method.md | 69 +- ...metadatatables-getnextuserstring-method.md | 3 +- .../imetadatatables-getnumtables-method.md | 63 +- .../metadata/imetadatatables-getrow-method.md | 3 +- .../imetadatatables-getstring-method.md | 69 +- ...metadatatables-getstringheapsize-method.md | 63 +- .../imetadatatables-gettableindex-method.md | 3 +- .../imetadatatables-gettableinfo-method.md | 103 +- .../imetadatatables-getuserstring-method.md | 3 +- ...datatables-getuserstringheapsize-method.md | 63 +- .../metadata/imetadatatables-interface.md | 85 +- ...tadatatables2-getmetadatastorage-method.md | 71 +- ...atatables2-getmetadatastreaminfo-method.md | 87 +- .../metadata/imetadatatables2-interface.md | 51 +- .../metadata/imetadatavalidate-interface.md | 51 +- ...etadatavalidate-validatemetadata-method.md | 49 +- .../imetadatavalidate-validatorinit-method.md | 71 +- docs/core/unmanaged-api/metadata/index.md | 35 +- .../metadata/metadata-enumerations.md | 303 ++-- .../metadata-global-static-functions.md | 21 +- .../metadata/metadata-interfaces.md | 135 +- .../metadata/metadata-structures.md | 57 +- .../unmanaged-api/metadata/metadata-unions.md | 33 +- .../metadata/osinfo-structure.md | 77 +- docs/core/unmanaged-api/metadata/toc.yml | 591 ------ .../cor-prf-rejit-flags-enumeration.md | 2 +- ...filerinfo9-getiltonativemapping3-method.md | 2 +- docs/core/unmanaged-api/toc.yml | 12 - .../app-domains/application-domains.md | 2 +- .../how-to-debug-clr-activation-issues.md | 2 +- ...ion-errors-managing-the-user-experience.md | 11 +- ...mmon-data-types-unmanaged-api-reference.md | 50 +- .../wcf/migrating-from-net-remoting-to-wcf.md | 1196 ++++++------- docs/navigate/tools-diagnostics/toc.yml | 1593 +++++++++++++++++ 779 files changed, 34148 insertions(+), 34931 deletions(-) delete mode 100644 docs/core/unmanaged-api/hosting/toc.yml delete mode 100644 docs/core/unmanaged-api/metadata/toc.yml delete mode 100644 docs/core/unmanaged-api/toc.yml diff --git a/docs/core/unmanaged-api/debugging/closeclrenumeration-function.md b/docs/core/unmanaged-api/debugging/closeclrenumeration-function.md index 7a0c7939832d2..13b420b0524b6 100644 --- a/docs/core/unmanaged-api/debugging/closeclrenumeration-function.md +++ b/docs/core/unmanaged-api/debugging/closeclrenumeration-function.md @@ -14,7 +14,6 @@ helpviewer_keywords: - "debugging API [.NET Core]" - ".NET Core, debugging" - "CloseCLR Enumeration function" -ms.assetid: 5e3c3958-80bb-43b1-a96b-dd3e6dbd9cd7 topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/closeresumehandle-function.md b/docs/core/unmanaged-api/debugging/closeresumehandle-function.md index ae8d08606cd69..9d2e803c53177 100644 --- a/docs/core/unmanaged-api/debugging/closeresumehandle-function.md +++ b/docs/core/unmanaged-api/debugging/closeresumehandle-function.md @@ -14,7 +14,6 @@ helpviewer_keywords: - "debugging API [.NET Core]" - ".NET Core, debugging" - "CloseResumeHandle function" -ms.assetid: 5e3c3958-80bb-43b1-a96b-dd3e6dbd9cd7 topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/clrcreateinstance-function.md b/docs/core/unmanaged-api/debugging/clrcreateinstance-function.md index cd8447d9fa0ed..3f30b7aa3763e 100644 --- a/docs/core/unmanaged-api/debugging/clrcreateinstance-function.md +++ b/docs/core/unmanaged-api/debugging/clrcreateinstance-function.md @@ -16,7 +16,6 @@ f1_keywords: helpviewer_keywords: - "CLRCreateInstance function [.NET Core Debugging]" - "CreateInterface function" -ms.assetid: 5de13327-96c6-4697-a89e-b8bf40717855 topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion-function.md b/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion-function.md index f9fad1da56fb9..acc031d4e7336 100644 --- a/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion-function.md +++ b/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion-function.md @@ -12,7 +12,6 @@ helpviewer_keywords: - "CreateDebuggingInterfaceFromVersion function" - "debugging API [.NET Core]" - ".NET Core, debugging" -ms.assetid: 35c7a18f-133a-4584-bd25-bb338568b0c6 --- # CreateDebuggingInterfaceFromVersion function diff --git a/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion2-function.md b/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion2-function.md index 658827175ee3a..5ad013ca3c3ba 100644 --- a/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion2-function.md +++ b/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion2-function.md @@ -12,7 +12,6 @@ helpviewer_keywords: - "CreateDebuggingInterfaceFromVersion2 function" - "debugging API [.NET Core]" - ".NET Core, debugging" -ms.assetid: 35c7a18f-133a-4584-bd25-bb338568b0c6 --- # CreateDebuggingInterfaceFromVersion2 function diff --git a/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion3-function.md b/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion3-function.md index 9edd7b960b39e..267bac3d6016b 100644 --- a/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion3-function.md +++ b/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion3-function.md @@ -12,7 +12,6 @@ helpviewer_keywords: - "CreateDebuggingInterfaceFromVersion3 function" - "debugging API [.NET Core]" - ".NET Core, debugging" -ms.assetid: 35c7a18f-133a-4584-bd25-bb338568b0c6 --- # CreateDebuggingInterfaceFromVersion3 function diff --git a/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversionex-function.md b/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversionex-function.md index 02bfb878d8713..045c46fd099d0 100644 --- a/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversionex-function.md +++ b/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversionex-function.md @@ -12,7 +12,6 @@ helpviewer_keywords: - "CreateDebuggingInterfaceFromVersionEx function" - "debugging API [.NET Core]" - ".NET Core, debugging" -ms.assetid: 35c7a18f-133a-4584-bd25-bb338568b0c6 --- # CreateDebuggingInterfaceFromVersionEx function diff --git a/docs/core/unmanaged-api/debugging/createprocessforlaunch-function.md b/docs/core/unmanaged-api/debugging/createprocessforlaunch-function.md index 8ef7ad3073c8f..032e826535ac8 100644 --- a/docs/core/unmanaged-api/debugging/createprocessforlaunch-function.md +++ b/docs/core/unmanaged-api/debugging/createprocessforlaunch-function.md @@ -14,7 +14,6 @@ helpviewer_keywords: - "debugging API [.NET Core]" - ".NET Core, debugging" - "CreateProcessForLaunch function" -ms.assetid: 3d2fe9bd-75ef-4364-84a6-da1e1994ac1a topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/createversionstringfrommodule-function.md b/docs/core/unmanaged-api/debugging/createversionstringfrommodule-function.md index 601e31e08df1b..d98510033d2a4 100644 --- a/docs/core/unmanaged-api/debugging/createversionstringfrommodule-function.md +++ b/docs/core/unmanaged-api/debugging/createversionstringfrommodule-function.md @@ -14,7 +14,6 @@ helpviewer_keywords: - "debugging API [.NET Core]" - ".NET Core, debugging" - "CreateVersionStringFromModule function" -ms.assetid: 3d2fe9bd-75ef-4364-84a6-da1e1994ac1a topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/enumerateclrs-function.md b/docs/core/unmanaged-api/debugging/enumerateclrs-function.md index ee75921ba3397..5f2b3e0188ca6 100644 --- a/docs/core/unmanaged-api/debugging/enumerateclrs-function.md +++ b/docs/core/unmanaged-api/debugging/enumerateclrs-function.md @@ -14,7 +14,6 @@ helpviewer_keywords: - "debugging API [.NET Core]" - ".NET Core, debugging" - "EnumerateCLRs function" -ms.assetid: f8d50cb3-ec4f-4529-8fe3-bd61fd28e13c topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/getstartupnotificationevent-function.md b/docs/core/unmanaged-api/debugging/getstartupnotificationevent-function.md index 94da414126f05..61d2e58e1663f 100644 --- a/docs/core/unmanaged-api/debugging/getstartupnotificationevent-function.md +++ b/docs/core/unmanaged-api/debugging/getstartupnotificationevent-function.md @@ -12,7 +12,6 @@ helpviewer_keywords: - "GetStartupNotificationEvent function" - "debugging API [.NET Core]" - ".NET Core, debugging" -ms.assetid: c94b1b61-045a-4695-bacd-0f18c5acc246 topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider2-interface.md b/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider2-interface.md index 4b291250f2cda..0bd13c69431de 100644 --- a/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider2-interface.md +++ b/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider2-interface.md @@ -14,7 +14,6 @@ f1_keywords: - "ICLRDebuggingLibraryProvider2" helpviewer_keywords: - "ICLRDebuggingLibraryProvider2 interface [.NET Core debugging]" -ms.assetid: 67739617-6add-41a9-9de5-a3200c3109ce topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider2-providelibrary2-method.md b/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider2-providelibrary2-method.md index e4187f9087acb..efac13be00166 100644 --- a/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider2-providelibrary2-method.md +++ b/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider2-providelibrary2-method.md @@ -15,7 +15,6 @@ f1_keywords: helpviewer_keywords: - "ProvideLibrary method [.NET Core debugging]" - "ICLRDebuggingLibraryProvider2::ProvideLibrary2 method [.NET Core debugging]" -ms.assetid: 86f06245-9517-49be-8d8c-ca5deaf34c02 topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-interface.md b/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-interface.md index 4e364341fb3ee..9491f155737ed 100644 --- a/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-interface.md +++ b/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-interface.md @@ -14,7 +14,6 @@ f1_keywords: - "ICLRDebuggingLibraryProvider3" helpviewer_keywords: - "ICLRDebuggingLibraryProvider3 interface [.NET Core debugging]" -ms.assetid: 67739617-6add-41a9-9de5-a3200c3109ce topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-provideunixlibrary-method.md b/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-provideunixlibrary-method.md index fbc1987fb5d7c..c6ff67be7d0dc 100644 --- a/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-provideunixlibrary-method.md +++ b/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-provideunixlibrary-method.md @@ -15,7 +15,6 @@ f1_keywords: helpviewer_keywords: - "ProvideUnixLibrary method [.NET Core debugging]" - "ICLRDebuggingLibraryProvider3::ProvideUnixLibrary method [.NET Core debugging]" -ms.assetid: 86f06245-9517-49be-8d8c-ca5deaf34c02 topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-providewindowslibrary-method.md b/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-providewindowslibrary-method.md index 0577ba35a7973..8e1ce7652f2b8 100644 --- a/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-providewindowslibrary-method.md +++ b/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-providewindowslibrary-method.md @@ -15,7 +15,6 @@ f1_keywords: helpviewer_keywords: - "ProvideWindowsLibrary method [.NET Core debugging]" - "ICLRDebuggingLibraryProvider3::ProvideWindowsLibrary method [.NET Core debugging]" -ms.assetid: 86f06245-9517-49be-8d8c-ca5deaf34c02 topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/libraryproviderindextype-enumeration.md b/docs/core/unmanaged-api/debugging/libraryproviderindextype-enumeration.md index e0e69221de8d9..b388cb396fcd2 100644 --- a/docs/core/unmanaged-api/debugging/libraryproviderindextype-enumeration.md +++ b/docs/core/unmanaged-api/debugging/libraryproviderindextype-enumeration.md @@ -14,7 +14,6 @@ f1_keywords: - "LIBRARY_PROVIDER_INDEX_TYPE" helpviewer_keywords: - "LIBRARY_PROVIDER_INDEX_TYPE enumeration [.NET Core debugging]" -ms.assetid: a6ac2531-ddfe-46fd-88fe-8b1eabe0b255 topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/registerforruntimestartup-function.md b/docs/core/unmanaged-api/debugging/registerforruntimestartup-function.md index 12742bef6bb37..40cc1eea4a040 100644 --- a/docs/core/unmanaged-api/debugging/registerforruntimestartup-function.md +++ b/docs/core/unmanaged-api/debugging/registerforruntimestartup-function.md @@ -12,7 +12,6 @@ helpviewer_keywords: - "RegisterForRuntimeStartup function" - "debugging API [.NET Core]" - ".NET Core, debugging" -ms.assetid: 35c7a18f-133a-4584-bd25-bb338568b0c6 --- # RegisterForRuntimeStartup function diff --git a/docs/core/unmanaged-api/debugging/registerforruntimestartup3-function.md b/docs/core/unmanaged-api/debugging/registerforruntimestartup3-function.md index 73e3be97716d5..6af963d7af686 100644 --- a/docs/core/unmanaged-api/debugging/registerforruntimestartup3-function.md +++ b/docs/core/unmanaged-api/debugging/registerforruntimestartup3-function.md @@ -12,7 +12,6 @@ helpviewer_keywords: - "RegisterForRuntimeStartup3 function" - "debugging API [.NET Core]" - ".NET Core, debugging" -ms.assetid: 35c7a18f-133a-4584-bd25-bb338568b0c6 --- # RegisterForRuntimeStartup3 function diff --git a/docs/core/unmanaged-api/debugging/registerforruntimestartupex-function.md b/docs/core/unmanaged-api/debugging/registerforruntimestartupex-function.md index 444c41ddff3fb..5ea49f0ec2843 100644 --- a/docs/core/unmanaged-api/debugging/registerforruntimestartupex-function.md +++ b/docs/core/unmanaged-api/debugging/registerforruntimestartupex-function.md @@ -12,7 +12,6 @@ helpviewer_keywords: - "RegisterForRuntimeStartupEx function" - "debugging API [.NET Core]" - ".NET Core, debugging" -ms.assetid: 35c7a18f-133a-4584-bd25-bb338568b0c6 --- # RegisterForRuntimeStartupEx function diff --git a/docs/core/unmanaged-api/debugging/resumeprocess-function.md b/docs/core/unmanaged-api/debugging/resumeprocess-function.md index d803b3fa6503b..0707c4663e975 100644 --- a/docs/core/unmanaged-api/debugging/resumeprocess-function.md +++ b/docs/core/unmanaged-api/debugging/resumeprocess-function.md @@ -14,7 +14,6 @@ helpviewer_keywords: - "debugging API [.NET Core]" - ".NET Core, debugging" - "ResumeProcess function" -ms.assetid: 5e3c3958-80bb-43b1-a96b-dd3e6dbd9cd7 topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/unregisterforruntimestartup-function.md b/docs/core/unmanaged-api/debugging/unregisterforruntimestartup-function.md index 5a8267a0354ff..c7922ee469a84 100644 --- a/docs/core/unmanaged-api/debugging/unregisterforruntimestartup-function.md +++ b/docs/core/unmanaged-api/debugging/unregisterforruntimestartup-function.md @@ -12,7 +12,6 @@ helpviewer_keywords: - "UnregisterForRuntimeStartup function" - "debugging API [.NET Core]" - ".NET Core, debugging" -ms.assetid: 35c7a18f-133a-4584-bd25-bb338568b0c6 --- # UnregisterForRuntimeStartup function diff --git a/docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md b/docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md index b8f3b61aa7777..b3127b7435294 100644 --- a/docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md +++ b/docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md @@ -2,58 +2,57 @@ description: "Learn more about: AssemblyBindInfo Structure" title: "AssemblyBindInfo Structure" ms.date: "03/30/2017" -api_name: +api_name: - "AssemblyBindInfo" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "AssemblyBindInfo" -helpviewer_keywords: +helpviewer_keywords: - "AssemblyBindInfo structure [.NET Framework hosting]" -ms.assetid: 6fc01e98-c2e7-49de-ab9f-95937cc89017 -topic_type: +topic_type: - "apiref" --- # AssemblyBindInfo Structure -Provides detailed information about the referenced assembly. - -## Syntax - -```cpp -typedef struct _AssemblyBindInfo { - DWORD dwAppDomainId; - LPCWSTR lpReferencedIdentity; - LPCWSTR lpPostPolicyIdentity; - DWORD ePolicyLevel; -} AssemblyBindInfo; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`dwAppDomainId`|A unique identifier for the `IStream` returned by a call to [IHostAssemblyStore::ProvideAssembly](ihostassemblystore-provideassembly-method.md), from which the referenced assembly is to be loaded.| -|`lpReferencedIdentity`|A unique identifier for the referenced assembly.| -|`lpPostPolicyIdentity`|The identifier for the referenced assembly after the application of any binding policy values.| -|`ePolicyLevel`|One of the [EPolicyAction](epolicyaction-enumeration.md) values that indicate which versioning policies, if any, should be applied to the referenced assembly.| - -## Remarks +Provides detailed information about the referenced assembly. - The host supplies the unique identifier `dwAppDomainId` to the common language runtime (CLR). After a call to `IHostAssemblyStore::ProvideAssembly` returns, the runtime uses the identifier to determine whether the contents of the `IStream` have been mapped. If so, the runtime loads the existing copy rather than remapping the stream. The runtime also uses this identifier as a lookup key for streams returned from calls to [IHostAssemblyStore::ProvideModule](ihostassemblystore-providemodule-method.md). Therefore, the identifier must be unique for module requests and for assembly requests. - -## Requirements +## Syntax + +```cpp +typedef struct _AssemblyBindInfo { + DWORD dwAppDomainId; + LPCWSTR lpReferencedIdentity; + LPCWSTR lpPostPolicyIdentity; + DWORD ePolicyLevel; +} AssemblyBindInfo; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`dwAppDomainId`|A unique identifier for the `IStream` returned by a call to [IHostAssemblyStore::ProvideAssembly](ihostassemblystore-provideassembly-method.md), from which the referenced assembly is to be loaded.| +|`lpReferencedIdentity`|A unique identifier for the referenced assembly.| +|`lpPostPolicyIdentity`|The identifier for the referenced assembly after the application of any binding policy values.| +|`ePolicyLevel`|One of the [EPolicyAction](epolicyaction-enumeration.md) values that indicate which versioning policies, if any, should be applied to the referenced assembly.| + +## Remarks + + The host supplies the unique identifier `dwAppDomainId` to the common language runtime (CLR). After a call to `IHostAssemblyStore::ProvideAssembly` returns, the runtime uses the identifier to determine whether the contents of the `IStream` have been mapped. If so, the runtime loads the existing copy rather than remapping the stream. The runtime also uses this identifier as a lookup key for streams returned from calls to [IHostAssemblyStore::ProvideModule](ihostassemblystore-providemodule-method.md). Therefore, the identifier must be unique for module requests and for assembly requests. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.idl + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.idl - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - ## See also - [Hosting Structures](hosting-structures.md) diff --git a/docs/core/unmanaged-api/hosting/bucketparameters-structure.md b/docs/core/unmanaged-api/hosting/bucketparameters-structure.md index 98ff600b1ddd1..af337396909b9 100644 --- a/docs/core/unmanaged-api/hosting/bucketparameters-structure.md +++ b/docs/core/unmanaged-api/hosting/bucketparameters-structure.md @@ -2,50 +2,49 @@ description: "Learn more about: BucketParameters Structure" title: "BucketParameters Structure" ms.date: "03/30/2017" -api_name: +api_name: - "BucketParameters" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "BucketParameters" -helpviewer_keywords: +helpviewer_keywords: - "BucketParameters structure [.NET Framework hosting]" -ms.assetid: 9432487e-f276-45d6-9a13-9a68024dbd46 -topic_type: +topic_type: - "apiref" --- # BucketParameters Structure -Stores the type name of an event and the parameters for the current exception that is associated with the event. - -## Syntax - -```cpp -typedef struct _BucketParameters { +Stores the type name of an event and the parameters for the current exception that is associated with the event. + +## Syntax + +```cpp +typedef struct _BucketParameters { BOOL fInited; WCHAR pszEventTypeName[255]; WCHAR pszParams[10][255]; -} BucketParameters; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`fInited`|`true`, if the rest of this structure is valid; otherwise, `false`.| -|`pszEventTypeName`|Name of the event type.| -|`pszParams`|An array of strings, each of which specifies a parameter for the current exception associated with the event.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.idl - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +} BucketParameters; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`fInited`|`true`, if the rest of this structure is valid; otherwise, `false`.| +|`pszEventTypeName`|Name of the event type.| +|`pszParams`|An array of strings, each of which specifies a parameter for the current exception associated with the event.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.idl + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Hosting Structures](hosting-structures.md) diff --git a/docs/core/unmanaged-api/hosting/callfunctionshim-function.md b/docs/core/unmanaged-api/hosting/callfunctionshim-function.md index 4f9843dd55798..c7ddccc7376c2 100644 --- a/docs/core/unmanaged-api/hosting/callfunctionshim-function.md +++ b/docs/core/unmanaged-api/hosting/callfunctionshim-function.md @@ -2,69 +2,68 @@ description: "Learn more about: CallFunctionShim Function" title: "CallFunctionShim Function" ms.date: "03/30/2017" -api_name: +api_name: - "CallFunctionShim" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "CallFunctionShim" -helpviewer_keywords: +helpviewer_keywords: - "CallfunctionShim function [.NET Framework hosting]" -ms.assetid: 37118465-ddf3-41f0-bf27-335b72777e63 -topic_type: +topic_type: - "apiref" --- # CallFunctionShim Function -Makes a call to the function that has the specified name and parameters in the specified library. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT CallFunctionShim ( - [in] LPCWSTR szDllName, - [in] LPCSTR szFunctionName, - [in] LPVOID lpvArgument1, - [in] LPVOID lpvArgument2, - [in] LPCWSTR szVersion, - [in] LPVOID pvReserved -); -``` - -## Parameters - - `szDllName` - [in] The name of the library containing the function. - - `szFunctionName` - [in] The name of the function. - - `lpvArgument1` - [in] The first argument to pass to the function. - - `lpvArgument2` - [in] The second argument to pass to the function. - - `szVersion` - [in] The version of the library that contains the function. - - `pvReserved` - [in] Reserved for future use. Pass zero in this parameter. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Makes a call to the function that has the specified name and parameters in the specified library. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT CallFunctionShim ( + [in] LPCWSTR szDllName, + [in] LPCSTR szFunctionName, + [in] LPVOID lpvArgument1, + [in] LPVOID lpvArgument2, + [in] LPCWSTR szVersion, + [in] LPVOID pvReserved +); +``` + +## Parameters + + `szDllName` + [in] The name of the library containing the function. + + `szFunctionName` + [in] The name of the function. + + `lpvArgument1` + [in] The first argument to pass to the function. + + `lpvArgument2` + [in] The second argument to pass to the function. + + `szVersion` + [in] The version of the library that contains the function. + + `pvReserved` + [in] Reserved for future use. Pass zero in this parameter. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md b/docs/core/unmanaged-api/hosting/clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md index fb742e2519859..66101f02a45a1 100644 --- a/docs/core/unmanaged-api/hosting/clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md +++ b/docs/core/unmanaged-api/hosting/clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md @@ -2,60 +2,59 @@ description: "Learn more about: CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5" title: "CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - "hosting interfaces [.NET Framework], version 4" - ".NET Framework 4, hosting interfaces" - "interfaces [.NET Framework hosting], version 4" -ms.assetid: f6af6116-f5b0-4bda-a276-fffdba70893d --- # CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5 -This section describes interfaces that unmanaged hosts can use to integrate the common language runtime (CLR) in the .NET Framework 4, .NET Framework 4.5, and later versions into their applications. These interfaces provide methods for a host to configure and load the runtime into a process. - - Starting with the .NET Framework 4, all hosting interfaces have the following characteristics: - -- They use lifetime management (`AddRef` and `Release`), encapsulation (implicit context) and `QueryInterface` from COM. - -- They do not use COM types such as `BSTR`, `SAFEARRAY`, or `VARIANT`. - -- There are no apartment models, aggregation, or registry activation that use the [CoCreateInstance function](/windows/win32/api/combaseapi/nf-combaseapi-cocreateinstance). - -## In This Section - - [ICLRAppDomainResourceMonitor Interface](iclrappdomainresourcemonitor-interface.md) - Provides methods that inspect an application domain's memory and CPU usage. - - [ICLRDomainManager Interface](iclrdomainmanager-interface.md) - Enables the host to specify the application domain manager that will be used to initialize the default application domain, and to specify initialization properties. - - [ICLRGCManager2 Interface](iclrgcmanager2-interface.md) - Provides the [SetGCStartupLimitsEx](iclrgcmanager2-setgcstartuplimitsex-method.md) method, which enables a host to set the size of the garbage collection segment and the maximum size of the garbage collection system's generation 0 to values greater than `DWORD`. - - [ICLRMetaHost Interface](iclrmetahost-interface.md) - Provides methods that return a specific version of the CLR, list all installed CLRs, list all in-process runtimes, return the activation interface, and discover the CLR version used to compile an assembly. - - [ICLRMetaHostPolicy Interface](iclrmetahostpolicy-interface.md) - Provides the [GetRequestedRuntime](iclrmetahostpolicy-getrequestedruntime-method.md) method that provides a CLR interface based on policy criteria, managed assembly, version, and configuration file. - - [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) - Provides methods that return information about a specific runtime, including version, directory, and load status. - - [ICLRStrongName Interface](iclrstrongname-interface.md) - Provides basic global static functions for signing assemblies with strong names. All the [ICLRStrongName](iclrstrongname-interface.md) methods return standard COM HRESULTs. - - [ICLRStrongName2 Interface](iclrstrongname2-interface.md) - Provides the ability to create strong names using the SHA-2 group of Secure Hash Algorithms (SHA-256, SHA-384, and SHA-512). - - [ICLRTask2 Interface](iclrtask2-interface.md) - Provides all the functionality of the [ICLRTask Interface](iclrtask-interface.md); in addition, provides methods that allow thread aborts to be delayed on the current thread. - -## Related Sections - - [Deprecated CLR Hosting Interfaces and Coclasses](deprecated-clr-hosting-interfaces-and-coclasses.md) - Describes the hosting interfaces provided with the .NET Framework versions 1.0 and 1.1. - - [CLR Hosting Interfaces](clr-hosting-interfaces.md) - Describes the hosting interfaces provided with the .NET Framework versions 2.0, 3.0, and 3.5. - - [Hosting](index.md) +This section describes interfaces that unmanaged hosts can use to integrate the common language runtime (CLR) in the .NET Framework 4, .NET Framework 4.5, and later versions into their applications. These interfaces provide methods for a host to configure and load the runtime into a process. + + Starting with the .NET Framework 4, all hosting interfaces have the following characteristics: + +- They use lifetime management (`AddRef` and `Release`), encapsulation (implicit context) and `QueryInterface` from COM. + +- They do not use COM types such as `BSTR`, `SAFEARRAY`, or `VARIANT`. + +- There are no apartment models, aggregation, or registry activation that use the [CoCreateInstance function](/windows/win32/api/combaseapi/nf-combaseapi-cocreateinstance). + +## In This Section + + [ICLRAppDomainResourceMonitor Interface](iclrappdomainresourcemonitor-interface.md) + Provides methods that inspect an application domain's memory and CPU usage. + + [ICLRDomainManager Interface](iclrdomainmanager-interface.md) + Enables the host to specify the application domain manager that will be used to initialize the default application domain, and to specify initialization properties. + + [ICLRGCManager2 Interface](iclrgcmanager2-interface.md) + Provides the [SetGCStartupLimitsEx](iclrgcmanager2-setgcstartuplimitsex-method.md) method, which enables a host to set the size of the garbage collection segment and the maximum size of the garbage collection system's generation 0 to values greater than `DWORD`. + + [ICLRMetaHost Interface](iclrmetahost-interface.md) + Provides methods that return a specific version of the CLR, list all installed CLRs, list all in-process runtimes, return the activation interface, and discover the CLR version used to compile an assembly. + + [ICLRMetaHostPolicy Interface](iclrmetahostpolicy-interface.md) + Provides the [GetRequestedRuntime](iclrmetahostpolicy-getrequestedruntime-method.md) method that provides a CLR interface based on policy criteria, managed assembly, version, and configuration file. + + [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) + Provides methods that return information about a specific runtime, including version, directory, and load status. + + [ICLRStrongName Interface](iclrstrongname-interface.md) + Provides basic global static functions for signing assemblies with strong names. All the [ICLRStrongName](iclrstrongname-interface.md) methods return standard COM HRESULTs. + + [ICLRStrongName2 Interface](iclrstrongname2-interface.md) + Provides the ability to create strong names using the SHA-2 group of Secure Hash Algorithms (SHA-256, SHA-384, and SHA-512). + + [ICLRTask2 Interface](iclrtask2-interface.md) + Provides all the functionality of the [ICLRTask Interface](iclrtask-interface.md); in addition, provides methods that allow thread aborts to be delayed on the current thread. + +## Related Sections + + [Deprecated CLR Hosting Interfaces and Coclasses](deprecated-clr-hosting-interfaces-and-coclasses.md) + Describes the hosting interfaces provided with the .NET Framework versions 1.0 and 1.1. + + [CLR Hosting Interfaces](clr-hosting-interfaces.md) + Describes the hosting interfaces provided with the .NET Framework versions 2.0, 3.0, and 3.5. + + [Hosting](index.md) Introduces hosting in the .NET Framework. diff --git a/docs/core/unmanaged-api/hosting/clr-hosting-interfaces.md b/docs/core/unmanaged-api/hosting/clr-hosting-interfaces.md index 842da1be4ba10..04833614f9066 100644 --- a/docs/core/unmanaged-api/hosting/clr-hosting-interfaces.md +++ b/docs/core/unmanaged-api/hosting/clr-hosting-interfaces.md @@ -2,189 +2,188 @@ description: "Learn more about: CLR Hosting Interfaces" title: "CLR Hosting Interfaces" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - "interfaces [.NET Framework hosting], version 2.0" - "hosting interfaces [.NET Framework], version 2.0" - ".NET Framework 2.0, hosting interfaces" -ms.assetid: 703b8381-43db-4a4d-9faa-cca39302d922 --- # CLR Hosting Interfaces -This section describes the interfaces that unmanaged hosts can use to integrate the common language runtime (CLR) into their applications. The information pertains to the .NET Framework version 2.0 and later versions. These interfaces enable the host to control many more aspects of the runtime than was possible in versions 1.0 and 1.1, and provide much tighter integration between the CLR and the host's execution model. - - In the .NET Framework version 1.0 and 1.1, the hosting model enabled an unmanaged host to load the CLR into a process, to configure certain settings, and to receive event notifications. However, in general, the host and the CLR ran independently in that process. In the .NET Framework version 2.0 and later versions, new layers of abstraction let the host provide many of the resources currently provided by the types in the Win32 assembly, and extend the set of capabilities that the host can configure. - -## In This Section - - [IActionOnCLREvent Interface](iactiononclrevent-interface.md) - Provides a method that performs a callback for a registered event. - - [IApartmentCallback Interface](iapartmentcallback-interface.md) - Provides methods for making callbacks within an apartment. - - [IAppDomainBinding Interface](iappdomainbinding-interface.md) - Provides methods for setting run-time configuration. - - [ICatalogServices Interface](icatalogservices-interface.md) - Provides methods for cataloging services. (This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code.) - - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) - Provides methods that support communication between the host and the CLR about assemblies. - - [ICLRAssemblyReferenceList Interface](iclrassemblyreferencelist-interface.md) - Manages a list of assemblies that are loaded by the CLR and not by the host. - - [ICLRControl Interface](iclrcontrol-interface.md) - Provides methods for the host to gain access to, and configure various aspects of, the CLR. - - [ICLRDebugManager Interface](iclrdebugmanager-interface.md) - Provides methods that enable a host to associate a set of tasks with an identifier and a friendly name. - - [ICLRErrorReportingManager Interface](iclrerrorreportingmanager-interface.md) - Provides methods that enable the host to configure custom heap dumps for error reporting. - - [ICLRGCManager Interface](iclrgcmanager-interface.md) - Provides methods that enable a host to interact with the CLR's garbage collection system. - - [ICLRHostBindingPolicyManager Interface](iclrhostbindingpolicymanager-interface.md) - Provides methods for the host to evaluate and communicate changes in policy information for assemblies. - - [ICLRHostProtectionManager Interface](iclrhostprotectionmanager-interface.md) - Enables the host to block specific managed classes, methods, properties, and fields from running in partially trusted code. - - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) - Implements a callback method that enables the host to notify the CLR of the status of specified I/O requests. - - [ICLRMemoryNotificationCallback Interface](iclrmemorynotificationcallback-interface.md) - Enables the host to report memory pressure conditions using an approach similar to that of the Win32 `CreateMemoryResourceNotification` function. - - [ICLROnEventManager Interface](iclroneventmanager-interface.md) - Provides methods that enable the host to register and unregister callbacks for CLR events. - - [ICLRPolicyManager Interface](iclrpolicymanager-interface.md) - Provides methods that enable the host to specify policy actions to be taken in the event of failures and timeouts. - - [ICLRProbingAssemblyEnum Interface](iclrprobingassemblyenum-interface.md) - Provides methods that enable the host to get the probing identities of an assembly by using the assembly's identity information that is internal to the CLR, without needing to create or understand that identity. - - [ICLRReferenceAssemblyEnum Interface](iclrreferenceassemblyenum-interface.md) - Provides methods that enable the host to manipulate the set of assemblies referenced by a file or stream using assembly identity data that is internal to the CLR, without needing to create or understand those identities. - - [ICLRRuntimeHost Interface](iclrruntimehost-interface.md) - Provides capabilities similar to [ICorRuntimeHost](icorruntimehost-interface.md), with an additional method to set the host control interface. - - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) - Provides methods for the host to get information about requested tasks and to detect deadlocks in its synchronization implementation. - - [ICLRTask Interface](iclrtask-interface.md) - Provides methods that enable the host to make requests of the CLR, or to provide notification to the CLR about the associated task. - - [ICLRTaskManager Interface](iclrtaskmanager-interface.md) - Provides methods that enable the host to request explicitly that the CLR create a new task, get the currently executing task, and set the geographic language and culture for the task. - - [ICLRValidator Interface](iclrvalidator-interface.md) - Provides methods for validating portable executable (PE) images and reporting validation errors. - - [ICorConfiguration Interface](icorconfiguration-interface.md) - Provides methods for configuring the CLR. - - [ICorThreadpool Interface](icorthreadpool-interface.md) - Provides methods for accessing the thread pool. - - [IDebuggerInfo Interface](idebuggerinfo-interface.md) - Provides methods for obtaining information about the state of the debugging services. - - [IDebuggerThreadControl Interface](idebuggerthreadcontrol-interface.md) - Provides methods for notifying the host about the blocking and unblocking of threads by the debugging services. - - [IGCHost Interface](igchost-interface.md) - Provides methods for obtaining information about the garbage collection system and for controlling some aspects of garbage collection. - - [IGCHost2 Interface](igchost2-interface.md) - Provides the [SetGCStartupLimitsEx](igchost2-setgcstartuplimitsex-method.md) method that enables a host to set the size of the garbage collection segment and the maximum size of the garbage collection system's generation zero to values greater than `DWORD`. - - [IGCHostControl Interface](igchostcontrol-interface.md) - Provides a method that enables the garbage collector to request the host to change the limits of virtual memory. - - [IGCThreadControl Interface](igcthreadcontrol-interface.md) - Provides methods for participating in the scheduling of threads that would otherwise be blocked for garbage collection. - - [IHostAssemblyManager Interface](ihostassemblymanager-interface.md) - Provides methods that enable a host to specify sets of assemblies that should be loaded by the CLR or by the host. - - [IHostAssemblyStore Interface](ihostassemblystore-interface.md) - Provides methods that enable a host to load assemblies and modules independently of the CLR. - - [IHostAutoEvent Interface](ihostautoevent-interface.md) - Provides a representation of an auto-reset event implemented by the host. - - [IHostControl Interface](ihostcontrol-interface.md) - Provides methods for configuring the loading of assemblies, and for determining which hosting interfaces the host supports. - - [IHostCrst Interface](ihostcrst-interface.md) - Serves as the host's representation of a critical section for threading. - - [IHostGCManager Interface](ihostgcmanager-interface.md) - Provides methods that notify the host of events in the garbage collection mechanism implemented by the CLR. - - [IHostIoCompletionManager Interface](ihostiocompletionmanager-interface.md) - Provides methods that enable the CLR to interact with I/O completion ports provided by the host. - - [IHostMalloc Interface](ihostmalloc-interface.md) - Provides methods for the CLR to request fine-grained allocations from the heap through the host. - - [IHostManualEvent Interface](ihostmanualevent-interface.md) - Provides the host's implementation of a representation of a manual reset event. - - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) - Provides methods for the CLR to make virtual memory requests through the host, instead of using the standard Win32 virtual memory functions. - - [IHostPolicyManager Interface](ihostpolicymanager-interface.md) - Provides methods that notify the host of the actions the CLR performs in case of aborts, timeouts, or failures. - - [IHostSecurityContext Interface](ihostsecuritycontext-interface.md) - Enables the CLR to maintain security context information implemented by the host. - - [IHostSecurityManager Interface](ihostsecuritymanager-interface.md) - Provides methods that enable access to, and control over, the security context of the currently executing thread. - - [IHostSemaphore Interface](ihostsemaphore-interface.md) - Provides a representation of a semaphore implemented by the host. - - [IHostSyncManager Interface](ihostsyncmanager-interface.md) - Provides methods for the CLR to create synchronization primitives by calling the host, instead of using the Win32 synchronization functions. - - [IHostTask Interface](ihosttask-interface.md) - Provides methods that enable the CLR to communicate with the host to manage tasks. - - [IHostTaskManager Interface](ihosttaskmanager-interface.md) - Provides methods that enable the CLR to work with tasks through the host instead of using the standard operating system threading or fiber functions. - - [IHostThreadPoolManager Interface](ihostthreadpoolmanager-interface.md) - Provides methods for the CLR to configure the thread pool and to queue work items to the thread pool. - - [IManagedObject Interface](imanagedobject-interface.md) - Provides methods for controlling a managed object. - - "IObjectHandle" - Provides a method for unwrapping marshal-by-value objects from indirection. - - [ITypeName Interface](itypename-interface.md) - Provides methods for obtaining type name information. (This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code.) - - [ITypeNameBuilder Interface](itypenamebuilder-interface.md) - Provides methods for building a type name. (This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code.) - - [ITypeNameFactory Interface](itypenamefactory-interface.md) - Provides methods for deconstructing a type name. (This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code.) - - "IValidator" - Provides methods for validating portable executable (PE) images and reporting validation errors. - -## Related Sections - - [Deprecated CLR Hosting Interfaces and Coclasses](deprecated-clr-hosting-interfaces-and-coclasses.md) - Contains topics that describe the hosting interfaces provided in the .NET Framework version 1.0 and 1.1. - - [CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5](clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md) +This section describes the interfaces that unmanaged hosts can use to integrate the common language runtime (CLR) into their applications. The information pertains to the .NET Framework version 2.0 and later versions. These interfaces enable the host to control many more aspects of the runtime than was possible in versions 1.0 and 1.1, and provide much tighter integration between the CLR and the host's execution model. + + In the .NET Framework version 1.0 and 1.1, the hosting model enabled an unmanaged host to load the CLR into a process, to configure certain settings, and to receive event notifications. However, in general, the host and the CLR ran independently in that process. In the .NET Framework version 2.0 and later versions, new layers of abstraction let the host provide many of the resources currently provided by the types in the Win32 assembly, and extend the set of capabilities that the host can configure. + +## In This Section + + [IActionOnCLREvent Interface](iactiononclrevent-interface.md) + Provides a method that performs a callback for a registered event. + + [IApartmentCallback Interface](iapartmentcallback-interface.md) + Provides methods for making callbacks within an apartment. + + [IAppDomainBinding Interface](iappdomainbinding-interface.md) + Provides methods for setting run-time configuration. + + [ICatalogServices Interface](icatalogservices-interface.md) + Provides methods for cataloging services. (This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code.) + + [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) + Provides methods that support communication between the host and the CLR about assemblies. + + [ICLRAssemblyReferenceList Interface](iclrassemblyreferencelist-interface.md) + Manages a list of assemblies that are loaded by the CLR and not by the host. + + [ICLRControl Interface](iclrcontrol-interface.md) + Provides methods for the host to gain access to, and configure various aspects of, the CLR. + + [ICLRDebugManager Interface](iclrdebugmanager-interface.md) + Provides methods that enable a host to associate a set of tasks with an identifier and a friendly name. + + [ICLRErrorReportingManager Interface](iclrerrorreportingmanager-interface.md) + Provides methods that enable the host to configure custom heap dumps for error reporting. + + [ICLRGCManager Interface](iclrgcmanager-interface.md) + Provides methods that enable a host to interact with the CLR's garbage collection system. + + [ICLRHostBindingPolicyManager Interface](iclrhostbindingpolicymanager-interface.md) + Provides methods for the host to evaluate and communicate changes in policy information for assemblies. + + [ICLRHostProtectionManager Interface](iclrhostprotectionmanager-interface.md) + Enables the host to block specific managed classes, methods, properties, and fields from running in partially trusted code. + + [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) + Implements a callback method that enables the host to notify the CLR of the status of specified I/O requests. + + [ICLRMemoryNotificationCallback Interface](iclrmemorynotificationcallback-interface.md) + Enables the host to report memory pressure conditions using an approach similar to that of the Win32 `CreateMemoryResourceNotification` function. + + [ICLROnEventManager Interface](iclroneventmanager-interface.md) + Provides methods that enable the host to register and unregister callbacks for CLR events. + + [ICLRPolicyManager Interface](iclrpolicymanager-interface.md) + Provides methods that enable the host to specify policy actions to be taken in the event of failures and timeouts. + + [ICLRProbingAssemblyEnum Interface](iclrprobingassemblyenum-interface.md) + Provides methods that enable the host to get the probing identities of an assembly by using the assembly's identity information that is internal to the CLR, without needing to create or understand that identity. + + [ICLRReferenceAssemblyEnum Interface](iclrreferenceassemblyenum-interface.md) + Provides methods that enable the host to manipulate the set of assemblies referenced by a file or stream using assembly identity data that is internal to the CLR, without needing to create or understand those identities. + + [ICLRRuntimeHost Interface](iclrruntimehost-interface.md) + Provides capabilities similar to [ICorRuntimeHost](icorruntimehost-interface.md), with an additional method to set the host control interface. + + [ICLRSyncManager Interface](iclrsyncmanager-interface.md) + Provides methods for the host to get information about requested tasks and to detect deadlocks in its synchronization implementation. + + [ICLRTask Interface](iclrtask-interface.md) + Provides methods that enable the host to make requests of the CLR, or to provide notification to the CLR about the associated task. + + [ICLRTaskManager Interface](iclrtaskmanager-interface.md) + Provides methods that enable the host to request explicitly that the CLR create a new task, get the currently executing task, and set the geographic language and culture for the task. + + [ICLRValidator Interface](iclrvalidator-interface.md) + Provides methods for validating portable executable (PE) images and reporting validation errors. + + [ICorConfiguration Interface](icorconfiguration-interface.md) + Provides methods for configuring the CLR. + + [ICorThreadpool Interface](icorthreadpool-interface.md) + Provides methods for accessing the thread pool. + + [IDebuggerInfo Interface](idebuggerinfo-interface.md) + Provides methods for obtaining information about the state of the debugging services. + + [IDebuggerThreadControl Interface](idebuggerthreadcontrol-interface.md) + Provides methods for notifying the host about the blocking and unblocking of threads by the debugging services. + + [IGCHost Interface](igchost-interface.md) + Provides methods for obtaining information about the garbage collection system and for controlling some aspects of garbage collection. + + [IGCHost2 Interface](igchost2-interface.md) + Provides the [SetGCStartupLimitsEx](igchost2-setgcstartuplimitsex-method.md) method that enables a host to set the size of the garbage collection segment and the maximum size of the garbage collection system's generation zero to values greater than `DWORD`. + + [IGCHostControl Interface](igchostcontrol-interface.md) + Provides a method that enables the garbage collector to request the host to change the limits of virtual memory. + + [IGCThreadControl Interface](igcthreadcontrol-interface.md) + Provides methods for participating in the scheduling of threads that would otherwise be blocked for garbage collection. + + [IHostAssemblyManager Interface](ihostassemblymanager-interface.md) + Provides methods that enable a host to specify sets of assemblies that should be loaded by the CLR or by the host. + + [IHostAssemblyStore Interface](ihostassemblystore-interface.md) + Provides methods that enable a host to load assemblies and modules independently of the CLR. + + [IHostAutoEvent Interface](ihostautoevent-interface.md) + Provides a representation of an auto-reset event implemented by the host. + + [IHostControl Interface](ihostcontrol-interface.md) + Provides methods for configuring the loading of assemblies, and for determining which hosting interfaces the host supports. + + [IHostCrst Interface](ihostcrst-interface.md) + Serves as the host's representation of a critical section for threading. + + [IHostGCManager Interface](ihostgcmanager-interface.md) + Provides methods that notify the host of events in the garbage collection mechanism implemented by the CLR. + + [IHostIoCompletionManager Interface](ihostiocompletionmanager-interface.md) + Provides methods that enable the CLR to interact with I/O completion ports provided by the host. + + [IHostMalloc Interface](ihostmalloc-interface.md) + Provides methods for the CLR to request fine-grained allocations from the heap through the host. + + [IHostManualEvent Interface](ihostmanualevent-interface.md) + Provides the host's implementation of a representation of a manual reset event. + + [IHostMemoryManager Interface](ihostmemorymanager-interface.md) + Provides methods for the CLR to make virtual memory requests through the host, instead of using the standard Win32 virtual memory functions. + + [IHostPolicyManager Interface](ihostpolicymanager-interface.md) + Provides methods that notify the host of the actions the CLR performs in case of aborts, timeouts, or failures. + + [IHostSecurityContext Interface](ihostsecuritycontext-interface.md) + Enables the CLR to maintain security context information implemented by the host. + + [IHostSecurityManager Interface](ihostsecuritymanager-interface.md) + Provides methods that enable access to, and control over, the security context of the currently executing thread. + + [IHostSemaphore Interface](ihostsemaphore-interface.md) + Provides a representation of a semaphore implemented by the host. + + [IHostSyncManager Interface](ihostsyncmanager-interface.md) + Provides methods for the CLR to create synchronization primitives by calling the host, instead of using the Win32 synchronization functions. + + [IHostTask Interface](ihosttask-interface.md) + Provides methods that enable the CLR to communicate with the host to manage tasks. + + [IHostTaskManager Interface](ihosttaskmanager-interface.md) + Provides methods that enable the CLR to work with tasks through the host instead of using the standard operating system threading or fiber functions. + + [IHostThreadPoolManager Interface](ihostthreadpoolmanager-interface.md) + Provides methods for the CLR to configure the thread pool and to queue work items to the thread pool. + + [IManagedObject Interface](imanagedobject-interface.md) + Provides methods for controlling a managed object. + + "IObjectHandle" + Provides a method for unwrapping marshal-by-value objects from indirection. + + [ITypeName Interface](itypename-interface.md) + Provides methods for obtaining type name information. (This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code.) + + [ITypeNameBuilder Interface](itypenamebuilder-interface.md) + Provides methods for building a type name. (This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code.) + + [ITypeNameFactory Interface](itypenamefactory-interface.md) + Provides methods for deconstructing a type name. (This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code.) + + "IValidator" + Provides methods for validating portable executable (PE) images and reporting validation errors. + +## Related Sections + + [Deprecated CLR Hosting Interfaces and Coclasses](deprecated-clr-hosting-interfaces-and-coclasses.md) + Contains topics that describe the hosting interfaces provided in the .NET Framework version 1.0 and 1.1. + + [CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5](clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md) Contains topics that describe the hosting interfaces provided in the .NET Framework 4. diff --git a/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md b/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md index 9a36bef39a805..25e1bb3f18af4 100644 --- a/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md +++ b/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md @@ -16,7 +16,6 @@ f1_keywords: helpviewer_keywords: - "CLRCreateInstance function [.NET Framework hosting]" - "CreateInterface function" -ms.assetid: 5de13327-96c6-4697-a89e-b8bf40717855 topic_type: - "apiref" --- @@ -101,7 +100,7 @@ hr = createInterface (CLSID_CLRDebugging, IID_ICLRDebugging, (LPVOID*)&pCLRDebu **Library:** Included as a resource in MSCorEE.dll - **.NET Framework Versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] ## See also diff --git a/docs/core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md b/docs/core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md index eaef7259a8b94..ff6eed095032b 100644 --- a/docs/core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md +++ b/docs/core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md @@ -2,65 +2,64 @@ description: "Learn more about: ClrCreateManagedInstance Function" title: "ClrCreateManagedInstance Function" ms.date: "03/30/2017" -api_name: +api_name: - "ClrCreateManagedInstance" -api_location: +api_location: - "mscoree.dll" - "clr.dll" - "mscorwks.dll" - "mscoreei.dll" - "mscorsvr.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "ClrCreateManagedInstance" -helpviewer_keywords: +helpviewer_keywords: - "ClrCreateManagedInstance function [.NET Framework hosting]" -ms.assetid: 58ba42c0-4857-43bf-a039-73a4dc6544c2 -topic_type: +topic_type: - "apiref" --- # ClrCreateManagedInstance Function -Creates an instance of the specified managed type. - - This function has been deprecated in the .NET Framework 4. Use COM activation to create an instance of the managed type, or use hosting (see [CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5](clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md)). - -## Syntax - -```cpp -STDAPI ClrCreateManagedInstance ( +Creates an instance of the specified managed type. + + This function has been deprecated in the .NET Framework 4. Use COM activation to create an instance of the managed type, or use hosting (see [CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5](clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md)). + +## Syntax + +```cpp +STDAPI ClrCreateManagedInstance ( [in] LPCWSTR pTypeName, [in] REFIID riid, - [out] void **ppObject -); -``` - -## Parameters - - `pTypeName` - [in] A pointer to the name of the instance type being requested. - - `riid` - [in] The `IID` of the instance type being requested. - - `ppObject` - [out] A pointer to a pointer to an instance of the managed type that was requested by the caller. - -## Remarks - - The common language runtime should already be loaded into a process. For example, it can be loaded by using a call to the [CorBindToRuntimeEx](corbindtoruntimeex-function.md) function before the `ClrCreateManagedInstance` function is called. If the runtime is not loaded, `ClrCreateManagedInstance` first tries to load v1.0.3705 of the runtime. If that fails, it attempts to load the latest version of the runtime. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] void **ppObject +); +``` + +## Parameters + + `pTypeName` + [in] A pointer to the name of the instance type being requested. + + `riid` + [in] The `IID` of the instance type being requested. + + `ppObject` + [out] A pointer to a pointer to an instance of the managed type that was requested by the caller. + +## Remarks + + The common language runtime should already be loaded into a process. For example, it can be loaded by using a call to the [CorBindToRuntimeEx](corbindtoruntimeex-function.md) function before the `ClrCreateManagedInstance` function is called. If the runtime is not loaded, `ClrCreateManagedInstance` first tries to load v1.0.3705 of the runtime. If that fails, it attempts to load the latest version of the runtime. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md b/docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md index b10e944ea5746..363b2607389f3 100644 --- a/docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md +++ b/docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md @@ -2,50 +2,49 @@ description: "Learn more about: CLRRuntimeHost Coclass" title: "CLRRuntimeHost Coclass" ms.date: "03/30/2017" -api_name: +api_name: - "CLRRuntimeHost Coclass" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CLRRuntimeHost" -helpviewer_keywords: +helpviewer_keywords: - "CLRRuntimeHost coclass [.NET Framework hosting]" -ms.assetid: 2ac9cbf5-8a2d-4e4f-8831-0dad8ef0a897 -topic_type: +topic_type: - "apiref" --- # CLRRuntimeHost Coclass -Provides interfaces for managing code execution by the runtime. - -## Syntax - -```cpp -coclass CLRRuntimeHost { - [default] interface ICLRRuntimeHost; - interface ICLRValidator; -}; -``` - -## Interfaces - -|Interface|Description| -|---------------|-----------------| -|[ICLRRuntimeHost Interface](iclrruntimehost-interface.md)|Provides methods for controlling the execution of applications by the runtime.| -|[ICLRValidator Interface](iclrvalidator-interface.md)|Provides methods for validation of portable executable images and for detailed reporting of validation errors.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.idl - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Provides interfaces for managing code execution by the runtime. + +## Syntax + +```cpp +coclass CLRRuntimeHost { + [default] interface ICLRRuntimeHost; + interface ICLRValidator; +}; +``` + +## Interfaces + +|Interface|Description| +|---------------|-----------------| +|[ICLRRuntimeHost Interface](iclrruntimehost-interface.md)|Provides methods for controlling the execution of applications by the runtime.| +|[ICLRValidator Interface](iclrvalidator-interface.md)|Provides methods for validation of portable executable images and for detailed reporting of validation errors.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.idl + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Hosting Coclasses](hosting-coclasses.md) diff --git a/docs/core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md b/docs/core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md index 1dd1685fcb1e3..29ae773e887c6 100644 --- a/docs/core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md @@ -2,48 +2,47 @@ description: "Learn more about: CLSID_RESOLUTION_FLAGS Enumeration" title: "CLSID_RESOLUTION_FLAGS Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CLSID_RESOLUTION_FLAGS" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CLSID_RESOLUTION_FLAGS" -helpviewer_keywords: +helpviewer_keywords: - "CLSID_RESOLUTION_FLAGS enumeration [.NET Framework hosting]" -ms.assetid: cd8b9879-962a-4811-aa46-2e2b6bae0d84 -topic_type: +topic_type: - "apiref" --- # CLSID_RESOLUTION_FLAGS Enumeration -Contains values that indicate how the common language runtime (CLR) should resolve a `CLSID`. - -## Syntax - -```cpp -typedef enum { - CLSID_RESOLUTION_DEFAULT = 0x0, - CLSID_RESOLUTION_REGISTERED = 0x1 -} CLSID_RESOLUTION_FLAGS; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`CLSID_RESOLUTION_DEFAULT`|Indicates the default behavior.| -|`CLSID_RESOLUTION_REGISTERED`|Indicates that the runtime searches the registry and applies shim policy.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] - +Contains values that indicate how the common language runtime (CLR) should resolve a `CLSID`. + +## Syntax + +```cpp +typedef enum { + CLSID_RESOLUTION_DEFAULT = 0x0, + CLSID_RESOLUTION_REGISTERED = 0x1 +} CLSID_RESOLUTION_FLAGS; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`CLSID_RESOLUTION_DEFAULT`|Indicates the default behavior.| +|`CLSID_RESOLUTION_REGISTERED`|Indicates that the runtime searches the registry and applies shim policy.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **.NET versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] + ## See also - [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md b/docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md index 9dc089672c3da..018e3bad0bfd5 100644 --- a/docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md +++ b/docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md @@ -2,53 +2,52 @@ 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](../../../framework/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)] - +> 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](../../../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 Global Static Functions](../metadata/metadata-global-static-functions.md) diff --git a/docs/core/unmanaged-api/hosting/coinitializecor-function.md b/docs/core/unmanaged-api/hosting/coinitializecor-function.md index f48cf805b3d79..443f65c05f93e 100644 --- a/docs/core/unmanaged-api/hosting/coinitializecor-function.md +++ b/docs/core/unmanaged-api/hosting/coinitializecor-function.md @@ -2,41 +2,40 @@ 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 - - To initialize the common language runtime, use either [CorBindToRuntimeEx](corbindtoruntimeex-function.md) or [CorBindToCurrentRuntime](corbindtocurrentruntime-function.md). - -## Requirements - - **Header:** Cor.h - +`CoInitializeCor` is obsolete. + +## Syntax + +```cpp +STDAPI CoInitializeCor ( + DWORD fFlags +); +``` + +## Remarks + + To initialize the common language runtime, use either [CorBindToRuntimeEx](corbindtoruntimeex-function.md) or [CorBindToCurrentRuntime](corbindtocurrentruntime-function.md). + +## Requirements + + **Header:** Cor.h + ## See also - [Metadata Global Static Functions](../metadata/metadata-global-static-functions.md) diff --git a/docs/core/unmanaged-api/hosting/coinitializeee-function.md b/docs/core/unmanaged-api/hosting/coinitializeee-function.md index de696434b9ba0..f595093842f43 100644 --- a/docs/core/unmanaged-api/hosting/coinitializeee-function.md +++ b/docs/core/unmanaged-api/hosting/coinitializeee-function.md @@ -2,62 +2,61 @@ 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](../../../framework/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)] - +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](../../../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 Global Static Functions](../metadata/metadata-global-static-functions.md) diff --git a/docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md b/docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md index ae324d66cd8f9..76d1c17050541 100644 --- a/docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md +++ b/docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md @@ -2,48 +2,47 @@ description: "Learn more about: ComCallUnmarshal Coclass" title: "ComCallUnmarshal Coclass" ms.date: "03/30/2017" -api_name: +api_name: - "ComCallUnmarshal Coclass" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ComCallUnmarshal" -helpviewer_keywords: +helpviewer_keywords: - "ComCallUnmarshal coclass [.NET Framework hosting]" -ms.assetid: 2adb5827-2268-4914-a1c6-f62b61880a45 -topic_type: +topic_type: - "apiref" --- # ComCallUnmarshal Coclass -Provides interfaces for managing the marshalling of interface pointers. - -## Syntax - -```cpp -coclass ComCallUnmarshal { - [default] interface IMarshal; -}; -``` - -## Interfaces - -|Interface|Description| -|---------------|-----------------| -|`IMarshal`|Provides methods for creating, initializing, and managing a proxy in a client process.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.idl - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Provides interfaces for managing the marshalling of interface pointers. + +## Syntax + +```cpp +coclass ComCallUnmarshal { + [default] interface IMarshal; +}; +``` + +## Interfaces + +|Interface|Description| +|---------------|-----------------| +|`IMarshal`|Provides methods for creating, initializing, and managing a proxy in a client process.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.idl + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Hosting Coclasses](hosting-coclasses.md) diff --git a/docs/core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md b/docs/core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md index d91b380b18cf1..29436174aa568 100644 --- a/docs/core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md +++ b/docs/core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md @@ -2,52 +2,51 @@ description: "Learn more about: COR_GC_STAT_TYPES Enumeration" title: "COR_GC_STAT_TYPES Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "COR_GC_STAT_TYPES" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "COR_GC_STAT_TYPES" -helpviewer_keywords: +helpviewer_keywords: - "COR_GC_STAT_TYPES enumeration [.NET Framework hosting]" -ms.assetid: fc51d6db-f7f8-408b-b93d-c166fc712c99 -topic_type: +topic_type: - "apiref" --- # COR_GC_STAT_TYPES Enumeration -Specifies the statistics to be recorded for a garbage collection. - -## Syntax - -```cpp -typedef enum { - COR_GC_COUNTS = 0x00000001 - COR_GC_MEMORYUSAGE = 0x00000002 -} COR_GC_STAT_TYPES; -``` - -## Remarks - - This enumeration specifies which statistics in the [COR_GC_STATS](cor-gc-stats-structure.md) structure are to be set by [ICLRGCManager::GetStats](iclrgcmanager-getstats-method.md) method. - -## Members - -|Member|Description| -|------------|-----------------| -|`COR_GC_COUNTS`|Records the number of garbage collections performed for each generation.| -|`COR_GC_MEMORYUSAGE`|Records memory usage and garbage collection size statistics.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl, GCHost.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Specifies the statistics to be recorded for a garbage collection. + +## Syntax + +```cpp +typedef enum { + COR_GC_COUNTS = 0x00000001 + COR_GC_MEMORYUSAGE = 0x00000002 +} COR_GC_STAT_TYPES; +``` + +## Remarks + + This enumeration specifies which statistics in the [COR_GC_STATS](cor-gc-stats-structure.md) structure are to be set by [ICLRGCManager::GetStats](iclrgcmanager-getstats-method.md) method. + +## Members + +|Member|Description| +|------------|-----------------| +|`COR_GC_COUNTS`|Records the number of garbage collections performed for each generation.| +|`COR_GC_MEMORYUSAGE`|Records memory usage and garbage collection size statistics.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** GCHost.idl, GCHost.h + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [COR_GC_STATS Structure](cor-gc-stats-structure.md) diff --git a/docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md b/docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md index 5def3e9ce26c7..fbab9113226b8 100644 --- a/docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md +++ b/docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md @@ -2,86 +2,85 @@ description: "Learn more about: COR_GC_STATS Structure" title: "COR_GC_STATS Structure" ms.date: "03/30/2017" -api_name: +api_name: - "COR_GC_STATS" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "COR_GC_STATS" -helpviewer_keywords: +helpviewer_keywords: - "COR_GC_STATS structure [.NET Framework hosting]" -ms.assetid: 8d4ff73e-739b-40f6-9349-359fbc99c2f9 -topic_type: +topic_type: - "apiref" --- # COR_GC_STATS Structure -Provides statistics about the garbage collection mechanism of the common language runtime (CLR). - -## Syntax - -```cpp -typedef struct _COR_GC_STATS { +Provides statistics about the garbage collection mechanism of the common language runtime (CLR). + +## Syntax + +```cpp +typedef struct _COR_GC_STATS { ULONG Flags; - SIZE_T ExplicitGCCount; - SIZE_T GenCollectionsTaken[3]; + SIZE_T ExplicitGCCount; + SIZE_T GenCollectionsTaken[3]; SIZE_T CommittedKBytes; - SIZE_T ReservedKBytes; - SIZE_T Gen0HeapSizeKBytes; - SIZE_T Gen1HeapSizeKBytes; - SIZE_T Gen2HeapSizeKBytes; - SIZE_T LargeObjectHeapSizeKBytes; - SIZE_T KBytesPromotedFromGen0; - SIZE_T KBytesPromotedFromGen1; -} COR_GC_STATS; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`Flags`|Indicates which field values should be calculated and returned.| -|`ExplicitGCCount`|Indicates the number of garbage collections that were forced by external request.| -|`GenCollectionsTaken`|Indicates the number of garbage collections performed for each generation.| -|`CommittedKBytes`|The total number of kilobytes committed in all heaps.| -|`ReservedKBytes`|The total number of kilobytes reserved in all heaps.| -|`Gen0HeapSizeKBytes`|The size, in kilobytes, of the generation-zero heap.| -|`Gen1HeapSizeKBytes`|The size, in kilobytes, of the generation-one heap.| -|`Gen2HeapSizeKBytes`|The size, in kilobytes, of the generation-two heap.| -|`LargeObjectHeapSizeKBytes`|The size, in kilobytes, of the large object heap.| -|`KBytesPromotedFromGen0`|The size, in kilobytes, of the objects promoted from generation zero to generation one.| -|`KBytesPromotedFromGen1`|The size, in kilobytes, of the objects promoted from generation one to generation two.| - -## Remarks - - The [ICLRGCManager::GetStats](iclrgcmanager-getstats-method.md) method requires the `Flags` field of the `COR_GC_STATS` structure to be set to one or more values of the [COR_GC_STAT_TYPES](cor-gc-stat-types-enumeration.md) enumeration to specify which statistics are to be set. - - The following table maps the statistics provided by this structure to the two [COR_GC_STAT_TYPES](cor-gc-stat-types-enumeration.md) enumeration values, `COR_GC_COUNTS` and `COR_GC_MEMORYUSAGE`. - -|Specified by COR_GC_COUNTS|Specified by COR_GC_MEMORYUSAGE| -|----------------------------------|---------------------------------------| -|`ExplicitGCCount`

`GenCollectionsTaken`|`CommittedKBytes`

`ReservedKBytes`

`Gen0HeapSizeKBytes`

`Gen1HeapSizeKBytes`

`Gen2HeapSizeKBytes`

`LargeObjectHeapSizeKBytes`

`KBytesPromotedFromGen0`

`KBytesPromotedFromGen1`| - - An example of the usage is as follows: - -```cpp -COR_GC_STATS GCStats; -GCStats.Flags = COR_GC_COUNTS | COR_GC_MEMORYUSAGE; -pCLRGCManager->GetStats(&GCStats); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + SIZE_T ReservedKBytes; + SIZE_T Gen0HeapSizeKBytes; + SIZE_T Gen1HeapSizeKBytes; + SIZE_T Gen2HeapSizeKBytes; + SIZE_T LargeObjectHeapSizeKBytes; + SIZE_T KBytesPromotedFromGen0; + SIZE_T KBytesPromotedFromGen1; +} COR_GC_STATS; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`Flags`|Indicates which field values should be calculated and returned.| +|`ExplicitGCCount`|Indicates the number of garbage collections that were forced by external request.| +|`GenCollectionsTaken`|Indicates the number of garbage collections performed for each generation.| +|`CommittedKBytes`|The total number of kilobytes committed in all heaps.| +|`ReservedKBytes`|The total number of kilobytes reserved in all heaps.| +|`Gen0HeapSizeKBytes`|The size, in kilobytes, of the generation-zero heap.| +|`Gen1HeapSizeKBytes`|The size, in kilobytes, of the generation-one heap.| +|`Gen2HeapSizeKBytes`|The size, in kilobytes, of the generation-two heap.| +|`LargeObjectHeapSizeKBytes`|The size, in kilobytes, of the large object heap.| +|`KBytesPromotedFromGen0`|The size, in kilobytes, of the objects promoted from generation zero to generation one.| +|`KBytesPromotedFromGen1`|The size, in kilobytes, of the objects promoted from generation one to generation two.| + +## Remarks + + The [ICLRGCManager::GetStats](iclrgcmanager-getstats-method.md) method requires the `Flags` field of the `COR_GC_STATS` structure to be set to one or more values of the [COR_GC_STAT_TYPES](cor-gc-stat-types-enumeration.md) enumeration to specify which statistics are to be set. + + The following table maps the statistics provided by this structure to the two [COR_GC_STAT_TYPES](cor-gc-stat-types-enumeration.md) enumeration values, `COR_GC_COUNTS` and `COR_GC_MEMORYUSAGE`. + +|Specified by COR_GC_COUNTS|Specified by COR_GC_MEMORYUSAGE| +|----------------------------------|---------------------------------------| +|`ExplicitGCCount`

`GenCollectionsTaken`|`CommittedKBytes`

`ReservedKBytes`

`Gen0HeapSizeKBytes`

`Gen1HeapSizeKBytes`

`Gen2HeapSizeKBytes`

`LargeObjectHeapSizeKBytes`

`KBytesPromotedFromGen0`

`KBytesPromotedFromGen1`| + + An example of the usage is as follows: + +```cpp +COR_GC_STATS GCStats; +GCStats.Flags = COR_GC_COUNTS | COR_GC_MEMORYUSAGE; +pCLRGCManager->GetStats(&GCStats); +``` + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** GCHost.idl + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Hosting Structures](hosting-structures.md) diff --git a/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md b/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md index ff3440275e92f..aecbc1ed584f1 100644 --- a/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md +++ b/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md @@ -2,54 +2,53 @@ description: "Learn more about: COR_GC_THREAD_STATS Structure" title: "COR_GC_THREAD_STATS Structure" ms.date: "03/30/2017" -api_name: +api_name: - "COR_GC_THREAD_STATS" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "COR_GC_THREAD_STATS" -helpviewer_keywords: +helpviewer_keywords: - "COR_GC_THREAD_STATS structure [.NET Framework hosting]" -ms.assetid: 01f9a59b-7679-4d42-9ced-4a8981625c3d -topic_type: +topic_type: - "apiref" --- # COR_GC_THREAD_STATS Structure -Contains per-thread statistics pertaining to garbage collection. - -## Syntax - -```cpp -typedef struct _COR_GC_THREAD_STATS { +Contains per-thread statistics pertaining to garbage collection. + +## Syntax + +```cpp +typedef struct _COR_GC_THREAD_STATS { ULONGLONG PerThreadAllocation; ULONG Flags; -} COR_GC_THREAD_STATS; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`PerThreadAllocation`|The number of bytes of memory allocated on the thread that is associated with the current `COR_GC_THREAD_STATS` instance. This number is cleared to zero each time a generation-zero garbage collection occurs.| -|`Flags`|The number of bytes promoted to a higher generation at the most recent garbage collection.| - -## Remarks - - [ICLRTask::GetMemStats](iclrtask-getmemstats-method.md) takes an output parameter of type `COR_GC_THREAD_STATS`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +} COR_GC_THREAD_STATS; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`PerThreadAllocation`|The number of bytes of memory allocated on the thread that is associated with the current `COR_GC_THREAD_STATS` instance. This number is cleared to zero each time a generation-zero garbage collection occurs.| +|`Flags`|The number of bytes promoted to a higher generation at the most recent garbage collection.| + +## Remarks + + [ICLRTask::GetMemStats](iclrtask-getmemstats-method.md) takes an output parameter of type `COR_GC_THREAD_STATS`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** GCHost.idl + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Hosting Structures](hosting-structures.md) diff --git a/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md b/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md index e04703a2976d4..e2c1ba0781d5c 100644 --- a/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md +++ b/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md @@ -2,46 +2,45 @@ description: "Learn more about: COR_GC_THREAD_STATS_TYPES Enumeration" title: "COR_GC_THREAD_STATS_TYPES Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "COR_GC_THREAD_STATS_TYPES" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "COR_GC_THREAD_STATS_TYPES" -helpviewer_keywords: +helpviewer_keywords: - "COR_GC_THREAD_STATS_TYPES enumeration [.NET Framework hosting]" -ms.assetid: aa227704-0ab1-4b08-aee2-1f439762162e -topic_type: +topic_type: - "apiref" --- # COR_GC_THREAD_STATS_TYPES Enumeration -Indicates the garbage collection statistics for a thread. - -## Syntax - -```cpp -typedef enum { - COR_GC_THREAD_HAS_PROMOTED_BYTES = 0x00000001 -} COR_GC_THREAD_STATS_TYPES; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`COR_GC_THREAD_HAS_PROMOTED_BYTES`|The thread has bytes that were promoted in the most recent garbage collection.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl, GCHost.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Indicates the garbage collection statistics for a thread. + +## Syntax + +```cpp +typedef enum { + COR_GC_THREAD_HAS_PROMOTED_BYTES = 0x00000001 +} COR_GC_THREAD_STATS_TYPES; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`COR_GC_THREAD_HAS_PROMOTED_BYTES`|The thread has bytes that were promoted in the most recent garbage collection.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** GCHost.idl, GCHost.h + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/corbindtocurrentruntime-function.md b/docs/core/unmanaged-api/hosting/corbindtocurrentruntime-function.md index d9bf77250fc8f..7e0a8caf91b5b 100644 --- a/docs/core/unmanaged-api/hosting/corbindtocurrentruntime-function.md +++ b/docs/core/unmanaged-api/hosting/corbindtocurrentruntime-function.md @@ -2,66 +2,65 @@ description: "Learn more about: CorBindToCurrentRuntime Function" title: "CorBindToCurrentRuntime Function" ms.date: "03/30/2017" -api_name: +api_name: - "CorBindToCurrentRuntime" -api_location: +api_location: - "mscoree.dll" - "mscoreei.dll" -api_type: +api_type: - "HeaderDef" -f1_keywords: +f1_keywords: - "CorBindToCurrentRuntime" -helpviewer_keywords: +helpviewer_keywords: - "CorBindToCurrentRuntime function [.NET Framework hosting]" -ms.assetid: 6105c13e-d9cd-44d2-a95a-924e042830c7 -topic_type: +topic_type: - "apiref" --- # CorBindToCurrentRuntime Function -Loads the common language runtime (CLR) into a process by using version information stored in an XML file. The format of the XML file is modeled after the standard application configuration file. For more information about configuration files, see [Configuration File Schema](../../configure-apps/file-schema/index.md). - - This function has been deprecated in the .NET Framework 4. See [Loading the Common Language Runtime into a Process](/previous-versions/dotnet/netframework-4.0/01918c6x(v=vs.100)). - -## Syntax - -```cpp -HRESULT CorBindToCurrentRuntime ( - [in] LPCWSTR pwszFileName, - [in] REFCLSID rclsid, - [in] REFIID riid, - [out] LPVOID *ppv -); -``` - -## Parameters - - `pwszFileName` - [in] The name of an application configuration file that specifies the version of the CLR to load. If the file name is not fully qualified, it is assumed to be in the same directory as the executable making the call. - - The version of the runtime to be loaded is described by the version attribute in the [\](../../configure-apps/file-schema/startup/requiredruntime-element.md) element of the configuration file. - - If no version is specified, or if the `` element cannot be found, the latest version of the CLR that is installed on the machine is loaded. - - `rclsid` - [in] The `CLSID` of the coclass that implements either the [ICorRuntimeHost](icorruntimehost-interface.md) or the [ICLRRuntimeHost](iclrruntimehost-interface.md) interface. Supported values are CLSID_CorRuntimeHost or CLSID_CLRRuntimeHost. - - `riid` - [in] The `IID` of the interface you are requesting. Supported values are IID_ICorRuntimeHost or IID_ICLRRuntimeHost. - - `ppv` - [out] The returned interface pointer. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Loads the common language runtime (CLR) into a process by using version information stored in an XML file. The format of the XML file is modeled after the standard application configuration file. For more information about configuration files, see [Configuration File Schema](../../../framework/configure-apps/file-schema/index.md). + + This function has been deprecated in the .NET Framework 4. See [Loading the Common Language Runtime into a Process](/previous-versions/dotnet/netframework-4.0/01918c6x(v=vs.100)). + +## Syntax + +```cpp +HRESULT CorBindToCurrentRuntime ( + [in] LPCWSTR pwszFileName, + [in] REFCLSID rclsid, + [in] REFIID riid, + [out] LPVOID *ppv +); +``` + +## Parameters + + `pwszFileName` + [in] The name of an application configuration file that specifies the version of the CLR to load. If the file name is not fully qualified, it is assumed to be in the same directory as the executable making the call. + + The version of the runtime to be loaded is described by the version attribute in the [\](../../../framework/configure-apps/file-schema/startup/requiredruntime-element.md) element of the configuration file. + + If no version is specified, or if the `` element cannot be found, the latest version of the CLR that is installed on the machine is loaded. + + `rclsid` + [in] The `CLSID` of the coclass that implements either the [ICorRuntimeHost](icorruntimehost-interface.md) or the [ICLRRuntimeHost](iclrruntimehost-interface.md) interface. Supported values are CLSID_CorRuntimeHost or CLSID_CLRRuntimeHost. + + `riid` + [in] The `IID` of the interface you are requesting. Supported values are IID_ICorRuntimeHost or IID_ICLRRuntimeHost. + + `ppv` + [out] The returned interface pointer. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [CorBindToRuntime Function](corbindtoruntime-function.md) diff --git a/docs/core/unmanaged-api/hosting/corbindtoruntime-function.md b/docs/core/unmanaged-api/hosting/corbindtoruntime-function.md index a6c8fd19b77be..3975c5d6b0299 100644 --- a/docs/core/unmanaged-api/hosting/corbindtoruntime-function.md +++ b/docs/core/unmanaged-api/hosting/corbindtoruntime-function.md @@ -2,96 +2,95 @@ description: "Learn more about: CorBindToRuntime Function" title: "CorBindToRuntime Function" ms.date: "03/30/2017" -api_name: +api_name: - "CorBindToRuntime" -api_location: +api_location: - "mscoree.dll" - "mscoreei.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "CorBindToRuntime" -helpviewer_keywords: +helpviewer_keywords: - "CorBindToRuntime function [.NET Framework hosting]" -ms.assetid: 799740aa-46ec-4532-95da-6444565b4971 -topic_type: +topic_type: - "apiref" --- # CorBindToRuntime Function -Enables unmanaged hosts to load the common language runtime (CLR) into a process. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT CorBindToRuntime ( +Enables unmanaged hosts to load the common language runtime (CLR) into a process. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT CorBindToRuntime ( [in] LPCWSTR pwszVersion, [in] LPCWSTR pwszBuildFlavor, [in] REFCLSID rclsid, [in] REFIID riid, - [out] LPVOID FAR *ppv -); -``` - -## Parameters - - `pwszVersion` - [in] A string describing the version of the CLR you want to load. - - A version number in the .NET Framework consists of four parts separated by periods: *major.minor.build.revision*. The string passed as `pwszVersion` must start with the character "v" followed by the first three parts of the version number (for example, "v1.0.1529"). - - Some versions of the CLR are installed with a policy statement that specifies compatibility with previous versions of the CLR. By default, the startup shim evaluates `pwszVersion` against policy statements and loads the latest version of the runtime that is compatible with the version being requested. A host can force the shim to skip policy evaluation and load the exact version specified in `pwszVersion` by passing a value of `STARTUP_LOADER_SAFEMODE` for the `flags` parameter, as described below. - - If the caller specifies null for `pwszVersion`, the latest version of the runtime is loaded. Passing null gives the host no control over which version of the runtime is loaded. Although this approach may be appropriate in some scenarios, it is strongly recommended that the host supply a specific version to load. - - `pwszBuildFlavor` - [in] A string that specifies whether to load the server or the workstation build of the CLR. Valid values are `svr` and `wks`. The server build is optimized to take advantage of multiple processors for garbage collections, and the workstation build is optimized for client applications running on a single-processor machine. - - If `pwszBuildFlavor` is set to null, the workstation build is loaded. When running on a single-processor machine, the workstation build is always loaded, even if `pwszBuildFlavor` is set to `svr`. However, if `pwszBuildFlavor` is set to `svr` and concurrent garbage collection is specified (see the description of the `flags` parameter), the server build is loaded. - - `rclsid` - [in] The `CLSID` of the coclass that implements either the [ICorRuntimeHost](icorruntimehost-interface.md) or the [ICLRRuntimeHost](iclrruntimehost-interface.md) interface. Supported values are CLSID_CorRuntimeHost or CLSID_CLRRuntimeHost. - - `riid` - [in] The `IID` of the requested interface from `rclsid`. Supported values are IID_ICorRuntimeHost or IID_ICLRRuntimeHost. - - `ppv` - [out] The returned interface pointer to `riid`. - -## Remarks - - If `pwszVersion` specifies a runtime version that does not exist, `CorBindToRuntimeEx` returns an HRESULT value of CLR_E_SHIM_RUNTIMELOAD. - - [CorBindToRuntimeEx](corbindtoruntimeex-function.md) and `CorBindToRuntime` perform the same operation, but the `CorBindToRuntimeEx` function allows you to set flags to specify the behavior of the CLR. - -## Execution Context and Flow of Windows Identity - - In version 1 of the CLR, the object does not flow across asynchronous points such as new threads, thread pools, or timer callbacks. In version 2.0 of the CLR, an object wraps some information about the currently executing thread and flows it across any asynchronous point, but not across application domain boundaries. Similarly, the object also flows across any asynchronous point. Therefore, the current impersonation on the thread, if any, flows too. - - You can alter the flow in two ways: - -1. By modifying the settings to suppress the flow on a per-thread basis (see the , , and methods). - -2. By changing the process default mode to the version 1 compatibility mode, where the object does not flow across any asynchronous point, regardless of the settings on the current thread. How you change the default mode depends on whether you use a managed executable or an unmanaged hosting interface to load the CLR: - - 1. For managed executables, you must set the `enabled` attribute of the [\](../../configure-apps/file-schema/runtime/legacyimpersonationpolicy-element.md) element to `true`. - - 2. For unmanaged hosting interfaces, set the `STARTUP_LEGACY_IMPERSONATION` flag in the `flags` parameter when calling the `CorBindToRuntimeEx` function. - - The version 1 compatibility mode applies to the entire process and to all the application domains in the process. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] LPVOID FAR *ppv +); +``` + +## Parameters + + `pwszVersion` + [in] A string describing the version of the CLR you want to load. + + A version number in the .NET Framework consists of four parts separated by periods: *major.minor.build.revision*. The string passed as `pwszVersion` must start with the character "v" followed by the first three parts of the version number (for example, "v1.0.1529"). + + Some versions of the CLR are installed with a policy statement that specifies compatibility with previous versions of the CLR. By default, the startup shim evaluates `pwszVersion` against policy statements and loads the latest version of the runtime that is compatible with the version being requested. A host can force the shim to skip policy evaluation and load the exact version specified in `pwszVersion` by passing a value of `STARTUP_LOADER_SAFEMODE` for the `flags` parameter, as described below. + + If the caller specifies null for `pwszVersion`, the latest version of the runtime is loaded. Passing null gives the host no control over which version of the runtime is loaded. Although this approach may be appropriate in some scenarios, it is strongly recommended that the host supply a specific version to load. + + `pwszBuildFlavor` + [in] A string that specifies whether to load the server or the workstation build of the CLR. Valid values are `svr` and `wks`. The server build is optimized to take advantage of multiple processors for garbage collections, and the workstation build is optimized for client applications running on a single-processor machine. + + If `pwszBuildFlavor` is set to null, the workstation build is loaded. When running on a single-processor machine, the workstation build is always loaded, even if `pwszBuildFlavor` is set to `svr`. However, if `pwszBuildFlavor` is set to `svr` and concurrent garbage collection is specified (see the description of the `flags` parameter), the server build is loaded. + + `rclsid` + [in] The `CLSID` of the coclass that implements either the [ICorRuntimeHost](icorruntimehost-interface.md) or the [ICLRRuntimeHost](iclrruntimehost-interface.md) interface. Supported values are CLSID_CorRuntimeHost or CLSID_CLRRuntimeHost. + + `riid` + [in] The `IID` of the requested interface from `rclsid`. Supported values are IID_ICorRuntimeHost or IID_ICLRRuntimeHost. + + `ppv` + [out] The returned interface pointer to `riid`. + +## Remarks + + If `pwszVersion` specifies a runtime version that does not exist, `CorBindToRuntimeEx` returns an HRESULT value of CLR_E_SHIM_RUNTIMELOAD. + + [CorBindToRuntimeEx](corbindtoruntimeex-function.md) and `CorBindToRuntime` perform the same operation, but the `CorBindToRuntimeEx` function allows you to set flags to specify the behavior of the CLR. + +## Execution Context and Flow of Windows Identity + + In version 1 of the CLR, the object does not flow across asynchronous points such as new threads, thread pools, or timer callbacks. In version 2.0 of the CLR, an object wraps some information about the currently executing thread and flows it across any asynchronous point, but not across application domain boundaries. Similarly, the object also flows across any asynchronous point. Therefore, the current impersonation on the thread, if any, flows too. + + You can alter the flow in two ways: + +1. By modifying the settings to suppress the flow on a per-thread basis (see the , , and methods). + +2. By changing the process default mode to the version 1 compatibility mode, where the object does not flow across any asynchronous point, regardless of the settings on the current thread. How you change the default mode depends on whether you use a managed executable or an unmanaged hosting interface to load the CLR: + + 1. For managed executables, you must set the `enabled` attribute of the [\](../../../framework/configure-apps/file-schema/runtime/legacyimpersonationpolicy-element.md) element to `true`. + + 2. For unmanaged hosting interfaces, set the `STARTUP_LEGACY_IMPERSONATION` flag in the `flags` parameter when calling the `CorBindToRuntimeEx` function. + + The version 1 compatibility mode applies to the entire process and to all the application domains in the process. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [CorBindToCurrentRuntime Function](corbindtocurrentruntime-function.md) diff --git a/docs/core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md b/docs/core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md index 86a52b24c7fc1..f944cf958fcc5 100644 --- a/docs/core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md +++ b/docs/core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md @@ -2,73 +2,72 @@ description: "Learn more about: CorBindToRuntimeByCfg Function" title: "CorBindToRuntimeByCfg Function" ms.date: "03/30/2017" -api_name: +api_name: - "CorBindToRuntimeByCfg" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "CorBindToRuntimeByCfg" -helpviewer_keywords: +helpviewer_keywords: - "CorBindToRuntimeByCfg function [.NET Framework hosting]" -ms.assetid: ded1e492-a782-4185-9c66-709e421c1782 -topic_type: +topic_type: - "apiref" --- # CorBindToRuntimeByCfg Function -Loads the common language runtime (CLR) into a process by using version information that is read from an XML file. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT CorBindToRuntimeByCfg ( - [in] IStream *pCfgStream, - [in] DWORD reserved, - [in] DWORD startupFlags, - [in] REFCLSID rclsid, +Loads the common language runtime (CLR) into a process by using version information that is read from an XML file. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT CorBindToRuntimeByCfg ( + [in] IStream *pCfgStream, + [in] DWORD reserved, + [in] DWORD startupFlags, + [in] REFCLSID rclsid, [in] REFIID riid, - [out] LPVOID FAR* ppv -); -``` - -## Parameters - - `pCfgStream` - [in] A pointer to an `IStream` object that reads the XML file. - - `reserved` - [in] Reserved for future use. Use 0 (zero) as value. - - `startupFlags` - [in] A value of the [STARTUP_FLAGS](startup-flags-enumeration.md) enumeration that specifies the startup behavior of the CLR. - - `rclsid` - [in] The `CLSID` of the coclass that implements either the [ICorRuntimeHost](icorruntimehost-interface.md) or the [ICLRRuntimeHost](iclrruntimehost-interface.md) interface. Supported values are CLSID_CorRuntimeHost or CLSID_CLRRuntimeHost. - - `riid` - [in] The `IID` of either the `ICorRuntimeHost` or the `ICLRRuntimeHost` interface. Supported values are IID_ICorRuntimeHost or IID_ICLRRuntimeHost. - - `ppv` - [out] A pointer to the address of the returned interface. - -## Remarks - - The format of the XML file is modeled after the standard application configuration file. For more information about XML files, see [Configuration File Schema](../../configure-apps/file-schema/index.md). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] LPVOID FAR* ppv +); +``` + +## Parameters + + `pCfgStream` + [in] A pointer to an `IStream` object that reads the XML file. + + `reserved` + [in] Reserved for future use. Use 0 (zero) as value. + + `startupFlags` + [in] A value of the [STARTUP_FLAGS](startup-flags-enumeration.md) enumeration that specifies the startup behavior of the CLR. + + `rclsid` + [in] The `CLSID` of the coclass that implements either the [ICorRuntimeHost](icorruntimehost-interface.md) or the [ICLRRuntimeHost](iclrruntimehost-interface.md) interface. Supported values are CLSID_CorRuntimeHost or CLSID_CLRRuntimeHost. + + `riid` + [in] The `IID` of either the `ICorRuntimeHost` or the `ICLRRuntimeHost` interface. Supported values are IID_ICorRuntimeHost or IID_ICLRRuntimeHost. + + `ppv` + [out] A pointer to the address of the returned interface. + +## Remarks + + The format of the XML file is modeled after the standard application configuration file. For more information about XML files, see [Configuration File Schema](../../../framework/configure-apps/file-schema/index.md). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [CorBindToCurrentRuntime Function](corbindtocurrentruntime-function.md) diff --git a/docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md b/docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md index f0d0dfbbe81b2..dcf77fcbf01d8 100644 --- a/docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md +++ b/docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md @@ -2,139 +2,138 @@ description: "Learn more about: CorBindToRuntimeEx Function" title: "CorBindToRuntimeEx Function" ms.date: "03/30/2017" -api_name: +api_name: - "CorBindToRuntimeEx" -api_location: +api_location: - "mscoree.dll" - "mscoreei.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "CorBindToRuntimeEx" -helpviewer_keywords: +helpviewer_keywords: - "CorBindToRuntimeEx function [.NET Framework hosting]" -ms.assetid: aae9fb17-5d01-41da-9773-1b5b5b642d81 -topic_type: +topic_type: - "apiref" --- # CorBindToRuntimeEx Function -Enables unmanaged hosts to load the common language runtime (CLR) into a process. The [CorBindToRuntime](corbindtoruntime-function.md) and `CorBindToRuntimeEx` functions perform the same operation, but the `CorBindToRuntimeEx` function allows you to set flags to specify the behavior of the CLR. - - This function has been deprecated in the .NET Framework 4. - - This function takes a set of parameters that allow a host to do the following: - -- Specify the version of the runtime that will be loaded. - -- Indicate whether the server or workstation build should be loaded. - -- Control whether concurrent garbage collection or non-concurrent garbage collection is done. - +Enables unmanaged hosts to load the common language runtime (CLR) into a process. The [CorBindToRuntime](corbindtoruntime-function.md) and `CorBindToRuntimeEx` functions perform the same operation, but the `CorBindToRuntimeEx` function allows you to set flags to specify the behavior of the CLR. + + This function has been deprecated in the .NET Framework 4. + + This function takes a set of parameters that allow a host to do the following: + +- Specify the version of the runtime that will be loaded. + +- Indicate whether the server or workstation build should be loaded. + +- Control whether concurrent garbage collection or non-concurrent garbage collection is done. + > [!NOTE] -> Concurrent garbage collection is not supported in applications running the WOW64 x86 emulator on 64-bit systems that implement the Intel Itanium architecture (formerly called IA-64). For more information about using WOW64 on 64-bit Windows systems, see [Running 32-bit Applications](/windows/desktop/WinProg64/running-32-bit-applications). - -- Control whether assemblies are loaded as domain-neutral. - -- Obtain an interface pointer to an [ICorRuntimeHost](icorruntimehost-interface.md) that can be used to set additional options for configuring an instance of the CLR before it is started. - -## Syntax - -```cpp -HRESULT CorBindToRuntimeEx ( +> Concurrent garbage collection is not supported in applications running the WOW64 x86 emulator on 64-bit systems that implement the Intel Itanium architecture (formerly called IA-64). For more information about using WOW64 on 64-bit Windows systems, see [Running 32-bit Applications](/windows/desktop/WinProg64/running-32-bit-applications). + +- Control whether assemblies are loaded as domain-neutral. + +- Obtain an interface pointer to an [ICorRuntimeHost](icorruntimehost-interface.md) that can be used to set additional options for configuring an instance of the CLR before it is started. + +## Syntax + +```cpp +HRESULT CorBindToRuntimeEx ( [in] LPCWSTR pwszVersion, [in] LPCWSTR pwszBuildFlavor, [in] DWORD startupFlags, [in] REFCLSID rclsid, [in] REFIID riid, - [out] LPVOID FAR *ppv -); -``` - -## Parameters - - `pwszVersion` - [in] A string describing the version of the CLR you want to load. - - A version number in the .NET Framework consists of four parts separated by periods: *major.minor.build.revision*. The string passed as `pwszVersion` must start with the character "v" followed by the first three parts of the version number (for example, "v1.0.1529"). - - Some versions of the CLR are installed with a policy statement that specifies compatibility with previous versions of the CLR. By default, the startup shim evaluates `pwszVersion` against policy statements and loads the latest version of the runtime that is compatible with the version being requested. A host can force the shim to skip policy evaluation and load the exact version specified in `pwszVersion` by passing a value of `STARTUP_LOADER_SAFEMODE` for the `startupFlags` parameter, as described below. - - If the caller specifies null for `pwszVersion`, `CorBindToRuntimeEx` identifies the set of installed runtimes whose version numbers are lower than the .NET Framework 4 runtime, and loads the latest version of the runtime from that set. It won't load the .NET Framework 4 or later, and fails if no earlier version is installed. Note that passing null gives the host no control over which version of the runtime is loaded. Although this approach may be appropriate in some scenarios, it is strongly recommended that the host supply a specific version to load. - - `pwszBuildFlavor` - [in] A string that specifies whether to load the server or the workstation build of the CLR. Valid values are `svr` and `wks`. The server build is optimized to take advantage of multiple processors for garbage collections, and the workstation build is optimized for client applications running on a single-processor machine. - - If `pwszBuildFlavor` is set to null, the workstation build is loaded. When running on a single-processor machine, the workstation build is always loaded, even if `pwszBuildFlavor` is set to `svr`. However, if `pwszBuildFlavor` is set to `svr` and concurrent garbage collection is specified (see the description of the `startupFlags` parameter), the server build is loaded. - - `startupFlags` - [in] A combination of values of the [STARTUP_FLAGS](startup-flags-enumeration.md) enumeration. These flags control concurrent garbage collection, domain-neutral code, and the behavior of the `pwszVersion` parameter. The default is single domain if no flag is set. The following values are valid: - -- `STARTUP_CONCURRENT_GC` - -- `STARTUP_LOADER_OPTIMIZATION_SINGLE_DOMAIN` - -- `STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN` - -- `STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN_HOST` - -- `STARTUP_LOADER_SAFEMODE` - -- `STARTUP_LOADER_SETPREFERENCE` - -- `STARTUP_SERVER_GC` - -- `STARTUP_HOARD_GC_VM` - -- `STARTUP_SINGLE_VERSION_HOSTING_INTERFACE` - -- `STARTUP_LEGACY_IMPERSONATION` - -- `STARTUP_DISABLE_COMMITTHREADSTACK` - -- `STARTUP_ALWAYSFLOW_IMPERSONATION` - - For descriptions of these flags, see the [STARTUP_FLAGS](startup-flags-enumeration.md) enumeration. - - `rclsid` - [in] The `CLSID` of the coclass that implements either the [ICorRuntimeHost](icorruntimehost-interface.md) or the [ICLRRuntimeHost](iclrruntimehost-interface.md) interface. Supported values are CLSID_CorRuntimeHost or CLSID_CLRRuntimeHost. - - `riid` - [in] The `IID` of the requested interface from `rclsid`. Supported values are IID_ICorRuntimeHost or IID_ICLRRuntimeHost. - - `ppv` - [out] The returned interface pointer to `riid`. - -## Remarks - - If `pwszVersion` specifies a runtime version that does not exist, `CorBindToRuntimeEx` returns an HRESULT value of CLR_E_SHIM_RUNTIMELOAD. - -## Execution Context and Flow of Windows Identity - - In version 1 of the CLR, the object does not flow across asynchronous points such as new threads, thread pools, or timer callbacks. In version 2.0 of the CLR, an object wraps some information about the currently executing thread and flows it across any asynchronous point, but not across application domain boundaries. Similarly, the object also flows across any asynchronous point. Therefore, the current impersonation on the thread, if any, flows too. - - You can alter the flow in two ways: - -1. By modifying the settings to suppress the flow on a per-thread basis (see the , , and methods). - -2. By changing the process default mode to the version 1 compatibility mode, where the object does not flow across any asynchronous point, regardless of the settings on the current thread. How you change the default mode depends on whether you use a managed executable or an unmanaged hosting interface to load the CLR: - - 1. For managed executables, you must set the `enabled` attribute of the [\](../../configure-apps/file-schema/runtime/legacyimpersonationpolicy-element.md) element to `true`. - - 2. For unmanaged hosting interfaces, set the `STARTUP_LEGACY_IMPERSONATION` flag in the `startupFlags` parameter when calling the `CorBindToRuntimeEx` function. - - The version 1 compatibility mode applies to the entire process and to all the application domains in the process. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] LPVOID FAR *ppv +); +``` + +## Parameters + + `pwszVersion` + [in] A string describing the version of the CLR you want to load. + + A version number in the .NET Framework consists of four parts separated by periods: *major.minor.build.revision*. The string passed as `pwszVersion` must start with the character "v" followed by the first three parts of the version number (for example, "v1.0.1529"). + + Some versions of the CLR are installed with a policy statement that specifies compatibility with previous versions of the CLR. By default, the startup shim evaluates `pwszVersion` against policy statements and loads the latest version of the runtime that is compatible with the version being requested. A host can force the shim to skip policy evaluation and load the exact version specified in `pwszVersion` by passing a value of `STARTUP_LOADER_SAFEMODE` for the `startupFlags` parameter, as described below. + + If the caller specifies null for `pwszVersion`, `CorBindToRuntimeEx` identifies the set of installed runtimes whose version numbers are lower than the .NET Framework 4 runtime, and loads the latest version of the runtime from that set. It won't load the .NET Framework 4 or later, and fails if no earlier version is installed. Note that passing null gives the host no control over which version of the runtime is loaded. Although this approach may be appropriate in some scenarios, it is strongly recommended that the host supply a specific version to load. + + `pwszBuildFlavor` + [in] A string that specifies whether to load the server or the workstation build of the CLR. Valid values are `svr` and `wks`. The server build is optimized to take advantage of multiple processors for garbage collections, and the workstation build is optimized for client applications running on a single-processor machine. + + If `pwszBuildFlavor` is set to null, the workstation build is loaded. When running on a single-processor machine, the workstation build is always loaded, even if `pwszBuildFlavor` is set to `svr`. However, if `pwszBuildFlavor` is set to `svr` and concurrent garbage collection is specified (see the description of the `startupFlags` parameter), the server build is loaded. + + `startupFlags` + [in] A combination of values of the [STARTUP_FLAGS](startup-flags-enumeration.md) enumeration. These flags control concurrent garbage collection, domain-neutral code, and the behavior of the `pwszVersion` parameter. The default is single domain if no flag is set. The following values are valid: + +- `STARTUP_CONCURRENT_GC` + +- `STARTUP_LOADER_OPTIMIZATION_SINGLE_DOMAIN` + +- `STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN` + +- `STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN_HOST` + +- `STARTUP_LOADER_SAFEMODE` + +- `STARTUP_LOADER_SETPREFERENCE` + +- `STARTUP_SERVER_GC` + +- `STARTUP_HOARD_GC_VM` + +- `STARTUP_SINGLE_VERSION_HOSTING_INTERFACE` + +- `STARTUP_LEGACY_IMPERSONATION` + +- `STARTUP_DISABLE_COMMITTHREADSTACK` + +- `STARTUP_ALWAYSFLOW_IMPERSONATION` + + For descriptions of these flags, see the [STARTUP_FLAGS](startup-flags-enumeration.md) enumeration. + + `rclsid` + [in] The `CLSID` of the coclass that implements either the [ICorRuntimeHost](icorruntimehost-interface.md) or the [ICLRRuntimeHost](iclrruntimehost-interface.md) interface. Supported values are CLSID_CorRuntimeHost or CLSID_CLRRuntimeHost. + + `riid` + [in] The `IID` of the requested interface from `rclsid`. Supported values are IID_ICorRuntimeHost or IID_ICLRRuntimeHost. + + `ppv` + [out] The returned interface pointer to `riid`. + +## Remarks + + If `pwszVersion` specifies a runtime version that does not exist, `CorBindToRuntimeEx` returns an HRESULT value of CLR_E_SHIM_RUNTIMELOAD. + +## Execution Context and Flow of Windows Identity + + In version 1 of the CLR, the object does not flow across asynchronous points such as new threads, thread pools, or timer callbacks. In version 2.0 of the CLR, an object wraps some information about the currently executing thread and flows it across any asynchronous point, but not across application domain boundaries. Similarly, the object also flows across any asynchronous point. Therefore, the current impersonation on the thread, if any, flows too. + + You can alter the flow in two ways: + +1. By modifying the settings to suppress the flow on a per-thread basis (see the , , and methods). + +2. By changing the process default mode to the version 1 compatibility mode, where the object does not flow across any asynchronous point, regardless of the settings on the current thread. How you change the default mode depends on whether you use a managed executable or an unmanaged hosting interface to load the CLR: + + 1. For managed executables, you must set the `enabled` attribute of the [\](../../../framework/configure-apps/file-schema/runtime/legacyimpersonationpolicy-element.md) element to `true`. + + 2. For unmanaged hosting interfaces, set the `STARTUP_LEGACY_IMPERSONATION` flag in the `startupFlags` parameter when calling the `CorBindToRuntimeEx` function. + + The version 1 compatibility mode applies to the entire process and to all the application domains in the process. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [CorBindToCurrentRuntime Function](corbindtocurrentruntime-function.md) diff --git a/docs/core/unmanaged-api/hosting/corbindtoruntimehost-function.md b/docs/core/unmanaged-api/hosting/corbindtoruntimehost-function.md index 88e58744e20db..d88ba842965af 100644 --- a/docs/core/unmanaged-api/hosting/corbindtoruntimehost-function.md +++ b/docs/core/unmanaged-api/hosting/corbindtoruntimehost-function.md @@ -17,14 +17,14 @@ topic_type: --- # CorBindToRuntimeHost Function -Enables hosts to load a specified version of the common language runtime (CLR) into a process. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT CorBindToRuntimeHost ( +Enables hosts to load a specified version of the common language runtime (CLR) into a process. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT CorBindToRuntimeHost ( [in] LPCWSTR pwszVersion, [in] LPCWSTR pwszBuildFlavor, [in] LPCWSTR pwszHostConfigFile, @@ -32,57 +32,57 @@ HRESULT CorBindToRuntimeHost ( [in] DWORD startupFlags, [in] REFCLSID rclsid, [in] REFIID riid, - [out] LPVOID FAR *ppv -); -``` - -## Parameters - - `pwszVersion` - [in] A string that describes the version of the CLR you want to load. - - A version number in the .NET Framework consists of four parts separated by periods: *major.minor.build.revision*. The string passed as `pwszVersion` must start with the character "v" followed by the first three parts of the version number (for example, "v1.0.1529"). - - Some versions of the CLR are installed with a policy statement that specifies compatibility with previous versions of the CLR. By default, the startup shim evaluates `pwszVersion` against policy statements and loads the latest version of the runtime that is compatible with the version being requested. A host can force the shim to skip policy evaluation and load the exact version specified in `pwszVersion` by passing a value of STARTUP_LOADER_SAFEMODE for the `startupFlags` parameter. - - If `pwszVersion` is `null`, the method does not load any version of the CLR. Instead, it returns CLR_E_SHIM_RUNTIMELOAD, which indicates that it failed to load the runtime. - - `pwszBuildFlavor` - [in] A string that specifies whether to load the server or the workstation build of the CLR. Valid values are `svr` and `wks`. The server build is optimized to take advantage of multiple processors for garbage collections, and the workstation build is optimized for client applications running on a single-processor machine. - - If `pwszBuildFlavor` is set to null, the workstation build is loaded. When running on a single-processor machine, the workstation build is always loaded, even if `pwszBuildFlavor` is set to `svr`. However, if `pwszBuildFlavor` is set to `svr` and concurrent garbage collection is specified (see the description of the `startupFlags` parameter), the server build is loaded. - + [out] LPVOID FAR *ppv +); +``` + +## Parameters + + `pwszVersion` + [in] A string that describes the version of the CLR you want to load. + + A version number in the .NET Framework consists of four parts separated by periods: *major.minor.build.revision*. The string passed as `pwszVersion` must start with the character "v" followed by the first three parts of the version number (for example, "v1.0.1529"). + + Some versions of the CLR are installed with a policy statement that specifies compatibility with previous versions of the CLR. By default, the startup shim evaluates `pwszVersion` against policy statements and loads the latest version of the runtime that is compatible with the version being requested. A host can force the shim to skip policy evaluation and load the exact version specified in `pwszVersion` by passing a value of STARTUP_LOADER_SAFEMODE for the `startupFlags` parameter. + + If `pwszVersion` is `null`, the method does not load any version of the CLR. Instead, it returns CLR_E_SHIM_RUNTIMELOAD, which indicates that it failed to load the runtime. + + `pwszBuildFlavor` + [in] A string that specifies whether to load the server or the workstation build of the CLR. Valid values are `svr` and `wks`. The server build is optimized to take advantage of multiple processors for garbage collections, and the workstation build is optimized for client applications running on a single-processor machine. + + If `pwszBuildFlavor` is set to null, the workstation build is loaded. When running on a single-processor machine, the workstation build is always loaded, even if `pwszBuildFlavor` is set to `svr`. However, if `pwszBuildFlavor` is set to `svr` and concurrent garbage collection is specified (see the description of the `startupFlags` parameter), the server build is loaded. + > [!NOTE] -> Concurrent garbage collection is not supported in applications running the WOW64 x86 emulator on 64-bit systems that implement the Intel Itanium architecture (formerly called IA-64). For more information about using WOW64 on 64-bit Windows systems, see [Running 32-bit Applications](/windows/desktop/WinProg64/running-32-bit-applications). - - `pwszHostConfigFile` - [in] The name of a host configuration file that specifies the version of the CLR to load. If the file name does not include a fully qualified path, the file is assumed to be in the same directory as the executable that is making the call. - - `pReserved` - [in] Reserved for future extensibility. - - `startupFlags` - [in] A set of flags that controls concurrent garbage collection, domain-neutral code, and the behavior of the `pwszVersion` parameter. The default is single domain if no flag is set. For a list of supported values, see the [STARTUP_FLAGS enumeration](startup-flags-enumeration.md). - - `rclsid` - [in] The `CLSID` of the coclass that implements either the [ICorRuntimeHost](icorruntimehost-interface.md) or the [ICLRRuntimeHost](iclrruntimehost-interface.md) interface. Supported values are CLSID_CorRuntimeHost or CLSID_CLRRuntimeHost. - - `riid` - [in] The `IID` of the interface you are requesting. Supported values are IID_ICorRuntimeHost or IID_ICLRRuntimeHost. - - `ppv` - [out] An interface pointer to the version of the runtime that was loaded. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.idl - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +> Concurrent garbage collection is not supported in applications running the WOW64 x86 emulator on 64-bit systems that implement the Intel Itanium architecture (formerly called IA-64). For more information about using WOW64 on 64-bit Windows systems, see [Running 32-bit Applications](/windows/desktop/WinProg64/running-32-bit-applications). + + `pwszHostConfigFile` + [in] The name of a host configuration file that specifies the version of the CLR to load. If the file name does not include a fully qualified path, the file is assumed to be in the same directory as the executable that is making the call. + + `pReserved` + [in] Reserved for future extensibility. + + `startupFlags` + [in] A set of flags that controls concurrent garbage collection, domain-neutral code, and the behavior of the `pwszVersion` parameter. The default is single domain if no flag is set. For a list of supported values, see the [STARTUP_FLAGS enumeration](startup-flags-enumeration.md). + + `rclsid` + [in] The `CLSID` of the coclass that implements either the [ICorRuntimeHost](icorruntimehost-interface.md) or the [ICLRRuntimeHost](iclrruntimehost-interface.md) interface. Supported values are CLSID_CorRuntimeHost or CLSID_CLRRuntimeHost. + + `riid` + [in] The `IID` of the interface you are requesting. Supported values are IID_ICorRuntimeHost or IID_ICLRRuntimeHost. + + `ppv` + [out] An interface pointer to the version of the runtime that was loaded. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.idl + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [CorBindToCurrentRuntime Function](corbindtocurrentruntime-function.md) diff --git a/docs/core/unmanaged-api/hosting/cordllmain-function.md b/docs/core/unmanaged-api/hosting/cordllmain-function.md index 069ecb4a2ef61..a609845a06d42 100644 --- a/docs/core/unmanaged-api/hosting/cordllmain-function.md +++ b/docs/core/unmanaged-api/hosting/cordllmain-function.md @@ -2,69 +2,68 @@ 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](../../../framework/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)] - + + For additional information, see the Remarks section in the [\_CorValidateImage](corvalidateimage-function.md) topic. + +## 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 Global Static Functions](../metadata/metadata-global-static-functions.md) diff --git a/docs/core/unmanaged-api/hosting/corexemain-function.md b/docs/core/unmanaged-api/hosting/corexemain-function.md index 4fb9ffdbc83ae..4c776cd277010 100644 --- a/docs/core/unmanaged-api/hosting/corexemain-function.md +++ b/docs/core/unmanaged-api/hosting/corexemain-function.md @@ -2,51 +2,50 @@ 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](../../../framework/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)] - + + For additional information, see the Remarks section in the [_CorValidateImage](corvalidateimage-function.md) article. + +## 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 Global Static Functions](../metadata/metadata-global-static-functions.md) diff --git a/docs/core/unmanaged-api/hosting/corexemain2-function.md b/docs/core/unmanaged-api/hosting/corexemain2-function.md index c3fb3608a8e3e..6812b15ba7d0b 100644 --- a/docs/core/unmanaged-api/hosting/corexemain2-function.md +++ b/docs/core/unmanaged-api/hosting/corexemain2-function.md @@ -2,63 +2,62 @@ 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 - - `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](../../../framework/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)] - +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 + + `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](../../../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 Global Static Functions](../metadata/metadata-global-static-functions.md) diff --git a/docs/core/unmanaged-api/hosting/corexitprocess-function.md b/docs/core/unmanaged-api/hosting/corexitprocess-function.md index 15b4521def77b..a4d5447f16e94 100644 --- a/docs/core/unmanaged-api/hosting/corexitprocess-function.md +++ b/docs/core/unmanaged-api/hosting/corexitprocess-function.md @@ -2,58 +2,57 @@ description: "Learn more about: CorExitProcess Function" title: "CorExitProcess Function" ms.date: "03/30/2017" -api_name: +api_name: - "CorExitProcess" -api_location: +api_location: - "mscoree.dll" - "clr.dll" - "mscorwks.dll" - "mscoreei.dll" - "mscorsvr.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "CorExitProcess" -helpviewer_keywords: +helpviewer_keywords: - "CorExitProcess function [.NET Framework hosting]" -ms.assetid: a5cab4c6-990e-47f3-8798-cf422b791015 -topic_type: +topic_type: - "apiref" --- # CorExitProcess Function -Shuts down the current unmanaged process. - - This function has been deprecated in the .NET Framework 4. Use the [ICLRMetaHost::ExitProcess](iclrmetahost-exitprocess-method.md) method instead. - -## Syntax - -```cpp +Shuts down the current unmanaged process. + + This function has been deprecated in the .NET Framework 4. Use the [ICLRMetaHost::ExitProcess](iclrmetahost-exitprocess-method.md) method instead. + +## Syntax + +```cpp void STDMETHODCALLTYPE CorExitProcess ( - int exitCode -); -``` - -## Parameters - - `exitCode` - An integer that specifies the process exit code. - -## Remarks - + int exitCode +); +``` + +## Parameters + + `exitCode` + An integer that specifies the process exit code. + +## Remarks + > [!NOTE] -> Beginning with the .NET Framework 4, `CorExitProcess` exits every started runtime in the process, not just the runtime to which the legacy APIs have been bound. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +> Beginning with the .NET Framework 4, `CorExitProcess` exits every started runtime in the process, not just the runtime to which the legacy APIs have been bound. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/corimageunloading-function.md b/docs/core/unmanaged-api/hosting/corimageunloading-function.md index 6651a7bccbd3c..5f534d2f6f7c5 100644 --- a/docs/core/unmanaged-api/hosting/corimageunloading-function.md +++ b/docs/core/unmanaged-api/hosting/corimageunloading-function.md @@ -2,49 +2,48 @@ 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](../../../framework/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] PVOID* ImageBase +); +``` + +## Parameters + + `ImageBase` + [in] A pointer to the starting location of the image to unload. + +## 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 Global Static Functions](../metadata/metadata-global-static-functions.md) diff --git a/docs/core/unmanaged-api/hosting/corlaunchapplication-function.md b/docs/core/unmanaged-api/hosting/corlaunchapplication-function.md index 3eb72010458fc..648e8eaf4768c 100644 --- a/docs/core/unmanaged-api/hosting/corlaunchapplication-function.md +++ b/docs/core/unmanaged-api/hosting/corlaunchapplication-function.md @@ -2,74 +2,73 @@ description: "Learn more about: CorLaunchApplication Function" title: "CorLaunchApplication Function" ms.date: "03/30/2017" -api_name: +api_name: - "CorLaunchApplication" -api_location: +api_location: - "mscoree.dll" - "clr.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorLaunchApplication" -helpviewer_keywords: +helpviewer_keywords: - "CorLaunchApplication function [.NET Framework hosting]" -ms.assetid: 71f362a9-8fe2-47ce-9302-05a645cf3d7d -topic_type: +topic_type: - "apiref" --- # CorLaunchApplication Function -Starts the application at the specified network path, using the specified manifests and other application data. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT CorLaunchApplication ( - [in] HOST_TYPE dwClickOnceHost, - [in] LPCWSTR pwzAppFullName, - [in] DWORD dwManifestPaths, - [in] LPCWSTR *ppwzManifestPaths, - [in] DWORD dwActivationData, - [in] LPCWSTR *ppwzActivationData, - [out] LPPROCESS_INFORMATION lpProcessInformation -); -``` - -## Parameters - - `dwClickOnceHost` - [in] A value of the [HOST_TYPE](host-type-enumeration.md) enumeration that specifies the type of host that is launching the application. - - `pwzAppFullName` - [in] The full name of the application that is being launched. - - `dwManifestPaths` - [in] The number of manifest paths for the application. - - `ppwzManifestPaths` - [in] An array of strings, each of which specifies a path to a manifest for the application that is being launched. - - `dwActivationData` - [in] The number of activation data items for the application that is being launched. - - `ppwzActivationData` - [in] An array of strings, each of which is an activation data item for the application that is being launched. - - `lpProcessInformation` - [out] A pointer to information about the process in which the application has been loaded. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Starts the application at the specified network path, using the specified manifests and other application data. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT CorLaunchApplication ( + [in] HOST_TYPE dwClickOnceHost, + [in] LPCWSTR pwzAppFullName, + [in] DWORD dwManifestPaths, + [in] LPCWSTR *ppwzManifestPaths, + [in] DWORD dwActivationData, + [in] LPCWSTR *ppwzActivationData, + [out] LPPROCESS_INFORMATION lpProcessInformation +); +``` + +## Parameters + + `dwClickOnceHost` + [in] A value of the [HOST_TYPE](host-type-enumeration.md) enumeration that specifies the type of host that is launching the application. + + `pwzAppFullName` + [in] The full name of the application that is being launched. + + `dwManifestPaths` + [in] The number of manifest paths for the application. + + `ppwzManifestPaths` + [in] An array of strings, each of which specifies a path to a manifest for the application that is being launched. + + `dwActivationData` + [in] The number of activation data items for the application that is being launched. + + `ppwzActivationData` + [in] An array of strings, each of which is an activation data item for the application that is being launched. + + `lpProcessInformation` + [out] A pointer to information about the process in which the application has been loaded. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md b/docs/core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md index b36529b4e1746..4d8753eb25ae1 100644 --- a/docs/core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md +++ b/docs/core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md @@ -2,40 +2,39 @@ description: "Learn more about: CorMarkThreadInThreadPool Function" title: "CorMarkThreadInThreadPool Function" ms.date: "03/30/2017" -api_name: +api_name: - "CorMarkThreadInThreadPool" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "CorMarkThreadInThreadPool" -helpviewer_keywords: +helpviewer_keywords: - "CorMarkThreadInThreadPool function [.NET Framework hosting]" -ms.assetid: 3f958d41-e82e-4ec3-ae6f-16c7b3b31e3e -topic_type: +topic_type: - "apiref" --- # CorMarkThreadInThreadPool Function -Marks the currently executing thread-pool thread for the execution of managed code. Starting with .NET Framework version 2.0, this function has no effect. It is not required, and can be removed from your code. This function is deprecated in the .NET Framework 4. - -## Syntax - -```cpp -void CorMarkThreadInThreadPool (); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Marks the currently executing thread-pool thread for the execution of managed code. Starting with .NET Framework version 2.0, this function has no effect. It is not required, and can be removed from your code. This function is deprecated in the .NET Framework 4. + +## Syntax + +```cpp +void CorMarkThreadInThreadPool (); +``` + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/corruntimehost-coclass.md b/docs/core/unmanaged-api/hosting/corruntimehost-coclass.md index 25b6f01907d37..50ae304b66325 100644 --- a/docs/core/unmanaged-api/hosting/corruntimehost-coclass.md +++ b/docs/core/unmanaged-api/hosting/corruntimehost-coclass.md @@ -2,56 +2,55 @@ description: "Learn more about: CorRuntimeHost Coclass" title: "CorRuntimeHost Coclass" ms.date: "03/30/2017" -api_name: +api_name: - "CorRuntimeHost Coclass" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorRuntimeHost" -helpviewer_keywords: +helpviewer_keywords: - "CoRuntimeHost coclass [.NET Framework hosting]" -ms.assetid: 5833740b-7d67-44b4-865c-b5bf45e291e3 -topic_type: +topic_type: - "apiref" --- # CorRuntimeHost Coclass -Provides interfaces for managing applications that are being executed by the common language runtime. - -## Syntax - -```cpp -coclass CorRuntimeHost { - [default] interface ICorRuntimeHost; - interface IGCHost; - interface ICorConfiguration; - interface IValidator; - interface IDebuggerInfo; -}; -``` - -## Interfaces - -|Interface|Description| -|---------------|-----------------| -|[ICorConfiguration Interface](icorconfiguration-interface.md)|Provides methods for configuring the common language runtime (CLR).| -|[ICorRuntimeHost Interface](icorruntimehost-interface.md)|Provides methods that enable the host to start and stop the common language runtime explicitly, to create and configure application domains, to access the default domain, and to enumerate all domains running in the process.| -|[IDebuggerInfo Interface](idebuggerinfo-interface.md)|Provides methods for obtaining information about the state of the debugging services.| -|[IGCHost Interface](igchost-interface.md)|Provides methods for obtaining information about the garbage collection system and for controlling some aspects of garbage collection.| -|"IValidator"|Provides methods for validation of portable executable images and detailed reporting of validation errors.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.idl - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Provides interfaces for managing applications that are being executed by the common language runtime. + +## Syntax + +```cpp +coclass CorRuntimeHost { + [default] interface ICorRuntimeHost; + interface IGCHost; + interface ICorConfiguration; + interface IValidator; + interface IDebuggerInfo; +}; +``` + +## Interfaces + +|Interface|Description| +|---------------|-----------------| +|[ICorConfiguration Interface](icorconfiguration-interface.md)|Provides methods for configuring the common language runtime (CLR).| +|[ICorRuntimeHost Interface](icorruntimehost-interface.md)|Provides methods that enable the host to start and stop the common language runtime explicitly, to create and configure application domains, to access the default domain, and to enumerate all domains running in the process.| +|[IDebuggerInfo Interface](idebuggerinfo-interface.md)|Provides methods for obtaining information about the state of the debugging services.| +|[IGCHost Interface](igchost-interface.md)|Provides methods for obtaining information about the garbage collection system and for controlling some aspects of garbage collection.| +|"IValidator"|Provides methods for validation of portable executable images and detailed reporting of validation errors.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.idl + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Hosting Coclasses](hosting-coclasses.md) diff --git a/docs/core/unmanaged-api/hosting/corvalidateimage-function.md b/docs/core/unmanaged-api/hosting/corvalidateimage-function.md index 3425763d064a8..dfb0e37350473 100644 --- a/docs/core/unmanaged-api/hosting/corvalidateimage-function.md +++ b/docs/core/unmanaged-api/hosting/corvalidateimage-function.md @@ -2,84 +2,83 @@ 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](../../../framework/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] 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](../../../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 Global Static Functions](../metadata/metadata-global-static-functions.md) diff --git a/docs/core/unmanaged-api/hosting/couninitializecor-function.md b/docs/core/unmanaged-api/hosting/couninitializecor-function.md index b491716f17953..54bea80cccdaa 100644 --- a/docs/core/unmanaged-api/hosting/couninitializecor-function.md +++ b/docs/core/unmanaged-api/hosting/couninitializecor-function.md @@ -2,35 +2,34 @@ 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. + +## Syntax + +```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. - 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 - [Metadata Global Static Functions](../metadata/metadata-global-static-functions.md) diff --git a/docs/core/unmanaged-api/hosting/couninitializeee-function.md b/docs/core/unmanaged-api/hosting/couninitializeee-function.md index ff8f0ed97ccf6..7f53d8577b590 100644 --- a/docs/core/unmanaged-api/hosting/couninitializeee-function.md +++ b/docs/core/unmanaged-api/hosting/couninitializeee-function.md @@ -2,37 +2,36 @@ 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) diff --git a/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md b/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md index 374871908eb75..3fe36f5688a9a 100644 --- a/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md +++ b/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md @@ -13,13 +13,12 @@ f1_keywords: - "CreateDebuggingInterfaceFromVersion" helpviewer_keywords: - "CreateDebuggingInterfaceFromVersion function [.NET Framework hosting]" -ms.assetid: a746a849-463c-44f5-a2f0-9e812ed8bcc3 topic_type: - "apiref" --- # CreateDebuggingInterfaceFromVersion Function (.NET Framework) -Creates an [ICorDebug](../debugging/icordebug-interface.md) object based on the specified version information. +Creates an [ICorDebug](../../../framework/debuggingicordebug-interface.md) object based on the specified version information. This function is obsolete in the .NET Framework 4. Instead, to get an interface for the common language runtime (CLR) 2.0, use the [ICLRRuntimeInfo::GetInterface](iclrruntimeinfo-getinterface-method.md) method and specify the class identifier CLSID_CLRDebuggingLegacy and the interface identifier IID_ICorDebug. To get an interface for CLR 4 or later, call the [CLRCreateInstance](clrcreateinstance-function.md) function and specify the class identifier CLSID_CLRDebugging and the interface identifier IID_ICLRDebugging. @@ -36,7 +35,7 @@ HRESULT CreateDebuggingInterfaceFromVersion ( ## Parameters `iDebuggerVersion`\ - [in] The version of `ICorDebug` that is expected by the debugger. See the [CorDebugInterfaceVersion](../debugging/cordebuginterfaceversion-enumeration.md) enumeration for valid values. + [in] The version of `ICorDebug` that is expected by the debugger. See the [CorDebugInterfaceVersion](../../../framework/debuggingcordebuginterfaceversion-enumeration.md) enumeration for valid values. `szDebuggeeVersion`\ [in] The common language runtime version associated with the application or process to be debugged. See the [GetVersionFromProcess](getversionfromprocess-function.md) or [GetRequestedRuntimeVersion](getrequestedruntimeversion-function.md) method for information on retrieving this value. @@ -65,7 +64,7 @@ HRESULT CreateDebuggingInterfaceFromVersion ( **Library:** 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/hosting/createiceefilegen-function.md b/docs/core/unmanaged-api/hosting/createiceefilegen-function.md index 23a2da9fd3ad9..50daf8562b0c2 100644 --- a/docs/core/unmanaged-api/hosting/createiceefilegen-function.md +++ b/docs/core/unmanaged-api/hosting/createiceefilegen-function.md @@ -2,61 +2,60 @@ description: "Learn more about: CreateICeeFileGen Function" title: "CreateICeeFileGen Function" ms.date: "03/30/2017" -api_name: +api_name: - "CreateICeeFileGen" -api_location: +api_location: - "mscoree.dll" - "mscorpehost.dll" - "mscorpe.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CreateICeeFileGen" -helpviewer_keywords: +helpviewer_keywords: - "CreateICeeFileGen function [.NET Framework hosting]" -ms.assetid: e36e1fd8-8456-4359-bdc3-3ec1765f041f -topic_type: +topic_type: - "apiref" --- # CreateICeeFileGen Function -Creates an [ICeeFileGen](iceefilegen-class.md) object. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT CreateICeeFileGen ( - [out] ICeeFileGen **ceeFileGen -); -``` - -## Parameters - - `ceeFileGen` - [out] A pointer to the address of a new `ICeeFileGen` object. - -## Return Value - - This method returns standard COM error codes. - -## Remarks - - The `ICeeFileGen` object is used to create common language runtime (CLR) portable executable (PE) files. - - Call the [DestroyICeeFileGen](destroyiceefilegen-function.md) function to destroy the `ICeeFileGen` object when finished. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** ICeeFileGen.h - - **Library:** MSCorPE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Creates an [ICeeFileGen](iceefilegen-class.md) object. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT CreateICeeFileGen ( + [out] ICeeFileGen **ceeFileGen +); +``` + +## Parameters + + `ceeFileGen` + [out] A pointer to the address of a new `ICeeFileGen` object. + +## Return Value + + This method returns standard COM error codes. + +## Remarks + + The `ICeeFileGen` object is used to create common language runtime (CLR) portable executable (PE) files. + + Call the [DestroyICeeFileGen](destroyiceefilegen-function.md) function to destroy the `ICeeFileGen` object when finished. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** ICeeFileGen.h + + **Library:** MSCorPE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/customdumpitem-structure.md b/docs/core/unmanaged-api/hosting/customdumpitem-structure.md index bc881f30389cc..be6ce2e3d1bce 100644 --- a/docs/core/unmanaged-api/hosting/customdumpitem-structure.md +++ b/docs/core/unmanaged-api/hosting/customdumpitem-structure.md @@ -2,56 +2,55 @@ description: "Learn more about: CustomDumpItem Structure" title: "CustomDumpItem Structure" ms.date: "03/30/2017" -api_name: +api_name: - "CustomDumpItem" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CustomDumpItem" -helpviewer_keywords: +helpviewer_keywords: - "CustomDumpItem structure [.NET Framework hosting]" -ms.assetid: fd9085ff-7beb-4c38-97f0-037cd8ba4f65 -topic_type: +topic_type: - "apiref" --- # CustomDumpItem Structure -Describes an item to be added to a custom dump in error reporting. - -## Syntax - -```cpp -struct { +Describes an item to be added to a custom dump in error reporting. + +## Syntax + +```cpp +struct { ECustomDumpItemKind itemKind; - union { - UINT_PTR pReserved; - } -} CustomDumpItem; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`itemKind`|An [ECustomDumpItemKind](ecustomdumpitemkind-enumeration.md) value that indicates the kind of item to be added.| -|`pReserved`|Not currently used. Any items added to the union must be no larger than pointer size. If a `struct` is required, you must allocate it separately and point to it.| - -## Remarks - - [ICLRErrorReportingManager::BeginCustomDump](iclrerrorreportingmanager-begincustomdump-method.md) takes a parameter of type `CustomDumpItem`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.idl - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - + union { + UINT_PTR pReserved; + } +} CustomDumpItem; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`itemKind`|An [ECustomDumpItemKind](ecustomdumpitemkind-enumeration.md) value that indicates the kind of item to be added.| +|`pReserved`|Not currently used. Any items added to the union must be no larger than pointer size. If a `struct` is required, you must allocate it separately and point to it.| + +## Remarks + + [ICLRErrorReportingManager::BeginCustomDump](iclrerrorreportingmanager-begincustomdump-method.md) takes a parameter of type `CustomDumpItem`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.idl + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Hosting Structures](hosting-structures.md) diff --git a/docs/core/unmanaged-api/hosting/deprecated-clr-hosting-functions.md b/docs/core/unmanaged-api/hosting/deprecated-clr-hosting-functions.md index ebffca45d0571..8a6d0bf0a2106 100644 --- a/docs/core/unmanaged-api/hosting/deprecated-clr-hosting-functions.md +++ b/docs/core/unmanaged-api/hosting/deprecated-clr-hosting-functions.md @@ -2,160 +2,159 @@ description: "Learn more about: Deprecated CLR Hosting Functions" title: "Deprecated CLR Hosting Functions" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - ".NET Framework 1.1, hosting global static functions" - "global static functions [.NET Framework hosting], version 2.0" - ".NET Framework 2.0, hosting global static functions" - "hosting global static functions [.NET Framework], version 2.0" -ms.assetid: 91fbbb35-e543-4814-b806-371cebae8c5a --- # Deprecated CLR Hosting Functions -This section describes the unmanaged global static functions that earlier versions of the hosting API used. - - With the exception of the infrastructure functions (`_Cor*` functions), which are used only by the .NET Framework, these functions have been deprecated in the .NET Framework 4. - -## Activation functions - - [ClrCreateManagedInstance Function](clrcreatemanagedinstance-function.md) - Deprecated. Creates an instance of the specified managed type. - - [CoInitializeCor Function](coinitializecor-function.md) - Obsolete. To initialize the common language runtime (CLR), use either [CorBindToRuntimeEx](corbindtoruntimeex-function.md) or [CorBindToCurrentRuntime](corbindtocurrentruntime-function.md). - - [CoInitializeEE Function](coinitializeee-function.md) - Deprecated. Ensures that the CLR execution engine is loaded into a process. Use the [ICLRRuntimeHost::Start](iclrruntimehost-start-method.md) method instead. - - [CorBindToCurrentRuntime Function](corbindtocurrentruntime-function.md) - Deprecated. Loads the common language runtime (CLR) into a process by using version information stored in an XML file. - - [CorBindToRuntime Function](corbindtoruntime-function.md) - Deprecated. Enables unmanaged hosts to load the CLR into a process. - - [CorBindToRuntimeByCfg Function](corbindtoruntimebycfg-function.md) - Deprecated. Loads the CLR into a process by using version information that is read from an XML file. - - [CorBindToRuntimeEx Function](corbindtoruntimeex-function.md) - Deprecated. Enables unmanaged hosts to load the CLR into a process, and allows you to set flags to specify the behavior of the CLR. - - [CorBindToRuntimeHost Function](corbindtoruntimehost-function.md) - Deprecated. Enables hosts to load a specified version of the CLR into a process. - - [GetCORRequiredVersion Function](getcorrequiredversion-function.md) - Deprecated. Gets the required CLR version number. - - [GetCORSystemDirectory Function](getcorsystemdirectory-function.md) - Deprecated. Returns the installation directory of the CLR that is loaded into the process. - - [GetRealProcAddress Function](getrealprocaddress-function.md) - Deprecated. Gets the address of the specified function that is exported from the latest installed version of the CLR. - - [GetRequestedRuntimeInfo Function](getrequestedruntimeinfo-function.md) - Deprecated. Gets version and directory information about the CLR requested by an application. - -## CLR version functions - - The functions in this section return a CLR version; they do not activate the CLR. - - [GetCORVersion Function](getcorversion-function.md) - Deprecated. Returns the version number of the CLR that is running in the current process. - - [GetFileVersion Function](getfileversion-function.md) - Deprecated. Gets the CLR version information of the specified file, using the specified buffer. - - [GetRequestedRuntimeVersion Function](getrequestedruntimeversion-function.md) - Deprecated. Gets the version number of the CLR requested by the specified application. If that version is not installed, gets the most recent version that is installed before the requested version. - - [GetRequestedRuntimeVersionForCLSID Function](getrequestedruntimeversionforclsid-function.md) - Deprecated. Gets the appropriate CLR version information for the class with the specified CLSID. - - [GetVersionFromProcess Function](getversionfromprocess-function.md) - Deprecated. Gets the version number of the CLR that is associated with the specified process handle. - - [LockClrVersion Function](lockclrversion-function.md) - Deprecated. Allows the host to determine which version of the CLR will be used within the process before explicitly initializing the CLR. - -## Hosting functions - - [CallFunctionShim Function](callfunctionshim-function.md) - Deprecated. Makes a call to the function that has the specified name and parameters in the specified library. - - [CoEEShutDownCOM Function](coeeshutdowncom-function.md) - Deprecated. Unloads a COM assembly from the process. - - [CorExitProcess Function](corexitprocess-function.md) - Deprecated. Shuts down the current unmanaged process. - - [CorLaunchApplication Function](corlaunchapplication-function.md) - Deprecated. Starts the application at the specified network path, using the specified manifests and other application data. - - [CorMarkThreadInThreadPool Function](cormarkthreadinthreadpool-function.md) - Deprecated. Marks the currently executing thread-pool thread for the execution of managed code. Starting with .NET Framework version 2.0, this function has no effect. It is not required, and can be removed from your code. - - [CoUninitializeCor Function](couninitializecor-function.md) - Obsolete. The CLR cannot be unloaded from a process. - - [CoUninitializeEE Function](couninitializeee-function.md) - Obsolete. - - [CreateDebuggingInterfaceFromVersion Function](createdebugginginterfacefromversion-function.md) - Deprecated. Creates an [ICorDebug](../debugging/icordebug-interface.md) object based on the specified version information. - - [CreateICeeFileGen Function](createiceefilegen-function.md) - Deprecated. Creates an [ICeeFileGen](iceefilegen-class.md) object. - - [DestroyICeeFileGen Function](destroyiceefilegen-function.md) - Deprecated. Destroys an [ICeeFileGen](iceefilegen-class.md) object. - - [FExecuteInAppDomainCallback Function Pointer](fexecuteinappdomaincallback-function-pointer.md) - Deprecated. Points to a function that the CLR calls to execute managed code. - - [FLockClrVersionCallback Function Pointer](flockclrversioncallback-function-pointer.md) - Deprecated. Points to a function that the CLR calls to notify the host that initialization has either started or completed. - - [GetCLRIdentityManager Function](getclridentitymanager-function.md) - Deprecated. Gets a pointer to an interface that allows the CLR to manage identities. - - [LoadLibraryShim Function](loadlibraryshim-function.md) - Deprecated. Loads a specified version of a .NET Framework DLL. - - [LoadStringRC Function](loadstringrc-function.md) - Deprecated. Translates an HRESULT value into an error message by using the default culture of the current thread. - - [LoadStringRCEx Function](loadstringrcex-function.md) - Deprecated. Translates an HRESULT value to an appropriate error message for the specified culture. - - [LPOVERLAPPED_COMPLETION_ROUTINE Function Pointer](lpoverlapped-completion-routine-function-pointer.md) - Deprecated. Points to a function that notifies the host when an overlapped (that is, asynchronous) I/O to a device has completed. - - [LPTHREAD_START_ROUTINE Function Pointer](lpthread-start-routine-function-pointer.md) - Deprecated. Points to a function that notifies the host that a thread has started to execute. - - [RunDll32ShimW Function](rundll32shimw-function.md) - Deprecated. Executes the specified command. - - [WAITORTIMERCALLBACK Function Pointer](waitortimercallback-function-pointer.md) - Deprecated. Points to a function that notifies the host that a wait handle has either been signaled or timed out. - -## Infrastructure functions - - The functions in this section are for use by the .NET Framework only. - - [_CorDllMain Function](cordllmain-function.md) - Initializes the CLR, locates the managed entry point in the DLL assembly's CLR header, and begins execution. - - [_CorExeMain Function](corexemain-function.md) - Initializes the CLR, locates the managed entry point in the executable assembly's CLR header, and begins execution. - - [_CorExeMain2 Function](corexemain2-function.md) - Executes the entry point in the specified memory-mapped code. This function is called by the operating system loader. - - [_CorImageUnloading Function](corimageunloading-function.md) - Notifies the loader when the managed module images are unloaded. - - [_CorValidateImage Function](corvalidateimage-function.md) - Validates managed module images, and notifies the operating system loader after they have been loaded. - +This section describes the unmanaged global static functions that earlier versions of the hosting API used. + + With the exception of the infrastructure functions (`_Cor*` functions), which are used only by the .NET Framework, these functions have been deprecated in the .NET Framework 4. + +## Activation functions + + [ClrCreateManagedInstance Function](clrcreatemanagedinstance-function.md) + Deprecated. Creates an instance of the specified managed type. + + [CoInitializeCor Function](coinitializecor-function.md) + Obsolete. To initialize the common language runtime (CLR), use either [CorBindToRuntimeEx](corbindtoruntimeex-function.md) or [CorBindToCurrentRuntime](corbindtocurrentruntime-function.md). + + [CoInitializeEE Function](coinitializeee-function.md) + Deprecated. Ensures that the CLR execution engine is loaded into a process. Use the [ICLRRuntimeHost::Start](iclrruntimehost-start-method.md) method instead. + + [CorBindToCurrentRuntime Function](corbindtocurrentruntime-function.md) + Deprecated. Loads the common language runtime (CLR) into a process by using version information stored in an XML file. + + [CorBindToRuntime Function](corbindtoruntime-function.md) + Deprecated. Enables unmanaged hosts to load the CLR into a process. + + [CorBindToRuntimeByCfg Function](corbindtoruntimebycfg-function.md) + Deprecated. Loads the CLR into a process by using version information that is read from an XML file. + + [CorBindToRuntimeEx Function](corbindtoruntimeex-function.md) + Deprecated. Enables unmanaged hosts to load the CLR into a process, and allows you to set flags to specify the behavior of the CLR. + + [CorBindToRuntimeHost Function](corbindtoruntimehost-function.md) + Deprecated. Enables hosts to load a specified version of the CLR into a process. + + [GetCORRequiredVersion Function](getcorrequiredversion-function.md) + Deprecated. Gets the required CLR version number. + + [GetCORSystemDirectory Function](getcorsystemdirectory-function.md) + Deprecated. Returns the installation directory of the CLR that is loaded into the process. + + [GetRealProcAddress Function](getrealprocaddress-function.md) + Deprecated. Gets the address of the specified function that is exported from the latest installed version of the CLR. + + [GetRequestedRuntimeInfo Function](getrequestedruntimeinfo-function.md) + Deprecated. Gets version and directory information about the CLR requested by an application. + +## CLR version functions + + The functions in this section return a CLR version; they do not activate the CLR. + + [GetCORVersion Function](getcorversion-function.md) + Deprecated. Returns the version number of the CLR that is running in the current process. + + [GetFileVersion Function](getfileversion-function.md) + Deprecated. Gets the CLR version information of the specified file, using the specified buffer. + + [GetRequestedRuntimeVersion Function](getrequestedruntimeversion-function.md) + Deprecated. Gets the version number of the CLR requested by the specified application. If that version is not installed, gets the most recent version that is installed before the requested version. + + [GetRequestedRuntimeVersionForCLSID Function](getrequestedruntimeversionforclsid-function.md) + Deprecated. Gets the appropriate CLR version information for the class with the specified CLSID. + + [GetVersionFromProcess Function](getversionfromprocess-function.md) + Deprecated. Gets the version number of the CLR that is associated with the specified process handle. + + [LockClrVersion Function](lockclrversion-function.md) + Deprecated. Allows the host to determine which version of the CLR will be used within the process before explicitly initializing the CLR. + +## Hosting functions + + [CallFunctionShim Function](callfunctionshim-function.md) + Deprecated. Makes a call to the function that has the specified name and parameters in the specified library. + + [CoEEShutDownCOM Function](coeeshutdowncom-function.md) + Deprecated. Unloads a COM assembly from the process. + + [CorExitProcess Function](corexitprocess-function.md) + Deprecated. Shuts down the current unmanaged process. + + [CorLaunchApplication Function](corlaunchapplication-function.md) + Deprecated. Starts the application at the specified network path, using the specified manifests and other application data. + + [CorMarkThreadInThreadPool Function](cormarkthreadinthreadpool-function.md) + Deprecated. Marks the currently executing thread-pool thread for the execution of managed code. Starting with .NET Framework version 2.0, this function has no effect. It is not required, and can be removed from your code. + + [CoUninitializeCor Function](couninitializecor-function.md) + Obsolete. The CLR cannot be unloaded from a process. + + [CoUninitializeEE Function](couninitializeee-function.md) + Obsolete. + + [CreateDebuggingInterfaceFromVersion Function](createdebugginginterfacefromversion-function.md) + Deprecated. Creates an [ICorDebug](../../../framework/debuggingicordebug-interface.md) object based on the specified version information. + + [CreateICeeFileGen Function](createiceefilegen-function.md) + Deprecated. Creates an [ICeeFileGen](iceefilegen-class.md) object. + + [DestroyICeeFileGen Function](destroyiceefilegen-function.md) + Deprecated. Destroys an [ICeeFileGen](iceefilegen-class.md) object. + + [FExecuteInAppDomainCallback Function Pointer](fexecuteinappdomaincallback-function-pointer.md) + Deprecated. Points to a function that the CLR calls to execute managed code. + + [FLockClrVersionCallback Function Pointer](flockclrversioncallback-function-pointer.md) + Deprecated. Points to a function that the CLR calls to notify the host that initialization has either started or completed. + + [GetCLRIdentityManager Function](getclridentitymanager-function.md) + Deprecated. Gets a pointer to an interface that allows the CLR to manage identities. + + [LoadLibraryShim Function](loadlibraryshim-function.md) + Deprecated. Loads a specified version of a .NET Framework DLL. + + [LoadStringRC Function](loadstringrc-function.md) + Deprecated. Translates an HRESULT value into an error message by using the default culture of the current thread. + + [LoadStringRCEx Function](loadstringrcex-function.md) + Deprecated. Translates an HRESULT value to an appropriate error message for the specified culture. + + [LPOVERLAPPED_COMPLETION_ROUTINE Function Pointer](lpoverlapped-completion-routine-function-pointer.md) + Deprecated. Points to a function that notifies the host when an overlapped (that is, asynchronous) I/O to a device has completed. + + [LPTHREAD_START_ROUTINE Function Pointer](lpthread-start-routine-function-pointer.md) + Deprecated. Points to a function that notifies the host that a thread has started to execute. + + [RunDll32ShimW Function](rundll32shimw-function.md) + Deprecated. Executes the specified command. + + [WAITORTIMERCALLBACK Function Pointer](waitortimercallback-function-pointer.md) + Deprecated. Points to a function that notifies the host that a wait handle has either been signaled or timed out. + +## Infrastructure functions + + The functions in this section are for use by the .NET Framework only. + + [_CorDllMain Function](cordllmain-function.md) + Initializes the CLR, locates the managed entry point in the DLL assembly's CLR header, and begins execution. + + [_CorExeMain Function](corexemain-function.md) + Initializes the CLR, locates the managed entry point in the executable assembly's CLR header, and begins execution. + + [_CorExeMain2 Function](corexemain2-function.md) + Executes the entry point in the specified memory-mapped code. This function is called by the operating system loader. + + [_CorImageUnloading Function](corimageunloading-function.md) + Notifies the loader when the managed module images are unloaded. + + [_CorValidateImage Function](corvalidateimage-function.md) + Validates managed module images, and notifies the operating system loader after they have been loaded. + ## See also - [.NET Framework 4 Hosting Global Static Functions](net-framework-4-hosting-global-static-functions.md) diff --git a/docs/core/unmanaged-api/hosting/deprecated-clr-hosting-interfaces-and-coclasses.md b/docs/core/unmanaged-api/hosting/deprecated-clr-hosting-interfaces-and-coclasses.md index 0a0bcd13b9f65..ec3babecb5ee8 100644 --- a/docs/core/unmanaged-api/hosting/deprecated-clr-hosting-interfaces-and-coclasses.md +++ b/docs/core/unmanaged-api/hosting/deprecated-clr-hosting-interfaces-and-coclasses.md @@ -2,29 +2,28 @@ description: "Learn more about: Deprecated CLR Hosting Interfaces and Coclasses" title: "Deprecated CLR Hosting Interfaces and Coclasses" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - "interfaces [.NET Framework hosting], version 1" - ".NET Framework 1.1, hosting interfaces" - "hosting interfaces [.NET Framework], version 1" - ".NET Framework 1.0, hosting interfaces" -ms.assetid: 7b3d2755-cbab-4160-bc69-eb85791e38c7 --- # Deprecated CLR Hosting Interfaces and Coclasses -This section describes the interfaces that unmanaged hosts can use to integrate the common language runtime (CLR) in the .NET Framework versions 1.0 and 1.1 into their applications. These interfaces provide methods for a host to configure and load the runtime into a process. - -## In This Section +This section describes the interfaces that unmanaged hosts can use to integrate the common language runtime (CLR) in the .NET Framework versions 1.0 and 1.1 into their applications. These interfaces provide methods for a host to configure and load the runtime into a process. - IAppDomainSetup - Provides methods for the host to configure an . - - [ICeeFileGen Class](iceefilegen-class.md) - (Deprecated) Provides functionality for creating a native portable executable (PE) file. - - [ICorRuntimeHost Interface](icorruntimehost-interface.md) - Provides methods for the host to configure CLR settings. - -## Related Sections +## In This Section - [CLR Hosting Interfaces](clr-hosting-interfaces.md) + IAppDomainSetup + Provides methods for the host to configure an . + + [ICeeFileGen Class](iceefilegen-class.md) + (Deprecated) Provides functionality for creating a native portable executable (PE) file. + + [ICorRuntimeHost Interface](icorruntimehost-interface.md) + Provides methods for the host to configure CLR settings. + +## Related Sections + + [CLR Hosting Interfaces](clr-hosting-interfaces.md) Contains topics that describe the hosting interfaces provided with the .NET Framework version 2.0 and later versions. diff --git a/docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md b/docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md index 44ae2ffdb3974..f62fd41857684 100644 --- a/docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md +++ b/docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md @@ -2,59 +2,58 @@ description: "Learn more about: DestroyICeeFileGen Function" title: "DestroyICeeFileGen Function" ms.date: "03/30/2017" -api_name: +api_name: - "DestroyICeeFileGen" -api_location: +api_location: - "mscoree.dll" - "mscorpehost.dll" - "mscorpe.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "DestroyICeeFileGen" -helpviewer_keywords: +helpviewer_keywords: - "DestroyICeeFileGen function [.NET Framework hosting]" -ms.assetid: dc1e2235-e721-4cb2-a0b8-6b0c030d7bab -topic_type: +topic_type: - "apiref" --- # DestroyICeeFileGen Function -Destroys an [ICeeFileGen](iceefilegen-class.md) object. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT DestroyICeeFileGen ( - [in] ICeeFileGen **ceeFileGen -); -``` - -## Parameters - - `ceeFileGen` - [in] The `ICeeFileGen` object to destroy. - -## Return Value - - This method returns standard COM error codes. - -## Remarks - - `DestroyICeeFileGen` destroys the `ICeeFileGen` object created by the [CreateICeeFileGen](createiceefilegen-function.md) function. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** ICeeFileGen.h - - **Library:** MSCorPE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Destroys an [ICeeFileGen](iceefilegen-class.md) object. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT DestroyICeeFileGen ( + [in] ICeeFileGen **ceeFileGen +); +``` + +## Parameters + + `ceeFileGen` + [in] The `ICeeFileGen` object to destroy. + +## Return Value + + This method returns standard COM error codes. + +## Remarks + + `DestroyICeeFileGen` destroys the `ICeeFileGen` object created by the [CreateICeeFileGen](createiceefilegen-function.md) function. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** ICeeFileGen.h + + **Library:** MSCorPE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/eapicategories-enumeration.md b/docs/core/unmanaged-api/hosting/eapicategories-enumeration.md index 782b61f2e039f..e166a5f4867c3 100644 --- a/docs/core/unmanaged-api/hosting/eapicategories-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eapicategories-enumeration.md @@ -2,74 +2,73 @@ description: "Learn more about: EApiCategories Enumeration" title: "EApiCategories Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EApiCategories" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EApiCategories" -helpviewer_keywords: +helpviewer_keywords: - "EApiCategories enumeration [.NET Framework hosting]" -ms.assetid: 3c4a8a5a-8a46-4ac9-947f-4959bc9d6ac6 -topic_type: +topic_type: - "apiref" --- # EApiCategories Enumeration -Describes the categories of capabilities that the host can block from running in partially trusted code. - -## Syntax - -```cpp -typedef enum { - eNoCategory = 0, - eSynchronization = 0x1, - eSharedState = 0x2, - eExternalProcessMgmt = 0x4, - eSelfAffectingProcessMgmt = 0x8, - eExternalThreading = 0x10, - eSelfAffectingThreading = 0x20, - eSecurityInfrastructure = 0x40, - eUI = 0x80, - eMayLeakOnAbort = 0x100, - eAll = 0x1ff -} EHostProtectionCategories; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`eAll`|Specifies that all managed classes and members that are covered by other `EApiCategories` fields be blocked from running in partially trusted code.| -|`eExternalProcessMgmt`|Specifies that managed classes and members that allow the creation, manipulation, and destruction of external processes be blocked from running in partially trusted code.| -|`eExternalThreading`|Specifies that managed classes and members that allow the creation, manipulation, and destruction of external threads be blocked from running in partially trusted code.| -|`eMayLeakOnAbort`|Specifies that managed types and members that could potentially leak memory on abort be blocked from running in partially trusted code.| -|`eNoCategory`|Specifies that no managed code categories be blocked from running in partially trusted code.| -|`eSecurityInfrastructure`|Specifies that the common language runtime (CLR) security infrastructure be blocked from being used by partially trusted code.| -|`eSelfAffectingProcessMgmt`|Specifies that managed classes and members whose capabilities can affect the hosted process be blocked from running in partially trusted code.| -|`eSelfAffectingThreading`|Specifies that managed classes and members whose capabilities can affect threads in the hosted process be blocked from running in partially trusted code.| -|`eSharedState`|Specifies that managed classes and members that expose shared state be blocked from running in partially trusted code.| -|`eSynchronization`|Specifies that common language runtime classes and members that allow user code to hold locks be blocked from running in partially trusted code.| -|`eUI`|Specifies that managed classes and members that allow or require human interaction be blocked from running in partially trusted code.| - -## Remarks +Describes the categories of capabilities that the host can block from running in partially trusted code. - The [ICLRHostProtectionManager::SetProtectedCategories](iclrhostprotectionmanager-setprotectedcategories-method.md) method takes a parameter of type `EApiCategories`. - - The `EApiCategories` enumeration and the `SetProtectedCategories` method are directly related to the managed class. The managed class is used with the enumeration, whose values correspond directly to the `EApiCategories` values, to mark managed types and members that expose capabilities corresponding to the categories described by `EApiCategories`. - -## Requirements +## Syntax + +```cpp +typedef enum { + eNoCategory = 0, + eSynchronization = 0x1, + eSharedState = 0x2, + eExternalProcessMgmt = 0x4, + eSelfAffectingProcessMgmt = 0x8, + eExternalThreading = 0x10, + eSelfAffectingThreading = 0x20, + eSecurityInfrastructure = 0x40, + eUI = 0x80, + eMayLeakOnAbort = 0x100, + eAll = 0x1ff +} EHostProtectionCategories; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`eAll`|Specifies that all managed classes and members that are covered by other `EApiCategories` fields be blocked from running in partially trusted code.| +|`eExternalProcessMgmt`|Specifies that managed classes and members that allow the creation, manipulation, and destruction of external processes be blocked from running in partially trusted code.| +|`eExternalThreading`|Specifies that managed classes and members that allow the creation, manipulation, and destruction of external threads be blocked from running in partially trusted code.| +|`eMayLeakOnAbort`|Specifies that managed types and members that could potentially leak memory on abort be blocked from running in partially trusted code.| +|`eNoCategory`|Specifies that no managed code categories be blocked from running in partially trusted code.| +|`eSecurityInfrastructure`|Specifies that the common language runtime (CLR) security infrastructure be blocked from being used by partially trusted code.| +|`eSelfAffectingProcessMgmt`|Specifies that managed classes and members whose capabilities can affect the hosted process be blocked from running in partially trusted code.| +|`eSelfAffectingThreading`|Specifies that managed classes and members whose capabilities can affect threads in the hosted process be blocked from running in partially trusted code.| +|`eSharedState`|Specifies that managed classes and members that expose shared state be blocked from running in partially trusted code.| +|`eSynchronization`|Specifies that common language runtime classes and members that allow user code to hold locks be blocked from running in partially trusted code.| +|`eUI`|Specifies that managed classes and members that allow or require human interaction be blocked from running in partially trusted code.| + +## Remarks + + The [ICLRHostProtectionManager::SetProtectedCategories](iclrhostprotectionmanager-setprotectedcategories-method.md) method takes a parameter of type `EApiCategories`. + + The `EApiCategories` enumeration and the `SetProtectedCategories` method are directly related to the managed class. The managed class is used with the enumeration, whose values correspond directly to the `EApiCategories` values, to mark managed types and members that expose capabilities corresponding to the categories described by `EApiCategories`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - ## See also - [ICLRHostProtectionManager Interface](iclrhostprotectionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md b/docs/core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md index 31578a4d5668c..a058ba480654d 100644 --- a/docs/core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md @@ -2,66 +2,65 @@ description: "Learn more about: EBindPolicyLevels Enumeration" title: "EBindPolicyLevels Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EBindPolicyLevels" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EBindPolicyLevels" -helpviewer_keywords: +helpviewer_keywords: - "EBindPolicyLevels enumeration [.NET Framework hosting]" -ms.assetid: a9e00b4f-b6d0-4257-bd88-4fe9af97b8fa -topic_type: +topic_type: - "apiref" --- # EBindPolicyLevels Enumeration -Provides flags to specify the level at which to apply or modify assembly policy. - -## Syntax - -```cpp -typedef enum { - ePolicyLevelNone = 0x0, - ePolicyLevelRetargetable = 0x1, - ePolicyUnifiedToCLR = 0x2, - ePolicyLevelApp = 0x4, - ePolicyLevelPublisher = 0x8, - ePolicyLevelHost = 0x10, - ePolicyLevelAdmin = 0x20 - ePolicyPortability = 0x40 -} EBindPolicyLevels; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`ePolicyLevelAdmin`|Specifies that policy should be applied at the administrator level.| -|`ePolicyLevelApp`|Specifies that policy should be applied at the application level.| -|`ePolicyLevelHost`|Specifies that policy should be applied at the host level.| -|`ePolicyLevelNone`|Specifies no policy-level flags.| -|`ePolicyLevelPublisher`|Specifies that policy should be applied at the publisher level.| -|`ePolicyLevelRetargetable`|Specifies that policy should be applicable at variable levels.| -|`ePolicyPortability`|Specifies that policy should support portability between implementations of a .NET Framework assembly. See the [\](../../configure-apps/file-schema/runtime/supportportability-element.md) configuration file element.| -|`ePolicyUnifiedToCLR`|Specifies that policy should be unified to that of the common language runtime (CLR).| - -## Remarks +Provides flags to specify the level at which to apply or modify assembly policy. - This enumeration is passed to methods of the [ICLRHostBindingPolicyManager](iclrhostbindingpolicymanager-interface.md) interface to specify changes in application policy. - -## Requirements +## Syntax + +```cpp +typedef enum { + ePolicyLevelNone = 0x0, + ePolicyLevelRetargetable = 0x1, + ePolicyUnifiedToCLR = 0x2, + ePolicyLevelApp = 0x4, + ePolicyLevelPublisher = 0x8, + ePolicyLevelHost = 0x10, + ePolicyLevelAdmin = 0x20 + ePolicyPortability = 0x40 +} EBindPolicyLevels; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`ePolicyLevelAdmin`|Specifies that policy should be applied at the administrator level.| +|`ePolicyLevelApp`|Specifies that policy should be applied at the application level.| +|`ePolicyLevelHost`|Specifies that policy should be applied at the host level.| +|`ePolicyLevelNone`|Specifies no policy-level flags.| +|`ePolicyLevelPublisher`|Specifies that policy should be applied at the publisher level.| +|`ePolicyLevelRetargetable`|Specifies that policy should be applicable at variable levels.| +|`ePolicyPortability`|Specifies that policy should support portability between implementations of a .NET Framework assembly. See the [\](../../../framework/configure-apps/file-schema/runtime/supportportability-element.md) configuration file element.| +|`ePolicyUnifiedToCLR`|Specifies that policy should be unified to that of the common language runtime (CLR).| + +## Remarks + + This enumeration is passed to methods of the [ICLRHostBindingPolicyManager](iclrhostbindingpolicymanager-interface.md) interface to specify changes in application policy. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - ## See also - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md b/docs/core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md index 1f83cb7dd0e64..4c94074067d1a 100644 --- a/docs/core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md @@ -2,46 +2,45 @@ description: "Learn more about: ECLRAssemblyIdentityFlags Enumeration" title: "ECLRAssemblyIdentityFlags Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "ECLRAssemblyIdentityFlags" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ECLRAssemblyIdentityFlags" -helpviewer_keywords: +helpviewer_keywords: - "ECLRAssemblyIdentityFlags enumeration [.NET Framework hosting]" -ms.assetid: d1e0b654-ccaf-4fa2-9aa3-8e007813c84d -topic_type: +topic_type: - "apiref" --- # ECLRAssemblyIdentityFlags Enumeration -Indicates the type of an assembly's identity. - -## Syntax - -```cpp -typedef enum _CLRAssemblyIdentityFlags { - CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT = 0 -} ECLRAssemblyIdentityFlags; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT`|The identity is canonicalized.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Indicates the type of an assembly's identity. + +## Syntax + +```cpp +typedef enum _CLRAssemblyIdentityFlags { + CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT = 0 +} ECLRAssemblyIdentityFlags; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT`|The identity is canonicalized.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/eclrevent-enumeration.md b/docs/core/unmanaged-api/hosting/eclrevent-enumeration.md index 17ead968a6a67..ab2310a50971c 100644 --- a/docs/core/unmanaged-api/hosting/eclrevent-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eclrevent-enumeration.md @@ -2,62 +2,61 @@ description: "Learn more about: EClrEvent Enumeration" title: "EClrEvent Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EClrEvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EClrEvent" -helpviewer_keywords: +helpviewer_keywords: - "EClrEvent enumeration [.NET Framework hosting]" -ms.assetid: 7c36a7c2-75a2-4971-bc23-abf54c812154 -topic_type: +topic_type: - "apiref" --- # EClrEvent Enumeration -Describes the common language runtime (CLR) events for which the host can register callbacks. - -## Syntax - -```cpp -typedef enum { - Event_ClrDisabled, - Event_DomainUnload, - Event_MDAFired, - Event_StackOverflow -} EClrEvent; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`Event_ClrDisabled`|Specifies a fatal CLR error.| -|`Event_DomainUnload`|Specifies the unloading of a particular .| -|`Event_MDAFired`|Specifies that a Managed Debugging Assistant (MDA) message has been generated.| -|`Event_StackOverflow`|Specifies that a stack overflow error has occurred.| - -## Remarks - - The host can register callbacks for any of the event types described by `EClrEvent` by calling methods of the [ICLROnEventManager](iclroneventmanager-interface.md) interface. The host gets a pointer to this interface by calling the [ICLRControl::GetCLRManager](iclrcontrol-getclrmanager-method.md) method. - - The `Event_CLRDisabled` and `Event_DomainUnload` events can be raised more than once and from different threads to signal an unload or the disabling of the CLR. - - The `Event_MDAFired` event raises the creation of an [MDAInfo](mdainfo-structure.md) instance that contains the details of the MDA message. For more information about MDAs, see [Diagnosing Errors with Managed Debugging Assistants](../../debug-trace-profile/diagnosing-errors-with-managed-debugging-assistants.md). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Describes the common language runtime (CLR) events for which the host can register callbacks. + +## Syntax + +```cpp +typedef enum { + Event_ClrDisabled, + Event_DomainUnload, + Event_MDAFired, + Event_StackOverflow +} EClrEvent; +``` + +## Members + +| Member | Description | +|-----------------------|--------------------------------------------------------------------------------| +| `Event_ClrDisabled` | Specifies a fatal CLR error. | +| `Event_DomainUnload` | Specifies the unloading of a particular . | +| `Event_MDAFired` | Specifies that a Managed Debugging Assistant (MDA) message has been generated. | +| `Event_StackOverflow` | Specifies that a stack overflow error has occurred. | + +## Remarks + + The host can register callbacks for any of the event types described by `EClrEvent` by calling methods of the [ICLROnEventManager](iclroneventmanager-interface.md) interface. The host gets a pointer to this interface by calling the [ICLRControl::GetCLRManager](iclrcontrol-getclrmanager-method.md) method. + + The `Event_CLRDisabled` and `Event_DomainUnload` events can be raised more than once and from different threads to signal an unload or the disabling of the CLR. + + The `Event_MDAFired` event raises the creation of an [MDAInfo](mdainfo-structure.md) instance that contains the details of the MDA message. For more information about MDAs, see [Diagnosing Errors with Managed Debugging Assistants](../../../framework/debug-trace-profile/diagnosing-errors-with-managed-debugging-assistants.md). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [IActionOnCLREvent Interface](iactiononclrevent-interface.md) diff --git a/docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md b/docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md index c275684004b38..72fd61b81c3b7 100644 --- a/docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md @@ -2,64 +2,63 @@ description: "Learn more about: EClrFailure Enumeration" title: "EClrFailure Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EClrFailure" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EClrFailure" -helpviewer_keywords: +helpviewer_keywords: - "EClrFailure enumeration [.NET Framework hosting]" -ms.assetid: 37b95cce-9bfb-4ecf-a00b-33dcba782c67 -topic_type: +topic_type: - "apiref" --- # EClrFailure Enumeration -Describes the set of failures for which a host can set policy actions. - -## Syntax - -```cpp -typedef enum { - FAIL_NonCriticalResource, - FAIL_CriticalResource, - FAIL_FatalRuntime, - FAIL_OrphanedLock - FAIL_StackOverflow - FAIL_AccessViolation - FAIL_CodeContract -} EClrFailure; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`FAIL_NonCriticalResource`|A failure occurred during an attempt to allocate a resource (such as a thread, a block of memory, or a lock) in a non-critical region of code.| -|`FAIL_CriticalResource`|A failure occurred during an attempt to allocate a resource (such as a thread, a block of memory, or a lock) in a critical region of code.| -|`FAIL_FatalRuntime`|The common language runtime (CLR) is no longer able to run managed code in the process. Henceforth, calls to any hosting functions return an HRESULT value of HOST_E_CLRNOTAVAILABLE.| -|`FAIL_OrphanedLock`|A thread has failed to release a lock upon returning from an object. The host cannot set this failure to cause a thread to abort.| -|`FAIL_StackOverflow`|A stack overflow has occurred.| -|`FAIL_AccessViolation`|An attempt was made to read or write protected memory. Not supported in the .NET Framework 4.| -|`FAIL_CodeContract`|A code contract failure occurred. See [Code Contracts](../../debug-trace-profile/code-contracts.md).| - -## Remarks +Describes the set of failures for which a host can set policy actions. - See the [ICLRPolicyManager::SetActionOnFailure](iclrpolicymanager-setactiononfailure-method.md) method for a list of [EPolicyAction](epolicyaction-enumeration.md) values the host can use to specify the policy actions for failure conditions. For more information about critical and non-critical regions of code, see [EClrOperation](eclroperation-enumeration.md). - -## Requirements +## Syntax + +```cpp +typedef enum { + FAIL_NonCriticalResource, + FAIL_CriticalResource, + FAIL_FatalRuntime, + FAIL_OrphanedLock + FAIL_StackOverflow + FAIL_AccessViolation + FAIL_CodeContract +} EClrFailure; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`FAIL_NonCriticalResource`|A failure occurred during an attempt to allocate a resource (such as a thread, a block of memory, or a lock) in a non-critical region of code.| +|`FAIL_CriticalResource`|A failure occurred during an attempt to allocate a resource (such as a thread, a block of memory, or a lock) in a critical region of code.| +|`FAIL_FatalRuntime`|The common language runtime (CLR) is no longer able to run managed code in the process. Henceforth, calls to any hosting functions return an HRESULT value of HOST_E_CLRNOTAVAILABLE.| +|`FAIL_OrphanedLock`|A thread has failed to release a lock upon returning from an object. The host cannot set this failure to cause a thread to abort.| +|`FAIL_StackOverflow`|A stack overflow has occurred.| +|`FAIL_AccessViolation`|An attempt was made to read or write protected memory. Not supported in the .NET Framework 4.| +|`FAIL_CodeContract`|A code contract failure occurred. See [Code Contracts](../../../framework/debug-trace-profile/code-contracts.md).| + +## Remarks + + See the [ICLRPolicyManager::SetActionOnFailure](iclrpolicymanager-setactiononfailure-method.md) method for a list of [EPolicyAction](epolicyaction-enumeration.md) values the host can use to specify the policy actions for failure conditions. For more information about critical and non-critical regions of code, see [EClrOperation](eclroperation-enumeration.md). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - ## See also - [ICLRPolicyManager Interface](iclrpolicymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/eclroperation-enumeration.md b/docs/core/unmanaged-api/hosting/eclroperation-enumeration.md index 9186b85f06e48..12e7041668064 100644 --- a/docs/core/unmanaged-api/hosting/eclroperation-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eclroperation-enumeration.md @@ -2,70 +2,69 @@ description: "Learn more about: EClrOperation Enumeration" title: "EClrOperation Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EClrOperation" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EClrOperation" -helpviewer_keywords: +helpviewer_keywords: - "EClrOperation enumeration [.NET Framework hosting]" -ms.assetid: 5aef6808-5aac-4b2f-a2c7-fee1575c55ed -topic_type: +topic_type: - "apiref" --- # EClrOperation Enumeration -Describes the set of operations for which a host can apply policy actions. - -## Syntax - -```cpp -typedef enum { - OPR_ThreadAbort, - OPR_ThreadRudeAbortInNonCriticalRegion, - OPR_ThreadRudeAbortInCriticalRegion, - OPR_AppDomainUnload, - OPR_AppDomainRudeUnload, - OPR_ProcessExit, - OPR_FinalizerRun -} EClrOperation; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`OPR_AppDomainRudeUnload`|The host can specify policy actions to be taken when an is unloaded in a non-graceful (rude) manner.| -|`OPR_AppDomainUnload`|The host can specify policy actions to be taken when an is unloaded.| -|`OPR_FinalizerRun`|The host can specify policy actions to be taken when finalizers run.| -|`OPR_ProcessExit`|The host can specify policy actions to be taken when the process exits.| -|`OPR_ThreadAbort`|The host can specify policy actions to be taken when a thread is aborted.| -|`OPR_ThreadRudeAbortInCriticalRegion`|The host can specify policy actions to be taken when a rude thread abort occurs in a critical region of code.| -|`OPR_ThreadRudeAbortInNonCriticalRegion`|The host can specify policy actions to be take when a rude thread abort occurs in a non-critical region of code.| - -## Remarks - - The common language runtime (CLR) reliability infrastructure distinguishes between aborts and resource allocation failures that occur in critical regions of code and those that occur in non-critical regions of code. This distinction is designed to allow hosts to set different policies depending on where a failure occurs in the code. - - A *critical region of code* is any space where the CLR cannot guarantee that aborting a task or failing to complete a request for resources will affect only the current task. For example, if a task is holding a lock and receives an HRESULT that indicates failure upon making a memory allocation request, it is insufficient simply to abort that task to ensure the stability of the , because the might contain other tasks waiting for the same lock. To abandon the current task might cause those other tasks to stop responding. In such a case, the host needs the ability to unload the entire rather than risk potential instability. - - A *non-critical region of code*, on the other hand, is a region where the CLR can guarantee that an abort or a failure will affect only the task upon which the error occurs. - - The CLR also distinguishes between graceful and non-graceful (rude) aborts. In general, a normal or graceful abort makes every effort to run exception-handling routines and finalizers before aborting a task, while a rude abort makes no such guarantees. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Describes the set of operations for which a host can apply policy actions. + +## Syntax + +```cpp +typedef enum { + OPR_ThreadAbort, + OPR_ThreadRudeAbortInNonCriticalRegion, + OPR_ThreadRudeAbortInCriticalRegion, + OPR_AppDomainUnload, + OPR_AppDomainRudeUnload, + OPR_ProcessExit, + OPR_FinalizerRun +} EClrOperation; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`OPR_AppDomainRudeUnload`|The host can specify policy actions to be taken when an is unloaded in a non-graceful (rude) manner.| +|`OPR_AppDomainUnload`|The host can specify policy actions to be taken when an is unloaded.| +|`OPR_FinalizerRun`|The host can specify policy actions to be taken when finalizers run.| +|`OPR_ProcessExit`|The host can specify policy actions to be taken when the process exits.| +|`OPR_ThreadAbort`|The host can specify policy actions to be taken when a thread is aborted.| +|`OPR_ThreadRudeAbortInCriticalRegion`|The host can specify policy actions to be taken when a rude thread abort occurs in a critical region of code.| +|`OPR_ThreadRudeAbortInNonCriticalRegion`|The host can specify policy actions to be take when a rude thread abort occurs in a non-critical region of code.| + +## Remarks + + The common language runtime (CLR) reliability infrastructure distinguishes between aborts and resource allocation failures that occur in critical regions of code and those that occur in non-critical regions of code. This distinction is designed to allow hosts to set different policies depending on where a failure occurs in the code. + + A *critical region of code* is any space where the CLR cannot guarantee that aborting a task or failing to complete a request for resources will affect only the current task. For example, if a task is holding a lock and receives an HRESULT that indicates failure upon making a memory allocation request, it is insufficient simply to abort that task to ensure the stability of the , because the might contain other tasks waiting for the same lock. To abandon the current task might cause those other tasks to stop responding. In such a case, the host needs the ability to unload the entire rather than risk potential instability. + + A *non-critical region of code*, on the other hand, is a region where the CLR can guarantee that an abort or a failure will affect only the task upon which the error occurs. + + The CLR also distinguishes between graceful and non-graceful (rude) aborts. In general, a normal or graceful abort makes every effort to run exception-handling routines and finalizers before aborting a task, while a rude abort makes no such guarantees. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [EClrFailure Enumeration](eclrfailure-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md b/docs/core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md index e625ef52fc637..eb4414bccd5c8 100644 --- a/docs/core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md +++ b/docs/core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md @@ -2,54 +2,53 @@ description: "Learn more about: EClrUnhandledException Enumeration" title: "EClrUnhandledException Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EClrUnhandledException" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EClrUnhandledException" -helpviewer_keywords: +helpviewer_keywords: - "EClrUnhandledException enumeration [.NET Framework hosting]" -ms.assetid: d231044e-2b53-4836-93f9-8117ff0e5c3a -topic_type: +topic_type: - "apiref" --- # EClrUnhandledException Enumeration -Describes the available options for managing exceptions that are unhandled in user code. - -## Syntax - -```cpp -typedef enum { - eRuntimeDeterminedPolicy, - eHostDeterminedPolicy -} EClrUnhandledException; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`eRuntimeDeterminedPolicy`|Specifies that the default behavior occurs. The process is torn down.| -|`eHostDeterminedPolicy`|Specifies that the common language runtime (CLR) ignores unhandled exceptions and lets the host determine any further action.| - -## Remarks - - To specify that the CLR behave like earlier versions, use the `eHostDeterminedPolicy` member. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Describes the available options for managing exceptions that are unhandled in user code. + +## Syntax + +```cpp +typedef enum { + eRuntimeDeterminedPolicy, + eHostDeterminedPolicy +} EClrUnhandledException; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`eRuntimeDeterminedPolicy`|Specifies that the default behavior occurs. The process is torn down.| +|`eHostDeterminedPolicy`|Specifies that the common language runtime (CLR) ignores unhandled exceptions and lets the host determine any further action.| + +## Remarks + + To specify that the CLR behave like earlier versions, use the `eHostDeterminedPolicy` member. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [EClrFailure Enumeration](eclrfailure-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/econtexttype-enumeration.md b/docs/core/unmanaged-api/hosting/econtexttype-enumeration.md index d5ddeb33d9eb2..02f9d7034f84f 100644 --- a/docs/core/unmanaged-api/hosting/econtexttype-enumeration.md +++ b/docs/core/unmanaged-api/hosting/econtexttype-enumeration.md @@ -2,54 +2,53 @@ description: "Learn more about: EContextType Enumeration" title: "EContextType Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EContextType" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EContextType" -helpviewer_keywords: +helpviewer_keywords: - "EContextType enumeration [.NET Framework hosting]" -ms.assetid: 92b926a9-b87e-408a-9036-df7b752c9492 -topic_type: +topic_type: - "apiref" --- # EContextType Enumeration -Describes the security context of the currently executing thread. - -## Syntax - -```cpp -typedef enum { - eCurrentContext = 0x00, - eRestrictedContext = 0x01 -} EContextType; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`eCurrentContext`|Indicates the context on the current thread at the time the common language runtime (CLR) calls the [IHostSecurityManager::GetSecurityContext](ihostsecuritymanager-getsecuritycontext-method.md) method, or the context requested by the CLR in a call to the [IHostSecurityManager::SetSecurityContext](ihostsecuritymanager-setsecuritycontext-method.md) method.| -|`eRestrictedContext`|Indicates a context over which the host has lower privileges, such as the garbage collector, or class or module constructors.| - -## Remarks - - The CLR supplies one of the `EContextType` values as a parameter value in calls to the `IHostSecurityManager::GetSecurityContext` and `IHostSecurityManager::SetSecurityContext` methods. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Describes the security context of the currently executing thread. + +## Syntax + +```cpp +typedef enum { + eCurrentContext = 0x00, + eRestrictedContext = 0x01 +} EContextType; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`eCurrentContext`|Indicates the context on the current thread at the time the common language runtime (CLR) calls the [IHostSecurityManager::GetSecurityContext](ihostsecuritymanager-getsecuritycontext-method.md) method, or the context requested by the CLR in a call to the [IHostSecurityManager::SetSecurityContext](ihostsecuritymanager-setsecuritycontext-method.md) method.| +|`eRestrictedContext`|Indicates a context over which the host has lower privileges, such as the garbage collector, or class or module constructors.| + +## Remarks + + The CLR supplies one of the `EContextType` values as a parameter value in calls to the `IHostSecurityManager::GetSecurityContext` and `IHostSecurityManager::SetSecurityContext` methods. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [IHostSecurityContext Interface](ihostsecuritycontext-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md b/docs/core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md index 11030aeb3d2bb..9ca244a7025df 100644 --- a/docs/core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md @@ -2,54 +2,53 @@ description: "Learn more about: ECustomDumpFlavor Enumeration" title: "ECustomDumpFlavor Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "ECustomDumpFlavor" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ECustomDumpFlavor" -helpviewer_keywords: +helpviewer_keywords: - "ECustomDumpFlavor enumeration [.NET Framework hosting]" -ms.assetid: b39b3320-fac7-41f1-9a03-ab6fb0cd89c7 -topic_type: +topic_type: - "apiref" --- # ECustomDumpFlavor Enumeration -Contains values that indicate which items to include in a custom subset of a heap dump when reporting errors. - -## Syntax - -```cpp -typedef enum { - DUMP_FLAVOR_Mini = 1, - DUMP_FLAVOR_NonHeapCLRState = 2 -} ECustomDumpFlavor; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`DUMP_FLAVOR_Mini`|Specifies that the custom heap dump should start as a minidump and include extra data specified by any [CustomDumpItem](customdumpitem-structure.md) instances passed to the same method.| -|`DUMP_FLAVOR_NonHeapCLRState`|Specifies that the custom heap dump should gather all run-time state data that was not dynamically allocated.| - -## Remarks - - A parameter of type `ECustomDumpFlavor` is passed to the [ICLRErrorReportingManager::BeginCustomDump](iclrerrorreportingmanager-begincustomdump-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Contains values that indicate which items to include in a custom subset of a heap dump when reporting errors. + +## Syntax + +```cpp +typedef enum { + DUMP_FLAVOR_Mini = 1, + DUMP_FLAVOR_NonHeapCLRState = 2 +} ECustomDumpFlavor; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`DUMP_FLAVOR_Mini`|Specifies that the custom heap dump should start as a minidump and include extra data specified by any [CustomDumpItem](customdumpitem-structure.md) instances passed to the same method.| +|`DUMP_FLAVOR_NonHeapCLRState`|Specifies that the custom heap dump should gather all run-time state data that was not dynamically allocated.| + +## Remarks + + A parameter of type `ECustomDumpFlavor` is passed to the [ICLRErrorReportingManager::BeginCustomDump](iclrerrorreportingmanager-begincustomdump-method.md) method. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [ECustomDumpItemKind Enumeration](ecustomdumpitemkind-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md b/docs/core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md index 8df86d9f65135..790893d24d043 100644 --- a/docs/core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md @@ -2,48 +2,47 @@ description: "Learn more about: ECustomDumpItemKind Enumeration" title: "ECustomDumpItemKind Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "ECustomDumpItemKind" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ECustomDumpItemKind" -helpviewer_keywords: +helpviewer_keywords: - "ECustomDumpItemKind enumeration [.NET Framework hosting]" -ms.assetid: 7105a6c8-6e4e-48de-ac3d-74ac75e5de2e -topic_type: +topic_type: - "apiref" --- # ECustomDumpItemKind Enumeration -Reserved for future extension of the [CustomDumpItem](customdumpitem-structure.md) structure. - -## Syntax - -```cpp -typedef enum { - DUMP_ITEM_None = 0 -} ECustomDumpItemKind; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`DUMP_ITEM_None`|Reserved for future use.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Reserved for future extension of the [CustomDumpItem](customdumpitem-structure.md) structure. + +## Syntax + +```cpp +typedef enum { + DUMP_ITEM_None = 0 +} ECustomDumpItemKind; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`DUMP_ITEM_None`|Reserved for future use.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [ICLRErrorReportingManager Interface](iclrerrorreportingmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md b/docs/core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md index 14f729ab3542c..1d6c09d5630cc 100644 --- a/docs/core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md @@ -2,42 +2,41 @@ description: "Learn more about: EHostApplicationPolicy Enumeration" title: "EHostApplicationPolicy Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EHostApplicationPolicy" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EHostApplicationPolicy" -helpviewer_keywords: +helpviewer_keywords: - "EHostApplicationPolicy enumeration [.NET Framework hosting]" -ms.assetid: 0be52d90-1976-4bf7-9717-908833a8a78d -topic_type: +topic_type: - "apiref" --- # EHostApplicationPolicy Enumeration -Indicates how to modify an [IHostAssemblyManager](ihostassemblymanager-interface.md) interface object. This enumeration has been deprecated. - -## Syntax - -```cpp -typedef enum _HostApplicationPolicy { - HOST_APPLICATION_BINDING_POLICY = 1 -} EHostApplicationPolicy; -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Indicates how to modify an [IHostAssemblyManager](ihostassemblymanager-interface.md) interface object. This enumeration has been deprecated. + +## Syntax + +```cpp +typedef enum _HostApplicationPolicy { + HOST_APPLICATION_BINDING_POLICY = 1 +} EHostApplicationPolicy; +``` + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md b/docs/core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md index ac1398521c9d7..ef031eb5b1b9c 100644 --- a/docs/core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md @@ -2,58 +2,57 @@ description: "Learn more about: EHostBindingPolicyModifyFlags Enumeration" title: "EHostBindingPolicyModifyFlags Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EHostBindingPolicyModifyFlags" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EHostBindingPolicyModifyFlags" -helpviewer_keywords: +helpviewer_keywords: - "EHostBindingPolicyModifyFlags enumeration [.NET Framework hosting]" -ms.assetid: 0339af16-ee1d-48ec-837d-a79d9a9c89f8 -topic_type: +topic_type: - "apiref" --- # EHostBindingPolicyModifyFlags Enumeration -Allows the host to specify the type of redirection the common language runtime (CLR) should perform when applying policy modifications from a source assembly to a target assembly. - -## Syntax - -```cpp -typedef enum _hostBindingPolicyModifyFlags { - HOST_BINDING_POLICY_MODIFY_DEFAULT = 0, - HOST_BINDING_POLICY_MODIFY_CHAIN = 1, - HOST_BINDING_POLICY_MODIFY_REMOVE = 2, - HOST_BINDING_POLICY_MODIFY_MAX = 3 -} EHostBindingPolicyModifyFlags; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`HOST_BINDING_POLICY_MODIFY_CHAIN`|Specifies that the CLR will chain policy values of the source assembly onto those of the target assembly.| -|`HOST_BINDING_POLICY_MODIFY_DEFAULT`|Specifies that the CLR will perform the default action.| -|`HOST_BINDING_POLICY_MODIFY_MAX`|Specifies that the CLR will set the policy values of the target assembly to the maximum values.| -|`HOST_BINDING_POLICY_MODIFY_REMOVE`|Specifies that the CLR will replace policy values of the target assembly with those of the source assembly.| - -## Remarks - - The [ICLRHostBindingPolicyManager::ModifyApplicationPolicy](iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md) method takes a parameter of type `EHostBindingPolicyModifyFlags`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Allows the host to specify the type of redirection the common language runtime (CLR) should perform when applying policy modifications from a source assembly to a target assembly. + +## Syntax + +```cpp +typedef enum _hostBindingPolicyModifyFlags { + HOST_BINDING_POLICY_MODIFY_DEFAULT = 0, + HOST_BINDING_POLICY_MODIFY_CHAIN = 1, + HOST_BINDING_POLICY_MODIFY_REMOVE = 2, + HOST_BINDING_POLICY_MODIFY_MAX = 3 +} EHostBindingPolicyModifyFlags; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`HOST_BINDING_POLICY_MODIFY_CHAIN`|Specifies that the CLR will chain policy values of the source assembly onto those of the target assembly.| +|`HOST_BINDING_POLICY_MODIFY_DEFAULT`|Specifies that the CLR will perform the default action.| +|`HOST_BINDING_POLICY_MODIFY_MAX`|Specifies that the CLR will set the policy values of the target assembly to the maximum values.| +|`HOST_BINDING_POLICY_MODIFY_REMOVE`|Specifies that the CLR will replace policy values of the target assembly with those of the source assembly.| + +## Remarks + + The [ICLRHostBindingPolicyManager::ModifyApplicationPolicy](iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md) method takes a parameter of type `EHostBindingPolicyModifyFlags`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [ICLRHostBindingPolicyManager Interface](iclrhostbindingpolicymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md b/docs/core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md index 508ebeb14378a..3a8c9cb5be4a3 100644 --- a/docs/core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md @@ -2,52 +2,51 @@ description: "Learn more about: EInitializeNewDomainFlags Enumeration" title: "EInitializeNewDomainFlags Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EInitializeNewDomainFlags" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EInitializeNewDomainFlags" -helpviewer_keywords: +helpviewer_keywords: - "EInitializeNewDomainFlags enumeration [.NET Framework hosting]" -ms.assetid: 3a120ab2-f5ef-4c9b-8595-d3ed7247c342 --- # EInitializeNewDomainFlags Enumeration -Enables the host to provide the runtime with information about the initialization of an application domain. - -## Syntax - -```cpp -typedef enum { - eInitializeNewDomainFlags_None = 0x0000, - eInitializeNewDomainFlags_NoSecurityChanges = 0x0002 -} EInitializeNewDomainFlags; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`eInitializeNewDomainFlags_None`|No flags.| -|`eInitializeNewDomainFlags_NoSecurityChanges`|Informs the common language runtime (CLR) that the host will not make changes to the security state of the application domain in the method.| - -## Remarks - - The [ICLRDomainManager::SetAppDomainManagerType](iclrdomainmanager-setappdomainmanagertype-method.md) method takes a parameter of type `EInitializeNewDomainFlags`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Enables the host to provide the runtime with information about the initialization of an application domain. + +## Syntax + +```cpp +typedef enum { + eInitializeNewDomainFlags_None = 0x0000, + eInitializeNewDomainFlags_NoSecurityChanges = 0x0002 +} EInitializeNewDomainFlags; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`eInitializeNewDomainFlags_None`|No flags.| +|`eInitializeNewDomainFlags_NoSecurityChanges`|Informs the common language runtime (CLR) that the host will not make changes to the security state of the application domain in the method.| + +## Remarks + + The [ICLRDomainManager::SetAppDomainManagerType](iclrdomainmanager-setappdomainmanagertype-method.md) method takes a parameter of type `EInitializeNewDomainFlags`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md b/docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md index 117dc39e3b661..2ca597f48f310 100644 --- a/docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md @@ -2,56 +2,55 @@ description: "Learn more about: EMemoryAvailable Enumeration" title: "EMemoryAvailable Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EMemoryAvailable" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EMemoryAvailable" -helpviewer_keywords: +helpviewer_keywords: - "EMemoryAvailable enumeration [.NET Framework hosting]" -ms.assetid: 38e72a06-dbed-473b-a59b-7e0b3ea4f2af -topic_type: +topic_type: - "apiref" --- # EMemoryAvailable Enumeration -Contains values that indicate the amount of free physical memory on the computer. These values logically map to the events for high and low memory returned from the `CreateMemoryResourceNotification` function in the Windows API. - -## Syntax - -```cpp -typedef enum { - eMemoryAvailableLow = 1, - eMemoryAvailableNeutral = 2, +Contains values that indicate the amount of free physical memory on the computer. These values logically map to the events for high and low memory returned from the `CreateMemoryResourceNotification` function in the Windows API. + +## Syntax + +```cpp +typedef enum { + eMemoryAvailableLow = 1, + eMemoryAvailableNeutral = 2, eMemoryAvailableHigh = 3 -} EMemoryAvailable; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`eMemoryAvailableHigh`|Plenty of physical memory is available.| -|`eMemoryAvailableLow`|Very little physical memory is available.| -|`eMemoryAvailableNeutral`|The available physical memory is neutral.| - -## Remarks - - This value is passed by the host to the common language runtime (CLR) by using a call to the [ICLRMemoryNotificationCallback::OnMemoryNotification](iclrmemorynotificationcallback-onmemorynotification-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +} EMemoryAvailable; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`eMemoryAvailableHigh`|Plenty of physical memory is available.| +|`eMemoryAvailableLow`|Very little physical memory is available.| +|`eMemoryAvailableNeutral`|The available physical memory is neutral.| + +## Remarks + + This value is passed by the host to the common language runtime (CLR) by using a call to the [ICLRMemoryNotificationCallback::OnMemoryNotification](iclrmemorynotificationcallback-onmemorynotification-method.md) method. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md b/docs/core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md index 45c616f4695bc..63a8ed188c1e6 100644 --- a/docs/core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md +++ b/docs/core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md @@ -2,56 +2,55 @@ description: "Learn more about: EMemoryCriticalLevel Enumeration" title: "EMemoryCriticalLevel Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EMemoryCriticalLevel" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EMemoryCriticalLevel" -helpviewer_keywords: +helpviewer_keywords: - "EMemoryCriticalLevel enumeration [.NET Framework hosting]" -ms.assetid: 2ca8a7a2-7b54-4ba3-8e73-277c7df485f3 -topic_type: +topic_type: - "apiref" --- # EMemoryCriticalLevel Enumeration -Contains values that indicate the impact of a failure when a specific memory allocation has been requested but cannot be satisfied. - -## Syntax - -```cpp -typedef enum { - eTaskCritical = 0, - eAppDomainCritical = 1, - eProcessCritical = 2 -} EMemoryCriticalLevel; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`eAppDomainCritical`|Indicates that the allocation is critical for executing managed code in the domain that has requested the allocation. If memory cannot be allocated, the CLR cannot guarantee that the domain is still usable. The host decides what action to take when the allocation cannot be satisfied. It can instruct the CLR to abort the `AppDomain` automatically, or allow it to keep running by calling methods on [ICLRPolicyManager](iclrpolicymanager-interface.md).| -|`eProcessCritical`|Indicates that the allocation is critical to the execution of managed code in the process. This value is used during startup and when running finalizers. If memory cannot be allocated, the CLR cannot operate in the process. If the allocation fails, the CLR is effectively disabled. All subsequent calls into the CLR fail with HOST_E_CLRNOTAVAILABLE.| -|`eTaskCritical`|Indicates that the allocation is critical to running the task that has requested the allocation. If memory cannot be allocated, the CLR cannot guarantee that the task can be executed. In the event of failure, the CLR raises a on the physical operation system thread.| - -## Remarks - - The memory allocation methods defined in the [IHostMemoryManager](ihostmemorymanager-interface.md) and [IHostMAlloc](ihostmalloc-interface.md) interfaces take a parameter of this type. Depending upon the severity of a failure, a host can decide whether to fail the allocation request immediately or to wait until it can be satisfied. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Contains values that indicate the impact of a failure when a specific memory allocation has been requested but cannot be satisfied. + +## Syntax + +```cpp +typedef enum { + eTaskCritical = 0, + eAppDomainCritical = 1, + eProcessCritical = 2 +} EMemoryCriticalLevel; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`eAppDomainCritical`|Indicates that the allocation is critical for executing managed code in the domain that has requested the allocation. If memory cannot be allocated, the CLR cannot guarantee that the domain is still usable. The host decides what action to take when the allocation cannot be satisfied. It can instruct the CLR to abort the `AppDomain` automatically, or allow it to keep running by calling methods on [ICLRPolicyManager](iclrpolicymanager-interface.md).| +|`eProcessCritical`|Indicates that the allocation is critical to the execution of managed code in the process. This value is used during startup and when running finalizers. If memory cannot be allocated, the CLR cannot operate in the process. If the allocation fails, the CLR is effectively disabled. All subsequent calls into the CLR fail with HOST_E_CLRNOTAVAILABLE.| +|`eTaskCritical`|Indicates that the allocation is critical to running the task that has requested the allocation. If memory cannot be allocated, the CLR cannot guarantee that the task can be executed. In the event of failure, the CLR raises a on the physical operation system thread.| + +## Remarks + + The memory allocation methods defined in the [IHostMemoryManager](ihostmemorymanager-interface.md) and [IHostMAlloc](ihostmalloc-interface.md) interfaces take a parameter of this type. Depending upon the severity of a failure, a host can decide whether to fail the allocation request immediately or to wait until it can be satisfied. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [ICLRMemoryNotificationCallback Interface](iclrmemorynotificationcallback-interface.md) diff --git a/docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md b/docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md index 2adc72cb45664..28d40ff68a4b7 100644 --- a/docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md +++ b/docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md @@ -2,70 +2,69 @@ description: "Learn more about: EPolicyAction Enumeration" title: "EPolicyAction Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EPolicyAction" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EPolicyAction" -helpviewer_keywords: +helpviewer_keywords: - "EPolicyAction enumeration [.NET Framework hosting]" -ms.assetid: 72dd76ba-239e-45ac-9ded-318fb07d6c6d -topic_type: +topic_type: - "apiref" --- # EPolicyAction Enumeration -Describes the policy actions the host can set for operations described by [EClrOperation](eclroperation-enumeration.md) and failures described by [EClrFailure](eclrfailure-enumeration.md). - -## Syntax - -```cpp -typedef enum { - eNoAction, - eThrowException, - eAbortThread, - eRudeAbortThread, - eUnloadAppDomain, - eRudeUnloadAppDomain, - eExitProcess, - eFastExitProcess, - eRudeExitProcess, - eDisableRuntime -} EPolicyAction; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`eAbortThread`|Specifies that the common language runtime (CLR) should abort the thread gracefully. A graceful abort includes attempts to run all `finally` blocks, any `catch` blocks related to thread aborts, and finalizers.| -|`eDisableRuntime`|Specifies that the CLR should enter a disabled state. No further managed code can be executed in the affected process, and threads are blocked from entering the CLR.| -|`eExitProcess`|Specifies that the CLR should attempt a graceful exit of the process, including running finalizers and performing cleanup and logging operations.| -|`eFastExitProcess`|Specifies that the CLR should exit the process immediately, without running finalizers or performing cleanup and logging operations. However, notification is sent to the debugger.| -|`eNoAction`|Specifies that no action should be taken.| -|`eRudeAbortThread`|Specifies that the CLR should perform a rude thread abort. Only those `catch` and `finally` blocks marked with are executed.| -|`eRudeExitProcess`|Specifies that the CLR should exit the process without running finalizers or logging operations.| -|`eRudeUnloadAppDomain`|Specifies that the CLR should perform a rude unload of the . Only finalizers marked with are executed. Similarly, all threads with this in their stack receive a `ThreadAbortException`, but only those `catch` and `finally` blocks marked with are executed.| -|`eThrowException`|Specifies that an exception appropriate to the condition, such as out-of-memory, buffer overflow, and so forth, should be thrown.| -|`eUnloadAppDomain`|Specifies that the should be unloaded. The CLR attempts to run finalizers.| - -## Remarks +Describes the policy actions the host can set for operations described by [EClrOperation](eclroperation-enumeration.md) and failures described by [EClrFailure](eclrfailure-enumeration.md). - The host sets policy actions by calling methods of the [ICLRPolicyManager](iclrpolicymanager-interface.md) interface. For information about rude and graceful aborts, see the [EClrOperation](eclroperation-enumeration.md) enumeration. - -## Requirements +## Syntax + +```cpp +typedef enum { + eNoAction, + eThrowException, + eAbortThread, + eRudeAbortThread, + eUnloadAppDomain, + eRudeUnloadAppDomain, + eExitProcess, + eFastExitProcess, + eRudeExitProcess, + eDisableRuntime +} EPolicyAction; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`eAbortThread`|Specifies that the common language runtime (CLR) should abort the thread gracefully. A graceful abort includes attempts to run all `finally` blocks, any `catch` blocks related to thread aborts, and finalizers.| +|`eDisableRuntime`|Specifies that the CLR should enter a disabled state. No further managed code can be executed in the affected process, and threads are blocked from entering the CLR.| +|`eExitProcess`|Specifies that the CLR should attempt a graceful exit of the process, including running finalizers and performing cleanup and logging operations.| +|`eFastExitProcess`|Specifies that the CLR should exit the process immediately, without running finalizers or performing cleanup and logging operations. However, notification is sent to the debugger.| +|`eNoAction`|Specifies that no action should be taken.| +|`eRudeAbortThread`|Specifies that the CLR should perform a rude thread abort. Only those `catch` and `finally` blocks marked with are executed.| +|`eRudeExitProcess`|Specifies that the CLR should exit the process without running finalizers or logging operations.| +|`eRudeUnloadAppDomain`|Specifies that the CLR should perform a rude unload of the . Only finalizers marked with are executed. Similarly, all threads with this in their stack receive a `ThreadAbortException`, but only those `catch` and `finally` blocks marked with are executed.| +|`eThrowException`|Specifies that an exception appropriate to the condition, such as out-of-memory, buffer overflow, and so forth, should be thrown.| +|`eUnloadAppDomain`|Specifies that the should be unloaded. The CLR attempts to run finalizers.| + +## Remarks + + The host sets policy actions by calling methods of the [ICLRPolicyManager](iclrpolicymanager-interface.md) interface. For information about rude and graceful aborts, see the [EClrOperation](eclroperation-enumeration.md) enumeration. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - ## See also - [EClrFailure Enumeration](eclrfailure-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md b/docs/core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md index fc925601aa779..c534f08819799 100644 --- a/docs/core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md +++ b/docs/core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md @@ -2,56 +2,55 @@ description: "Learn more about: ESymbolReadingPolicy Enumeration" title: "ESymbolReadingPolicy Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "ESymbolReadingPolicy" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ESymbolReadingPolicy" -helpviewer_keywords: +helpviewer_keywords: - "ESymbolReadingPolicy enumeration [.NET Framework hosting]" -ms.assetid: 4dc6c80d-b694-480b-a378-d5b18420ce17 -topic_type: +topic_type: - "apiref" --- # ESymbolReadingPolicy Enumeration -Contains values that set the policy for reading program database (PDB) files. - -## Syntax - -```cpp -typedef enum { - eSymbolReadingNever, - eSymbolReadingAlways, - eSymbolReadingFullTrustOnly -} ESymbolReadingPolicy; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`eSymbolReadingAlways`|Specifies that the debugger should always read PDB files.| -|`eSymbolReadingFullTrustOnly`|Specifies that the debugger should read only PDB files that are associated with full-trust assemblies.| -|`eSymbolReadingNever`|Specifies that the debugger should never read PDB files.| - -## Remarks - - The `ESymbolReadingPolicy` enumeration is used with the [ICLRDebugManager::SetSymbolReadingPolicy](iclrdebugmanager-setsymbolreadingpolicy-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Contains values that set the policy for reading program database (PDB) files. + +## Syntax + +```cpp +typedef enum { + eSymbolReadingNever, + eSymbolReadingAlways, + eSymbolReadingFullTrustOnly +} ESymbolReadingPolicy; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`eSymbolReadingAlways`|Specifies that the debugger should always read PDB files.| +|`eSymbolReadingFullTrustOnly`|Specifies that the debugger should read only PDB files that are associated with full-trust assemblies.| +|`eSymbolReadingNever`|Specifies that the debugger should never read PDB files.| + +## Remarks + + The `ESymbolReadingPolicy` enumeration is used with the [ICLRDebugManager::SetSymbolReadingPolicy](iclrdebugmanager-setsymbolreadingpolicy-method.md) method. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/etasktype-enumeration.md b/docs/core/unmanaged-api/hosting/etasktype-enumeration.md index bf93adfe72e18..ea9e7bc37118e 100644 --- a/docs/core/unmanaged-api/hosting/etasktype-enumeration.md +++ b/docs/core/unmanaged-api/hosting/etasktype-enumeration.md @@ -2,68 +2,67 @@ description: "Learn more about: ETaskType Enumeration" title: "ETaskType Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "ETaskType" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ETaskType" -helpviewer_keywords: +helpviewer_keywords: - "ETaskType enumeration [.NET Framework hosting]" -ms.assetid: aa527b31-89d4-41f2-ad6f-63b76950b7df -topic_type: +topic_type: - "apiref" --- # ETaskType Enumeration -Contains values that indicate the type of task that is represented by either an [ICLRTask](iclrtask-interface.md) or an [IHostTask](ihosttask-interface.md) interface. - -## Syntax - -```cpp -typedef enum ETaskType { - TT_DEBUGGERHELPER = 0x1, - TT_GC = 0x2, - TT_FINALIZER = 0x4, - TT_THREADPOOL_TIMER = 0x8, - TT_THREADPOOL_GATE = 0x10, - TT_THREADPOOL_WORKER = 0x20, - TT_THREADPOOL_IOCOMPLETION = 0x40, - TT_ADUNLOAD = 0x80, - TT_USER = 0x100, - TT_THREADPOOL_WAIT = 0x200, - TT_UNKNOWN = 0x80000000 -} ETaskType; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`TT_ADUNLOAD`|The interface represents an application domain unloading task.| -|`TT_DEBUGGERHELPER`|The interface represents a debugger helper task.| -|`TT_FINALIZER`|The interface represents a finalizer task.| -|`TT_GC`|The interface represents a garbage collection task.| -|`TT_THREADPOOL_GATE`|The interface represents a gate thread task.| -|`TT_THREADPOOL_IOCOMPLETION`|The interface represents an I/O thread task or a completion port thread task.| -|`TT_THREADPOOL_TIMER`|The interface represents a timer thread task.| -|`TT_THREADPOOL_WAIT`|The interface represents a wait thread task.| -|`TT_THREADPOOL_WORKER`|The interface represents a worker thread task.| -|`TT_UNKNOWN`|The task is unknown.| -|`TT_USER`|The interface represents a user task.| - -## Requirements +Contains values that indicate the type of task that is represented by either an [ICLRTask](iclrtask-interface.md) or an [IHostTask](ihosttask-interface.md) interface. + +## Syntax + +```cpp +typedef enum ETaskType { + TT_DEBUGGERHELPER = 0x1, + TT_GC = 0x2, + TT_FINALIZER = 0x4, + TT_THREADPOOL_TIMER = 0x8, + TT_THREADPOOL_GATE = 0x10, + TT_THREADPOOL_WORKER = 0x20, + TT_THREADPOOL_IOCOMPLETION = 0x40, + TT_ADUNLOAD = 0x80, + TT_USER = 0x100, + TT_THREADPOOL_WAIT = 0x200, + TT_UNKNOWN = 0x80000000 +} ETaskType; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`TT_ADUNLOAD`|The interface represents an application domain unloading task.| +|`TT_DEBUGGERHELPER`|The interface represents a debugger helper task.| +|`TT_FINALIZER`|The interface represents a finalizer task.| +|`TT_GC`|The interface represents a garbage collection task.| +|`TT_THREADPOOL_GATE`|The interface represents a gate thread task.| +|`TT_THREADPOOL_IOCOMPLETION`|The interface represents an I/O thread task or a completion port thread task.| +|`TT_THREADPOOL_TIMER`|The interface represents a timer thread task.| +|`TT_THREADPOOL_WAIT`|The interface represents a wait thread task.| +|`TT_THREADPOOL_WORKER`|The interface represents a worker thread task.| +|`TT_UNKNOWN`|The task is unknown.| +|`TT_USER`|The interface represents a user task.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - ## See also - [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md b/docs/core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md index f7b8b87538440..87f8714b498d8 100644 --- a/docs/core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md +++ b/docs/core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md @@ -2,51 +2,50 @@ description: "Learn more about: FExecuteInAppDomainCallback Function Pointer" title: "FExecuteInAppDomainCallback Function Pointer" ms.date: "03/30/2017" -api_name: +api_name: - "FExecuteInAppDomainCallback" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "FExecuteInAppDomainCallback" -helpviewer_keywords: +helpviewer_keywords: - "FExecuteInAppDomainCallback function pointer [.NET Framework hosting]" -ms.assetid: 2709f18f-3eee-497f-bc33-3ab7a485599b -topic_type: +topic_type: - "apiref" --- # FExecuteInAppDomainCallback Function Pointer -Points to a function that is called by the common language runtime (CLR) to execute managed code. - - This function pointer has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -typedef HRESULT (__stdcall *FExecuteInAppDomainCallback) ( - [in] void *cookie -); -``` - -## Parameters - - `cookie` - [in] A pointer to opaque caller-allocated memory that contains the managed code to be executed. - - The allocation and lifetime of this memory are controlled by the caller (that is, the CLR). This is not CLR managed-heap memory. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorWks.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Points to a function that is called by the common language runtime (CLR) to execute managed code. + + This function pointer has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +typedef HRESULT (__stdcall *FExecuteInAppDomainCallback) ( + [in] void *cookie +); +``` + +## Parameters + + `cookie` + [in] A pointer to opaque caller-allocated memory that contains the managed code to be executed. + + The allocation and lifetime of this memory are controlled by the caller (that is, the CLR). This is not CLR managed-heap memory. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorWks.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md b/docs/core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md index 742d743442d4d..c056f342765bc 100644 --- a/docs/core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md +++ b/docs/core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md @@ -2,46 +2,45 @@ description: "Learn more about: FLockClrVersionCallback Function Pointer" title: "FLockClrVersionCallback Function Pointer" ms.date: "03/30/2017" -api_name: +api_name: - "FLockClrVersionCallback" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "FLockClrVersionCallback" -helpviewer_keywords: +helpviewer_keywords: - "FLockClrVersionCallback function pointer [.NET Framework hosting]" -ms.assetid: 98a4762d-9ad2-45bd-9d03-39064a028b44 -topic_type: +topic_type: - "apiref" --- # FLockClrVersionCallback Function Pointer -Points to a function that the common language runtime (CLR) calls to indicate that initialization has either started or completed. - - This function pointer has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -typedef HRESULT (__stdcall *FLockClrVersionCallback) ( ); -``` - -## Remarks - - This function is implemented by the host. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorWks.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Points to a function that the common language runtime (CLR) calls to indicate that initialization has either started or completed. + + This function pointer has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +typedef HRESULT (__stdcall *FLockClrVersionCallback) ( ); +``` + +## Remarks + + This function is implemented by the host. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorWks.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [LockClrVersion Function](lockclrversion-function.md) diff --git a/docs/core/unmanaged-api/hosting/getclridentitymanager-function.md b/docs/core/unmanaged-api/hosting/getclridentitymanager-function.md index 0ecc37da75ee1..ea286aaa72e3e 100644 --- a/docs/core/unmanaged-api/hosting/getclridentitymanager-function.md +++ b/docs/core/unmanaged-api/hosting/getclridentitymanager-function.md @@ -2,57 +2,56 @@ description: "Learn more about: GetCLRIdentityManager Function" title: "GetCLRIdentityManager Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetCLRIdentityManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "GetCLRIdentityManager" -helpviewer_keywords: +helpviewer_keywords: - "GetCLRIdentityManager function [.NET Framework hosting]" -ms.assetid: 66eeca30-adb4-45f4-aff5-347564c95724 -topic_type: +topic_type: - "apiref" --- # GetCLRIdentityManager Function -Gets a pointer to an interface that allows the common language runtime (CLR) to manage identities. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -STDAPI GetCLRIdentityManager( - [in] REFIID riid, - [out] IUnknown **ppManager -); -``` - -## Parameters - - `riid` - [in] A `REFIID` (an interface identifier) that specifies which interface to get. This value must be either IID_ICLRAssemblyIdentityManager or IID_ICLRHostBindingPolicyManager. - - `ppManager` - [out] A pointer to the address of either an [ICLRAssemblyIdentityManager](iclrassemblyidentitymanager-interface.md) or an [ICLRHostBindingPolicyManager](iclrhostbindingpolicymanager-interface.md) object. - -## Remarks - - Call the [GetRealProcAddress](getrealprocaddress-function.md) function to get a pointer to the `GetCLRIdentityManager` function. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorWks.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Gets a pointer to an interface that allows the common language runtime (CLR) to manage identities. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +STDAPI GetCLRIdentityManager( + [in] REFIID riid, + [out] IUnknown **ppManager +); +``` + +## Parameters + + `riid` + [in] A `REFIID` (an interface identifier) that specifies which interface to get. This value must be either IID_ICLRAssemblyIdentityManager or IID_ICLRHostBindingPolicyManager. + + `ppManager` + [out] A pointer to the address of either an [ICLRAssemblyIdentityManager](iclrassemblyidentitymanager-interface.md) or an [ICLRHostBindingPolicyManager](iclrhostbindingpolicymanager-interface.md) object. + +## Remarks + + Call the [GetRealProcAddress](getrealprocaddress-function.md) function to get a pointer to the `GetCLRIdentityManager` function. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorWks.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/getcorrequiredversion-function.md b/docs/core/unmanaged-api/hosting/getcorrequiredversion-function.md index 41c15b94fa142..ea3df399c586c 100644 --- a/docs/core/unmanaged-api/hosting/getcorrequiredversion-function.md +++ b/docs/core/unmanaged-api/hosting/getcorrequiredversion-function.md @@ -2,57 +2,56 @@ description: "Learn more about: GetCORRequiredVersion Function" title: "GetCORRequiredVersion Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetCORRequiredVersion" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "GetCORRequiredVersion" -helpviewer_keywords: +helpviewer_keywords: - "GetCORRequiredVersion function [.NET Framework hosting]" -ms.assetid: 1588fe7b-c378-4f4b-9c4b-48647f1119cc -topic_type: +topic_type: - "apiref" --- # GetCORRequiredVersion Function -Gets the required common language runtime (CLR) version number. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT GetCORRequiredVersion ( - [out] LPWSTR pbuffer, - [in] DWORD cchBuffer, - [out] DWORD *dwLength -); -``` - -## Parameters - - `pbuffer` - [out] A buffer containing a string that specifies the version number. - - `cchBuffer` - [in] The size, in bytes, of the buffer. - - `dwLength` - [out] The number of bytes returned in the buffer. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets the required common language runtime (CLR) version number. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT GetCORRequiredVersion ( + [out] LPWSTR pbuffer, + [in] DWORD cchBuffer, + [out] DWORD *dwLength +); +``` + +## Parameters + + `pbuffer` + [out] A buffer containing a string that specifies the version number. + + `cchBuffer` + [in] The size, in bytes, of the buffer. + + `dwLength` + [out] The number of bytes returned in the buffer. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/getcorsystemdirectory-function.md b/docs/core/unmanaged-api/hosting/getcorsystemdirectory-function.md index ec5376431e013..020a6bbea7161 100644 --- a/docs/core/unmanaged-api/hosting/getcorsystemdirectory-function.md +++ b/docs/core/unmanaged-api/hosting/getcorsystemdirectory-function.md @@ -2,63 +2,62 @@ description: "Learn more about: GetCORSystemDirectory Function" title: "GetCORSystemDirectory Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetCORSystemDirectory" -api_location: +api_location: - "mscoree.dll" - "mscoreei.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "GetCORSystemDirectory" -helpviewer_keywords: +helpviewer_keywords: - "GetCORSystemDirectory function [.NET Framework hosting]" -ms.assetid: 3dcd16a7-dafc-4ca8-b5cd-20ffb37db91d -topic_type: +topic_type: - "apiref" --- # GetCORSystemDirectory Function -Returns the installation directory of the common language runtime (CLR) that is loaded into the process. The installation directory is fully qualified, for example, "c:\windows\microsoft.net\framework\v1.0.3705". - - This function is deprecated. It is superseded by the [ICLRRuntimeInfo::GetRuntimeDirectory](iclrruntimeinfo-getruntimedirectory-method.md) method provided in the .NET Framework 4. - -## Syntax - -```cpp +Returns the installation directory of the common language runtime (CLR) that is loaded into the process. The installation directory is fully qualified, for example, "c:\windows\microsoft.net\framework\v1.0.3705". + + This function is deprecated. It is superseded by the [ICLRRuntimeInfo::GetRuntimeDirectory](iclrruntimeinfo-getruntimedirectory-method.md) method provided in the .NET Framework 4. + +## Syntax + +```cpp HRESULT GetCORSystemDirectory ( [out] LPWSTR pbuffer, [in] DWORD cchBuffer, - [out] DWORD* dwlength + [out] DWORD* dwlength ); -``` - -## Parameters - - `pbuffer` - [out] A buffer in which the runtime returns a string that contains the fully qualified name of the installation directory for the runtime that is loaded into the process. If the runtime has not yet been loaded into the process, the function returns the appropriate directory information for the latest version of the runtime installed on the computer. - - `cchBuffer` - [in] The size, in bytes, of `pbuffer`. - - `dwLength` - [out] The number of characters returned in `pbuffer`. - -## Remarks - +``` + +## Parameters + + `pbuffer` + [out] A buffer in which the runtime returns a string that contains the fully qualified name of the installation directory for the runtime that is loaded into the process. If the runtime has not yet been loaded into the process, the function returns the appropriate directory information for the latest version of the runtime installed on the computer. + + `cchBuffer` + [in] The size, in bytes, of `pbuffer`. + + `dwLength` + [out] The number of characters returned in `pbuffer`. + +## Remarks + > [!CAUTION] -> Do not use this function in processes that are running version 4 of the CLR. If an earlier version of the CLR is installed on the computer, this function returns the installation directory for that version. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +> Do not use this function in processes that are running version 4 of the CLR. If an earlier version of the CLR is installed on the computer, this function returns the installation directory for that version. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/getcorversion-function.md b/docs/core/unmanaged-api/hosting/getcorversion-function.md index 4ee8d9520d935..5714c97c8cee8 100644 --- a/docs/core/unmanaged-api/hosting/getcorversion-function.md +++ b/docs/core/unmanaged-api/hosting/getcorversion-function.md @@ -18,41 +18,41 @@ topic_type: --- # GetCORVersion Function -Returns the version number of the common language runtime (CLR) that is running in the current process. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT GetCORVersion ( - [in] LPWSTR pbuffer, +Returns the version number of the common language runtime (CLR) that is running in the current process. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT GetCORVersion ( + [in] LPWSTR pbuffer, [in] DWORD cchBuffer, - [out] DWORD* dwlength + [out] DWORD* dwlength ); -``` - -## Parameters - - `pbuffer` - A pointer to a buffer in which the CLR returns a string specifying the version of the runtime that is currently loaded into the process. The returned string takes the same form as strings passed to [CorBindToRuntimeEx](corbindtoruntimeex-function.md), for example, "v1.0.1216". If the runtime has not yet been loaded into the process, the function returns the appropriate directory information for the latest version of the runtime installed on the computer. - - `cchBuffer` - The number of characters (`WCHAR`s) that can be held in `pbuffer`. - - `dwLength` - A pointer to the number of characters actually returned in `pbuffer`. If `pbuffer` is a null pointer, the runtime returns E_POINTER. If the number of characters is greater then the length of `pbuffer`, the runtime returns ERROR_INSUFFICIENT_BUFFER. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +``` + +## Parameters + + `pbuffer` + A pointer to a buffer in which the CLR returns a string specifying the version of the runtime that is currently loaded into the process. The returned string takes the same form as strings passed to [CorBindToRuntimeEx](corbindtoruntimeex-function.md), for example, "v1.0.1216". If the runtime has not yet been loaded into the process, the function returns the appropriate directory information for the latest version of the runtime installed on the computer. + + `cchBuffer` + The number of characters (`WCHAR`s) that can be held in `pbuffer`. + + `dwLength` + A pointer to the number of characters actually returned in `pbuffer`. If `pbuffer` is a null pointer, the runtime returns E_POINTER. If the number of characters is greater then the length of `pbuffer`, the runtime returns ERROR_INSUFFICIENT_BUFFER. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/getfileversion-function.md b/docs/core/unmanaged-api/hosting/getfileversion-function.md index 0c87e07a67b8d..540d94d828a8b 100644 --- a/docs/core/unmanaged-api/hosting/getfileversion-function.md +++ b/docs/core/unmanaged-api/hosting/getfileversion-function.md @@ -2,59 +2,58 @@ description: "Learn more about: GetFileVersion Function" title: "GetFileVersion Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetFileVersion" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "GetFileVersion" -helpviewer_keywords: +helpviewer_keywords: - "GetFileVersion function [.NET Framework hosting]" -ms.assetid: b3222c85-da88-4485-97d7-3a6ee3e8d358 -topic_type: +topic_type: - "apiref" --- # GetFileVersion Function -Gets the common language runtime (CLR) version information of the specified file, using the specified buffer. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT GetFileVersion ( +Gets the common language runtime (CLR) version information of the specified file, using the specified buffer. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT GetFileVersion ( [in] LPCWSTR szFilename, [in, out] LPWSTR szBuffer, [in] DWORD cchBuffer, - [out] DWORD *dwLength -); -``` - -## Parameters - - `szFilename` - [in] The path of the file to be examined. - - `szBuffer` - [in, out] The buffer allocated for the version information that is returned. - - `cchBuffer` - [in] The size, in wide characters, of `szBuffer`. - - `dwLength` - [out] The size, in bytes, of the returned `szBuffer`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] - + [out] DWORD *dwLength +); +``` + +## Parameters + + `szFilename` + [in] The path of the file to be examined. + + `szBuffer` + [in, out] The buffer allocated for the version information that is returned. + + `cchBuffer` + [in] The size, in wide characters, of `szBuffer`. + + `dwLength` + [out] The size, in bytes, of the returned `szBuffer`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **.NET versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/getrealprocaddress-function.md b/docs/core/unmanaged-api/hosting/getrealprocaddress-function.md index ba090a280b23a..8ae8d7d3ec8e6 100644 --- a/docs/core/unmanaged-api/hosting/getrealprocaddress-function.md +++ b/docs/core/unmanaged-api/hosting/getrealprocaddress-function.md @@ -2,63 +2,62 @@ description: "Learn more about: GetRealProcAddress Function" title: "GetRealProcAddress Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetRealProcAddress" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "GetRealProcAddress" -helpviewer_keywords: +helpviewer_keywords: - "GetRealProcAddress function [.NET Framework hosting]" -ms.assetid: f1f2fab1-400b-488f-95f2-d49c4fca3556 -topic_type: +topic_type: - "apiref" --- # GetRealProcAddress Function -Gets the address of the specified function that is exported from the latest installed version of the common language runtime (CLR). - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT GetRealProcAddress ( +Gets the address of the specified function that is exported from the latest installed version of the common language runtime (CLR). + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT GetRealProcAddress ( [in] LPCSTR pwszProcName, - [out] VOID **ppv -); -``` - -## Parameters - - `pwszProcName` - [in] The name of the function. - - `ppv` - [out] The location that receives a pointer to the address of the function. - -## Return Value - - This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values defined in CorError.h. - -|Return code|Description| -|-----------------|-----------------| -|S_OK|The method completed successfully.| -|E_POINTER|`ppv` is not valid.| -|CLR_E_SHIM_RUNTIMEEXPORT|The function is not exported from the runtime.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [out] VOID **ppv +); +``` + +## Parameters + + `pwszProcName` + [in] The name of the function. + + `ppv` + [out] The location that receives a pointer to the address of the function. + +## Return Value + + This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values defined in CorError.h. + +|Return code|Description| +|-----------------|-----------------| +|S_OK|The method completed successfully.| +|E_POINTER|`ppv` is not valid.| +|CLR_E_SHIM_RUNTIMEEXPORT|The function is not exported from the runtime.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md b/docs/core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md index 58b36386af799..e471c840228a2 100644 --- a/docs/core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md +++ b/docs/core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md @@ -2,31 +2,30 @@ description: "Learn more about: GetRequestedRuntimeInfo Function" title: "GetRequestedRuntimeInfo Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetRequestedRuntimeInfo" -api_location: +api_location: - "mscoree.dll" - "mscoreei.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "GetRequestedRuntimeInfo" -helpviewer_keywords: +helpviewer_keywords: - "GetRequestedRuntimeInfo function [.NET Framework hosting]" -ms.assetid: 0dfd7cdc-c116-4e25-b56a-ac7b0378c942 -topic_type: +topic_type: - "apiref" --- # GetRequestedRuntimeInfo Function -Gets version and directory information about the common language runtime (CLR) requested by an application. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT GetRequestedRuntimeInfo ( +Gets version and directory information about the common language runtime (CLR) requested by an application. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT GetRequestedRuntimeInfo ( [in] LPCWSTR pExe, [in] LPCWSTR pwszVersion, [in] LPCWSTR pConfigurationFile, @@ -37,90 +36,90 @@ HRESULT GetRequestedRuntimeInfo ( [out] DWORD *dwDirectoryLength, [out] LPWSTR pVersion, [in] DWORD cchBuffer, - [out] DWORD *dwlength -); -``` - -## Parameters - - `pExe` - [in] The name of the application. - - `pwszVersion` - [in] A string specifying the version number of the runtime. - - `pConfigurationFile` - [in] The name of the configuration file that is associated with `pExe`. - - `startupFlags` - [in] One or more of the [STARTUP_FLAGS](startup-flags-enumeration.md) enumeration values. - - `runtimeInfoFlags` - [in] One or more of the [RUNTIME_INFO_FLAGS](runtime-info-flags-enumeration.md) enumeration values. - - `pDirectory` - [out] A buffer that contains the directory path to the runtime upon successful completion. - - `dwDirectory` - [in] The length of the directory buffer. - - `dwDirectoryLength` - [out] A pointer to the length of the directory path string. - - `pVersion` - [out] A buffer that contains the version number of the runtime upon successful completion. - - `cchBuffer` - [in] The length of the version string buffer. - - `dwlength` - [out] A pointer to the length of the version string. - -## Return Value - - This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values. - -|Return code|Description| -|-----------------|-----------------| -|S_OK|The method completed successfully.| -|ERROR_INSUFFICIENT_BUFFER|The directory buffer is not large enough to store the directory path.

- or -

The version buffer is not large enough to store the version string.| - -## Remarks - - The `GetRequestedRuntimeInfo` method returns run-time information about the version loaded into the process, which is not necessarily the latest version installed on the computer. - - In .NET Framework version 2.0, you can get information about the latest installed version by using the `GetRequestedRuntimeInfo` method as follows: - -- Specify the `pExe`, `pwszVersion`, and `pConfigurationFile` parameters as null. - -- Specify the RUNTIME_INFO_UPGRADE_VERSION flag in the `RUNTIME_INFO_FLAGS` enumerations for the `runtimeInfoFlags` parameter. - - The `GetRequestedRuntimeInfo` method does not return the latest CLR version in the following circumstances: - -- An application configuration file that specifies loading a particular CLR version exists. Note that the .NET Framework will use the configuration file even if you specify null for the `pConfigurationFile` parameter. - -- The [CorBindToRuntimeEx](corbindtoruntimeex-function.md) method was called specifying an earlier CLR version. - -- An application that was compiled for an earlier CLR version is currently running. - - For the `runtimeInfoFlags` parameter, you can specify only one of the architecture constants of the `RUNTIME_INFO_FLAGS` enumeration at a time: - -- RUNTIME_INFO_REQUEST_IA64 - -- RUNTIME_INFO_REQUEST_AMD64 - -- RUNTIME_INFO_REQUEST_X86 - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] - + [out] DWORD *dwlength +); +``` + +## Parameters + + `pExe` + [in] The name of the application. + + `pwszVersion` + [in] A string specifying the version number of the runtime. + + `pConfigurationFile` + [in] The name of the configuration file that is associated with `pExe`. + + `startupFlags` + [in] One or more of the [STARTUP_FLAGS](startup-flags-enumeration.md) enumeration values. + + `runtimeInfoFlags` + [in] One or more of the [RUNTIME_INFO_FLAGS](runtime-info-flags-enumeration.md) enumeration values. + + `pDirectory` + [out] A buffer that contains the directory path to the runtime upon successful completion. + + `dwDirectory` + [in] The length of the directory buffer. + + `dwDirectoryLength` + [out] A pointer to the length of the directory path string. + + `pVersion` + [out] A buffer that contains the version number of the runtime upon successful completion. + + `cchBuffer` + [in] The length of the version string buffer. + + `dwlength` + [out] A pointer to the length of the version string. + +## Return Value + + This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values. + +|Return code|Description| +|-----------------|-----------------| +|S_OK|The method completed successfully.| +|ERROR_INSUFFICIENT_BUFFER|The directory buffer is not large enough to store the directory path.

- or -

The version buffer is not large enough to store the version string.| + +## Remarks + + The `GetRequestedRuntimeInfo` method returns run-time information about the version loaded into the process, which is not necessarily the latest version installed on the computer. + + In .NET Framework version 2.0, you can get information about the latest installed version by using the `GetRequestedRuntimeInfo` method as follows: + +- Specify the `pExe`, `pwszVersion`, and `pConfigurationFile` parameters as null. + +- Specify the RUNTIME_INFO_UPGRADE_VERSION flag in the `RUNTIME_INFO_FLAGS` enumerations for the `runtimeInfoFlags` parameter. + + The `GetRequestedRuntimeInfo` method does not return the latest CLR version in the following circumstances: + +- An application configuration file that specifies loading a particular CLR version exists. Note that the .NET Framework will use the configuration file even if you specify null for the `pConfigurationFile` parameter. + +- The [CorBindToRuntimeEx](corbindtoruntimeex-function.md) method was called specifying an earlier CLR version. + +- An application that was compiled for an earlier CLR version is currently running. + + For the `runtimeInfoFlags` parameter, you can specify only one of the architecture constants of the `RUNTIME_INFO_FLAGS` enumeration at a time: + +- RUNTIME_INFO_REQUEST_IA64 + +- RUNTIME_INFO_REQUEST_AMD64 + +- RUNTIME_INFO_REQUEST_X86 + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] + ## See also - [GetRequestedRuntimeVersion Function](getrequestedruntimeversion-function.md) diff --git a/docs/core/unmanaged-api/hosting/getrequestedruntimeversion-function.md b/docs/core/unmanaged-api/hosting/getrequestedruntimeversion-function.md index e68bad607b80d..a6330c0f7c9f7 100644 --- a/docs/core/unmanaged-api/hosting/getrequestedruntimeversion-function.md +++ b/docs/core/unmanaged-api/hosting/getrequestedruntimeversion-function.md @@ -2,72 +2,71 @@ description: "Learn more about: GetRequestedRuntimeVersion Function" title: "GetRequestedRuntimeVersion Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetRequestedRuntimeVersion" -api_location: +api_location: - "mscoree.dll" - "mscoreei.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "GetRequestedRuntimeVersion" -helpviewer_keywords: +helpviewer_keywords: - "GetRequestedRuntimeVersion function [.NET Framework hosting]" -ms.assetid: 82f596a4-483d-4509-b0c5-a84c53c3da1b -topic_type: +topic_type: - "apiref" --- # GetRequestedRuntimeVersion Function -Gets the version number of the common language runtime (CLR) requested by the specified application. If that version is not installed, gets the most recent version that is installed before the requested version. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT GetRequestedRuntimeVersion ( +Gets the version number of the common language runtime (CLR) requested by the specified application. If that version is not installed, gets the most recent version that is installed before the requested version. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT GetRequestedRuntimeVersion ( [in] LPWSTR pExe, [out] LPWSTR pVersion, [in] DWORD cchBuffer, - [out] DWORD *pdwLength -); -``` - -## Parameters - - `pExe` - [in] The name of the application. - - `pVersion` - [out] A buffer that contains the version number string upon successful completion. - - `cchBuffer` - [in] The length of the version buffer. - - `pdwLength` - [out] A pointer to the length of the version number string. - -## Return Value - - This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values. - -|Return code|Description| -|-----------------|-----------------| -|S_OK|The method completed successfully.| -|ERROR_INSUFFICIENT_BUFFER|The version buffer is not large enough to store the version string.| -|E_POINTER|`pdwLength` is null.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] - + [out] DWORD *pdwLength +); +``` + +## Parameters + + `pExe` + [in] The name of the application. + + `pVersion` + [out] A buffer that contains the version number string upon successful completion. + + `cchBuffer` + [in] The length of the version buffer. + + `pdwLength` + [out] A pointer to the length of the version number string. + +## Return Value + + This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values. + +|Return code|Description| +|-----------------|-----------------| +|S_OK|The method completed successfully.| +|ERROR_INSUFFICIENT_BUFFER|The version buffer is not large enough to store the version string.| +|E_POINTER|`pdwLength` is null.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] + ## See also - [GetRequestedRuntimeInfo Function](getrequestedruntimeinfo-function.md) diff --git a/docs/core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md b/docs/core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md index 347b7cd78daa6..c76966e471dce 100644 --- a/docs/core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md +++ b/docs/core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md @@ -2,77 +2,76 @@ description: "Learn more about: GetRequestedRuntimeVersionForCLSID Function" title: "GetRequestedRuntimeVersionForCLSID Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetRequestedRuntimeVersionForCLSID" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "GetRequestedRuntimeVersionForCLSID" -helpviewer_keywords: +helpviewer_keywords: - "GetRequestedRuntimeVersionForCLSID function [.NET Framework hosting]" -ms.assetid: 5bb12f9a-0612-434b-b4ed-2db636a20bec -topic_type: +topic_type: - "apiref" --- # GetRequestedRuntimeVersionForCLSID Function -Gets the appropriate common language runtime (CLR) version information for the class with the specified `CLSID`. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT GetRequestedRuntimeVersionForCLSID ( +Gets the appropriate common language runtime (CLR) version information for the class with the specified `CLSID`. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT GetRequestedRuntimeVersionForCLSID ( [in] REFCLSID rclsid, [out] LPWSTR pVersion, [in] DWORD cchBuffer, [out] DWORD* dwLength, - [in] CLSID_RESOLUTION_FLAGS dwResolutionFlags -); -``` - -## Parameters - - `rclsid` - [in] The `CLSID` of the component. - - `pVersion` - [out] A buffer that contains the version number string upon successful completion. - - `cchBuffer` - [in] The size, in wide characters, of the `pVersion` buffer. - - `dwLength` - [out] The length, in bytes, of the returned buffer. - - `dwResolutionFlags` - [in] One of the CLSID_RESOLUTION_FLAGS values. The following values are supported: - -- CLSID_RESOLUTION_DEFAULT: (0x0) Specifies that default interop behavior should be used. - -- CLSID_RESOLUTION_REGISTERED: (0x1) Specifies that the registry should be searched and shim policy should be applied. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The function returned successfully.| -|E_INVALIDARG|One of the parameters has an invalid type or format.| -|ERROR_INSUFFICIENT_BUFFER|The `pVersion` buffer is not large enough to hold the entire version string.| -|REGDB_E_CLASSNOTREG|There is no class registered with the specified `CLSID`.| -|E_POINTER|`dwLength` is null, or `cchBuffer` is large enough to hold the version string, but `pVersion` is null.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] - + [in] CLSID_RESOLUTION_FLAGS dwResolutionFlags +); +``` + +## Parameters + + `rclsid` + [in] The `CLSID` of the component. + + `pVersion` + [out] A buffer that contains the version number string upon successful completion. + + `cchBuffer` + [in] The size, in wide characters, of the `pVersion` buffer. + + `dwLength` + [out] The length, in bytes, of the returned buffer. + + `dwResolutionFlags` + [in] One of the CLSID_RESOLUTION_FLAGS values. The following values are supported: + +- CLSID_RESOLUTION_DEFAULT: (0x0) Specifies that default interop behavior should be used. + +- CLSID_RESOLUTION_REGISTERED: (0x1) Specifies that the registry should be searched and shim policy should be applied. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The function returned successfully.| +|E_INVALIDARG|One of the parameters has an invalid type or format.| +|ERROR_INSUFFICIENT_BUFFER|The `pVersion` buffer is not large enough to hold the entire version string.| +|REGDB_E_CLASSNOTREG|There is no class registered with the specified `CLSID`.| +|E_POINTER|`dwLength` is null, or `cchBuffer` is large enough to hold the version string, but `pVersion` is null.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **.NET versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/getversionfromprocess-function.md b/docs/core/unmanaged-api/hosting/getversionfromprocess-function.md index 110c5285a49f7..0b73cf56e547f 100644 --- a/docs/core/unmanaged-api/hosting/getversionfromprocess-function.md +++ b/docs/core/unmanaged-api/hosting/getversionfromprocess-function.md @@ -2,73 +2,72 @@ description: "Learn more about: GetVersionFromProcess Function" title: "GetVersionFromProcess Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetVersionFromProcess" -api_location: +api_location: - "mscoree.dll" - "mscoreei.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "GetVersionFromProcess" -helpviewer_keywords: +helpviewer_keywords: - "GetVersionFromProcess function [.NET Framework hosting]" -ms.assetid: a9f7f824-64a1-408d-8607-91c7f19d21fe -topic_type: +topic_type: - "apiref" --- # GetVersionFromProcess Function -Gets the version number of the common language runtime (CLR) that is associated with the specified process handle. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT GetVersionFromProcess ( +Gets the version number of the common language runtime (CLR) that is associated with the specified process handle. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT GetVersionFromProcess ( [in] HANDLE hProcess, [out] LPWSTR pVersion, [in] DWORD cchBuffer, - [out] DWORD *dwLength -); -``` - -## Parameters - - `hProcess` - [in] A handle to a process. - - `pVersion` - [out] A buffer that contains the version number string upon successful completion of the method. - - `cchBuffer` - [in] The length of the version buffer. - - `pdwLength` - [out] A pointer to the length of the version number string. - -## Return Value - - This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values. - -|Return code|Description| -|-----------------|-----------------| -|S_OK|The method completed successfully.| -|E_INVALIDARG|`pVersion` is null and `cchBuffer` is not null, or vice versa.

-or-

`hProcess` is not a valid handle to a process.

-or-

The CLR is not loaded.| -|ERROR_INSUFFICIENT_BUFFER|`cchBuffer` is null or less than the length of the version string.| -|E_NOTIMPL|This method is not available on the Microsoft Windows 95, Microsoft Windows 98, or Microsoft Windows Millennium Edition operating system.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - + [out] DWORD *dwLength +); +``` + +## Parameters + + `hProcess` + [in] A handle to a process. + + `pVersion` + [out] A buffer that contains the version number string upon successful completion of the method. + + `cchBuffer` + [in] The length of the version buffer. + + `pdwLength` + [out] A pointer to the length of the version number string. + +## Return Value + + This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values. + +|Return code|Description| +|-----------------|-----------------| +|S_OK|The method completed successfully.| +|E_INVALIDARG|`pVersion` is null and `cchBuffer` is not null, or vice versa.

-or-

`hProcess` is not a valid handle to a process.

-or-

The CLR is not loaded.| +|ERROR_INSUFFICIENT_BUFFER|`cchBuffer` is null or less than the length of the version string.| +|E_NOTIMPL|This method is not available on the Microsoft Windows 95, Microsoft Windows 98, or Microsoft Windows Millennium Edition operating system.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [GetRequestedRuntimeInfo Function](getrequestedruntimeinfo-function.md) diff --git a/docs/core/unmanaged-api/hosting/host-type-enumeration.md b/docs/core/unmanaged-api/hosting/host-type-enumeration.md index 9c5e8b9a31bf1..25e4322d36a03 100644 --- a/docs/core/unmanaged-api/hosting/host-type-enumeration.md +++ b/docs/core/unmanaged-api/hosting/host-type-enumeration.md @@ -2,52 +2,51 @@ description: "Learn more about: HOST_TYPE Enumeration" title: "HOST_TYPE Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "HOST_TYPE" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "HOST_TYPE" -helpviewer_keywords: +helpviewer_keywords: - "HOST_TYPE enumeration [.NET Framework hosting]" -ms.assetid: 51f848be-84c5-4036-9839-c762c576bbf5 -topic_type: +topic_type: - "apiref" --- # HOST_TYPE Enumeration -Contains values that specify the type of host that is launching an application. - -## Syntax - -```cpp -typedef enum { - HOST_TYPE_DEFAULT = 0x0, - HOST_TYPE_APPLAUNCH = 0x1, - HOST_TYPE_CORFLAG = 0x2 -} HOST_TYPE; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`HOST_TYPE_APPLAUNCH`|Launch the application from AppLaunch.exe.

Use this value for partially-trusted applications.| -|`HOST_TYPE_CORFLAG`|Launch the application directly. That is, launch the application from its own .exe file.

Use this value for fully-trusted applications.| -|`HOST_TYPE_DEFAULT`|Same as HOST_TYPE_APPLAUNCH.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Contains values that specify the type of host that is launching an application. + +## Syntax + +```cpp +typedef enum { + HOST_TYPE_DEFAULT = 0x0, + HOST_TYPE_APPLAUNCH = 0x1, + HOST_TYPE_CORFLAG = 0x2 +} HOST_TYPE; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`HOST_TYPE_APPLAUNCH`|Launch the application from AppLaunch.exe.

Use this value for partially-trusted applications.| +|`HOST_TYPE_CORFLAG`|Launch the application directly. That is, launch the application from its own .exe file.

Use this value for fully-trusted applications.| +|`HOST_TYPE_DEFAULT`|Same as HOST_TYPE_APPLAUNCH.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/hosting-coclasses.md b/docs/core/unmanaged-api/hosting/hosting-coclasses.md index d6dee8e980612..01c08fb537625 100644 --- a/docs/core/unmanaged-api/hosting/hosting-coclasses.md +++ b/docs/core/unmanaged-api/hosting/hosting-coclasses.md @@ -2,36 +2,35 @@ description: "Learn more about: Hosting Coclasses" title: "Hosting Coclasses" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - "hosting coclasses [.NET Framework]" - "unmanaged coclasses [.NET Framework], hosting" - "coclasses [.NET Framework hosting]" -ms.assetid: e32d8667-58ee-4760-814f-d22963881622 --- # Hosting Coclasses -This section describes the unmanaged API coclasses that the hosting API uses. - -## In This Section - - [CLRRuntimeHost Coclass](clrruntimehost-coclass.md) - Provides interfaces for managing code execution by the runtime. - - [ComCallUnmarshal Coclass](comcallunmarshal-coclass.md) - Provides interfaces for managing the marshalling of interface pointers. - - [CorRuntimeHost Coclass](corruntimehost-coclass.md) - Provides interfaces for managing applications that are being executed by the common language runtime. - - [TypeNameFactory Coclass](typenamefactory-coclass.md) - Provides an interface for managing the deconstruction of a type name. - -## Related Sections - - [Hosting Interfaces](hosting-interfaces.md) - - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) - - [Hosting Enumerations](hosting-enumerations.md) - +This section describes the unmanaged API coclasses that the hosting API uses. + +## In This Section + + [CLRRuntimeHost Coclass](clrruntimehost-coclass.md) + Provides interfaces for managing code execution by the runtime. + + [ComCallUnmarshal Coclass](comcallunmarshal-coclass.md) + Provides interfaces for managing the marshalling of interface pointers. + + [CorRuntimeHost Coclass](corruntimehost-coclass.md) + Provides interfaces for managing applications that are being executed by the common language runtime. + + [TypeNameFactory Coclass](typenamefactory-coclass.md) + Provides an interface for managing the deconstruction of a type name. + +## Related Sections + + [Hosting Interfaces](hosting-interfaces.md) + + [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) + + [Hosting Enumerations](hosting-enumerations.md) + [Hosting Structures](hosting-structures.md) diff --git a/docs/core/unmanaged-api/hosting/hosting-enumerations.md b/docs/core/unmanaged-api/hosting/hosting-enumerations.md index 58327e64bb8e1..e9825f13ffddf 100644 --- a/docs/core/unmanaged-api/hosting/hosting-enumerations.md +++ b/docs/core/unmanaged-api/hosting/hosting-enumerations.md @@ -2,114 +2,113 @@ description: "Learn more about: Hosting Enumerations" title: "Hosting Enumerations" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - "unmanaged enumerations [.NET Framework], hosting" - "enumerations [.NET Framework hosting]" - "hosting enumerations [.NET Framework]" -ms.assetid: e09131eb-1f7d-4f52-ae42-7393e9b62ef6 --- # Hosting Enumerations -This section describes the unmanaged enumerations that the hosting API uses. - -## In This Section - - [CLSID_RESOLUTION_FLAGS Enumeration](clsid-resolution-flags-enumeration.md) - Contains values that indicate how the common language runtime (CLR) should resolve a `CLSID`. - - [COR_GC_STAT_TYPES Enumeration](cor-gc-stat-types-enumeration.md) - Specifies the statistics to be recorded for a garbage collection. - - [COR_GC_THREAD_STATS_TYPES Enumeration](cor-gc-thread-stats-types-enumeration.md) - Indicates the garbage collection statistics for a thread. - - [EApiCategories Enumeration](eapicategories-enumeration.md) - Describes the categories of capabilities that the host can block from running in partially trusted code. - - [EBindPolicyLevels Enumeration](ebindpolicylevels-enumeration.md) - Provides flags that specify the level at which to apply or modify assembly policy. - - [ECLRAssemblyIdentityFlags Enumeration](eclrassemblyidentityflags-enumeration.md) - Indicates the type of an assembly's identity. - - [EClrEvent Enumeration](eclrevent-enumeration.md) - Describes the CLR events for which the host can register callbacks. - - [EClrFailure Enumeration](eclrfailure-enumeration.md) - Describes the set of failures for which a host can set policy actions. - - [EClrOperation Enumeration](eclroperation-enumeration.md) - Describes the set of operations for which a host can apply policy actions. - - [EClrUnhandledException Enumeration](eclrunhandledexception-enumeration.md) - Describes the available options for managing exceptions that are unhandled in user code. - - [EContextType Enumeration](econtexttype-enumeration.md) - Describes the security context of the currently executing thread. - - [ECustomDumpFlavor Enumeration](ecustomdumpflavor-enumeration.md) - Contains values that indicate which items to include in a custom subset of a heap dump when reporting errors. - - [ECustomDumpItemKind Enumeration](ecustomdumpitemkind-enumeration.md) - Reserved for future extension of the [CustomDumpItem Structure](customdumpitem-structure.md) structure. - - [EHostApplicationPolicy Enumeration](ehostapplicationpolicy-enumeration.md) - Indicates how to modify an [IHostAssemblyManager Interface](ihostassemblymanager-interface.md) interface object. This enumeration has been deprecated. - - [EHostBindingPolicyModifyFlags Enumeration](ehostbindingpolicymodifyflags-enumeration.md) - Allows the host to specify the type of redirection the CLR should perform when applying policy modifications from a source assembly to a target assembly. - - [EInitializeNewDomainFlags Enumeration](einitializenewdomainflags-enumeration.md) - Enables the host to provide the runtime with information about the initialization of an application domain. - - [EMemoryAvailable Enumeration](ememoryavailable-enumeration.md) - Contains values that indicate the amount of free physical memory on the computer. - - [EMemoryCriticalLevel Enumeration](ememorycriticallevel-enumeration.md) - Contains values that indicate the impact of a failure when a specific memory allocation has been requested but cannot be satisfied. - - [EPolicyAction Enumeration](epolicyaction-enumeration.md) - Describes the policy actions the host can set for operations described by [EClrOperation Enumeration](eclroperation-enumeration.md) and failures described by [EClrFailure Enumeration](eclrfailure-enumeration.md). - - [ESymbolReadingPolicy Enumeration](esymbolreadingpolicy-enumeration.md) - Contains values that set the policy for reading program database (PDB) files. - - [ETaskType Enumeration](etasktype-enumeration.md) - Contains values that indicate the kind of task represented by an [ICLRTask Interface](iclrtask-interface.md) or an [IHostTask Interface](ihosttask-interface.md) interface. - - [HOST_TYPE Enumeration](host-type-enumeration.md) - Contains values that specify the type of host that is launching an application. - - [MALLOC_TYPE Enumeration](malloc-type-enumeration.md) - Contains values that specify the characteristics of the memory that is being allocated. - - [METAHOST_CONFIG_FLAGS Enumeration](metahost-config-flags-enumeration.md) - Describes the possible flags returned in the `pdwConfigFlags` parameter of the [ICLRMetaHostPolicy::GetRequestedRuntime](iclrmetahostpolicy-getrequestedruntime-method.md) method. - - [METAHOST_POLICY_FLAGS Enumeration](metahost-policy-flags-enumeration.md) - Provides binding policies that are common to most runtime hosts. - - [RUNTIME_INFO_FLAGS Enumeration](runtime-info-flags-enumeration.md) - Contains values that indicate what information about the CLR should be returned. - - [StackOverflowType Enumeration](stackoverflowtype-enumeration.md) - Contains values that indicate the underlying cause of a stack overflow event. - - [STARTUP_FLAGS Enumeration](startup-flags-enumeration.md) - Contains values that indicate the startup behavior of the CLR. - - [ValidatorFlags Enumeration](validatorflags-enumeration.md) - Contains values that indicate the type of validation that should be performed in a call to [Validate Method](iclrvalidator-validate-method.md). - - [WAIT_OPTION Enumeration](wait-option-enumeration.md) - Indicates the action a host should take if an operation requested by the CLR blocks. - -## Related Sections - - [Hosting Coclasses](hosting-coclasses.md) - - [Hosting Interfaces](hosting-interfaces.md) - - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) - +This section describes the unmanaged enumerations that the hosting API uses. + +## In This Section + + [CLSID_RESOLUTION_FLAGS Enumeration](clsid-resolution-flags-enumeration.md) + Contains values that indicate how the common language runtime (CLR) should resolve a `CLSID`. + + [COR_GC_STAT_TYPES Enumeration](cor-gc-stat-types-enumeration.md) + Specifies the statistics to be recorded for a garbage collection. + + [COR_GC_THREAD_STATS_TYPES Enumeration](cor-gc-thread-stats-types-enumeration.md) + Indicates the garbage collection statistics for a thread. + + [EApiCategories Enumeration](eapicategories-enumeration.md) + Describes the categories of capabilities that the host can block from running in partially trusted code. + + [EBindPolicyLevels Enumeration](ebindpolicylevels-enumeration.md) + Provides flags that specify the level at which to apply or modify assembly policy. + + [ECLRAssemblyIdentityFlags Enumeration](eclrassemblyidentityflags-enumeration.md) + Indicates the type of an assembly's identity. + + [EClrEvent Enumeration](eclrevent-enumeration.md) + Describes the CLR events for which the host can register callbacks. + + [EClrFailure Enumeration](eclrfailure-enumeration.md) + Describes the set of failures for which a host can set policy actions. + + [EClrOperation Enumeration](eclroperation-enumeration.md) + Describes the set of operations for which a host can apply policy actions. + + [EClrUnhandledException Enumeration](eclrunhandledexception-enumeration.md) + Describes the available options for managing exceptions that are unhandled in user code. + + [EContextType Enumeration](econtexttype-enumeration.md) + Describes the security context of the currently executing thread. + + [ECustomDumpFlavor Enumeration](ecustomdumpflavor-enumeration.md) + Contains values that indicate which items to include in a custom subset of a heap dump when reporting errors. + + [ECustomDumpItemKind Enumeration](ecustomdumpitemkind-enumeration.md) + Reserved for future extension of the [CustomDumpItem Structure](customdumpitem-structure.md) structure. + + [EHostApplicationPolicy Enumeration](ehostapplicationpolicy-enumeration.md) + Indicates how to modify an [IHostAssemblyManager Interface](ihostassemblymanager-interface.md) interface object. This enumeration has been deprecated. + + [EHostBindingPolicyModifyFlags Enumeration](ehostbindingpolicymodifyflags-enumeration.md) + Allows the host to specify the type of redirection the CLR should perform when applying policy modifications from a source assembly to a target assembly. + + [EInitializeNewDomainFlags Enumeration](einitializenewdomainflags-enumeration.md) + Enables the host to provide the runtime with information about the initialization of an application domain. + + [EMemoryAvailable Enumeration](ememoryavailable-enumeration.md) + Contains values that indicate the amount of free physical memory on the computer. + + [EMemoryCriticalLevel Enumeration](ememorycriticallevel-enumeration.md) + Contains values that indicate the impact of a failure when a specific memory allocation has been requested but cannot be satisfied. + + [EPolicyAction Enumeration](epolicyaction-enumeration.md) + Describes the policy actions the host can set for operations described by [EClrOperation Enumeration](eclroperation-enumeration.md) and failures described by [EClrFailure Enumeration](eclrfailure-enumeration.md). + + [ESymbolReadingPolicy Enumeration](esymbolreadingpolicy-enumeration.md) + Contains values that set the policy for reading program database (PDB) files. + + [ETaskType Enumeration](etasktype-enumeration.md) + Contains values that indicate the kind of task represented by an [ICLRTask Interface](iclrtask-interface.md) or an [IHostTask Interface](ihosttask-interface.md) interface. + + [HOST_TYPE Enumeration](host-type-enumeration.md) + Contains values that specify the type of host that is launching an application. + + [MALLOC_TYPE Enumeration](malloc-type-enumeration.md) + Contains values that specify the characteristics of the memory that is being allocated. + + [METAHOST_CONFIG_FLAGS Enumeration](metahost-config-flags-enumeration.md) + Describes the possible flags returned in the `pdwConfigFlags` parameter of the [ICLRMetaHostPolicy::GetRequestedRuntime](iclrmetahostpolicy-getrequestedruntime-method.md) method. + + [METAHOST_POLICY_FLAGS Enumeration](metahost-policy-flags-enumeration.md) + Provides binding policies that are common to most runtime hosts. + + [RUNTIME_INFO_FLAGS Enumeration](runtime-info-flags-enumeration.md) + Contains values that indicate what information about the CLR should be returned. + + [StackOverflowType Enumeration](stackoverflowtype-enumeration.md) + Contains values that indicate the underlying cause of a stack overflow event. + + [STARTUP_FLAGS Enumeration](startup-flags-enumeration.md) + Contains values that indicate the startup behavior of the CLR. + + [ValidatorFlags Enumeration](validatorflags-enumeration.md) + Contains values that indicate the type of validation that should be performed in a call to [Validate Method](iclrvalidator-validate-method.md). + + [WAIT_OPTION Enumeration](wait-option-enumeration.md) + Indicates the action a host should take if an operation requested by the CLR blocks. + +## Related Sections + + [Hosting Coclasses](hosting-coclasses.md) + + [Hosting Interfaces](hosting-interfaces.md) + + [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) + [Hosting Structures](hosting-structures.md) diff --git a/docs/core/unmanaged-api/hosting/hosting-global-static-functions.md b/docs/core/unmanaged-api/hosting/hosting-global-static-functions.md index baaf3998fb295..85c1ffc74d6dd 100644 --- a/docs/core/unmanaged-api/hosting/hosting-global-static-functions.md +++ b/docs/core/unmanaged-api/hosting/hosting-global-static-functions.md @@ -2,28 +2,27 @@ description: "Learn more about: Hosting Global Static Functions" title: "Hosting Global Static Functions" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - "global static functions [.NET Framework hosting]" - "hosting global static functions [.NET Framework]" - "unmanaged global static functions [.NET Framework], hosting" -ms.assetid: 4e4ad69d-9343-4f6a-aed8-fe0335a3b979 --- # Hosting Global Static Functions -This section describes the unmanaged hosting functions used by the .NET Framework hosting APIs. - -## In This Section - - [.NET Framework 4 Hosting Global Static Functions](net-framework-4-hosting-global-static-functions.md) - Describes the functions introduced in the .NET Framework 4. - - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) - Describes the functions introduced in the .NET Framework 1.1 and 2.0, which are deprecated in the .NET Framework 4. - -## Related Sections - - [Hosting Coclasses](hosting-coclasses.md) - - [Hosting Enumerations](hosting-enumerations.md) - +This section describes the unmanaged hosting functions used by the .NET Framework hosting APIs. + +## In This Section + + [.NET Framework 4 Hosting Global Static Functions](net-framework-4-hosting-global-static-functions.md) + Describes the functions introduced in the .NET Framework 4. + + [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) + Describes the functions introduced in the .NET Framework 1.1 and 2.0, which are deprecated in the .NET Framework 4. + +## Related Sections + + [Hosting Coclasses](hosting-coclasses.md) + + [Hosting Enumerations](hosting-enumerations.md) + [Hosting Structures](hosting-structures.md) diff --git a/docs/core/unmanaged-api/hosting/hosting-interfaces.md b/docs/core/unmanaged-api/hosting/hosting-interfaces.md index 40a9468da337b..9011816aa2fb6 100644 --- a/docs/core/unmanaged-api/hosting/hosting-interfaces.md +++ b/docs/core/unmanaged-api/hosting/hosting-interfaces.md @@ -2,43 +2,42 @@ description: "Learn more about: Hosting Interfaces" title: "Hosting Interfaces" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - "interfaces [.NET Framework hosting]" - "hosting interfaces [.NET Framework]" - "unmanaged interfaces [.NET Framework], hosting" -ms.assetid: cc64cb05-38da-418e-815a-daac8e8e26e5 --- # Hosting Interfaces -This section describes the interfaces that unmanaged hosts can use to integrate the common language runtime (CLR) into their applications. - - The .NET Framework version 2.0 hosting interfaces supersede the .NET Framework version 1.0 and 1.1 interfaces. There are significant differences between the two sets of interfaces. Mixing them could cause unexpected behavior and is not recommended. - - The .NET Framework versions 3.0 and 3.5 use the .NET Framework version 2.0 hosting interfaces, and do not introduce any hosting features. - +This section describes the interfaces that unmanaged hosts can use to integrate the common language runtime (CLR) into their applications. + + The .NET Framework version 2.0 hosting interfaces supersede the .NET Framework version 1.0 and 1.1 interfaces. There are significant differences between the two sets of interfaces. Mixing them could cause unexpected behavior and is not recommended. + + The .NET Framework versions 3.0 and 3.5 use the .NET Framework version 2.0 hosting interfaces, and do not introduce any hosting features. + The .NET Framework 4 hosting interfaces supersede the .NET Framework 2.0 interfaces. - -## In This Section - - [Deprecated CLR Hosting Interfaces and Coclasses](deprecated-clr-hosting-interfaces-and-coclasses.md) - Describes the hosting interfaces introduced in the .NET Framework versions 1.0 and 1.1. - - [CLR Hosting Interfaces](clr-hosting-interfaces.md) - Describes the hosting interfaces introduced in .NET Framework version 2.0. - - [CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5](clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md) - Describes the hosting interfaces introduced in the .NET Framework 4. - -## Related Sections - - [Hosting Coclasses](hosting-coclasses.md) - - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) - - [Hosting Enumerations](hosting-enumerations.md) - - [Hosting Structures](hosting-structures.md) - - [Hosting](index.md) - + +## In This Section + + [Deprecated CLR Hosting Interfaces and Coclasses](deprecated-clr-hosting-interfaces-and-coclasses.md) + Describes the hosting interfaces introduced in the .NET Framework versions 1.0 and 1.1. + + [CLR Hosting Interfaces](clr-hosting-interfaces.md) + Describes the hosting interfaces introduced in .NET Framework version 2.0. + + [CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5](clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md) + Describes the hosting interfaces introduced in the .NET Framework 4. + +## Related Sections + + [Hosting Coclasses](hosting-coclasses.md) + + [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) + + [Hosting Enumerations](hosting-enumerations.md) + + [Hosting Structures](hosting-structures.md) + + [Hosting](index.md) + [Runtime Hosts](/previous-versions/dotnet/netframework-4.0/a51xd4ze(v=vs.100)) diff --git a/docs/core/unmanaged-api/hosting/hosting-structures.md b/docs/core/unmanaged-api/hosting/hosting-structures.md index 48fa68db29eb0..865edd4ef6ff2 100644 --- a/docs/core/unmanaged-api/hosting/hosting-structures.md +++ b/docs/core/unmanaged-api/hosting/hosting-structures.md @@ -2,48 +2,47 @@ description: "Learn more about: Hosting Structures" title: "Hosting Structures" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - "hosting structures [.NET Framework]" - "unmanaged structures [.NET Framework], hosting" - "structures [.NET Framework hosting]" -ms.assetid: 492e010f-7493-4134-9505-f7008ccdaae6 --- # Hosting Structures -This section describes the unmanaged structures that the hosting API uses. - -## In This Section - - [AssemblyBindInfo Structure](assemblybindinfo-structure.md) - Provides detailed information about the referenced assembly. - - [BucketParameters Structure](bucketparameters-structure.md) - Stores the type name of an event and the parameters for the current exception that is associated with the event. - - [COR_GC_STATS Structure](cor-gc-stats-structure.md) - Provides statistics about the garbage collection mechanism of the common language runtime (CLR). - - [COR_GC_THREAD_STATS Structure](cor-gc-thread-stats-structure.md) - Contains per-thread statistics pertaining to garbage collection. - - [CustomDumpItem Structure](customdumpitem-structure.md) - Describes an item to be added to a custom dump in error reporting. - - [MDAInfo Structure](mdainfo-structure.md) - Provides details about the `Event_MDAFired` event, which triggers the creation of a managed debugging assistant (MDA). - - [ModuleBindInfo Structure](modulebindinfo-structure.md) - Provides detailed information about the referenced module and the assembly that contains it. - - [StackOverflowInfo Structure](stackoverflowinfo-structure.md) - Stores the type of overflow that occurred and information on the exception that was thrown due to the overflow. - -## Related Sections - - [Hosting Coclasses](hosting-coclasses.md) - - [Hosting Interfaces](hosting-interfaces.md) - - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) - +This section describes the unmanaged structures that the hosting API uses. + +## In This Section + + [AssemblyBindInfo Structure](assemblybindinfo-structure.md) + Provides detailed information about the referenced assembly. + + [BucketParameters Structure](bucketparameters-structure.md) + Stores the type name of an event and the parameters for the current exception that is associated with the event. + + [COR_GC_STATS Structure](cor-gc-stats-structure.md) + Provides statistics about the garbage collection mechanism of the common language runtime (CLR). + + [COR_GC_THREAD_STATS Structure](cor-gc-thread-stats-structure.md) + Contains per-thread statistics pertaining to garbage collection. + + [CustomDumpItem Structure](customdumpitem-structure.md) + Describes an item to be added to a custom dump in error reporting. + + [MDAInfo Structure](mdainfo-structure.md) + Provides details about the `Event_MDAFired` event, which triggers the creation of a managed debugging assistant (MDA). + + [ModuleBindInfo Structure](modulebindinfo-structure.md) + Provides detailed information about the referenced module and the assembly that contains it. + + [StackOverflowInfo Structure](stackoverflowinfo-structure.md) + Stores the type of overflow that occurred and information on the exception that was thrown due to the overflow. + +## Related Sections + + [Hosting Coclasses](hosting-coclasses.md) + + [Hosting Interfaces](hosting-interfaces.md) + + [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) + [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md b/docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md index cb6ffc62f9884..a34cd774969a0 100644 --- a/docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md +++ b/docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md @@ -2,40 +2,39 @@ description: "Learn more about: IActionOnCLREvent Interface" title: "IActionOnCLREvent Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IActionOnCLREvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IActionOnCLREvent" -helpviewer_keywords: +helpviewer_keywords: - "IActionOnCLREvent interface [.NET Framework hosting]" -ms.assetid: b5f9b41e-7301-429c-911f-21d5422292b3 -topic_type: +topic_type: - "apiref" --- # IActionOnCLREvent Interface -Provides the [IActionOnCLREvent::OnEvent](iactiononclrevent-onevent-method.md) method, which performs callbacks on events that have been registered by using a call to the [ICLROnEventManager::RegisterActionOnEvent](iclroneventmanager-registeractiononevent-method.md) method. - -## Methods - -|Method|Description| -|------------|-----------------| -|[OnEvent Method](iactiononclrevent-onevent-method.md)|Performs a callback for a registered event.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides the [IActionOnCLREvent::OnEvent](iactiononclrevent-onevent-method.md) method, which performs callbacks on events that have been registered by using a call to the [ICLROnEventManager::RegisterActionOnEvent](iclroneventmanager-registeractiononevent-method.md) method. + +## Methods + +|Method|Description| +|------------|-----------------| +|[OnEvent Method](iactiononclrevent-onevent-method.md)|Performs a callback for a registered event.| + +## 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 2.0 + ## See also - [EClrEvent Enumeration](eclrevent-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md b/docs/core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md index 05c6f867cdf7f..e78947a83c505 100644 --- a/docs/core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md +++ b/docs/core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md @@ -2,72 +2,71 @@ description: "Learn more about: IActionOnCLREvent::OnEvent Method" title: "IActionOnCLREvent::OnEvent Method" ms.date: "03/30/2017" -api_name: +api_name: - "IActionOnCLREvent.OnEvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IActionOnCLREvent::OnEvent" -helpviewer_keywords: +helpviewer_keywords: - "OnEvent method [.NET Framework hosting]" - "IActionOnCLREvent::OnEvent method [.NET Framework hosting]" -ms.assetid: 0970f10c-4304-4c12-91c0-83e51455afb4 -topic_type: +topic_type: - "apiref" --- # IActionOnCLREvent::OnEvent Method -Performs callbacks on events that have been registered by using a call to the [ICLROnEventManager::RegisterActionOnEvent](iclroneventmanager-registeractiononevent-method.md) method. - -## Syntax - -```cpp -HRESULT OnEvent ( - [in] EClrEvent event, - [in] PVOID data -); -``` - -## Parameters - - `event` - [in] One of the [EClrEvent](eclrevent-enumeration.md) values, which indicates the type of event. - - `data` - [in] A pointer to an object that contains details about `event`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`OnEvent` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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 cancelled 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 any hosting method return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The `data` parameter is a pointer to an object of unspecified type. If the `event` parameter is `Event_DomainUnload`, `data` is the numeric identifier for the that was unloaded. The host can take appropriate action using this identifier as a key. - - If `event` is `Event_MDAFired`, `data` is a pointer to an [MDAInfo](mdainfo-structure.md) instance that contains the message output from a Managed Debugging Assistant (MDA). MDAs are a feature of the CLR that help developers with debugging, by generating XML messages about events that are otherwise difficult to trap. Such messages can be especially useful in debugging transitions between managed and unmanaged code. For more information, see [Diagnosing Errors with Managed Debugging Assistants](../../debug-trace-profile/diagnosing-errors-with-managed-debugging-assistants.md). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Performs callbacks on events that have been registered by using a call to the [ICLROnEventManager::RegisterActionOnEvent](iclroneventmanager-registeractiononevent-method.md) method. + +## Syntax + +```cpp +HRESULT OnEvent ( + [in] EClrEvent event, + [in] PVOID data +); +``` + +## Parameters + + `event` + [in] One of the [EClrEvent](eclrevent-enumeration.md) values, which indicates the type of event. + + `data` + [in] A pointer to an object that contains details about `event`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`OnEvent` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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 cancelled 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 any hosting method return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The `data` parameter is a pointer to an object of unspecified type. If the `event` parameter is `Event_DomainUnload`, `data` is the numeric identifier for the that was unloaded. The host can take appropriate action using this identifier as a key. + + If `event` is `Event_MDAFired`, `data` is a pointer to an [MDAInfo](mdainfo-structure.md) instance that contains the message output from a Managed Debugging Assistant (MDA). MDAs are a feature of the CLR that help developers with debugging, by generating XML messages about events that are otherwise difficult to trap. Such messages can be especially useful in debugging transitions between managed and unmanaged code. For more information, see [Diagnosing Errors with Managed Debugging Assistants](../../../framework/debug-trace-profile/diagnosing-errors-with-managed-debugging-assistants.md). + +## 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 2.0 + ## See also -- [Diagnosing Errors with Managed Debugging Assistants](../../debug-trace-profile/diagnosing-errors-with-managed-debugging-assistants.md) +- [Diagnosing Errors with Managed Debugging Assistants](../../../framework/debug-trace-profile/diagnosing-errors-with-managed-debugging-assistants.md) - [EClrEvent Enumeration](eclrevent-enumeration.md) - [IActionOnCLREvent Interface](iactiononclrevent-interface.md) - [ICLRControl Interface](iclrcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md b/docs/core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md index eaf6f5e24889b..a16aa15797c84 100644 --- a/docs/core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md +++ b/docs/core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IApartmentCallback::DoCallback Method" title: "IApartmentCallback::DoCallback Method" ms.date: "03/30/2017" -api_name: +api_name: - "IApartmentCallback.DoCallback" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "DoCallback" -helpviewer_keywords: +helpviewer_keywords: - "IApartmentCallback::DoCallback method [.NET Framework hosting]" - "DoCallback method [.NET Framework hosting]" -ms.assetid: 8edad30c-30ff-4bee-813c-75525a82fc93 -topic_type: +topic_type: - "apiref" --- # IApartmentCallback::DoCallback Method -Executes the specified function within an apartment. - -## Syntax - -```cpp -HRESULT _stdcall DoCallback( - [in] SIZE_T pFunc, - [in] SIZE_T pData -); -``` - -## Parameters - - `pFunc` - [in] A pointer to the function to be executed within the apartment. - - `pData` - [in] A pointer to the function's argument. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Executes the specified function within an apartment. + +## Syntax + +```cpp +HRESULT _stdcall DoCallback( + [in] SIZE_T pFunc, + [in] SIZE_T pData +); +``` + +## Parameters + + `pFunc` + [in] A pointer to the function to be executed within the apartment. + + `pData` + [in] A pointer to the function's argument. + +## 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 2.0 + ## See also - [IApartmentCallback Interface](iapartmentcallback-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md b/docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md index 864b320594f0a..3e12503ac2f42 100644 --- a/docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md +++ b/docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md @@ -2,40 +2,39 @@ description: "Learn more about: IApartmentCallback Interface" title: "IApartmentCallback Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IApartmentCallback" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IApartmentCallback" -helpviewer_keywords: +helpviewer_keywords: - "IApartmentCallback interface [.NET Framework hosting]" -ms.assetid: 57c33c58-bf0b-4533-b569-e6a682d02cba -topic_type: +topic_type: - "apiref" --- # IApartmentCallback Interface -Provides methods for making callbacks within an apartment. An *apartment* is a logical container within a process for objects that share the same thread access requirements. - -## Methods - -|Method|Description| -|------------|-----------------| -|[DoCallback Method](iapartmentcallback-docallback-method.md)|Executes the specified function within an apartment.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods for making callbacks within an apartment. An *apartment* is a logical container within a process for objects that share the same thread access requirements. + +## Methods + +|Method|Description| +|------------|-----------------| +|[DoCallback Method](iapartmentcallback-docallback-method.md)|Executes the specified function within an apartment.| + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md b/docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md index b3520290d72b1..1f8663d848a97 100644 --- a/docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md +++ b/docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md @@ -2,40 +2,39 @@ description: "Learn more about: IAppDomainBinding Interface" title: "IAppDomainBinding Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IAppDomainBinding" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IAppDomainBinding" -helpviewer_keywords: +helpviewer_keywords: - "IAppDomainBinding interface [.NET Framework hosting]" -ms.assetid: 368881ab-c4ea-4731-bf22-c596aac7c66c -topic_type: +topic_type: - "apiref" --- # IAppDomainBinding Interface -Provides a method that is called by the common language runtime (CLR) to notify the host application that an application domain has been created. - -## Methods - -|Method|Description| -|------------|-----------------| -|[OnAppDomain Method](iappdomainbinding-onappdomain-method.md)|Called by the common language runtime (CLR) to notify the host that an application domain has been created.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides a method that is called by the common language runtime (CLR) to notify the host application that an application domain has been created. + +## Methods + +|Method|Description| +|------------|-----------------| +|[OnAppDomain Method](iappdomainbinding-onappdomain-method.md)|Called by the common language runtime (CLR) to notify the host that an application domain has been created.| + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md b/docs/core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md index 39a044ab6a2dc..388131500ba67 100644 --- a/docs/core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md +++ b/docs/core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md @@ -2,48 +2,47 @@ description: "Learn more about: IAppDomainBinding::OnAppDomain Method" title: "IAppDomainBinding::OnAppDomain Method" ms.date: "03/30/2017" -api_name: +api_name: - "IAppDomainBinding.OnAppDomain" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "OnAppDomain" -helpviewer_keywords: +helpviewer_keywords: - "IAppDomainBinding::OnAppDomain method [.NET Framework hosting]" - "OnAppDomain method [.NET Framework hosting]" -ms.assetid: b419dcc9-e8aa-484b-af0d-0f40358edb99 -topic_type: +topic_type: - "apiref" --- # IAppDomainBinding::OnAppDomain Method -Called by the common language runtime (CLR) to notify the host that an application domain has been created. - -## Syntax - -```cpp -HRESULT OnAppDomain ( - [in] IUnknown* pAppdomain -); -``` - -## Parameters - - `pAppdomain` - [in] A pointer to an [IUnknown](/cpp/atl/iunknown) interface object that represents the new application domain. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Called by the common language runtime (CLR) to notify the host that an application domain has been created. + +## Syntax + +```cpp +HRESULT OnAppDomain ( + [in] IUnknown* pAppdomain +); +``` + +## Parameters + + `pAppdomain` + [in] A pointer to an [IUnknown](/cpp/atl/iunknown) interface object that represents the new application domain. + +## 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 2.0 + ## See also - [IAppDomainBinding Interface](iappdomainbinding-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md b/docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md index 08c6fed1f5128..2c51c065df2f8 100644 --- a/docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md +++ b/docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md @@ -2,55 +2,54 @@ description: "Learn more about: IAppDomainSetup Interface" title: "IAppDomainSetup Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IAppDomainSetup" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IAppDomainSetup" -helpviewer_keywords: +helpviewer_keywords: - "IAppDomainSetup interface [.NET Framework hosting]" -ms.assetid: 1844da85-c031-40bf-bea4-1a3d12a36c8c -topic_type: +topic_type: - "apiref" --- # IAppDomainSetup Interface -Provides properties that allow the host to configure an type before calling the [ICorRuntimeHost::CreateDomainEx](icorruntimehost-createdomainex-method.md) method to create it. - -## Properties - -|Property|Description| -|--------------|-----------------| -||Gets or sets the name of the directory that contains the application.| -||Gets or sets the name of the application.| -||Gets or sets the name of an area specific to the application where files are shadow-copied.| -||Gets or sets the name of the configuration file for an application.| -||Gets or sets the name of the directory where dynamically generated files are stored and accessed.| -||Gets or sets the path to the license file that is associated with this domain.| -||Gets or sets the list of directories combined with the directory to probe for private assemblies.| -||Gets or sets a string value that includes or excludes from the search path for the application.| -||Gets or sets the names of the directories that contain assemblies to be shadow-copied.| -||Gets or sets a string that indicates whether shadow-copying is turned on or off. Valid values are "true" or "false".| - -## Remarks - - The `IAppDomainSetup` interface corresponds to the managed interface, which the type implements. See for detailed descriptions of its properties. - - `IAppDomainSetup` represents assembly binding information that can be added to an instance before its creation. For example, a host can set the property to establish a root directory, which the common language runtime (CLR) probes for managed assemblies. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] - +Provides properties that allow the host to configure an type before calling the [ICorRuntimeHost::CreateDomainEx](icorruntimehost-createdomainex-method.md) method to create it. + +## Properties + +|Property|Description| +|--------------|-----------------| +||Gets or sets the name of the directory that contains the application.| +||Gets or sets the name of the application.| +||Gets or sets the name of an area specific to the application where files are shadow-copied.| +||Gets or sets the name of the configuration file for an application.| +||Gets or sets the name of the directory where dynamically generated files are stored and accessed.| +||Gets or sets the path to the license file that is associated with this domain.| +||Gets or sets the list of directories combined with the directory to probe for private assemblies.| +||Gets or sets a string value that includes or excludes from the search path for the application.| +||Gets or sets the names of the directories that contain assemblies to be shadow-copied.| +||Gets or sets a string that indicates whether shadow-copying is turned on or off. Valid values are "true" or "false".| + +## Remarks + + The `IAppDomainSetup` interface corresponds to the managed interface, which the type implements. See for detailed descriptions of its properties. + + `IAppDomainSetup` represents assembly binding information that can be added to an instance before its creation. For example, a host can set the property to establish a root directory, which the common language runtime (CLR) probes for managed assemblies. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] + ## See also - diff --git a/docs/core/unmanaged-api/hosting/icatalogservices-autodone-method.md b/docs/core/unmanaged-api/hosting/icatalogservices-autodone-method.md index 4387c7cbb8738..e957516fcb919 100644 --- a/docs/core/unmanaged-api/hosting/icatalogservices-autodone-method.md +++ b/docs/core/unmanaged-api/hosting/icatalogservices-autodone-method.md @@ -2,31 +2,30 @@ description: "Learn more about: ICatalogServices::Autodone Method" title: "ICatalogServices::Autodone Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICatalogServices.Autodone" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "Autodone" -helpviewer_keywords: +helpviewer_keywords: - "ICatalogServices::Autodone method [.NET Framework hosting]" - "Autodone method [.NET Framework hosting]" -ms.assetid: 3002f051-7aaa-4669-9314-cbc65b3a1772 -topic_type: +topic_type: - "apiref" --- # ICatalogServices::Autodone Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT Autodone ( ); -``` - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT Autodone ( ); +``` + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/icatalogservices-interface.md b/docs/core/unmanaged-api/hosting/icatalogservices-interface.md index 87c807c0d968b..ea93960219d2b 100644 --- a/docs/core/unmanaged-api/hosting/icatalogservices-interface.md +++ b/docs/core/unmanaged-api/hosting/icatalogservices-interface.md @@ -2,33 +2,32 @@ description: "Learn more about: ICatalogServices Interface" title: "ICatalogServices Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICatalogServices" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICatalogServices" -helpviewer_keywords: +helpviewer_keywords: - "ICatalogServices interface [.NET Framework hosting]" -ms.assetid: f0d7e49b-2394-4ae0-8820-1b64cae0cfe8 -topic_type: +topic_type: - "apiref" --- # ICatalogServices Interface -Provides methods for cataloging services. - - This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Autodone Method](icatalogservices-autodone-method.md)|Reserved for internal use only.| -|[NotAutodone Method](icatalogservices-notautodone-method.md)|Reserved for internal use only.| - +Provides methods for cataloging services. + + This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Autodone Method](icatalogservices-autodone-method.md)|Reserved for internal use only.| +|[NotAutodone Method](icatalogservices-notautodone-method.md)|Reserved for internal use only.| + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/icatalogservices-notautodone-method.md b/docs/core/unmanaged-api/hosting/icatalogservices-notautodone-method.md index 443cb06e298e0..37586b5097401 100644 --- a/docs/core/unmanaged-api/hosting/icatalogservices-notautodone-method.md +++ b/docs/core/unmanaged-api/hosting/icatalogservices-notautodone-method.md @@ -2,31 +2,30 @@ description: "Learn more about: ICatalogServices::NotAutodone Method" title: "ICatalogServices::NotAutodone Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICatalogServices.NotAutodone" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "NotAutodone" -helpviewer_keywords: +helpviewer_keywords: - "ICatalogServices::NotAutodone method [.NET Framework hosting]" - "NotAutodone method [.NET Framework hosting]" -ms.assetid: 86a09871-33e4-412c-aeb8-4d18f924595b -topic_type: +topic_type: - "apiref" --- # ICatalogServices::NotAutodone Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT NotAutodone ( ); -``` - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT NotAutodone ( ); +``` + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/iceefilegen-class.md b/docs/core/unmanaged-api/hosting/iceefilegen-class.md index e0a31c9931405..20260f45da7b0 100644 --- a/docs/core/unmanaged-api/hosting/iceefilegen-class.md +++ b/docs/core/unmanaged-api/hosting/iceefilegen-class.md @@ -2,242 +2,241 @@ description: "Learn more about: ICeeFileGen Class" title: "ICeeFileGen Class" ms.date: "03/30/2017" -api_name: +api_name: - "ICeeFileGen" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICeeFileGen" -helpviewer_keywords: +helpviewer_keywords: - "ICeeFileGen class [.NET Framework hosting]" -ms.assetid: 90368606-506e-40df-be1f-8d595159203f -topic_type: +topic_type: - "apiref" --- # ICeeFileGen Class -Provides functionality for creating a native portable executable (PE) file. The interface will typically be used by compilers to generate their compiled output executable. - +Provides functionality for creating a native portable executable (PE) file. The interface will typically be used by compilers to generate their compiled output executable. + > [!NOTE] -> `ICeeFileGen` supports the .NET Framework infrastructure and is not intended to be used directly from your code. - - This interface has been deprecated and will be removed in a future release. - -## Syntax - -```cpp -class ICeeFileGen { -public: - virtual HRESULT CreateCeeFile(HCEEFILE *ceeFile); - - virtual HRESULT EmitMetaData (HCEEFILE ceeFile, - IMetaDataEmit *emitter, mdScope scope); - - virtual HRESULT EmitLibraryName (HCEEFILE ceeFile, - IMetaDataEmit *emitter, mdScope scope); - - virtual HRESULT EmitMethod (); - - virtual HRESULT GetMethodRVA (HCEEFILE ceeFile, - ULONG codeOffset, ULONG *codeRVA); - - virtual HRESULT EmitSignature (); - - virtual HRESULT EmitString (HCEEFILE ceeFile, - __in LPWSTR strValue, ULONG *strRef); - - virtual HRESULT GenerateCeeFile (HCEEFILE ceeFile); - - virtual HRESULT SetOutputFileName (HCEEFILE ceeFile, - __in LPWSTR outputFileName); - - virtual HRESULT GetOutputFileName (HCEEFILE ceeFile, - __out LPWSTR *outputFileName); - - virtual HRESULT SetResourceFileName (HCEEFILE ceeFile, - __in LPWSTR resourceFileName); - - virtual HRESULT GetResourceFileName (HCEEFILE ceeFile, - __out LPWSTR *resourceFileName); - - virtual HRESULT SetImageBase(HCEEFILE ceeFile, size_t imageBase); - - virtual HRESULT SetSubsystem(HCEEFILE ceeFile, DWORD subsystem, - DWORD major, DWORD minor); - - virtual HRESULT SetEntryClassToken (); - - virtual HRESULT GetEntryClassToken (); - - virtual HRESULT SetEntryPointDescr (); - - virtual HRESULT GetEntryPointDescr (); - - virtual HRESULT SetEntryPointFlags (); - - virtual HRESULT GetEntryPointFlags (); - - virtual HRESULT SetDllSwitch (HCEEFILE ceeFile, BOOL dllSwitch); - - virtual HRESULT GetDllSwitch (HCEEFILE ceeFile, BOOL *dllSwitch); - - virtual HRESULT SetLibraryName (HCEEFILE ceeFile, - __in LPWSTR LibraryName); - - virtual HRESULT GetLibraryName (HCEEFILE ceeFile, - __out LPWSTR *LibraryName); - - virtual HRESULT SetLibraryGuid (HCEEFILE ceeFile, - __in LPWSTR LibraryGuid); - - virtual HRESULT DestroyCeeFile(HCEEFILE *ceeFile); - - virtual HRESULT GetSectionCreate (HCEEFILE ceeFile, - const char *name, DWORD flags, HCEESECTION *section); - - virtual HRESULT GetIlSection (HCEEFILE ceeFile, - HCEESECTION *section); - - virtual HRESULT GetRdataSection (HCEEFILE ceeFile, - HCEESECTION *section); - - virtual HRESULT GetSectionDataLen (HCEESECTION section, - ULONG *dataLen); - - virtual HRESULT GetSectionBlock (HCEESECTION section, ULONG len, - ULONG align=1, void **ppBytes=0); - - virtual HRESULT TruncateSection (HCEESECTION section, ULONG len); - - virtual HRESULT AddSectionReloc (HCEESECTION section, - ULONG offset, HCEESECTION relativeTo, - CeeSectionRelocType relocType); - - virtual HRESULT SetSectionDirectoryEntry (HCEESECTION section, - ULONG num); - - virtual HRESULT CreateSig (); - - virtual HRESULT AddSigArg (); - - virtual HRESULT SetSigReturnType (); - - virtual HRESULT SetSigCallingConvention (); - - virtual HRESULT DeleteSig (); - - virtual HRESULT SetEntryPoint (HCEEFILE ceeFile, - mdMethodDef method); - - virtual HRESULT GetEntryPoint (HCEEFILE ceeFile, - mdMethodDef *method); - - virtual HRESULT SetComImageFlags (HCEEFILE ceeFile, DWORD mask); - - virtual HRESULT GetComImageFlags (HCEEFILE ceeFile, DWORD *mask); - - virtual HRESULT GetIMapTokenIface(HCEEFILE ceeFile, - IMetaDataEmit *emitter, IUnknown **pIMapToken); - - virtual HRESULT SetDirectoryEntry (HCEEFILE ceeFile, - HCEESECTION section, ULONG num, ULONG size, ULONG offset = 0); - - virtual HRESULT EmitMetaDataEx (HCEEFILE ceeFile, +> `ICeeFileGen` supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + This interface has been deprecated and will be removed in a future release. + +## Syntax + +```cpp +class ICeeFileGen { +public: + virtual HRESULT CreateCeeFile(HCEEFILE *ceeFile); + + virtual HRESULT EmitMetaData (HCEEFILE ceeFile, + IMetaDataEmit *emitter, mdScope scope); + + virtual HRESULT EmitLibraryName (HCEEFILE ceeFile, + IMetaDataEmit *emitter, mdScope scope); + + virtual HRESULT EmitMethod (); + + virtual HRESULT GetMethodRVA (HCEEFILE ceeFile, + ULONG codeOffset, ULONG *codeRVA); + + virtual HRESULT EmitSignature (); + + virtual HRESULT EmitString (HCEEFILE ceeFile, + __in LPWSTR strValue, ULONG *strRef); + + virtual HRESULT GenerateCeeFile (HCEEFILE ceeFile); + + virtual HRESULT SetOutputFileName (HCEEFILE ceeFile, + __in LPWSTR outputFileName); + + virtual HRESULT GetOutputFileName (HCEEFILE ceeFile, + __out LPWSTR *outputFileName); + + virtual HRESULT SetResourceFileName (HCEEFILE ceeFile, + __in LPWSTR resourceFileName); + + virtual HRESULT GetResourceFileName (HCEEFILE ceeFile, + __out LPWSTR *resourceFileName); + + virtual HRESULT SetImageBase(HCEEFILE ceeFile, size_t imageBase); + + virtual HRESULT SetSubsystem(HCEEFILE ceeFile, DWORD subsystem, + DWORD major, DWORD minor); + + virtual HRESULT SetEntryClassToken (); + + virtual HRESULT GetEntryClassToken (); + + virtual HRESULT SetEntryPointDescr (); + + virtual HRESULT GetEntryPointDescr (); + + virtual HRESULT SetEntryPointFlags (); + + virtual HRESULT GetEntryPointFlags (); + + virtual HRESULT SetDllSwitch (HCEEFILE ceeFile, BOOL dllSwitch); + + virtual HRESULT GetDllSwitch (HCEEFILE ceeFile, BOOL *dllSwitch); + + virtual HRESULT SetLibraryName (HCEEFILE ceeFile, + __in LPWSTR LibraryName); + + virtual HRESULT GetLibraryName (HCEEFILE ceeFile, + __out LPWSTR *LibraryName); + + virtual HRESULT SetLibraryGuid (HCEEFILE ceeFile, + __in LPWSTR LibraryGuid); + + virtual HRESULT DestroyCeeFile(HCEEFILE *ceeFile); + + virtual HRESULT GetSectionCreate (HCEEFILE ceeFile, + const char *name, DWORD flags, HCEESECTION *section); + + virtual HRESULT GetIlSection (HCEEFILE ceeFile, + HCEESECTION *section); + + virtual HRESULT GetRdataSection (HCEEFILE ceeFile, + HCEESECTION *section); + + virtual HRESULT GetSectionDataLen (HCEESECTION section, + ULONG *dataLen); + + virtual HRESULT GetSectionBlock (HCEESECTION section, ULONG len, + ULONG align=1, void **ppBytes=0); + + virtual HRESULT TruncateSection (HCEESECTION section, ULONG len); + + virtual HRESULT AddSectionReloc (HCEESECTION section, + ULONG offset, HCEESECTION relativeTo, + CeeSectionRelocType relocType); + + virtual HRESULT SetSectionDirectoryEntry (HCEESECTION section, + ULONG num); + + virtual HRESULT CreateSig (); + + virtual HRESULT AddSigArg (); + + virtual HRESULT SetSigReturnType (); + + virtual HRESULT SetSigCallingConvention (); + + virtual HRESULT DeleteSig (); + + virtual HRESULT SetEntryPoint (HCEEFILE ceeFile, + mdMethodDef method); + + virtual HRESULT GetEntryPoint (HCEEFILE ceeFile, + mdMethodDef *method); + + virtual HRESULT SetComImageFlags (HCEEFILE ceeFile, DWORD mask); + + virtual HRESULT GetComImageFlags (HCEEFILE ceeFile, DWORD *mask); + + virtual HRESULT GetIMapTokenIface(HCEEFILE ceeFile, + IMetaDataEmit *emitter, IUnknown **pIMapToken); + + virtual HRESULT SetDirectoryEntry (HCEEFILE ceeFile, + HCEESECTION section, ULONG num, ULONG size, ULONG offset = 0); + + virtual HRESULT EmitMetaDataEx (HCEEFILE ceeFile, + IMetaDataEmit *emitter); + + virtual HRESULT EmitLibraryNameEx (HCEEFILE ceeFile, IMetaDataEmit *emitter); - - virtual HRESULT EmitLibraryNameEx (HCEEFILE ceeFile, - IMetaDataEmit *emitter); - - virtual HRESULT GetIMapTokenIfaceEx(HCEEFILE ceeFile, - IMetaDataEmit *emitter, IUnknown **pIMapToken); - - virtual HRESULT EmitMacroDefinitions(HCEEFILE ceeFile, - void *pData, DWORD cData); - - virtual HRESULT CreateCeeFileFromICeeGen(ICeeGen *pFromICeeGen, - HCEEFILE *ceeFile, DWORD createFlags = - ICEE_CREATE_FILE_PURE_IL); - - virtual HRESULT SetManifestEntry(HCEEFILE ceeFile, ULONG size, - ULONG offset); - - virtual HRESULT SetEnCRVABase(HCEEFILE ceeFile, ULONG dataBase, - ULONG rdataBase); - - virtual HRESULT GenerateCeeMemoryImage (HCEEFILE ceeFile, - void **ppImage); - - virtual HRESULT ComputeSectionOffset(HCEESECTION section, - __in char *ptr, unsigned *offset); - - virtual HRESULT ComputeOffset(HCEEFILE file, __in char *ptr, - HCEESECTION *pSection, unsigned *offset); - - virtual HRESULT GetCorHeader(HCEEFILE ceeFile, - IMAGE_COR20_HEADER **header); - - virtual HRESULT LinkCeeFile (HCEEFILE ceeFile); - - virtual HRESULT FixupCeeFile (HCEEFILE ceeFile); - - virtual HRESULT GetSectionRVA (HCEESECTION section, ULONG *rva); - - virtual HRESULT ComputeSectionPointer(HCEESECTION section, - ULONG offset, __out char **ptr); - - virtual HRESULT SetObjSwitch (HCEEFILE ceeFile, BOOL objSwitch); - - virtual HRESULT GetObjSwitch (HCEEFILE ceeFile, BOOL *objSwitch); - - virtual HRESULT SetVTableEntry(HCEEFILE ceeFile, ULONG size, - ULONG offset); - - virtual HRESULT SetStrongNameEntry(HCEEFILE ceeFile, ULONG size, - ULONG offset); - - virtual HRESULT EmitMetaDataAt (HCEEFILE ceeFile, - IMetaDataEmit *emitter, HCEESECTION section, DWORD offset, - BYTE* buffer, unsigned buffLen); - - virtual HRESULT GetFileTimeStamp (HCEEFILE ceeFile, - DWORD *pTimeStamp); - - virtual HRESULT AddNotificationHandler(HCEEFILE ceeFile, - IUnknown *pHandler); - - virtual HRESULT SetFileAlignment(HCEEFILE ceeFile, - ULONG fileAlignment); - - virtual HRESULT ClearComImageFlags (HCEEFILE ceeFile, DWORD mask); - - virtual HRESULT CreateCeeFileEx(HCEEFILE *ceeFile, - ULONG createFlags); - - virtual HRESULT SetImageBase64(HCEEFILE ceeFile, - ULONGLONG imageBase); - - virtual HRESULT GetHeaderInfo (HCEEFILE ceeFile, - PIMAGE_NT_HEADERS *ppNtHeaders, - PIMAGE_SECTION_HEADER *ppSections, ULONG *pNumSections); - - virtual HRESULT CreateCeeFileEx2(HCEEFILE *ceeFile, - ULONG createFlags, LPCWSTR seedFileName = NULL); - - virtual HRESULT SetVTableEntry64(HCEEFILE ceeFile, ULONG size, - void* ptr); -}; -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** ICeeFileGen.h - - **.NET Framework Version:** 1.0 - + + virtual HRESULT GetIMapTokenIfaceEx(HCEEFILE ceeFile, + IMetaDataEmit *emitter, IUnknown **pIMapToken); + + virtual HRESULT EmitMacroDefinitions(HCEEFILE ceeFile, + void *pData, DWORD cData); + + virtual HRESULT CreateCeeFileFromICeeGen(ICeeGen *pFromICeeGen, + HCEEFILE *ceeFile, DWORD createFlags = + ICEE_CREATE_FILE_PURE_IL); + + virtual HRESULT SetManifestEntry(HCEEFILE ceeFile, ULONG size, + ULONG offset); + + virtual HRESULT SetEnCRVABase(HCEEFILE ceeFile, ULONG dataBase, + ULONG rdataBase); + + virtual HRESULT GenerateCeeMemoryImage (HCEEFILE ceeFile, + void **ppImage); + + virtual HRESULT ComputeSectionOffset(HCEESECTION section, + __in char *ptr, unsigned *offset); + + virtual HRESULT ComputeOffset(HCEEFILE file, __in char *ptr, + HCEESECTION *pSection, unsigned *offset); + + virtual HRESULT GetCorHeader(HCEEFILE ceeFile, + IMAGE_COR20_HEADER **header); + + virtual HRESULT LinkCeeFile (HCEEFILE ceeFile); + + virtual HRESULT FixupCeeFile (HCEEFILE ceeFile); + + virtual HRESULT GetSectionRVA (HCEESECTION section, ULONG *rva); + + virtual HRESULT ComputeSectionPointer(HCEESECTION section, + ULONG offset, __out char **ptr); + + virtual HRESULT SetObjSwitch (HCEEFILE ceeFile, BOOL objSwitch); + + virtual HRESULT GetObjSwitch (HCEEFILE ceeFile, BOOL *objSwitch); + + virtual HRESULT SetVTableEntry(HCEEFILE ceeFile, ULONG size, + ULONG offset); + + virtual HRESULT SetStrongNameEntry(HCEEFILE ceeFile, ULONG size, + ULONG offset); + + virtual HRESULT EmitMetaDataAt (HCEEFILE ceeFile, + IMetaDataEmit *emitter, HCEESECTION section, DWORD offset, + BYTE* buffer, unsigned buffLen); + + virtual HRESULT GetFileTimeStamp (HCEEFILE ceeFile, + DWORD *pTimeStamp); + + virtual HRESULT AddNotificationHandler(HCEEFILE ceeFile, + IUnknown *pHandler); + + virtual HRESULT SetFileAlignment(HCEEFILE ceeFile, + ULONG fileAlignment); + + virtual HRESULT ClearComImageFlags (HCEEFILE ceeFile, DWORD mask); + + virtual HRESULT CreateCeeFileEx(HCEEFILE *ceeFile, + ULONG createFlags); + + virtual HRESULT SetImageBase64(HCEEFILE ceeFile, + ULONGLONG imageBase); + + virtual HRESULT GetHeaderInfo (HCEEFILE ceeFile, + PIMAGE_NT_HEADERS *ppNtHeaders, + PIMAGE_SECTION_HEADER *ppSections, ULONG *pNumSections); + + virtual HRESULT CreateCeeFileEx2(HCEEFILE *ceeFile, + ULONG createFlags, LPCWSTR seedFileName = NULL); + + virtual HRESULT SetVTableEntry64(HCEEFILE ceeFile, ULONG size, + void* ptr); +}; +``` + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** ICeeFileGen.h + + **.NET Framework Version:** 1.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentallocated-method.md b/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentallocated-method.md index 40270d58fe72c..776d8e7ca4c00 100644 --- a/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentallocated-method.md +++ b/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentallocated-method.md @@ -2,63 +2,62 @@ description: "Learn more about: ICLRAppDomainResourceMonitor::GetCurrentAllocated Method" title: "ICLRAppDomainResourceMonitor::GetCurrentAllocated Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAppDomainResourceMonitor.GetCurrentAllocated" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAppDomainResourceMonitor::GetCurrentAllocated" -helpviewer_keywords: +helpviewer_keywords: - "GetCurrentAllocated method [.NET Framework hosting]" - "ICLRAppDomainResourceMonitor::GetCurrentAllocated method [.NET Framework hosting]" -ms.assetid: 7bab209c-efd4-44c2-af30-61abab0ae2fc -topic_type: +topic_type: - "apiref" --- # ICLRAppDomainResourceMonitor::GetCurrentAllocated Method -Gets the total size, in bytes, of all memory allocations that have been made by the application domain since it was created, without subtracting memory that has been garbage-collected. - -## Syntax - -```cpp -HRESULT GetCurrentAllocated([in] DWORD dwAppDomainId, - [out] ULONGLONG* pBytesAllocated); -``` - -## Parameters - - `dwAppDomainId` - [in] The ID of the requested application domain. - - `pBytesAllocated` - [out] A pointer to the total size of all memory allocations. - -## 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.| -|COR_E_APPDOMAINUNLOADED|The application domain has been unloaded or does not exist.| - -## Remarks - - This method is the unmanaged equivalent of the managed property. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the total size, in bytes, of all memory allocations that have been made by the application domain since it was created, without subtracting memory that has been garbage-collected. + +## Syntax + +```cpp +HRESULT GetCurrentAllocated([in] DWORD dwAppDomainId, + [out] ULONGLONG* pBytesAllocated); +``` + +## Parameters + + `dwAppDomainId` + [in] The ID of the requested application domain. + + `pBytesAllocated` + [out] A pointer to the total size of all memory allocations. + +## 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.| +|COR_E_APPDOMAINUNLOADED|The application domain has been unloaded or does not exist.| + +## Remarks + + This method is the unmanaged equivalent of the managed property. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRAppDomainResourceMonitor Interface](iclrappdomainresourcemonitor-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentcputime-method.md b/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentcputime-method.md index 04c622a0c659f..69219dbe6eeac 100644 --- a/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentcputime-method.md +++ b/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentcputime-method.md @@ -2,62 +2,61 @@ description: "Learn more about: ICLRAppDomainResourceMonitor::GetCurrentCpuTime Method" title: "ICLRAppDomainResourceMonitor::GetCurrentCpuTime Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAppDomainResourceMonitor.GetCurrentCpuTime" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAppDomainResourceMonitor::GetCurrentCpuTime" -helpviewer_keywords: +helpviewer_keywords: - "ICLRAppDomainResourceMonitor::GetCurrentCpuTime method [.NET Framework hosting]" - "GetCurrentCpuTime method [.NET Framework hosting]" -ms.assetid: ebc9cc33-fcd6-4cae-9ecb-ea21c51874e6 -topic_type: +topic_type: - "apiref" --- # ICLRAppDomainResourceMonitor::GetCurrentCpuTime Method -Gets the total processor time that has been used by all threads while executing in the current application domain, since the application domain was created. - -## Syntax - -```cpp -HRESULT GetCurrentCpuTime([in] DWORD dwAppDomainId, - [out] ULONGLONG* pMilliseconds); -``` - -## Parameters - - `dwAppDomainId` - [in] The ID of the requested application domain. - - `pMilliseconds` - [out] A pointer to the total processor time that has been used by all threads while executing in the current application domain since the application domain was created. This parameter can be `null`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method completed successfully.| -|COR_E_APPDOMAINUNLOADED|The application domain has been unloaded or does not exist.| -|E_FAIL|Application domain resource monitoring is not enabled.

-or-

All other failures.| - -## Remarks - - This method is the unmanaged equivalent of the managed property. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the total processor time that has been used by all threads while executing in the current application domain, since the application domain was created. + +## Syntax + +```cpp +HRESULT GetCurrentCpuTime([in] DWORD dwAppDomainId, + [out] ULONGLONG* pMilliseconds); +``` + +## Parameters + + `dwAppDomainId` + [in] The ID of the requested application domain. + + `pMilliseconds` + [out] A pointer to the total processor time that has been used by all threads while executing in the current application domain since the application domain was created. This parameter can be `null`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method completed successfully.| +|COR_E_APPDOMAINUNLOADED|The application domain has been unloaded or does not exist.| +|E_FAIL|Application domain resource monitoring is not enabled.

-or-

All other failures.| + +## Remarks + + This method is the unmanaged equivalent of the managed property. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRAppDomainResourceMonitor Interface](iclrappdomainresourcemonitor-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md b/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md index 997172f044740..f2a32c122e542 100644 --- a/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md +++ b/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md @@ -2,70 +2,69 @@ description: "Learn more about: ICLRAppDomainResourceMonitor::GetCurrentSurvived Method" title: "ICLRAppDomainResourceMonitor::GetCurrentSurvived Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAppDomainResourceMonitor.GetCurrentSurvived" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAppDomainResourceMonitor::GetCurrentSurvived" -helpviewer_keywords: +helpviewer_keywords: - "ICLRAppDomainResourceMonitor::GetCurrentSurvived method [.NET Framework hosting]" - "GetCurrentSurvived method [.NET Framework hosting]" -ms.assetid: 392e9009-40ef-40e3-ad4d-7ce93a989e78 -topic_type: +topic_type: - "apiref" --- # ICLRAppDomainResourceMonitor::GetCurrentSurvived Method -Gets the number of bytes that survived the last full, blocking garbage collection and that are referenced by the current application domain. - -## Syntax - -```cpp -HRESULT STDMETHODCALLTYPE GetCurrentSurvived( - [in] DWORD dwAppDomainId, - [out] ULONGLONG *pAppDomainBytesSurvived, - [out] ULONGLONG *pTotalBytesSurvived); -``` - -## Parameters - - `dwAppDomainId` - [in] The ID of the requested application domain. - - `pAppDomainBytesSurvived` - [out] A pointer to the number of bytes that survived after the last garbage collection that are held by this application domain. After a full collection, this number is accurate and complete. After an ephemeral collection, this number is potentially incomplete. This parameter can be `null`. - - `pRuntimeBytesSurvived` - [out] A pointer to the total number of bytes that survived from the last garbage collection. After a full collection, this number represents the number of the bytes that are held in managed heaps. After an ephemeral collection, this number represents the number of bytes that are held live in ephemeral generations. This parameter can be `null`. - -## 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.| -|COR_E_APPDOMAINUNLOADED|The application domain has been unloaded or does not exist.| - -## Remarks - - Statistics are updated only after a full, blocking garbage collection; that is, a collection that includes all generations and that stops the application while collection occurs. For example, the method overload performs a full, blocking collection. Concurrent garbage collection occurs in the background and does not block the application. - - The `GetCurrentSurvived` method is the unmanaged equivalent of the managed property. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the number of bytes that survived the last full, blocking garbage collection and that are referenced by the current application domain. + +## Syntax + +```cpp +HRESULT STDMETHODCALLTYPE GetCurrentSurvived( + [in] DWORD dwAppDomainId, + [out] ULONGLONG *pAppDomainBytesSurvived, + [out] ULONGLONG *pTotalBytesSurvived); +``` + +## Parameters + + `dwAppDomainId` + [in] The ID of the requested application domain. + + `pAppDomainBytesSurvived` + [out] A pointer to the number of bytes that survived after the last garbage collection that are held by this application domain. After a full collection, this number is accurate and complete. After an ephemeral collection, this number is potentially incomplete. This parameter can be `null`. + + `pRuntimeBytesSurvived` + [out] A pointer to the total number of bytes that survived from the last garbage collection. After a full collection, this number represents the number of the bytes that are held in managed heaps. After an ephemeral collection, this number represents the number of bytes that are held live in ephemeral generations. This parameter can be `null`. + +## 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.| +|COR_E_APPDOMAINUNLOADED|The application domain has been unloaded or does not exist.| + +## Remarks + + Statistics are updated only after a full, blocking garbage collection; that is, a collection that includes all generations and that stops the application while collection occurs. For example, the method overload performs a full, blocking collection. Concurrent garbage collection occurs in the background and does not block the application. + + The `GetCurrentSurvived` method is the unmanaged equivalent of the managed property. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRAppDomainResourceMonitor Interface](iclrappdomainresourcemonitor-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md b/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md index ba9831ccb0ee1..dd0e6647a9a57 100644 --- a/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md @@ -2,59 +2,58 @@ description: "Learn more about: ICLRAppDomainResourceMonitor Interface" title: "ICLRAppDomainResourceMonitor Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAppDomainResourceMonitor" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAppDomainResourceMonitor" -helpviewer_keywords: +helpviewer_keywords: - "ICLRAppDomainResourceMonitor interface [.NET Framework hosting]" -ms.assetid: 72fa83a1-8997-41d7-b355-ab177a24a303 -topic_type: +topic_type: - "apiref" --- # ICLRAppDomainResourceMonitor Interface -Provides methods that inspect an application domain's memory and CPU usage. - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetCurrentAllocated Method](iclrappdomainresourcemonitor-getcurrentallocated-method.md)|Gets the total size, in bytes, of all memory allocations that have been made by the application domain since it was created, without subtracting memory that has been garbage-collected.| -|[GetCurrentSurvived Method](iclrappdomainresourcemonitor-getcurrentsurvived-method.md)|Gets the number of bytes that survived the last full, blocking garbage collection and that are referenced by the current application domain.| -|[GetCurrentCpuTime Method](iclrappdomainresourcemonitor-getcurrentcputime-method.md)|Gets the total processor time that has been used by all threads while executing in the current application domain, since the application domain was created.| - -## Remarks - - The `ICLRAppDomainResourceMonitor` interface provides functionality that is similar to the following managed properties: - -- - -- - -- - -- - -- - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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 inspect an application domain's memory and CPU usage. + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetCurrentAllocated Method](iclrappdomainresourcemonitor-getcurrentallocated-method.md)|Gets the total size, in bytes, of all memory allocations that have been made by the application domain since it was created, without subtracting memory that has been garbage-collected.| +|[GetCurrentSurvived Method](iclrappdomainresourcemonitor-getcurrentsurvived-method.md)|Gets the number of bytes that survived the last full, blocking garbage collection and that are referenced by the current application domain.| +|[GetCurrentCpuTime Method](iclrappdomainresourcemonitor-getcurrentcputime-method.md)|Gets the total processor time that has been used by all threads while executing in the current application domain, since the application domain was created.| + +## Remarks + + The `ICLRAppDomainResourceMonitor` interface provides functionality that is similar to the following managed properties: + +- + +- + +- + +- + +- + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also -- [\ Element](../../configure-apps/file-schema/runtime/appdomainresourcemonitoring-element.md) +- [\ Element](../../../framework/configure-apps/file-schema/runtime/appdomainresourcemonitoring-element.md) - [Application Domain Resource Monitoring](../../../standard/garbage-collection/app-domain-resource-monitoring.md) - [Hosting Interfaces](hosting-interfaces.md) - [Hosting](index.md) diff --git a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromfile-method.md b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromfile-method.md index 49344ae4d02fe..6737ad436a08f 100644 --- a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromfile-method.md +++ b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromfile-method.md @@ -2,77 +2,76 @@ description: "Learn more about: ICLRAssemblyIdentityManager::GetBindingIdentityFromFile Method" title: "ICLRAssemblyIdentityManager::GetBindingIdentityFromFile Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAssemblyIdentityManager.GetBindingIdentityFromFile" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAssemblyIdentityManager::GetBindingIdentityFromFile" -helpviewer_keywords: +helpviewer_keywords: - "GetBindingIdentityFromFile method [.NET Framework hosting]" - "ICLRAssemblyIdentityManager::GetBindingIdentifyFromFile method [.NET Framework hosting]" -ms.assetid: 7797562d-7b4c-4bd9-8b93-f35e0e2869e4 -topic_type: +topic_type: - "apiref" --- # ICLRAssemblyIdentityManager::GetBindingIdentityFromFile Method -Gets the assembly identity binding data for the assembly at the specified file path. - -## Syntax - -```cpp -HRESULT GetBindingIdentityFromFile( - [in] LPCWSTR pwzFilePath, - [in] DWORD dwFlags, - [out, size_is(*pcchBufferSize)] LPWSTR pwzBuffer, - [in, out] DWORD *pcchBufferSize -); -``` - -## Parameters - - `pwzFilePath` - [in] The path to the file to be evaluated. - - `dwFlags` - [in] A value of the [ECLRAssemblyIdentityFlags](eclrassemblyidentityflags-enumeration.md) enumeration that indicates an assembly's identity type. Provided for future extensibility. CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT is the only value that the common language runtime (CLR) version 2.0 supports. - - `pwzBuffer` - [out] A buffer containing the opaque assembly identity data. - - `pcchBufferSize` - [in, out] A pointer to the size of `pwzBuffer`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method returned successfully.| -|E_INVALIDARG|The supplied `pwzFilePath` is null.| -|ERROR_INSUFFICIENT_BUFFER|The size of `pwzBuffer` is too small.| -|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.| - -## Remarks - - `GetBindingIdentityFromFile` is typically called twice. The first call supplies a null value for `pwzBuffer`, and the method returns the appropriate size in `pcchBufferSize`. The second call supplies an appropriately allocated buffer, and the method returns with the actual buffer data upon completion. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the assembly identity binding data for the assembly at the specified file path. + +## Syntax + +```cpp +HRESULT GetBindingIdentityFromFile( + [in] LPCWSTR pwzFilePath, + [in] DWORD dwFlags, + [out, size_is(*pcchBufferSize)] LPWSTR pwzBuffer, + [in, out] DWORD *pcchBufferSize +); +``` + +## Parameters + + `pwzFilePath` + [in] The path to the file to be evaluated. + + `dwFlags` + [in] A value of the [ECLRAssemblyIdentityFlags](eclrassemblyidentityflags-enumeration.md) enumeration that indicates an assembly's identity type. Provided for future extensibility. CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT is the only value that the common language runtime (CLR) version 2.0 supports. + + `pwzBuffer` + [out] A buffer containing the opaque assembly identity data. + + `pcchBufferSize` + [in, out] A pointer to the size of `pwzBuffer`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method returned successfully.| +|E_INVALIDARG|The supplied `pwzFilePath` is null.| +|ERROR_INSUFFICIENT_BUFFER|The size of `pwzBuffer` is too small.| +|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.| + +## Remarks + + `GetBindingIdentityFromFile` is typically called twice. The first call supplies a null value for `pwzBuffer`, and the method returns the appropriate size in `pcchBufferSize`. The second call supplies an appropriately allocated buffer, and the method returns with the actual buffer data upon completion. + +## 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 2.0 + ## See also - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromstream-method.md b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromstream-method.md index 8175a1175b32a..9e789506477b4 100644 --- a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromstream-method.md +++ b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromstream-method.md @@ -2,73 +2,72 @@ description: "Learn more about: ICLRAssemblyIdentityManager::GetBindingIdentityFromStream Method" title: "ICLRAssemblyIdentityManager::GetBindingIdentityFromStream Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAssemblyIdentityManager.GetBindingIdentityFromStream" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAssemblyIdentityManager::GetBindingIdentityFromStream" -helpviewer_keywords: +helpviewer_keywords: - "GetBindingIdentityFromStream method [.NET Framework hosting]" - "ICLRAssemblyIdentityManager::GetBindingIdentityFromStream method [.NET Framework hosting]" -ms.assetid: 40123b30-a589-46b3-95d3-af7b2b0baa05 -topic_type: +topic_type: - "apiref" --- # ICLRAssemblyIdentityManager::GetBindingIdentityFromStream Method -Gets the canonical assembly identity data for the assembly in the specified stream. - -## Syntax - -```cpp -HRESULT GetBindingIdentityFromStream ( - [in] IStream *pStream, - [in] DWORD dwFlags, - [out, size_is(*pcchBufferSize)] LPWSTR pwzBuffer, - [in, out] DWORD *pcchBufferSize -); -``` - -## Parameters - - `pStream` - [in] The assembly stream to be evaluated. - - `dwFlags` - [in] Provided for future extensibility. CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT is the only value that the current version of the common language runtime (CLR) supports. - - `pwzBuffer` - [out] A buffer containing the opaque assembly identity data. - - `pcchBufferSize` - [in, out] The size of `pwzBuffer`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method returned successfully.| -|E_INVALIDARG|The supplied `pStream` is null.| -|ERROR_INSUFFICIENT_BUFFER|The size of `pwzBuffer` is too small.| -|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.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the canonical assembly identity data for the assembly in the specified stream. + +## Syntax + +```cpp +HRESULT GetBindingIdentityFromStream ( + [in] IStream *pStream, + [in] DWORD dwFlags, + [out, size_is(*pcchBufferSize)] LPWSTR pwzBuffer, + [in, out] DWORD *pcchBufferSize +); +``` + +## Parameters + + `pStream` + [in] The assembly stream to be evaluated. + + `dwFlags` + [in] Provided for future extensibility. CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT is the only value that the current version of the common language runtime (CLR) supports. + + `pwzBuffer` + [out] A buffer containing the opaque assembly identity data. + + `pcchBufferSize` + [in, out] The size of `pwzBuffer`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method returned successfully.| +|E_INVALIDARG|The supplied `pStream` is null.| +|ERROR_INSUFFICIENT_BUFFER|The size of `pwzBuffer` is too small.| +|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.| + +## 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 2.0 + ## See also - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md index 7887aa9f79d1e..01fca6c4ff8ff 100644 --- a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md +++ b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md @@ -2,67 +2,66 @@ description: "Learn more about: ICLRAssemblyIdentityManager::GetCLRAssemblyReferenceList Method" title: "ICLRAssemblyIdentityManager::GetCLRAssemblyReferenceList Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAssemblyIdentityManager.GetCLRAssemblyReferenceList" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAssemblyIdentityManager::GetCLRAssemblyReferenceList" -helpviewer_keywords: +helpviewer_keywords: - "GetClrAssemblyReferenceList method [.NET Framework hosting]" - "ICLRAssemblyIdentityManager::GetCLRAssemblyReferenceList method [.NET Framework hosting]" -ms.assetid: cb5ffae5-287b-4a87-9ca8-7ce3ae0601b7 -topic_type: +topic_type: - "apiref" --- # ICLRAssemblyIdentityManager::GetCLRAssemblyReferenceList Method -Gets an interface pointer to an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) instance from the supplied list of partial assembly identities. - -## Syntax - -```cpp -HRESULT GetCLRAssemblyReferenceList ( - [in] LPCWSTR *ppwzAssemblyReferences, - [in] DWORD dwNumOfReferences, - [out] ICLRAssemblyReferenceList **ppReferenceList -); -``` - -## Parameters - - `ppwzAssemblyReferences` - [in] An array of null-terminated strings in the form "name, property=value..." that specify a list of partial assembly identities. - - `dwNumOfReferences` - [in] The number of items in `ppwzAssemblyReferences`. - - `ppReferenceList` - [out] An interface pointer to an `ICLRAssemblyReferenceList` object that contains the assembly identity data for the list of assemblies specified in `ppwzAssemblyReferences`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets an interface pointer to an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) instance from the supplied list of partial assembly identities. + +## Syntax + +```cpp +HRESULT GetCLRAssemblyReferenceList ( + [in] LPCWSTR *ppwzAssemblyReferences, + [in] DWORD dwNumOfReferences, + [out] ICLRAssemblyReferenceList **ppReferenceList +); +``` + +## Parameters + + `ppwzAssemblyReferences` + [in] An array of null-terminated strings in the form "name, property=value..." that specify a list of partial assembly identities. + + `dwNumOfReferences` + [in] The number of items in `ppwzAssemblyReferences`. + + `ppReferenceList` + [out] An interface pointer to an `ICLRAssemblyReferenceList` object that contains the assembly identity data for the list of assemblies specified in `ppwzAssemblyReferences`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| + +## 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 2.0 + ## See also - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md index 3636745d1e65f..de42f8419303a 100644 --- a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md +++ b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md @@ -2,71 +2,70 @@ description: "Learn more about: ICLRAssemblyIdentityManager::GetProbingAssembliesFromReference Method" title: "ICLRAssemblyIdentityManager::GetProbingAssembliesFromReference Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAssemblyIdentityManager.GetProbingAssembliesFromReference" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAssemblyIdentityManager::GetProbingAssembliesFromReference" -helpviewer_keywords: +helpviewer_keywords: - "ICLRAssemblyIdentityManager::GetProbingAssembliesFromReference method [.NET Framework hosting]" - "GetProbingAssembliesFromReference method [.NET Framework hosting]" -ms.assetid: aec05744-e8d4-44c6-b4a8-e583229ac34e -topic_type: +topic_type: - "apiref" --- # ICLRAssemblyIdentityManager::GetProbingAssembliesFromReference Method -Gets an [ICLRProbingAssemblyEnum](iclrprobingassemblyenum-interface.md) enumerator for the assembly identities referenced by the assembly with the specified identity type. - -## Syntax - -```cpp -HRESULT GetProbingAssembliesFromReference ( - [in] DWORD dwMachineType, - [in] DWORD dwFlags, - [in] LPCWSTR pwzReferenceIdentity, - [out] ICLRProbingAssemblyEnum **ppProbingAssemblyEnum -); -``` - -## Parameters - - `dwMachineType` - [in] A valid value that specifies the processor architecture, as defined in WinNT.h. - - `dwFlags` - [in] Provided for future extensibility. CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT is the only value that the current version of the common language runtime (CLR) supports. - - `pwzReferenceIdentity` - [in] An opaque assembly binding identity, typically returned from a call to the [ICLRAssemblyIdentityManager::GetBindingIdentityFromFile](iclrassemblyidentitymanager-getbindingidentityfromfile-method.md) or [ICLRAssemblyIdentityManager::GetBindingIdentityFromStream](iclrassemblyidentitymanager-getbindingidentityfromstream-method.md) method. - - `ppProbingAssemblyEnum` - [out] An interface pointer to an `ICLRProbingAssemblyEnum` enumerator that contains references to the assemblies referenced by the assembly identified by `pwzReferenceIdentity`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method 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.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets an [ICLRProbingAssemblyEnum](iclrprobingassemblyenum-interface.md) enumerator for the assembly identities referenced by the assembly with the specified identity type. + +## Syntax + +```cpp +HRESULT GetProbingAssembliesFromReference ( + [in] DWORD dwMachineType, + [in] DWORD dwFlags, + [in] LPCWSTR pwzReferenceIdentity, + [out] ICLRProbingAssemblyEnum **ppProbingAssemblyEnum +); +``` + +## Parameters + + `dwMachineType` + [in] A valid value that specifies the processor architecture, as defined in WinNT.h. + + `dwFlags` + [in] Provided for future extensibility. CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT is the only value that the current version of the common language runtime (CLR) supports. + + `pwzReferenceIdentity` + [in] An opaque assembly binding identity, typically returned from a call to the [ICLRAssemblyIdentityManager::GetBindingIdentityFromFile](iclrassemblyidentitymanager-getbindingidentityfromfile-method.md) or [ICLRAssemblyIdentityManager::GetBindingIdentityFromStream](iclrassemblyidentitymanager-getbindingidentityfromstream-method.md) method. + + `ppProbingAssemblyEnum` + [out] An interface pointer to an `ICLRProbingAssemblyEnum` enumerator that contains references to the assemblies referenced by the assembly identified by `pwzReferenceIdentity`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method 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.| + +## 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 2.0 + ## See also - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md index 3b0cae9460ec4..9f3993893740d 100644 --- a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md +++ b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md @@ -2,75 +2,74 @@ description: "Learn more about: ICLRAssemblyIdentityManager::GetReferencedAssembliesFromFile Method" title: "ICLRAssemblyIdentityManager::GetReferencedAssembliesFromFile Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAssemblyIdentityManager.GetReferencedAssembliesFromFile" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAssemblyIdentityManager::GetReferencedAssembliesFromFile" -helpviewer_keywords: +helpviewer_keywords: - "ICLRAssemblyIdentityManager::GetReferenceAssembliesFromFile method [.NET Framework hosting]" - "GetReferenceAssembliesFromFile method [.NET Framework hosting]" -ms.assetid: eed63d31-d977-4c7d-9443-f9d37a2a7d81 -topic_type: +topic_type: - "apiref" --- # ICLRAssemblyIdentityManager::GetReferencedAssembliesFromFile Method -Gets an [ICLRReferenceAssemblyEnum](iclrreferenceassemblyenum-interface.md) instance that contains a list of assemblies referenced by the assembly at the specified file path. - -## Syntax - -```cpp -HRESULT GetReferencedAssembliesFromFile ( - [in] LPCWSTR pwzFilePath, - [in] DWORD dwFlags, - [in] ICLRAssemblyReferenceList *pExcludeAssembliesList, - [out] ICLRReferenceAssemblyEnum **ppReferenceEnum -); -``` - -## Parameters - - `pwzFilePath` - [in] The path to the assembly to be evaluated. - - `dwFlags` - [in] Provided for future extensibility. CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT is the only value that the current version of the common language runtime (CLR) supports. - - `pExcludeAssembliesList` - [in] A pointer to an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) object that represents assemblies that should be excluded from `ppReferenceEnum`. - - `ppReferenceEnum` - [out] A pointer to the address of an `ICLRReferenceAssemblyEnum` object that contains assembly identity data for the assemblies referenced by the assembly at `pwzFilePath`, excluding the assemblies represented by `pExcludeAssembliesList`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method 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.| - -## Remarks - - The caller can choose to exclude a set of known assembly references from the returned list. This set is defined by the `pExcludeAssembliesList` parameter. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets an [ICLRReferenceAssemblyEnum](iclrreferenceassemblyenum-interface.md) instance that contains a list of assemblies referenced by the assembly at the specified file path. + +## Syntax + +```cpp +HRESULT GetReferencedAssembliesFromFile ( + [in] LPCWSTR pwzFilePath, + [in] DWORD dwFlags, + [in] ICLRAssemblyReferenceList *pExcludeAssembliesList, + [out] ICLRReferenceAssemblyEnum **ppReferenceEnum +); +``` + +## Parameters + + `pwzFilePath` + [in] The path to the assembly to be evaluated. + + `dwFlags` + [in] Provided for future extensibility. CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT is the only value that the current version of the common language runtime (CLR) supports. + + `pExcludeAssembliesList` + [in] A pointer to an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) object that represents assemblies that should be excluded from `ppReferenceEnum`. + + `ppReferenceEnum` + [out] A pointer to the address of an `ICLRReferenceAssemblyEnum` object that contains assembly identity data for the assemblies referenced by the assembly at `pwzFilePath`, excluding the assemblies represented by `pExcludeAssembliesList`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method 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.| + +## Remarks + + The caller can choose to exclude a set of known assembly references from the returned list. This set is defined by the `pExcludeAssembliesList` parameter. + +## 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 2.0 + ## See also - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md index 324310b14cdc2..90f95fcacb3cd 100644 --- a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md +++ b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md @@ -2,75 +2,74 @@ description: "Learn more about: ICLRAssemblyIdentityManager::GetReferencedAssembliesFromStream Method" title: "ICLRAssemblyIdentityManager::GetReferencedAssembliesFromStream Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAssemblyIdentityManager.GetReferencedAssembliesFromStream" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAssemblyIdentityManager::GetReferencedAssembliesFromStream" -helpviewer_keywords: +helpviewer_keywords: - "ICLRAssemblyIdentityManager::GetReferencedAssembliesFromStream method [.NET Framework hosting]" - "GetReferencedAssembliesFromStream method [.NET Framework hosting]" -ms.assetid: fe9849c1-c3fc-477b-a31f-e8619f5516f5 -topic_type: +topic_type: - "apiref" --- # ICLRAssemblyIdentityManager::GetReferencedAssembliesFromStream Method -Gets a pointer to an [ICLRReferenceAssemblyEnum](iclrreferenceassemblyenum-interface.md) object that contains assembly identity data for the assemblies referenced by the assembly in the specified stream. - -## Syntax - -```cpp -HRESULT GetReferencedAssembliesFromStream ( - [in] IStream *pStream, - [in] DWORD dwFlags, - [in] ICLRAssemblyReferenceList *pExcludeAssembliesList, - [out] ICLRReferenceAssemblyEnum **ppReferenceEnum -); -``` - -## Parameters - - `pStream` - [in] An interface pointer to an `IStream` containing the assembly to be evaluated. - - `dwFlags` - [in] Provided for future extensibility. CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT is the only value that the current version of the common language runtime (CLR) supports. - - `pExcludeAssembliesList` - [in] A pointer to an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) object that contains assembly identity data for the assemblies to be excluded from `ppReferenceEnum`. - - `ppReferenceEnum` - [out] A pointer to the address of an `ICLRReferenceAssemblyEnum` object that contains assembly identity data for the assemblies referenced by the assembly in `pStream`, excluding the assemblies in `pExcludeAssembliesList`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method 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.| - -## Remarks - - The caller can choose to exclude a set of known assembly references from the returned list. This set is defined by `pExcludeAssembliesList`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets a pointer to an [ICLRReferenceAssemblyEnum](iclrreferenceassemblyenum-interface.md) object that contains assembly identity data for the assemblies referenced by the assembly in the specified stream. + +## Syntax + +```cpp +HRESULT GetReferencedAssembliesFromStream ( + [in] IStream *pStream, + [in] DWORD dwFlags, + [in] ICLRAssemblyReferenceList *pExcludeAssembliesList, + [out] ICLRReferenceAssemblyEnum **ppReferenceEnum +); +``` + +## Parameters + + `pStream` + [in] An interface pointer to an `IStream` containing the assembly to be evaluated. + + `dwFlags` + [in] Provided for future extensibility. CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT is the only value that the current version of the common language runtime (CLR) supports. + + `pExcludeAssembliesList` + [in] A pointer to an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) object that contains assembly identity data for the assemblies to be excluded from `ppReferenceEnum`. + + `ppReferenceEnum` + [out] A pointer to the address of an `ICLRReferenceAssemblyEnum` object that contains assembly identity data for the assemblies referenced by the assembly in `pStream`, excluding the assemblies in `pExcludeAssembliesList`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method 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.| + +## Remarks + + The caller can choose to exclude a set of known assembly references from the returned list. This set is defined by `pExcludeAssembliesList`. + +## 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 2.0 + ## See also - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-interface.md b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-interface.md index 50500efbc2b9a..aac31b2b160dc 100644 --- a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-interface.md @@ -2,50 +2,49 @@ description: "Learn more about: ICLRAssemblyIdentityManager Interface" title: "ICLRAssemblyIdentityManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAssemblyIdentityManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAssemblyIdentityManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLRAssemblyIdentityManager interface [.NET Framework hosting]" -ms.assetid: 6a81c6fe-cc22-4062-ae27-d6eeee03a7b9 -topic_type: +topic_type: - "apiref" --- # ICLRAssemblyIdentityManager Interface -Provides methods that support communication between the host and the common language runtime (CLR) about assemblies. - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetBindingIdentityFromFile Method](iclrassemblyidentitymanager-getbindingidentityfromfile-method.md)|Gets the assembly identity binding data for the assembly at the specified file path.| -|[GetBindingIdentityFromStream Method](iclrassemblyidentitymanager-getbindingidentityfromstream-method.md)|Gets the canonical assembly identity data for the assembly in the specified stream.| -|[GetCLRAssemblyReferenceList Method](iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md)|Gets an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) instance from the supplied list of partial assembly identities.| -|[GetProbingAssembliesFromReference Method](iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md)|Gets an [ICLRProbingAssemblyEnum](iclrprobingassemblyenum-interface.md) enumerator for the assembly identities referenced by the assembly with the specified identity.| -|[GetReferencedAssembliesFromFile Method](iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md)|Gets an [ICLRReferenceAssemblyEnum](iclrreferenceassemblyenum-interface.md) instance that contains a list of assemblies referenced by the assembly at the specified file path.| -|[GetReferencedAssembliesFromStream Method](iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md)|Gets a pointer to an `ICLRReferenceAssemblyEnum` object that contains assembly identity data for the assemblies referenced by the assembly in the specified stream.| -|[IsStronglyNamed Method](iclrassemblyidentitymanager-isstronglynamed-method.md)|Gets a value that indicates whether the specified assembly is strongly named.| - -## Remarks - - Use `ICLRAssemblyIdentityManager` to get instances of `ICLRAssemblyReferenceList` and to enumerate assembly identities. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods that support communication between the host and the common language runtime (CLR) about assemblies. + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetBindingIdentityFromFile Method](iclrassemblyidentitymanager-getbindingidentityfromfile-method.md)|Gets the assembly identity binding data for the assembly at the specified file path.| +|[GetBindingIdentityFromStream Method](iclrassemblyidentitymanager-getbindingidentityfromstream-method.md)|Gets the canonical assembly identity data for the assembly in the specified stream.| +|[GetCLRAssemblyReferenceList Method](iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md)|Gets an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) instance from the supplied list of partial assembly identities.| +|[GetProbingAssembliesFromReference Method](iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md)|Gets an [ICLRProbingAssemblyEnum](iclrprobingassemblyenum-interface.md) enumerator for the assembly identities referenced by the assembly with the specified identity.| +|[GetReferencedAssembliesFromFile Method](iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md)|Gets an [ICLRReferenceAssemblyEnum](iclrreferenceassemblyenum-interface.md) instance that contains a list of assemblies referenced by the assembly at the specified file path.| +|[GetReferencedAssembliesFromStream Method](iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md)|Gets a pointer to an `ICLRReferenceAssemblyEnum` object that contains assembly identity data for the assemblies referenced by the assembly in the specified stream.| +|[IsStronglyNamed Method](iclrassemblyidentitymanager-isstronglynamed-method.md)|Gets a value that indicates whether the specified assembly is strongly named.| + +## Remarks + + Use `ICLRAssemblyIdentityManager` to get instances of `ICLRAssemblyReferenceList` and to enumerate assembly identities. + +## 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 2.0 + ## See also - [ICLRAssemblyReferenceList Interface](iclrassemblyreferencelist-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-isstronglynamed-method.md b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-isstronglynamed-method.md index 85bab7d62e875..8b02bfda5adad 100644 --- a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-isstronglynamed-method.md +++ b/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-isstronglynamed-method.md @@ -2,63 +2,62 @@ description: "Learn more about: ICLRAssemblyIdentityManager::IsStronglyNamed Method" title: "ICLRAssemblyIdentityManager::IsStronglyNamed Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAssemblyIdentityManager.IsStronglyNamed" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAssemblyIdentityManager::IsStronglyNamed" -helpviewer_keywords: +helpviewer_keywords: - "IsStronglyNamed method [.NET Framework hosting]" - "ICLRAssemblyIdentityManager::IsStronglyNamed method [.NET Framework hosting]" -ms.assetid: 954bd386-2076-4d00-9d46-38c728aa9cab -topic_type: +topic_type: - "apiref" --- # ICLRAssemblyIdentityManager::IsStronglyNamed Method -Gets a value that indicates whether the specified assembly is strongly named. - -## Syntax - -```cpp -RESULT IsStronglyNamed ( - [in] LPCWSTR pwzAssemblyIdentity, - [out] BOOL *pbIsStronglyNamed -); -``` - -## Parameters +Gets a value that indicates whether the specified assembly is strongly named. - `pwzAssemblyIdentity` - [in] The opaque canonical assembly identity data of the assembly to be evaluated. - - `pbIsStronglyNamed` - [out] `true`, if the assembly referenced by the `pwzAssemblyIdentity` parameter is strongly named; otherwise, `false`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| - -## Requirements +## Syntax + +```cpp +RESULT IsStronglyNamed ( + [in] LPCWSTR pwzAssemblyIdentity, + [out] BOOL *pbIsStronglyNamed +); +``` + +## Parameters + + `pwzAssemblyIdentity` + [in] The opaque canonical assembly identity data of the assembly to be evaluated. + + `pbIsStronglyNamed` + [out] `true`, if the assembly referenced by the `pwzAssemblyIdentity` parameter is strongly named; otherwise, `false`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| + +## 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 2.0 - **Platforms:** See [System Requirements](../../../framework/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 - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-interface.md b/docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-interface.md index 7be1e2dae3599..a4dd921025057 100644 --- a/docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-interface.md @@ -2,45 +2,44 @@ description: "Learn more about: ICLRAssemblyReferenceList Interface" title: "ICLRAssemblyReferenceList Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAssemblyReferenceList" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAssemblyReferenceList" -helpviewer_keywords: +helpviewer_keywords: - "ICLRAssemblyReferenceList interface [.NET Framework hosting]" -ms.assetid: 5f890fdf-d22a-429e-a35f-135273d1a636 -topic_type: +topic_type: - "apiref" --- # ICLRAssemblyReferenceList Interface -Manages a list of assemblies that are loaded by the common language runtime (CLR) and not by the host. - -## Methods - -|Method|Description| -|------------|-----------------| -|[IsAssemblyReferenceInList Method](iclrassemblyreferencelist-isassemblyreferenceinlist-method.md)|Gets a value that indicates whether the supplied pointer references an assembly in the list.| -|[IsStringAssemblyReferenceInList Method](iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md)|Gets a value that indicates whether the supplied name matches the name of an assembly in the list.| - -## Remarks - - Call the [ICLRAssemblyIdentityManager::GetCLRAssemblyReferenceList](iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md) method to get a pointer to an instance of `ICLRAssemblyReferenceList`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Manages a list of assemblies that are loaded by the common language runtime (CLR) and not by the host. + +## Methods + +|Method|Description| +|------------|-----------------| +|[IsAssemblyReferenceInList Method](iclrassemblyreferencelist-isassemblyreferenceinlist-method.md)|Gets a value that indicates whether the supplied pointer references an assembly in the list.| +|[IsStringAssemblyReferenceInList Method](iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md)|Gets a value that indicates whether the supplied name matches the name of an assembly in the list.| + +## Remarks + + Call the [ICLRAssemblyIdentityManager::GetCLRAssemblyReferenceList](iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md) method to get a pointer to an instance of `ICLRAssemblyReferenceList`. + +## 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 2.0 + ## See also - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-isassemblyreferenceinlist-method.md b/docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-isassemblyreferenceinlist-method.md index 8cb8bdd52f59d..a71ff44219b5d 100644 --- a/docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-isassemblyreferenceinlist-method.md +++ b/docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-isassemblyreferenceinlist-method.md @@ -2,56 +2,55 @@ description: "Learn more about: ICLRAssemblyReferenceList::IsAssemblyReferenceInList Method" title: "ICLRAssemblyReferenceList::IsAssemblyReferenceInList Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAssemblyReferenceList.IsAssemblyReferenceInList" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAssemblyReferenceList::IsAssemblyReferenceInList" -helpviewer_keywords: +helpviewer_keywords: - "ICLRAssemblyReferenceList::IsAssemblyReferenceInList method [.NET Framework hosting]" - "IsAssemblyReferenceInList method [.NET Framework hosting]" -ms.assetid: 8a570813-21be-407e-92a6-7ae8de3bc728 -topic_type: +topic_type: - "apiref" --- # ICLRAssemblyReferenceList::IsAssemblyReferenceInList Method -Gets a value that indicates whether the supplied pointer refers to an assembly in the list. - -## Syntax - -```cpp -HRESULT IsAssemblyReferenceInList ( - [in] IUnknown *pName -); -``` - -## Parameters - - `pName` - [in] An interface pointer to the assembly for which to search. Valid values are of type `IAssemblyName` or `IReferenceIdentity`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The string appears in the list.| -|S_FALSE|The string does not appear in the list.| -|E_FAIL|An unknown catastrophic failure occurred. After a method returns E_FAIL, the common language runtime is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets a value that indicates whether the supplied pointer refers to an assembly in the list. + +## Syntax + +```cpp +HRESULT IsAssemblyReferenceInList ( + [in] IUnknown *pName +); +``` + +## Parameters + + `pName` + [in] An interface pointer to the assembly for which to search. Valid values are of type `IAssemblyName` or `IReferenceIdentity`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The string appears in the list.| +|S_FALSE|The string does not appear in the list.| +|E_FAIL|An unknown catastrophic failure occurred. After a method returns E_FAIL, the common language runtime is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 2.0 + ## See also - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md b/docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md index fda35c7477652..a23fbe5f99740 100644 --- a/docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md +++ b/docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md @@ -2,56 +2,55 @@ description: "Learn more about: ICLRAssemblyReferenceList::IsStringAssemblyReferenceInList Method" title: "ICLRAssemblyReferenceList::IsStringAssemblyReferenceInList Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAssemblyReferenceList.IsStringAssemblyReferenceInList" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAssemblyReferenceList::IsStringAssemblyReferenceInList" -helpviewer_keywords: +helpviewer_keywords: - "ICLRAssemblyReferenceList::IsStringAssemblyReferenceInList method [.NET Framework hosting]" - "IsStringAssemblyReferenceInList method [.NET Framework hosting]" -ms.assetid: e6121cc3-2f11-42c7-bdae-47808581ff71 -topic_type: +topic_type: - "apiref" --- # ICLRAssemblyReferenceList::IsStringAssemblyReferenceInList Method -Gets a value that indicates whether the supplied name matches the name of an assembly in the list. - -## Syntax - -```cpp -HRESULT IsStringAssemblyReferenceInList ( - [in] LPCWSTR pwzAssemblyName -); -``` - -## Parameters - - `pwzAssemblyName` - [in] The name of the assembly for which to search. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The string appears in the list.| -|S_FALSE|The string does not appear in the list.| -|E_FAIL|An unknown catastrophic failure occurred. After a method returns E_FAIL, the common language runtime is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets a value that indicates whether the supplied name matches the name of an assembly in the list. + +## Syntax + +```cpp +HRESULT IsStringAssemblyReferenceInList ( + [in] LPCWSTR pwzAssemblyName +); +``` + +## Parameters + + `pwzAssemblyName` + [in] The name of the assembly for which to search. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The string appears in the list.| +|S_FALSE|The string does not appear in the list.| +|E_FAIL|An unknown catastrophic failure occurred. After a method returns E_FAIL, the common language runtime is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 2.0 + ## See also - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrcontrol-getclrmanager-method.md b/docs/core/unmanaged-api/hosting/iclrcontrol-getclrmanager-method.md index 3b8dcc9b6850d..55fff00d08d0c 100644 --- a/docs/core/unmanaged-api/hosting/iclrcontrol-getclrmanager-method.md +++ b/docs/core/unmanaged-api/hosting/iclrcontrol-getclrmanager-method.md @@ -2,78 +2,77 @@ description: "Learn more about: ICLRControl::GetCLRManager Method" title: "ICLRControl::GetCLRManager Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRControl.GetCLRManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRControl::GetCLRManager" -helpviewer_keywords: +helpviewer_keywords: - "GetCLRManager method [.NET Framework hosting]" - "ICLRControl::GetCLRManager method [.NET Framework hosting]" -ms.assetid: 8a11bfa4-cbb0-4082-82b5-f9fba66c93f5 -topic_type: +topic_type: - "apiref" --- # ICLRControl::GetCLRManager Method -Gets an interface pointer to an instance of any of the manager types the host can use to configure the common language runtime (CLR). - -## Syntax - -```cpp -HRESULT GetCLRManager ( - [in] REFIID riid, - [out] void **ppObject -); -``` - -## Parameters - - `riid` - [in] The `IID` of the manager type to return. The following `IID` values are supported. - -- IID_ICLRDebugManager: Specifies that `ppObject` will be of type [ICLRDebugManager](iclrdebugmanager-interface.md). - -- IID_ICLRErrorReportingManager: Specifies that `ppObject` will be of type [ICLRErrorReportingManager](iclrerrorreportingmanager-interface.md). - -- IID_ICLRGCManager: Specifies that `ppObject` will be of type [ICLRGCManager](iclrgcmanager-interface.md). - -- IID_ICLRHostProtectionManager: Specifies that `ppObject` will be of type [ICLRHostProtectionManager](iclrhostprotectionmanager-interface.md). - -- IID_ICLROnEventManager: Specifies that `ppObject` will be of type [ICLROnEventManager](iclroneventmanager-interface.md). - -- IID_ICLRPolicyManager: Specifies that `ppObject` will be of type [ICLRPolicyManager](iclrpolicymanager-interface.md). - -- IID_ICLRTaskManager: Specifies that `ppObject` will be of type [ICLRTaskManager](iclrtaskmanager-interface.md). - - `ppObject` - [out] An interface pointer to the requested manager, or null, if an invalid manager type was requested. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOINTERFACE|The interface type is not supported.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets an interface pointer to an instance of any of the manager types the host can use to configure the common language runtime (CLR). + +## Syntax + +```cpp +HRESULT GetCLRManager ( + [in] REFIID riid, + [out] void **ppObject +); +``` + +## Parameters + + `riid` + [in] The `IID` of the manager type to return. The following `IID` values are supported. + +- IID_ICLRDebugManager: Specifies that `ppObject` will be of type [ICLRDebugManager](iclrdebugmanager-interface.md). + +- IID_ICLRErrorReportingManager: Specifies that `ppObject` will be of type [ICLRErrorReportingManager](iclrerrorreportingmanager-interface.md). + +- IID_ICLRGCManager: Specifies that `ppObject` will be of type [ICLRGCManager](iclrgcmanager-interface.md). + +- IID_ICLRHostProtectionManager: Specifies that `ppObject` will be of type [ICLRHostProtectionManager](iclrhostprotectionmanager-interface.md). + +- IID_ICLROnEventManager: Specifies that `ppObject` will be of type [ICLROnEventManager](iclroneventmanager-interface.md). + +- IID_ICLRPolicyManager: Specifies that `ppObject` will be of type [ICLRPolicyManager](iclrpolicymanager-interface.md). + +- IID_ICLRTaskManager: Specifies that `ppObject` will be of type [ICLRTaskManager](iclrtaskmanager-interface.md). + + `ppObject` + [out] An interface pointer to the requested manager, or null, if an invalid manager type was requested. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOINTERFACE|The interface type is not supported.| + +## 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 2.0 + ## See also - [ICLRControl Interface](iclrcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrcontrol-interface.md b/docs/core/unmanaged-api/hosting/iclrcontrol-interface.md index a476d0d8ca4cc..6ec2ff8f91f9e 100644 --- a/docs/core/unmanaged-api/hosting/iclrcontrol-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrcontrol-interface.md @@ -2,41 +2,40 @@ description: "Learn more about: ICLRControl Interface" title: "ICLRControl Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRControl" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRControl" -helpviewer_keywords: +helpviewer_keywords: - "ICLRControl interface [.NET Framework hosting]" -ms.assetid: a24fd905-1fa6-45a0-ad65-e9e2ee58861e -topic_type: +topic_type: - "apiref" --- # ICLRControl Interface -Provides methods that allow a host to get references to, and configure aspects of, the common language runtime (CLR). - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetCLRManager Method](iclrcontrol-getclrmanager-method.md)|Gets an interface pointer to an instance of any of the manager types the host can use to configure the CLR.| -|[SetAppDomainManagerType Method](iclrcontrol-setappdomainmanagertype-method.md)|Sets a type derived from as the type for application domain managers.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods that allow a host to get references to, and configure aspects of, the common language runtime (CLR). + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetCLRManager Method](iclrcontrol-getclrmanager-method.md)|Gets an interface pointer to an instance of any of the manager types the host can use to configure the CLR.| +|[SetAppDomainManagerType Method](iclrcontrol-setappdomainmanagertype-method.md)|Sets a type derived from as the type for application domain managers.| + +## 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 2.0 + ## See also - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.md b/docs/core/unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.md index cddf38633bda8..a0829aa6a9c1a 100644 --- a/docs/core/unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.md +++ b/docs/core/unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.md @@ -2,63 +2,62 @@ description: "Learn more about: ICLRControl::SetAppDomainManagerType Method" title: "ICLRControl::SetAppDomainManagerType Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRControl.SetAppDomainManagerType" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRControl::SetAppDomainManagerType" -helpviewer_keywords: +helpviewer_keywords: - "SetAppDomainManagerType method, ICLRControl interface [.NET Framework hosting]" - "ICLRControl::SetAppDomainManagerType method [.NET Framework hosting]" -ms.assetid: ec57828b-2aad-496d-a35a-e45d4bd7fe77 -topic_type: +topic_type: - "apiref" --- # ICLRControl::SetAppDomainManagerType Method -Sets a type derived from as the type for application domain managers. - -## Syntax - -```cpp -HRESULT SetAppDomainManagerType ( - [in] LPCWSTR pwzAppDomainManagerAssembly, - [in] LPCWSTR pwzAppDomainManagerType -); -``` - -## Parameters +Sets a type derived from as the type for application domain managers. - `pwzAppDomainManagerAssembly` - [in] The name of the assembly in which the requested type derived from is implemented. - - `pwzAppDomainManagerType` - [in] The name of the type implemented in the `pwzAppDomainManagerAssembly` parameter that implements the capabilities of . - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Requirements +## Syntax + +```cpp +HRESULT SetAppDomainManagerType ( + [in] LPCWSTR pwzAppDomainManagerAssembly, + [in] LPCWSTR pwzAppDomainManagerType +); +``` + +## Parameters + + `pwzAppDomainManagerAssembly` + [in] The name of the assembly in which the requested type derived from is implemented. + + `pwzAppDomainManagerType` + [in] The name of the type implemented in the `pwzAppDomainManagerAssembly` parameter that implements the capabilities of . + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 2.0 - **Platforms:** See [System Requirements](../../../framework/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 - [ICLRControl Interface](iclrcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrdebugmanager-beginconnection-method.md b/docs/core/unmanaged-api/hosting/iclrdebugmanager-beginconnection-method.md index e967c23c080cd..3838987ba7f71 100644 --- a/docs/core/unmanaged-api/hosting/iclrdebugmanager-beginconnection-method.md +++ b/docs/core/unmanaged-api/hosting/iclrdebugmanager-beginconnection-method.md @@ -2,72 +2,71 @@ description: "Learn more about: ICLRDebugManager::BeginConnection Method" title: "ICLRDebugManager::BeginConnection Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRDebugManager.BeginConnection" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRDebugManager::BeginConnection" -helpviewer_keywords: +helpviewer_keywords: - "ICLRDebugManager::BeginConnection method [.NET Framework hosting]" - "BeginConnection method [.NET Framework hosting]" -ms.assetid: bdd98146-ff4d-4150-a264-a4c1a32d31f3 -topic_type: +topic_type: - "apiref" --- # ICLRDebugManager::BeginConnection Method -Establishes a new connection between the host and the debugger to associate a list of tasks with an identifier and a friendly name. - -## Syntax - -```cpp -HRESULT BeginConnection ( - [in] CONNID dwConnectionId, - [in, string] wchar_t* szConnectionName -); -``` - -## Parameters - - `dwConnectionId` - [in] An identifier to associate with the list of common language runtime (CLR) tasks. - - `szConnectionName` - [in] A friendly name to associate with the list of CLR tasks. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`BeginConnection` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_INVALIDARG|`dwConnectionId` was zero, or `BeginConnection` was already called using this `dwConnectionId` value, or `szConnectionName` was null.| -|E_OUTOFMEMORY|Not enough memory could be allocated to hold the list of tasks associated with this connection.| - -## Remarks - - [ICLRDebugManager](iclrdebugmanager-interface.md) provides three methods, `BeginConnection`, [SetConnectionTasks](iclrdebugmanager-setconnectiontasks-method.md), and [EndConnection](iclrdebugmanager-endconnection-method.md), for associating task lists with identifiers and friendly names. - +Establishes a new connection between the host and the debugger to associate a list of tasks with an identifier and a friendly name. + +## Syntax + +```cpp +HRESULT BeginConnection ( + [in] CONNID dwConnectionId, + [in, string] wchar_t* szConnectionName +); +``` + +## Parameters + + `dwConnectionId` + [in] An identifier to associate with the list of common language runtime (CLR) tasks. + + `szConnectionName` + [in] A friendly name to associate with the list of CLR tasks. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`BeginConnection` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_INVALIDARG|`dwConnectionId` was zero, or `BeginConnection` was already called using this `dwConnectionId` value, or `szConnectionName` was null.| +|E_OUTOFMEMORY|Not enough memory could be allocated to hold the list of tasks associated with this connection.| + +## Remarks + + [ICLRDebugManager](iclrdebugmanager-interface.md) provides three methods, `BeginConnection`, [SetConnectionTasks](iclrdebugmanager-setconnectiontasks-method.md), and [EndConnection](iclrdebugmanager-endconnection-method.md), for associating task lists with identifiers and friendly names. + > [!IMPORTANT] -> These three methods must be called in a specific order for each set of tasks. `BeginConnection` is called first to establish a new connection. `SetConnectionTasks` is called next to provide the set of tasks to be associated with that connection. `EndConnection` is called last to remove the association between the task list and the identifier and friendly name.However, calls for different connections can be nested. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> These three methods must be called in a specific order for each set of tasks. `BeginConnection` is called first to establish a new connection. `SetConnectionTasks` is called next to provide the set of tasks to be associated with that connection. `EndConnection` is called last to remove the association between the task list and the identifier and friendly name.However, calls for different connections can be nested. + +## 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 2.0 + ## See also - [ICLRControl Interface](iclrcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrdebugmanager-endconnection-method.md b/docs/core/unmanaged-api/hosting/iclrdebugmanager-endconnection-method.md index 3a2624d11653f..6c1e516e815bd 100644 --- a/docs/core/unmanaged-api/hosting/iclrdebugmanager-endconnection-method.md +++ b/docs/core/unmanaged-api/hosting/iclrdebugmanager-endconnection-method.md @@ -2,67 +2,66 @@ description: "Learn more about: ICLRDebugManager::EndConnection Method" title: "ICLRDebugManager::EndConnection Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRDebugManager.EndConnection" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRDebugManager::EndConnection" -helpviewer_keywords: +helpviewer_keywords: - "ICLRDebugManager::EndConnection method [.NET Framework hosting]" - "EndConnection method [.NET Framework hosting]" -ms.assetid: 89dc7363-2f29-4eb2-8f23-fccdda6a76a6 -topic_type: +topic_type: - "apiref" --- # ICLRDebugManager::EndConnection Method -Removes the association between a list of tasks and an identifier and a friendly name. - -## Syntax - -```cpp -HRESULT EndConnection ( - [in] CONNID dwConnectionId -); -``` - -## Parameters - - `dwConnectionId` - [in] The host-specific identifier for the connection and the associated list of common language runtime (CLR) tasks. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`EndConnection` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_INVALIDARG|[BeginConnection](iclrdebugmanager-beginconnection-method.md) was never called using `dwConnectionId`, or `dwConnectionId` was zero.| - -## Remarks - - [ICLRDebugManager](iclrdebugmanager-interface.md) provides three methods, `BeginConnection`, [SetConnectionTasks](iclrdebugmanager-setconnectiontasks-method.md), and `EndConnection`, for associating task lists with identifiers and friendly names. - +Removes the association between a list of tasks and an identifier and a friendly name. + +## Syntax + +```cpp +HRESULT EndConnection ( + [in] CONNID dwConnectionId +); +``` + +## Parameters + + `dwConnectionId` + [in] The host-specific identifier for the connection and the associated list of common language runtime (CLR) tasks. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`EndConnection` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_INVALIDARG|[BeginConnection](iclrdebugmanager-beginconnection-method.md) was never called using `dwConnectionId`, or `dwConnectionId` was zero.| + +## Remarks + + [ICLRDebugManager](iclrdebugmanager-interface.md) provides three methods, `BeginConnection`, [SetConnectionTasks](iclrdebugmanager-setconnectiontasks-method.md), and `EndConnection`, for associating task lists with identifiers and friendly names. + > [!IMPORTANT] -> These three methods must be called in a specific order for each set of tasks. `BeginConnection` is called first to establish a new connection. `SetConnectionTasks` is called next to provide the set of tasks to be associated with that connection. `EndConnection` is called last to remove the association between the task list and the identifier and friendly name.However, calls for different connections can be nested. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> These three methods must be called in a specific order for each set of tasks. `BeginConnection` is called first to establish a new connection. `SetConnectionTasks` is called next to provide the set of tasks to be associated with that connection. `EndConnection` is called last to remove the association between the task list and the identifier and friendly name.However, calls for different connections can be nested. + +## 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 2.0 + ## See also - [ICLRControl Interface](iclrcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrdebugmanager-getdacl-method.md b/docs/core/unmanaged-api/hosting/iclrdebugmanager-getdacl-method.md index ecca09f782982..7f931d9581df8 100644 --- a/docs/core/unmanaged-api/hosting/iclrdebugmanager-getdacl-method.md +++ b/docs/core/unmanaged-api/hosting/iclrdebugmanager-getdacl-method.md @@ -2,54 +2,53 @@ description: "Learn more about: ICLRDebugManager::GetDacl Method" title: "ICLRDebugManager::GetDacl Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRDebugManager.GetDacl" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRDebugManager::GetDacl" -helpviewer_keywords: +helpviewer_keywords: - "GetDacl method [.NET Framework hosting]" - "ICLRDebugManager::GetDacl method [.NET Framework hosting]" -ms.assetid: 7115e920-aaff-440a-824e-39497139c6f6 -topic_type: +topic_type: - "apiref" --- # ICLRDebugManager::GetDacl Method -This method is not implemented. - -## Syntax - -```cpp -HRESULT GetDacl ( - [out] PACL* ppacl -); -``` - -## Parameters - - `ppacl` - [out] An interface pointer to the Access Control List (ACL). - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|E_NOTIMPL|The method is not implemented.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method is not implemented. + +## Syntax + +```cpp +HRESULT GetDacl ( + [out] PACL* ppacl +); +``` + +## Parameters + + `ppacl` + [out] An interface pointer to the Access Control List (ACL). + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|E_NOTIMPL|The method is not implemented.| + +## 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 2.0 + ## See also - [ICLRControl Interface](iclrcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrdebugmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrdebugmanager-interface.md index 49ee8fa4a8f37..c3e4177a8b51d 100644 --- a/docs/core/unmanaged-api/hosting/iclrdebugmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrdebugmanager-interface.md @@ -2,55 +2,54 @@ description: "Learn more about: ICLRDebugManager Interface" title: "ICLRDebugManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRDebugManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRDebugManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLRDebugManager interface [.NET Framework hosting]" -ms.assetid: e835062c-c7d6-4945-8a44-2de7ebf3928e -topic_type: +topic_type: - "apiref" --- # ICLRDebugManager Interface -Provides methods that allow a host to associate a set of tasks with an identifier and a friendly name. - -## Methods - -|Method|Description| -|------------|-----------------| -|[BeginConnection Method](iclrdebugmanager-beginconnection-method.md)|Establishes a new connection between the host and the debugger to associate tasks with an identifier and a friendly name.| -|[EndConnection Method](iclrdebugmanager-endconnection-method.md)|Removes the association between a list of tasks and an identifier and a friendly name.| -|[GetDacl Method](iclrdebugmanager-getdacl-method.md)|This method is not implemented.| -|[IsDebuggerAttached Method](iclrdebugmanager-isdebuggerattached-method.md)|Gets a value that indicates whether a debugger is attached to the process.| -|[SetConnectionTasks Method](iclrdebugmanager-setconnectiontasks-method.md)|Associates a list of [ICLRTask](iclrtask-interface.md) instances with an identifier and a friendly name.| -|[SetDacl Method](iclrdebugmanager-setdacl-method.md)|This method is not implemented.| -|[SetSymbolReadingPolicy Method](iclrdebugmanager-setsymbolreadingpolicy-method.md)|Sets the policy for reading program database (PDB) files. The policy determines whether information about line numbers and files is included in call stacks.| - -## Remarks - - In debugging scenarios, a host might want to group tasks according to its own programming logic. For example, a grouping would allow a developer to see only the tasks required by the developer's APIs, instead of seeing every task running in the process. `ICLRDebugManager` allows the host to implement this kind of grouping. - +Provides methods that allow a host to associate a set of tasks with an identifier and a friendly name. + +## Methods + +|Method|Description| +|------------|-----------------| +|[BeginConnection Method](iclrdebugmanager-beginconnection-method.md)|Establishes a new connection between the host and the debugger to associate tasks with an identifier and a friendly name.| +|[EndConnection Method](iclrdebugmanager-endconnection-method.md)|Removes the association between a list of tasks and an identifier and a friendly name.| +|[GetDacl Method](iclrdebugmanager-getdacl-method.md)|This method is not implemented.| +|[IsDebuggerAttached Method](iclrdebugmanager-isdebuggerattached-method.md)|Gets a value that indicates whether a debugger is attached to the process.| +|[SetConnectionTasks Method](iclrdebugmanager-setconnectiontasks-method.md)|Associates a list of [ICLRTask](iclrtask-interface.md) instances with an identifier and a friendly name.| +|[SetDacl Method](iclrdebugmanager-setdacl-method.md)|This method is not implemented.| +|[SetSymbolReadingPolicy Method](iclrdebugmanager-setsymbolreadingpolicy-method.md)|Sets the policy for reading program database (PDB) files. The policy determines whether information about line numbers and files is included in call stacks.| + +## Remarks + + In debugging scenarios, a host might want to group tasks according to its own programming logic. For example, a grouping would allow a developer to see only the tasks required by the developer's APIs, instead of seeing every task running in the process. `ICLRDebugManager` allows the host to implement this kind of grouping. + > [!IMPORTANT] -> Three `ICLRDebugManager` methods, `BeginConnection`, `SetConnectionTasks` and `EndConnection`, are dependent upon each other. They must be called in the given order to work as expected. - - The grouping, and the identifiers and friendly names that the host assigns to the grouping, have no meaning for the common language runtime (CLR). The CLR merely passes the information along to the debugger. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> Three `ICLRDebugManager` methods, `BeginConnection`, `SetConnectionTasks` and `EndConnection`, are dependent upon each other. They must be called in the given order to work as expected. + + The grouping, and the identifiers and friendly names that the host assigns to the grouping, have no meaning for the common language runtime (CLR). The CLR merely passes the information along to the debugger. + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/iclrdebugmanager-isdebuggerattached-method.md b/docs/core/unmanaged-api/hosting/iclrdebugmanager-isdebuggerattached-method.md index 8b72d8e1fda70..6996de167c3af 100644 --- a/docs/core/unmanaged-api/hosting/iclrdebugmanager-isdebuggerattached-method.md +++ b/docs/core/unmanaged-api/hosting/iclrdebugmanager-isdebuggerattached-method.md @@ -2,63 +2,62 @@ description: "Learn more about: ICLRDebugManager::IsDebuggerAttached Method" title: "ICLRDebugManager::IsDebuggerAttached Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRDebugManager.IsDebuggerAttached" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRDebugManager::IsDebuggerAttached" -helpviewer_keywords: +helpviewer_keywords: - "IsDebuggerAttached method, ICLRDebugManager interface [.NET Framework hosting]" - "ICLRDebugManager::IsDebuggerAttached method [.NET Framework hosting]" -ms.assetid: 2f105fe0-f52d-49c5-bda5-583fb27e3aa6 -topic_type: +topic_type: - "apiref" --- # ICLRDebugManager::IsDebuggerAttached Method -Gets a value that indicates whether a debugger is attached to the process. - -## Syntax - -```cpp -HRESULT IsDebuggerAttached ( - [out] BOOL *pbAttached -); -``` - -## Parameters - - `pbAttached` - [out] `true` if a debugger is attached to the process; otherwise, `false`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`IsDebuggerAttached` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `IsDebuggerAttached` allows the host to query the CLR to determine whether a debugger is attached to the process. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets a value that indicates whether a debugger is attached to the process. + +## Syntax + +```cpp +HRESULT IsDebuggerAttached ( + [out] BOOL *pbAttached +); +``` + +## Parameters + + `pbAttached` + [out] `true` if a debugger is attached to the process; otherwise, `false`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`IsDebuggerAttached` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `IsDebuggerAttached` allows the host to query the CLR to determine whether a debugger is attached to the process. + +## 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 2.0 + ## See also - [ICLRControl Interface](iclrcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrdebugmanager-setconnectiontasks-method.md b/docs/core/unmanaged-api/hosting/iclrdebugmanager-setconnectiontasks-method.md index 8dd293c2a13c0..1e41a41a1a692 100644 --- a/docs/core/unmanaged-api/hosting/iclrdebugmanager-setconnectiontasks-method.md +++ b/docs/core/unmanaged-api/hosting/iclrdebugmanager-setconnectiontasks-method.md @@ -2,75 +2,74 @@ description: "Learn more about: ICLRDebugManager::SetConnectionTasks Method" title: "ICLRDebugManager::SetConnectionTasks Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRDebugManager.SetConnectionTasks" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRDebugManager::SetConnectionTasks" -helpviewer_keywords: +helpviewer_keywords: - "SetConnectionTasks method [.NET Framework hosting]" - "ICLRDebugManager::SetConnectionTasks method [.NET Framework hosting]" -ms.assetid: b38bbc9a-872c-41a9-b8c3-ca011d25456a -topic_type: +topic_type: - "apiref" --- # ICLRDebugManager::SetConnectionTasks Method -Associates a list of [ICLRTask](iclrtask-interface.md) instances with an identifier and a friendly name. - -## Syntax - -```cpp -HRESULT SetConnectionTasks ( - [in] CONNID id, - [in] DWORD dwCount, - [in, size_is(dwCount)] ICLRTask **ppCLRTask -); -``` - -## Parameters - - `id` - [in] The host-specific identifier for the connection with which to associate the `ppCLRTask` array. - - `dwCount` - [in] The number of members of `ppCLRTask`. This number must be greater than zero. - - `ppCLRTask` - [in] An array of `ICLRTask` pointers to associate with the connection identified by `id`. This array must contain at least one member. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetConnectionTasks` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_INVALIDARG|[BeginConnection](iclrdebugmanager-beginconnection-method.md) has not been called using this value of `id`, or `dwCount` or `id` is zero, or one of the elements of `ppCLRTask` is null.| - -## Remarks - - [ICLRDebugManager](iclrdebugmanager-interface.md) provides three methods, `BeginConnection`, `SetConnectionTasks`, and [EndConnection](iclrdebugmanager-endconnection-method.md), for associating task lists with identifiers and friendly names. - +Associates a list of [ICLRTask](iclrtask-interface.md) instances with an identifier and a friendly name. + +## Syntax + +```cpp +HRESULT SetConnectionTasks ( + [in] CONNID id, + [in] DWORD dwCount, + [in, size_is(dwCount)] ICLRTask **ppCLRTask +); +``` + +## Parameters + + `id` + [in] The host-specific identifier for the connection with which to associate the `ppCLRTask` array. + + `dwCount` + [in] The number of members of `ppCLRTask`. This number must be greater than zero. + + `ppCLRTask` + [in] An array of `ICLRTask` pointers to associate with the connection identified by `id`. This array must contain at least one member. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetConnectionTasks` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_INVALIDARG|[BeginConnection](iclrdebugmanager-beginconnection-method.md) has not been called using this value of `id`, or `dwCount` or `id` is zero, or one of the elements of `ppCLRTask` is null.| + +## Remarks + + [ICLRDebugManager](iclrdebugmanager-interface.md) provides three methods, `BeginConnection`, `SetConnectionTasks`, and [EndConnection](iclrdebugmanager-endconnection-method.md), for associating task lists with identifiers and friendly names. + > [!IMPORTANT] -> These three methods must be called in a specific order for each set of tasks. `BeginConnection` is called first to establish a new connection. `SetConnectionTasks` is called next to provide the set of tasks to be associated with that connection. `EndConnection` is called last to remove the association between the task list and the identifier and friendly name.However, calls for different connections can be nested. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> These three methods must be called in a specific order for each set of tasks. `BeginConnection` is called first to establish a new connection. `SetConnectionTasks` is called next to provide the set of tasks to be associated with that connection. `EndConnection` is called last to remove the association between the task list and the identifier and friendly name.However, calls for different connections can be nested. + +## 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 2.0 + ## See also - [ICLRControl Interface](iclrcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrdebugmanager-setdacl-method.md b/docs/core/unmanaged-api/hosting/iclrdebugmanager-setdacl-method.md index 5c77f39ebc26b..12aedacb1f57f 100644 --- a/docs/core/unmanaged-api/hosting/iclrdebugmanager-setdacl-method.md +++ b/docs/core/unmanaged-api/hosting/iclrdebugmanager-setdacl-method.md @@ -2,54 +2,53 @@ description: "Learn more about: ICLRDebugManager::SetDacl Method" title: "ICLRDebugManager::SetDacl Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRDebugManager.SetDacl" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRDebugManager::SetDacl" -helpviewer_keywords: +helpviewer_keywords: - "SetDacl method [.NET Framework hosting]" - "ICLRDebugManager::SetDacl method [.NET Framework hosting]" -ms.assetid: 52f4af3f-e02b-4c20-9fd9-e8e4f4d6fc31 -topic_type: +topic_type: - "apiref" --- # ICLRDebugManager::SetDacl Method -This method is not implemented. - -## Syntax - -```cpp -HRESULT SetDacl ( - [in] PACL pacl -); -``` - -## Parameters - - `pacl` - [in] A pointer to the Access Control List (ACL). - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|E_NOTIMPL|The method is not implemented.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method is not implemented. + +## Syntax + +```cpp +HRESULT SetDacl ( + [in] PACL pacl +); +``` + +## Parameters + + `pacl` + [in] A pointer to the Access Control List (ACL). + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|E_NOTIMPL|The method is not implemented.| + +## 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 2.0 + ## See also - [ICLRControl Interface](iclrcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrdebugmanager-setsymbolreadingpolicy-method.md b/docs/core/unmanaged-api/hosting/iclrdebugmanager-setsymbolreadingpolicy-method.md index 3d9f99b4d7441..f2601dda0f079 100644 --- a/docs/core/unmanaged-api/hosting/iclrdebugmanager-setsymbolreadingpolicy-method.md +++ b/docs/core/unmanaged-api/hosting/iclrdebugmanager-setsymbolreadingpolicy-method.md @@ -2,57 +2,56 @@ description: "Learn more about: ICLRDebugManager::SetSymbolReadingPolicy Method" title: "ICLRDebugManager::SetSymbolReadingPolicy Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRDebugManager.SetSymbolReadingPolicy" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRDebugManager::SetSymbolReadingPolicy" -helpviewer_keywords: +helpviewer_keywords: - "ICLRDebugManager, SetSymbolREadingPolicy method" - "SetSymbolReadingPolicy method [.NET Framework hosting]" - "ICLRDebugManager::SetSymbolReadingPolicy method [.NET Framework hosting]" -ms.assetid: bd921fa2-d377-4d79-acfc-64c38d4dcae9 -topic_type: +topic_type: - "apiref" --- # ICLRDebugManager::SetSymbolReadingPolicy Method -Sets the policy for reading program database (PDB) files. The policy determines whether information about line numbers and files is included in call stacks. - -## Syntax - -```cpp -HRESULT SetSymbolReadingPolicy ( - [in] ESymbolReadingPolicy policy -); -``` - -## Parameters - - `policy` - [in] A member of the [ESymbolReadingPolicy](esymbolreadingpolicy-enumeration.md) enumeration. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetSymbolReadingPolicy` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| -|E_FAIL|An unknown catastrophic failure occurred. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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 policy for reading program database (PDB) files. The policy determines whether information about line numbers and files is included in call stacks. + +## Syntax + +```cpp +HRESULT SetSymbolReadingPolicy ( + [in] ESymbolReadingPolicy policy +); +``` + +## Parameters + + `policy` + [in] A member of the [ESymbolReadingPolicy](esymbolreadingpolicy-enumeration.md) enumeration. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetSymbolReadingPolicy` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| +|E_FAIL|An unknown catastrophic failure occurred. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 2.0 + ## See also - [ICLRDebugManager Interface](iclrdebugmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrdomainmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrdomainmanager-interface.md index 0cf2059e698b8..d22b31c11b353 100644 --- a/docs/core/unmanaged-api/hosting/iclrdomainmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrdomainmanager-interface.md @@ -2,43 +2,42 @@ description: "Learn more about: ICLRDomainManager Interface" title: "ICLRDomainManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRDomainManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRDomainManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLRDomainManager interface [.NET Framework hosting]" -ms.assetid: f08b2390-d872-4521-a815-e9c237c4c45d --- # ICLRDomainManager Interface -Enables the host to specify the application domain manager that will be used to initialize the default application domain, and to specify initialization properties. - -## Methods - -|Method|Description| -|------------|-----------------| -|[SetAppDomainManagerType Method](iclrdomainmanager-setappdomainmanagertype-method.md)|Specifies the type, derived from the class, of the application domain manager that will be used to initialize the default application domain.| -|[SetPropertiesForDefaultAppDomain Method](iclrdomainmanager-setpropertiesfordefaultappdomain-method.md)|Sets properties that will be used to initialize the default application domain.| - -## Remarks - - To get an instance of this interface, call the [ICLRControl::GetCLRManager](iclrcontrol-getclrmanager-method.md) method with the manager type IID `IID_ICLRDomainManager`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Enables the host to specify the application domain manager that will be used to initialize the default application domain, and to specify initialization properties. + +## Methods + +|Method|Description| +|------------|-----------------| +|[SetAppDomainManagerType Method](iclrdomainmanager-setappdomainmanagertype-method.md)|Specifies the type, derived from the class, of the application domain manager that will be used to initialize the default application domain.| +|[SetPropertiesForDefaultAppDomain Method](iclrdomainmanager-setpropertiesfordefaultappdomain-method.md)|Sets properties that will be used to initialize the default application domain.| + +## Remarks + + To get an instance of this interface, call the [ICLRControl::GetCLRManager](iclrcontrol-getclrmanager-method.md) method with the manager type IID `IID_ICLRDomainManager`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/iclrdomainmanager-setappdomainmanagertype-method.md b/docs/core/unmanaged-api/hosting/iclrdomainmanager-setappdomainmanagertype-method.md index a94584d99fb45..640b8baa92d8e 100644 --- a/docs/core/unmanaged-api/hosting/iclrdomainmanager-setappdomainmanagertype-method.md +++ b/docs/core/unmanaged-api/hosting/iclrdomainmanager-setappdomainmanagertype-method.md @@ -2,72 +2,71 @@ description: "Learn more about: ICLRDomainManager::SetAppDomainManagerType Method" title: "ICLRDomainManager::SetAppDomainManagerType Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRDomainManager.SetAppDomainManagerType" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRDomainManager::SetAppDomainManagerType" -helpviewer_keywords: +helpviewer_keywords: - "SetAppDomainManagerType method, ICLRDomainManager interface [.NET Framework hosting]" - "ICLRDomainManager::SetAppDomainManagerType method [.NET Framework hosting]" -ms.assetid: ee91abb0-cb74-41dd-927b-e117fb8ffdf4 --- # ICLRDomainManager::SetAppDomainManagerType Method -Specifies the type, derived from the class, of the application domain manager that will be used to initialize the default application domain. - -## Syntax - -```cpp -HRESULT SetAppDomainManagerType( - [in] LPCWSTR wszAppDomainManagerAssembly, - [in] LPCWSTR wszAppDomainManagerType, - [in] EInitializeNewDomainFlags dwInitializeDomainFlags -); -``` - -## Parameters - - `wszAppDomainManagerAssembly` - [in] The display name of the assembly that contains the application domain manager type; for example: "AdMgrExample, Version=1.0.0.0, Culture=neutral, PublicKeyToken=6856bccf150f00b3". - - `wszAppDomainManagerType` - [in] The type name of the application domain manager, including the namespace. - - `dwInitializeDomainFlags` - [in] A combination of [EInitializeNewDomainFlags](einitializenewdomainflags-enumeration.md) enumeration values that provide information about the application domain manager. - -## 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.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| - -## Remarks - - Currently, the only defined value for `dwInitializeDomainFlags` is `eInitializeNewDomainFlags_NoSecurityChanges`, which tells the common language runtime (CLR) that the application domain manager will not modify security settings during the execution of the method. This allows the CLR to optimize the loading of assemblies that have the conditional (APTCA) attribute. This can result in a significant improvement in startup time if the transitive closure of this set of assemblies is large. - +Specifies the type, derived from the class, of the application domain manager that will be used to initialize the default application domain. + +## Syntax + +```cpp +HRESULT SetAppDomainManagerType( + [in] LPCWSTR wszAppDomainManagerAssembly, + [in] LPCWSTR wszAppDomainManagerType, + [in] EInitializeNewDomainFlags dwInitializeDomainFlags +); +``` + +## Parameters + + `wszAppDomainManagerAssembly` + [in] The display name of the assembly that contains the application domain manager type; for example: "AdMgrExample, Version=1.0.0.0, Culture=neutral, PublicKeyToken=6856bccf150f00b3". + + `wszAppDomainManagerType` + [in] The type name of the application domain manager, including the namespace. + + `dwInitializeDomainFlags` + [in] A combination of [EInitializeNewDomainFlags](einitializenewdomainflags-enumeration.md) enumeration values that provide information about the application domain manager. + +## 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.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| + +## Remarks + + Currently, the only defined value for `dwInitializeDomainFlags` is `eInitializeNewDomainFlags_NoSecurityChanges`, which tells the common language runtime (CLR) that the application domain manager will not modify security settings during the execution of the method. This allows the CLR to optimize the loading of assemblies that have the conditional (APTCA) attribute. This can result in a significant improvement in startup time if the transitive closure of this set of assemblies is large. + > [!IMPORTANT] -> If the host specifies `eInitializeNewDomainFlags_NoSecurityChanges` for the application domain manager, an is thrown if any attempt is made to modify the security of the application domain. - - Calling the [ICLRControl::SetAppDomainManagerType](iclrcontrol-setappdomainmanagertype-method.md)method is equivalent to calling `ICLRDomainManager::SetAppDomainManagerType` with `eInitializeNewDomainFlags_None`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> If the host specifies `eInitializeNewDomainFlags_NoSecurityChanges` for the application domain manager, an is thrown if any attempt is made to modify the security of the application domain. + + Calling the [ICLRControl::SetAppDomainManagerType](iclrcontrol-setappdomainmanagertype-method.md)method is equivalent to calling `ICLRDomainManager::SetAppDomainManagerType` with `eInitializeNewDomainFlags_None`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [Hosting](index.md) diff --git a/docs/core/unmanaged-api/hosting/iclrdomainmanager-setpropertiesfordefaultappdomain-method.md b/docs/core/unmanaged-api/hosting/iclrdomainmanager-setpropertiesfordefaultappdomain-method.md index d9be19b3635f1..dff9f11a49c3d 100644 --- a/docs/core/unmanaged-api/hosting/iclrdomainmanager-setpropertiesfordefaultappdomain-method.md +++ b/docs/core/unmanaged-api/hosting/iclrdomainmanager-setpropertiesfordefaultappdomain-method.md @@ -2,67 +2,66 @@ description: "Learn more about: ICLRDomainManager::SetPropertiesForDefaultAppDomain Method" title: "ICLRDomainManager::SetPropertiesForDefaultAppDomain Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRDomainManager.SetPropertiesForDefaultAppDomain" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRDomainManager::SetPropertiesForDefaultAppDomain" -helpviewer_keywords: +helpviewer_keywords: - "ICLRDomainManager::SetPropertiesForDefaultAppDomain method [.NET Framework hosting]" - "SetPropertiesForDefaultAppDomain method [.NET Framework hosting]" -ms.assetid: 43e61c4b-c435-45ec-9ef6-c68403aa4200 --- # ICLRDomainManager::SetPropertiesForDefaultAppDomain Method -Sets properties that will be used to initialize the default application domain. - -## Syntax - -```cpp -HRESULT SetPropertiesForDefaultAppDomain( - [in] DWORD nProperties, - [in] LPCWSTR *pwszPropertyNames, - [in] LPCWSTR *pwszPropertyValues -); -``` - -## Parameters - - `nProperties` - [in] The number of entries in `pwszPropertyNames` and `pwszPropertyValues`. - - `pwszPropertyNames` - [in] An array of property names, or null if there are no properties. Currently, the only property name that is recognized by this method is "PARTIAL_TRUST_VISIBLE_ASSEMBLIES". - - `pwszPropertyValues` - [in] An array of property values, or null if there are no properties. - -## 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.| -|HRESULT_FROM_WIN32(ERROR_UNKNOWN_PROPERTY)|`pwszPropertyNames` includes a property name that is not recognized by this method.| - -## Remarks - - The property value for "PARTIAL_TRUST_VISIBLE_ASSEMBLIES" is a list of assemblies that have the conditional (APTCA) attribute with the flag, which are to be made visible to partially trusted callers in the default application domain. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Sets properties that will be used to initialize the default application domain. + +## Syntax + +```cpp +HRESULT SetPropertiesForDefaultAppDomain( + [in] DWORD nProperties, + [in] LPCWSTR *pwszPropertyNames, + [in] LPCWSTR *pwszPropertyValues +); +``` + +## Parameters + + `nProperties` + [in] The number of entries in `pwszPropertyNames` and `pwszPropertyValues`. + + `pwszPropertyNames` + [in] An array of property names, or null if there are no properties. Currently, the only property name that is recognized by this method is "PARTIAL_TRUST_VISIBLE_ASSEMBLIES". + + `pwszPropertyValues` + [in] An array of property values, or null if there are no properties. + +## 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.| +|HRESULT_FROM_WIN32(ERROR_UNKNOWN_PROPERTY)|`pwszPropertyNames` includes a property name that is not recognized by this method.| + +## Remarks + + The property value for "PARTIAL_TRUST_VISIBLE_ASSEMBLIES" is a list of assemblies that have the conditional (APTCA) attribute with the flag, which are to be made visible to partially trusted callers in the default application domain. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [Hosting](index.md) diff --git a/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-begincustomdump-method.md b/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-begincustomdump-method.md index c5b9b993207f4..352d16d1b3cd1 100644 --- a/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-begincustomdump-method.md +++ b/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-begincustomdump-method.md @@ -2,78 +2,77 @@ description: "Learn more about: ICLRErrorReportingManager::BeginCustomDump Method" title: "ICLRErrorReportingManager::BeginCustomDump Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRErrorReportingManager.BeginCustomDump" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRErrorReportingManager::BeginCustomDump" -helpviewer_keywords: +helpviewer_keywords: - "ICLRErrorReportingManager::BeginCustomDump method [.NET Framework hosting]" - "BeginCustomDump method" -ms.assetid: 93424a87-ba13-4fa1-b4dc-69d44437b7ae -topic_type: +topic_type: - "apiref" --- # ICLRErrorReportingManager::BeginCustomDump Method -Specifies the configuration of custom heap dumps for error reporting. - -## Syntax - -```cpp -HRESULT BeginCustomDump ( - [in] ECustomDumpFlavor dwFlavor, - [in] DWORD dwNumItems, - [in, size_is(dwNumItems), length_is(dwNumItems)] CustomDumpItem items[], - DWORD dwReserved -); -``` - -## Parameters - - `dwFlavor` - [in] A [ECustomDumpFlavor](ecustomdumpflavor-enumeration.md) value that indicates the kind of heap dump upon which to build the custom heap dump. - - `dwNumItems` - [in] The length of the `items` array. If `dwFlavor` is not DUMP_FLAVOR_Mini, `dwNumItems` should be zero. - - `items` - [in] An array of [CustomDumpItem](customdumpitem-structure.md) instances, specifying the items to add to the mini-dump. If `dwFlavor` is not DUMP_FLAVOR_Mini, `items` should be null. - - `dwReserved` - [in] Reserved for future use. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The `BeginCustomDump` method sets custom heap dump configuration. The [EndCustomDump](iclrerrorreportingmanager-endcustomdump-method.md) method clears the custom heap dump configuration and frees any associated state. It should be called after the custom heap dump is complete. - +Specifies the configuration of custom heap dumps for error reporting. + +## Syntax + +```cpp +HRESULT BeginCustomDump ( + [in] ECustomDumpFlavor dwFlavor, + [in] DWORD dwNumItems, + [in, size_is(dwNumItems), length_is(dwNumItems)] CustomDumpItem items[], + DWORD dwReserved +); +``` + +## Parameters + + `dwFlavor` + [in] A [ECustomDumpFlavor](ecustomdumpflavor-enumeration.md) value that indicates the kind of heap dump upon which to build the custom heap dump. + + `dwNumItems` + [in] The length of the `items` array. If `dwFlavor` is not DUMP_FLAVOR_Mini, `dwNumItems` should be zero. + + `items` + [in] An array of [CustomDumpItem](customdumpitem-structure.md) instances, specifying the items to add to the mini-dump. If `dwFlavor` is not DUMP_FLAVOR_Mini, `items` should be null. + + `dwReserved` + [in] Reserved for future use. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The `BeginCustomDump` method sets custom heap dump configuration. The [EndCustomDump](iclrerrorreportingmanager-endcustomdump-method.md) method clears the custom heap dump configuration and frees any associated state. It should be called after the custom heap dump is complete. + > [!IMPORTANT] -> Failure to call `EndCustomDump` causes memory to leak. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> Failure to call `EndCustomDump` causes memory to leak. + +## 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 2.0 + ## See also - [CustomDumpItem Structure](customdumpitem-structure.md) diff --git a/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-endcustomdump-method.md b/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-endcustomdump-method.md index ada4956a51f35..4d2f489cddce9 100644 --- a/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-endcustomdump-method.md +++ b/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-endcustomdump-method.md @@ -2,59 +2,58 @@ description: "Learn more about: ICLRErrorReportingManager::EndCustomDump Method" title: "ICLRErrorReportingManager::EndCustomDump Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRErrorReportingManager.EndCustomDump" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRErrorReportingManager::EndCustomDump" -helpviewer_keywords: +helpviewer_keywords: - "ICLRErrorReportingManager::EndCustomDump method [.NET Framework hosting]" - "EndCustomDump method [.NET Framework hosting]" -ms.assetid: 88a5da04-8729-4108-82c4-af206a7d483e -topic_type: +topic_type: - "apiref" --- # ICLRErrorReportingManager::EndCustomDump Method -Removes the custom stack dump configuration that was specified in an earlier call to the [ICLRErrorReportingManager::BeginCustomDump](iclrerrorreportingmanager-begincustomdump-method.md) method. - -## Syntax - -```cpp -HRESULT EndCustomDump (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`EndCustomDump` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The `EndCustomDump` method clears the custom stack dump configuration set by an earlier call to the `BeginCustomDump` method and frees any associated state. It should be called after the custom stack dump is complete. - +Removes the custom stack dump configuration that was specified in an earlier call to the [ICLRErrorReportingManager::BeginCustomDump](iclrerrorreportingmanager-begincustomdump-method.md) method. + +## Syntax + +```cpp +HRESULT EndCustomDump (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`EndCustomDump` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The `EndCustomDump` method clears the custom stack dump configuration set by an earlier call to the `BeginCustomDump` method and frees any associated state. It should be called after the custom stack dump is complete. + > [!IMPORTANT] -> Failure to call `EndCustomDump` causes memory to leak. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> Failure to call `EndCustomDump` causes memory to leak. + +## 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 2.0 + ## See also - [CustomDumpItem Structure](customdumpitem-structure.md) diff --git a/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md b/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md index f505a292332d6..a348c9a74a56d 100644 --- a/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md +++ b/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md @@ -2,50 +2,49 @@ description: "Learn more about: ICLRErrorReportingManager::GetBucketParametersForCurrentException Method" title: "ICLRErrorReportingManager::GetBucketParametersForCurrentException Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRErrorReportingManager.GetBucketParametersForCurrentException" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRErrorReportingManager::GetBucketParametersForCurrentException" -helpviewer_keywords: +helpviewer_keywords: - "ICLRErrorReportingManager::GetBucketParametersForCurrentException method [.NET Framework hosting]" - "GetBucketParametersForCurrentException method [.NET Framework hosting]" -ms.assetid: a13ec8a6-8e18-4acb-8054-77f5b1a0e0b9 -topic_type: +topic_type: - "apiref" --- # ICLRErrorReportingManager::GetBucketParametersForCurrentException Method -Gets the Watson bucket for the current exception on the calling thread. - - A *bucket* is a collection of error data that is related to the same code defect. *Watson* refers to a set of technologies for collecting and analyzing data that is associated with an exception. - -## Syntax - -```cpp -HRESULT GetBucketParametersForCurrentException( - [out] BucketParameters *pParams -); -``` - -## Parameters - - `pParams` - [out] A pointer to a [BucketParameters](bucketparameters-structure.md) structure that contains error data for the exception. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the Watson bucket for the current exception on the calling thread. + + A *bucket* is a collection of error data that is related to the same code defect. *Watson* refers to a set of technologies for collecting and analyzing data that is associated with an exception. + +## Syntax + +```cpp +HRESULT GetBucketParametersForCurrentException( + [out] BucketParameters *pParams +); +``` + +## Parameters + + `pParams` + [out] A pointer to a [BucketParameters](bucketparameters-structure.md) structure that contains error data for the exception. + +## 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 2.0 + ## See also - [ICLRErrorReportingManager Interface](iclrerrorreportingmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-interface.md index e1aa4589dbd33..f96dd84cbc666 100644 --- a/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-interface.md @@ -2,49 +2,48 @@ description: "Learn more about: ICLRErrorReportingManager Interface" title: "ICLRErrorReportingManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRErrorReportingManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRErrorReportingManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLRErrorReportingManager interface [.NET Framework hosting]" -ms.assetid: ea8af0d5-4133-4472-8a1f-50570d7e85fa -topic_type: +topic_type: - "apiref" --- # ICLRErrorReportingManager Interface -Provides methods that allow the host to configure custom stack dumps for error reporting. - -## Methods - -|Method|Description| -|------------|-----------------| -|[BeginCustomDump Method](iclrerrorreportingmanager-begincustomdump-method.md)|Specifies the configuration of custom stack dumps for error reporting.| -|[EndCustomDump Method](iclrerrorreportingmanager-endcustomdump-method.md)|Clears the custom stack dump configuration that was set by an earlier call to `BeginCustomDump`.| -|[GetBucketParametersForCurrentException Method](iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md)|Gets the Watson bucket for the current exception on the calling thread.| - -## Remarks - - The `BeginCustomDump` method sets custom stack dump configuration. The `EndCustomDump` method clears the custom stack dump configuration and frees any associated state. It should be called after the custom dump is complete. - +Provides methods that allow the host to configure custom stack dumps for error reporting. + +## Methods + +|Method|Description| +|------------|-----------------| +|[BeginCustomDump Method](iclrerrorreportingmanager-begincustomdump-method.md)|Specifies the configuration of custom stack dumps for error reporting.| +|[EndCustomDump Method](iclrerrorreportingmanager-endcustomdump-method.md)|Clears the custom stack dump configuration that was set by an earlier call to `BeginCustomDump`.| +|[GetBucketParametersForCurrentException Method](iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md)|Gets the Watson bucket for the current exception on the calling thread.| + +## Remarks + + The `BeginCustomDump` method sets custom stack dump configuration. The `EndCustomDump` method clears the custom stack dump configuration and frees any associated state. It should be called after the custom dump is complete. + > [!IMPORTANT] -> Failure to call `EndCustomDump` causes memory to leak. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> Failure to call `EndCustomDump` causes memory to leak. + +## 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 2.0 + ## See also - [ECustomDumpItemKind Enumeration](ecustomdumpitemkind-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager-collect-method.md b/docs/core/unmanaged-api/hosting/iclrgcmanager-collect-method.md index e46442e77b225..8facdacbdb98d 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager-collect-method.md +++ b/docs/core/unmanaged-api/hosting/iclrgcmanager-collect-method.md @@ -2,63 +2,62 @@ description: "Learn more about: ICLRGCManager::Collect Method" title: "ICLRGCManager::Collect Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRGCManager.Collect" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRGCManager::Collect" -helpviewer_keywords: +helpviewer_keywords: - "ICLRGCManager::Collect method [.NET Framework hosting]" - "Collect method, ICLRGCManager interface [.NET Framework hosting]" -ms.assetid: 0c6cbbea-c27c-4695-bda3-17c1910d8ddb -topic_type: +topic_type: - "apiref" --- # ICLRGCManager::Collect Method -Forces a garbage collection for the specified generation. - -## Syntax - -```cpp -HRESULT Collect ( - [in] LONG Generation -); -``` - -## Parameters - - `Generation` - [in] The generation to collect. A value of -1 forces a collection of all generations. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Collect` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The `Collect` method forces the CLR's garbage collector to perform a collection regardless of its current state. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Forces a garbage collection for the specified generation. + +## Syntax + +```cpp +HRESULT Collect ( + [in] LONG Generation +); +``` + +## Parameters + + `Generation` + [in] The generation to collect. A value of -1 forces a collection of all generations. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Collect` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The `Collect` method forces the CLR's garbage collector to perform a collection regardless of its current state. + +## 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 2.0 + ## See also - [Automatic Memory Management](../../../standard/automatic-memory-management.md) diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager-getstats-method.md b/docs/core/unmanaged-api/hosting/iclrgcmanager-getstats-method.md index 26dc063075c84..0f2516ef35bb1 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager-getstats-method.md +++ b/docs/core/unmanaged-api/hosting/iclrgcmanager-getstats-method.md @@ -2,73 +2,72 @@ description: "Learn more about: ICLRGCManager::GetStats Method" title: "ICLRGCManager::GetStats Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRGCManager.GetStats" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRGCManager::GetStats" -helpviewer_keywords: +helpviewer_keywords: - "GetStats method, ICLRGCManager interface [.NET Framework hosting]" - "ICLRGCManager::GetStats method [.NET Framework hosting]" -ms.assetid: ce259d1d-cd81-4490-a7a1-0d0ea0804872 -topic_type: +topic_type: - "apiref" --- # ICLRGCManager::GetStats Method -Gets a set of current statistics about the common language runtime's garbage collection system. - -## Syntax - -```cpp -HRESULT GetStats ( - [in, out] COR_GC_STATS *pStats -); -``` - -## Parameters - - `pStats` - [in, out] A [COR_GC_STATS](cor-gc-stats-structure.md) instance that contains the requested statistics. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetStats` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR calculates and returns only those statistics that are specified by the `Flags` field of `pStats`. - - Set the `Flags` field to one or more values of the [COR_GC_STAT_TYPES](cor-gc-stat-types-enumeration.md) enumeration to specify which statistics in the [COR_GC_STATS](cor-gc-stats-structure.md) structure are to be set. - - An example of the usage is as follows: - -```cpp -COR_GC_STATS GCStats; -GCStats.Flags = COR_GC_COUNTS | COR_GC_MEMORYUSAGE; -pCLRGCManager->GetStats(&GCStats); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets a set of current statistics about the common language runtime's garbage collection system. + +## Syntax + +```cpp +HRESULT GetStats ( + [in, out] COR_GC_STATS *pStats +); +``` + +## Parameters + + `pStats` + [in, out] A [COR_GC_STATS](cor-gc-stats-structure.md) instance that contains the requested statistics. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetStats` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR calculates and returns only those statistics that are specified by the `Flags` field of `pStats`. + + Set the `Flags` field to one or more values of the [COR_GC_STAT_TYPES](cor-gc-stat-types-enumeration.md) enumeration to specify which statistics in the [COR_GC_STATS](cor-gc-stats-structure.md) structure are to be set. + + An example of the usage is as follows: + +```cpp +COR_GC_STATS GCStats; +GCStats.Flags = COR_GC_COUNTS | COR_GC_MEMORYUSAGE; +pCLRGCManager->GetStats(&GCStats); +``` + +## 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 2.0 + ## See also - [Automatic Memory Management](../../../standard/automatic-memory-management.md) diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md index 5ec8c13a602bc..c7151d4ffcc01 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md @@ -2,49 +2,48 @@ description: "Learn more about: ICLRGCManager Interface" title: "ICLRGCManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRGCManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRGCManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLRGCManager interface [.NET Framework hosting]" -ms.assetid: fb511c9b-3fe4-41b0-822a-6ba4a079d1f5 -topic_type: +topic_type: - "apiref" --- # ICLRGCManager Interface -Provides methods that allow a host to interact with the common language runtime's garbage collection system. - +Provides methods that allow a host to interact with the common language runtime's garbage collection system. + > [!NOTE] -> Starting with .NET Framework 4.5, you can use the [ICLRGCManager2::SetGCStartupLimitsEx](iclrgcmanager2-setgcstartuplimitsex-method.md) method to set the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0 to values greater than the `DWORD` limit that is imposed by the [SetGCStartupLimits](iclrgcmanager-setgcstartuplimits-method.md) method. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Collect Method](iclrgcmanager-collect-method.md)|Forces a garbage collection for the specified generation.| -|[GetStats Method](iclrgcmanager-getstats-method.md)|Gets a set of current statistics about the garbage collection system.| -|[SetGCStartupLimits Method](iclrgcmanager-setgcstartuplimits-method.md)|Sets the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0.| - -## Remarks - - The common language runtime (CLR) implements its garbage collection mechanism with the managed type. For more information about the garbage collection system, see [Garbage Collection](../../../standard/garbage-collection/index.md). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> Starting with .NET Framework 4.5, you can use the [ICLRGCManager2::SetGCStartupLimitsEx](iclrgcmanager2-setgcstartuplimitsex-method.md) method to set the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0 to values greater than the `DWORD` limit that is imposed by the [SetGCStartupLimits](iclrgcmanager-setgcstartuplimits-method.md) method. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Collect Method](iclrgcmanager-collect-method.md)|Forces a garbage collection for the specified generation.| +|[GetStats Method](iclrgcmanager-getstats-method.md)|Gets a set of current statistics about the garbage collection system.| +|[SetGCStartupLimits Method](iclrgcmanager-setgcstartuplimits-method.md)|Sets the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0.| + +## Remarks + + The common language runtime (CLR) implements its garbage collection mechanism with the managed type. For more information about the garbage collection system, see [Garbage Collection](../../../standard/garbage-collection/index.md). + +## 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 2.0 + ## See also - [Automatic Memory Management](../../../standard/automatic-memory-management.md) diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md b/docs/core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md index 2082a60cf1c55..b2401db9f0b29 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md +++ b/docs/core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md @@ -2,74 +2,73 @@ description: "Learn more about: ICLRGCManager::SetGCStartupLimits Method" title: "ICLRGCManager::SetGCStartupLimits Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRGCManager.SetGCStartupLimits" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRGCManager::SetGCStartupLimits" -helpviewer_keywords: +helpviewer_keywords: - "SetGCStartupLimits method, ICLRGCManager interface [.NET Framework hosting]" - "ICLRGCManager::SetGCStartupLimits method [.NET Framework hosting]" -ms.assetid: 1c8d9959-95b5-4131-be4a-556d97774014 -topic_type: +topic_type: - "apiref" --- # ICLRGCManager::SetGCStartupLimits Method -Sets the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0. - +Sets the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0. + > [!IMPORTANT] -> Starting with .NET Framework 4.5, you can set segment size and maximum generation 0 size to values greater than `DWORD` by using the [ICLRGCManager2::SetGCStartupLimitsEx](iclrgcmanager2-setgcstartuplimitsex-method.md) method. - -## Syntax - -```cpp -HRESULT SetGCStartupLimits ( +> Starting with .NET Framework 4.5, you can set segment size and maximum generation 0 size to values greater than `DWORD` by using the [ICLRGCManager2::SetGCStartupLimitsEx](iclrgcmanager2-setgcstartuplimitsex-method.md) method. + +## Syntax + +```cpp +HRESULT SetGCStartupLimits ( [in] DWORD SegmentSize, - [in] DWORD MaxGen0Size -); -``` - -## Parameters - - `SegmentSize` - [in] The specified size of a garbage collection segment. - - The minimum segment size is 4 MB. Segments can be increased in increments of 1 MB or larger. - - `MaxGen0Size` - [in] The specified maximum size for generation 0. - - The minimum generation 0 size is 64 KB. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetGCStartupLimits` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The values that `SetGCStartupLimits` sets can be specified only once. Later calls to `SetGCStartupLimits` are ignored. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - + [in] DWORD MaxGen0Size +); +``` + +## Parameters + + `SegmentSize` + [in] The specified size of a garbage collection segment. + + The minimum segment size is 4 MB. Segments can be increased in increments of 1 MB or larger. + + `MaxGen0Size` + [in] The specified maximum size for generation 0. + + The minimum generation 0 size is 64 KB. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetGCStartupLimits` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The values that `SetGCStartupLimits` sets can be specified only once. Later calls to `SetGCStartupLimits` are ignored. + +## 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 2.0 + ## See also - [Automatic Memory Management](../../../standard/automatic-memory-management.md) diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md b/docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md index ca0091740804b..fa49a97d4da2a 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md @@ -2,46 +2,45 @@ description: "Learn more about: ICLRGCManager2 Interface" title: "ICLRGCManager2 Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRGCManager2" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRGCManager2" -helpviewer_keywords: +helpviewer_keywords: - "ICLRGCManager2 interface [.NET Framework hosting]" -ms.assetid: 4b5ffd7b-9ad7-41cd-9bba-34030ae3da7e -topic_type: +topic_type: - "apiref" --- # ICLRGCManager2 Interface -Provides methods that allow a host to interact with the common language runtime's garbage collection system. - -## Methods - -|Method|Description| -|------------|-----------------| -|[SetGCStartupLimitsEx Method](iclrgcmanager2-setgcstartuplimitsex-method.md)|Sets the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0. Enables generation 0 and segment sizes larger than `DWORD`.| - -## Remarks - - This interface inherits from the [ICLRGCManager Interface](iclrgcmanager-interface.md). - - The common language runtime (CLR) implements its garbage collection mechanism with the managed type. For more information about the garbage collection system, see [Garbage Collection](../../../standard/garbage-collection/index.md). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] - +Provides methods that allow a host to interact with the common language runtime's garbage collection system. + +## Methods + +|Method|Description| +|------------|-----------------| +|[SetGCStartupLimitsEx Method](iclrgcmanager2-setgcstartuplimitsex-method.md)|Sets the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0. Enables generation 0 and segment sizes larger than `DWORD`.| + +## Remarks + + This interface inherits from the [ICLRGCManager Interface](iclrgcmanager-interface.md). + + The common language runtime (CLR) implements its garbage collection mechanism with the managed type. For more information about the garbage collection system, see [Garbage Collection](../../../standard/garbage-collection/index.md). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] + ## See also - [Automatic Memory Management](../../../standard/automatic-memory-management.md) diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md b/docs/core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md index 7f6f938a38be9..1f7ae466ef03f 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md +++ b/docs/core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md @@ -2,73 +2,72 @@ description: "Learn more about: ICLRGCManager2::SetGCStartupLimitsEx Method" title: "ICLRGCManager2::SetGCStartupLimitsEx Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRGCManager2.SetGCStartupLimitsEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRGCManager2::SetCLRGCStartupLimitsEx" -helpviewer_keywords: +helpviewer_keywords: - "ICLRGCManager2::SetGCStartupLimitsEx method [.NET Framework hosting]" - "SetGCStartupLimitsEx method, ICLRGCManager2 interface [.NET Framework hosting]" -ms.assetid: 6c3a08a9-5d65-48d4-8bbf-2a86ed7d356a -topic_type: +topic_type: - "apiref" --- # ICLRGCManager2::SetGCStartupLimitsEx Method -Sets the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0. - -## Syntax - -```cpp -HRESULT SetGCStartupLimitsEx ( +Sets the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0. + +## Syntax + +```cpp +HRESULT SetGCStartupLimitsEx ( [in] SIZE_T SegmentSize, - [in] SIZE_T MaxGen0Size -); -``` - -## Parameters - - `SegmentSize` - [in] The specified size of a garbage collection segment. - - The minimum segment size is 4 MB. Segments can be increased in increments of 1 MB or larger. - - `MaxGen0Size` - [in] The specified maximum size for generation 0. - - The minimum generation 0 size is 64 KB. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetGCStartupLimitsEx` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The values that `SetGCStartupLimitsEx` sets can be specified only before the host is started. Later calls to `SetGCStartupLimitsEx` are ignored. - - To set either parameter without affecting the other, specify 0 (zero) for the parameter you don't want to change. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] - + [in] SIZE_T MaxGen0Size +); +``` + +## Parameters + + `SegmentSize` + [in] The specified size of a garbage collection segment. + + The minimum segment size is 4 MB. Segments can be increased in increments of 1 MB or larger. + + `MaxGen0Size` + [in] The specified maximum size for generation 0. + + The minimum generation 0 size is 64 KB. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetGCStartupLimitsEx` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The values that `SetGCStartupLimitsEx` sets can be specified only before the host is started. Later calls to `SetGCStartupLimitsEx` are ignored. + + To set either parameter without affecting the other, specify 0 (zero) for the parameter you don't want to change. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] + ## See also - [Automatic Memory Management](../../../standard/automatic-memory-management.md) diff --git a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md index 528b3d77f55e1..a79b533f62a69 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md +++ b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md @@ -2,85 +2,84 @@ description: "Learn more about: ICLRHostBindingPolicyManager::EvaluatePolicy Method" title: "ICLRHostBindingPolicyManager::EvaluatePolicy Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRHostBindingPolicyManager.EvaluatePolicy" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRHostBindingPolicyManager::EvaluatePolicy" -helpviewer_keywords: +helpviewer_keywords: - "ICLRHostBindingPolicyManager::EvaluatePolicy method [.NET Framework hosting]" - "EvaluatePolicy method [.NET Framework hosting]" -ms.assetid: 3a3a9446-7a4e-4836-9b27-5c536c15993d -topic_type: +topic_type: - "apiref" --- # ICLRHostBindingPolicyManager::EvaluatePolicy Method -Evaluates binding policy on behalf of the host. - -## Syntax - -```cpp -HRESULT EvaluatePolicy ( - [in] LPCWSTR pwzReferenceIdentity, - [in] BYTE *pbApplicationPolicy, - [in] DWORD cbAppPolicySize, - [out, size_is(*pcchPostPolicyReferenceIdentity)] LPWSTR pwzPostPolicyReferenceIdentity, - [in, out] DWORD *pcchPostPolicyReferenceIdentity, - [out] DWORD *pdwPoliciesApplied -); -``` - -## Parameters - - `pwzReferenceIdentity` - [in] A reference to the assembly before the policy evaluation. - - `pbApplicationPolicy` - [in] A pointer to a buffer that contains the policy data. - - `cbAppPolicySize` - [in] The size of the `pbApplicationPolicy` buffer. - - `pwzPostPolicyReferenceIdentity` - [out] A reference to the assembly after the evaluation of the new policy data. - - `pcchPostPolicyReferenceIdentity` - [in, out] A pointer to the size of the assembly identity reference buffer after the evaluation of the new policy data. - - `pdwPoliciesApplied` - [out] A pointer to a logical OR combination of [EBindPolicyLevels](ebindpolicylevels-enumeration.md) values, indicating which policies have been applied. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The evaluation completed successfully.| -|E_INVALIDARG|Either `pwzReferenceIdentity` or `pbApplicationPolicy` is a null reference.| -|ERROR_INSUFFICIENT_BUFFER|`cbAppPolicySize` is too small.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The `EvaluatePolicy` method allows the host to influence binding policy to maintain host-specific assembly versioning requirements. The policy engine itself remains inside the CLR. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Evaluates binding policy on behalf of the host. + +## Syntax + +```cpp +HRESULT EvaluatePolicy ( + [in] LPCWSTR pwzReferenceIdentity, + [in] BYTE *pbApplicationPolicy, + [in] DWORD cbAppPolicySize, + [out, size_is(*pcchPostPolicyReferenceIdentity)] LPWSTR pwzPostPolicyReferenceIdentity, + [in, out] DWORD *pcchPostPolicyReferenceIdentity, + [out] DWORD *pdwPoliciesApplied +); +``` + +## Parameters + + `pwzReferenceIdentity` + [in] A reference to the assembly before the policy evaluation. + + `pbApplicationPolicy` + [in] A pointer to a buffer that contains the policy data. + + `cbAppPolicySize` + [in] The size of the `pbApplicationPolicy` buffer. + + `pwzPostPolicyReferenceIdentity` + [out] A reference to the assembly after the evaluation of the new policy data. + + `pcchPostPolicyReferenceIdentity` + [in, out] A pointer to the size of the assembly identity reference buffer after the evaluation of the new policy data. + + `pdwPoliciesApplied` + [out] A pointer to a logical OR combination of [EBindPolicyLevels](ebindpolicylevels-enumeration.md) values, indicating which policies have been applied. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The evaluation completed successfully.| +|E_INVALIDARG|Either `pwzReferenceIdentity` or `pbApplicationPolicy` is a null reference.| +|ERROR_INSUFFICIENT_BUFFER|`cbAppPolicySize` is too small.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The `EvaluatePolicy` method allows the host to influence binding policy to maintain host-specific assembly versioning requirements. The policy engine itself remains inside the CLR. + +## 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 2.0 + ## See also - [ICLRHostBindingPolicyManager Interface](iclrhostbindingpolicymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md index 1884a784cdc51..62bb9b61f041b 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md @@ -2,41 +2,40 @@ description: "Learn more about: ICLRHostBindingPolicyManager Interface" title: "ICLRHostBindingPolicyManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRHostBindingPolicyManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRHostBindingPolicyManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLRHostBindingPolicyManager interface [.NET Framework hosting]" -ms.assetid: f9da168b-366b-4b2b-bdb9-330b6bad5a6b -topic_type: +topic_type: - "apiref" --- # ICLRHostBindingPolicyManager Interface -Provides methods for the host to evaluate current binding policy and communicate policy changes for a specified assembly. - -## Methods - -|Method|Description| -|------------|-----------------| -|[EvaluatePolicy Method](iclrhostbindingpolicymanager-evaluatepolicy-method.md)|Evaluates binding policy on behalf of the host.| -|[ModifyApplicationPolicy Method](iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md)|Modifies the binding policy for the specified assembly, and creates a new version of the policy.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods for the host to evaluate current binding policy and communicate policy changes for a specified assembly. + +## Methods + +|Method|Description| +|------------|-----------------| +|[EvaluatePolicy Method](iclrhostbindingpolicymanager-evaluatepolicy-method.md)|Evaluates binding policy on behalf of the host.| +|[ModifyApplicationPolicy Method](iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md)|Modifies the binding policy for the specified assembly, and creates a new version of the policy.| + +## 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 2.0 + ## See also - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md index edcf45c4c75ba..79cc34935afcf 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md +++ b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md @@ -2,89 +2,88 @@ description: "Learn more about: ICLRHostBindingPolicyManager::ModifyApplicationPolicy Method" title: "ICLRHostBindingPolicyManager::ModifyApplicationPolicy Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRHostBindingPolicyManager.ModifyApplicationPolicy" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRHostBindingPolicyManager::ModifyApplicationPolicy" -helpviewer_keywords: +helpviewer_keywords: - "ICLRHostBindingPolicyManager::ModifyApplicationPolicy method [.NET Framework hosting]" - "ModifyApplicationPolicy method [.NET Framework hosting]" -ms.assetid: d82d633e-cce6-427c-8b02-8227e34e12ba -topic_type: +topic_type: - "apiref" --- # ICLRHostBindingPolicyManager::ModifyApplicationPolicy Method -Modifies the binding policy for the specified assembly, and creates a new version of the policy. - -## Syntax - -```cpp -HRESULT ModifyApplicationPolicy ( +Modifies the binding policy for the specified assembly, and creates a new version of the policy. + +## Syntax + +```cpp +HRESULT ModifyApplicationPolicy ( [in] LPCWSTR pwzSourceAssemblyIdentity, - [in] LPCWSTR pwzTargetAssemblyIdentity, - [in] BYTE *pbApplicationPolicy, - [in] DWORD cbAppPolicySize, - [in] DWORD dwPolicyModifyFlags, + [in] LPCWSTR pwzTargetAssemblyIdentity, + [in] BYTE *pbApplicationPolicy, + [in] DWORD cbAppPolicySize, + [in] DWORD dwPolicyModifyFlags, [out, size_is(*pcbNewAppPolicySize)] BYTE *pbNewApplicationPolicy, - [in, out] DWORD *pcbNewAppPolicySize -); -``` - -## Parameters - - `pwzSourceAssemblyIdentity` - [in] The identity of the assembly to modify. - - `pwzTargetAssemblyIdentity` - [in] The new identity of the modified assembly. - - `pbApplicationPolicy` - [in] A pointer to a buffer that contains the binding policy data for the assembly to modify. - - `cbAppPolicySize` - [in] The size of the binding policy to be replaced. - - `dwPolicyModifyFlags` - [in] A logical OR combination of [EHostBindingPolicyModifyFlags](ehostbindingpolicymodifyflags-enumeration.md) values, indicating control of redirection. - - `pbNewApplicationPolicy` - [out] A pointer to a buffer that contains the new binding policy data. - - `pcbNewAppPolicySize` - [in, out] A pointer to the size of the new binding policy buffer. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The policy was modified successfully.| -|E_INVALIDARG|`pwzSourceAssemblyIdentity` or `pwzTargetAssemblyIdentity` was a null reference.| -|ERROR_INSUFFICIENT_BUFFER|`pbNewApplicationPolicy` is too small.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The `ModifyApplicationPolicy` method can be called twice. The first call should supply a null value for the `pbNewApplicationPolicy` parameter. This call will return with the necessary value for `pcbNewAppPolicySize`. The second call should supply this value for `pcbNewAppPolicySize`, and point to a buffer of that size for `pbNewApplicationPolicy`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - + [in, out] DWORD *pcbNewAppPolicySize +); +``` + +## Parameters + + `pwzSourceAssemblyIdentity` + [in] The identity of the assembly to modify. + + `pwzTargetAssemblyIdentity` + [in] The new identity of the modified assembly. + + `pbApplicationPolicy` + [in] A pointer to a buffer that contains the binding policy data for the assembly to modify. + + `cbAppPolicySize` + [in] The size of the binding policy to be replaced. + + `dwPolicyModifyFlags` + [in] A logical OR combination of [EHostBindingPolicyModifyFlags](ehostbindingpolicymodifyflags-enumeration.md) values, indicating control of redirection. + + `pbNewApplicationPolicy` + [out] A pointer to a buffer that contains the new binding policy data. + + `pcbNewAppPolicySize` + [in, out] A pointer to the size of the new binding policy buffer. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The policy was modified successfully.| +|E_INVALIDARG|`pwzSourceAssemblyIdentity` or `pwzTargetAssemblyIdentity` was a null reference.| +|ERROR_INSUFFICIENT_BUFFER|`pbNewApplicationPolicy` is too small.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The `ModifyApplicationPolicy` method can be called twice. The first call should supply a null value for the `pbNewApplicationPolicy` parameter. This call will return with the necessary value for `pcbNewAppPolicySize`. The second call should supply this value for `pcbNewAppPolicySize`, and point to a buffer of that size for `pbNewApplicationPolicy`. + +## 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 2.0 + ## See also - [ICLRHostBindingPolicyManager Interface](iclrhostbindingpolicymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md index 2461be6d6ce45..258eb87f637cb 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md @@ -2,41 +2,40 @@ description: "Learn more about: ICLRHostProtectionManager Interface" title: "ICLRHostProtectionManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRHostProtectionManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRHostProtectionManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLRHostProtectionManager interface [.NET Framework hosting]" -ms.assetid: ce2770ae-23d0-45d9-8bcf-46504ac5020e -topic_type: +topic_type: - "apiref" --- # ICLRHostProtectionManager Interface -Enables the host to block specific managed classes, methods, properties, and fields from running in partially trusted code. - -## Methods - -|Method|Description| -|------------|-----------------| -|[SetEagerSerializeGrantSets](iclrhostprotectionmanager-seteagerserializegrantsets-method.md)|Provides a guarantee that certain rare race conditions that can cause fatal common language runtime (CLR) errors will never arise.| -|[SetProtectedCategories Method](iclrhostprotectionmanager-setprotectedcategories-method.md)|Specifies the categories of managed types and members that should be blocked from running in partially trusted code.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Enables the host to block specific managed classes, methods, properties, and fields from running in partially trusted code. + +## Methods + +|Method|Description| +|------------|-----------------| +|[SetEagerSerializeGrantSets](iclrhostprotectionmanager-seteagerserializegrantsets-method.md)|Provides a guarantee that certain rare race conditions that can cause fatal common language runtime (CLR) errors will never arise.| +|[SetProtectedCategories Method](iclrhostprotectionmanager-setprotectedcategories-method.md)|Specifies the categories of managed types and members that should be blocked from running in partially trusted code.| + +## 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 2.0 + ## See also - [EApiCategories Enumeration](eapicategories-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md index dab749ac96d2b..45e77b2f31fbe 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md +++ b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md @@ -2,52 +2,51 @@ description: "Learn more about: ICLRHostProtectionManager::SetEagerSerializeGrantSets Method" title: "ICLRHostProtectionManager::SetEagerSerializeGrantSets Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRHostProtectionManager.SetEagerSerializeGrantSets" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRHostProtectionManager::SetEagerSerializeGrantSets" -helpviewer_keywords: +helpviewer_keywords: - "SetEagerSerializeGrantSets method [.NET Framework hosting]" - "ICLRHostProtectionManager::SetEagerSerializeGrantSets method [.NET Framework hosting]" -ms.assetid: d6158360-22b1-4ace-ad85-d830b9964783 -topic_type: +topic_type: - "apiref" --- # ICLRHostProtectionManager::SetEagerSerializeGrantSets Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT SetEagerSerializeGrantSets (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetEagerSerializeGrantSets` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT SetEagerSerializeGrantSets (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetEagerSerializeGrantSets` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 2.0 + ## See also - [ICLRControl Interface](iclrcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md index fbb07bf93a7f9..96ff997fae5f3 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md +++ b/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md @@ -2,63 +2,62 @@ description: "Learn more about: ICLRHostProtectionManager::SetProtectedCategories Method" title: "ICLRHostProtectionManager::SetProtectedCategories Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRHostProtectionManager.SetProtectedCategories" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRHostProtectionManager::SetProtectedCategories" -helpviewer_keywords: +helpviewer_keywords: - "SetProtectedCategories method [.NET Framework hosting]" - "ICLRHostProtectionManager::SetProtectedCategories method [.NET Framework hosting]" -ms.assetid: fa21dc7b-5da7-440b-b59e-9180e5181f9d -topic_type: +topic_type: - "apiref" --- # ICLRHostProtectionManager::SetProtectedCategories Method -Specifies which categories of managed types and members should be blocked from running in partially trusted code. - -## Syntax - -```cpp -HRESULT SetProtectedCategories ( - [in] EApiCategories categories -); -``` - -## Parameters - - `categories` - [in] A combination of [EApiCategories](eapicategories-enumeration.md) values, indicating which categories of managed types and members should be blocked from running in partially trusted code. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetProtectedCategories` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - Each `EApiCategories` value refers to a list of managed types and members. The `EApiCategories` enumeration and the `SetProtectedCategories` method are directly related to the managed class, which is used to mark managed types and members that expose capabilities corresponding to the categories described by `EApiCategories`. For more information, see and the enumeration, which directly corresponds to `EApiCategories`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Specifies which categories of managed types and members should be blocked from running in partially trusted code. + +## Syntax + +```cpp +HRESULT SetProtectedCategories ( + [in] EApiCategories categories +); +``` + +## Parameters + + `categories` + [in] A combination of [EApiCategories](eapicategories-enumeration.md) values, indicating which categories of managed types and members should be blocked from running in partially trusted code. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetProtectedCategories` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + Each `EApiCategories` value refers to a list of managed types and members. The `EApiCategories` enumeration and the `SetProtectedCategories` method are directly related to the managed class, which is used to mark managed types and members that expose capabilities corresponding to the categories described by `EApiCategories`. For more information, see and the enumeration, which directly corresponds to `EApiCategories`. + +## 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 2.0 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/iclriocompletionmanager-interface.md b/docs/core/unmanaged-api/hosting/iclriocompletionmanager-interface.md index 86756ff949825..7d9526d47fe52 100644 --- a/docs/core/unmanaged-api/hosting/iclriocompletionmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclriocompletionmanager-interface.md @@ -2,44 +2,43 @@ description: "Learn more about: ICLRIoCompletionManager Interface" title: "ICLRIoCompletionManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRIoCompletionManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRIoCompletionManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLRIoCompletionManager interface [.NET Framework hosting]" -ms.assetid: c6c3ace6-e5e7-4450-8cc5-a9a48208c493 -topic_type: +topic_type: - "apiref" --- # ICLRIoCompletionManager Interface -Implements a callback method that allows the host to notify the common language runtime (CLR) of the status of specified I/O requests. - -## Methods - -|Method|Description| -|------------|-----------------| -|[OnComplete Method](iclriocompletionmanager-oncomplete-method.md)|Notifies the CLR of the status of an I/O request that was made by using a call to the [IHostIoCompletionManager::Bind](ihostiocompletionmanager-bind-method.md) method.| - -## Remarks - - The host implements the I/O completion abstraction by using the [IHostIoCompletionManager](ihostiocompletionmanager-interface.md) interface. The CLR makes I/O requests through this interface, and the host notifies the runtime of the outcome of such requests by using the `ICLRIoCompletionManager` interface. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Implements a callback method that allows the host to notify the common language runtime (CLR) of the status of specified I/O requests. + +## Methods + +|Method|Description| +|------------|-----------------| +|[OnComplete Method](iclriocompletionmanager-oncomplete-method.md)|Notifies the CLR of the status of an I/O request that was made by using a call to the [IHostIoCompletionManager::Bind](ihostiocompletionmanager-bind-method.md) method.| + +## Remarks + + The host implements the I/O completion abstraction by using the [IHostIoCompletionManager](ihostiocompletionmanager-interface.md) interface. The CLR makes I/O requests through this interface, and the host notifies the runtime of the outcome of such requests by using the `ICLRIoCompletionManager` interface. + +## 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 2.0 + ## See also - [IHostIoCompletionManager Interface](ihostiocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md b/docs/core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md index d5a7e09652bd4..9c201e72c15d3 100644 --- a/docs/core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md +++ b/docs/core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md @@ -2,77 +2,76 @@ description: "Learn more about: ICLRIoCompletionManager::OnComplete Method" title: "ICLRIoCompletionManager::OnComplete Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRIoCompletionManager.OnComplete" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRIoCompletionManager::OnComplete" -helpviewer_keywords: +helpviewer_keywords: - "OnComplete method [.NET Framework hosting]" - "ICLRIoCompletionManager::OnComplete method [.NET Framework hosting]" -ms.assetid: 003f6974-9727-4322-bed5-e330d1224d0b -topic_type: +topic_type: - "apiref" --- # ICLRIoCompletionManager::OnComplete Method -Notifies the common language runtime (CLR) of the status of an I/O request that was made by using a call to the [IHostIoCompletionManager::Bind](ihostiocompletionmanager-bind-method.md) method. - -## Syntax - -```cpp -HRESULT OnComplete ( - [in] DWORD dwErrorCode, - [in] DWORD NumberOfBytesTransferred, - [in] void* pvOverlapped -); -``` - -## Parameters - - `dwErrorCode` - [in] An HRESULT value that indicates the status of the bind operation. - -- S_OK indicates that the operation completed successfully. - -- HOST_E_INTERRUPTED indicates that the call terminated before completion. - -- E_FAIL indicates that an unknown, unrecoverable, catastrophic failure occurred. - - `NumberOfBytesTransferred` - [in] The number of bytes transferred during the processing of the I/O request. - - `pvOverlapped` - [in] A pointer to the `OVERLAPPED` structure that was passed to the call to the `IHostIoCompletionManager::Bind` method. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`OnComplete` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - If the host implements an I/O completion abstraction, the CLR makes I/O requests through the host by using methods of [IHostIoCompletionManager](ihostiocompletionmanager-interface.md). The host then calls the `OnComplete` method to notify the runtime of the outcome of such requests. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Notifies the common language runtime (CLR) of the status of an I/O request that was made by using a call to the [IHostIoCompletionManager::Bind](ihostiocompletionmanager-bind-method.md) method. + +## Syntax + +```cpp +HRESULT OnComplete ( + [in] DWORD dwErrorCode, + [in] DWORD NumberOfBytesTransferred, + [in] void* pvOverlapped +); +``` + +## Parameters + + `dwErrorCode` + [in] An HRESULT value that indicates the status of the bind operation. + +- S_OK indicates that the operation completed successfully. + +- HOST_E_INTERRUPTED indicates that the call terminated before completion. + +- E_FAIL indicates that an unknown, unrecoverable, catastrophic failure occurred. + + `NumberOfBytesTransferred` + [in] The number of bytes transferred during the processing of the I/O request. + + `pvOverlapped` + [in] A pointer to the `OVERLAPPED` structure that was passed to the call to the `IHostIoCompletionManager::Bind` method. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`OnComplete` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + If the host implements an I/O completion abstraction, the CLR makes I/O requests through the host by using methods of [IHostIoCompletionManager](ihostiocompletionmanager-interface.md). The host then calls the `OnComplete` method to notify the runtime of the outcome of such requests. + +## 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 2.0 + ## See also - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md b/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md index fc266f7eee08d..0479eda5aa45b 100644 --- a/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md @@ -2,44 +2,43 @@ description: "Learn more about: ICLRMemoryNotificationCallback Interface" title: "ICLRMemoryNotificationCallback Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRMemoryNotificationCallback" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRMemoryNotificationCallback" -helpviewer_keywords: +helpviewer_keywords: - "ICLRMemoryNotificationCallback interface [.NET Framework hosting]" -ms.assetid: 873639e2-4837-4568-83b3-4493e67e4174 -topic_type: +topic_type: - "apiref" --- # ICLRMemoryNotificationCallback Interface -Allows the host to report memory pressure conditions using an approach similar to that of the Win32 `CreateMemoryResourceNotification` function. - -## Methods - -|Method|Description| -|------------|-----------------| -|[OnMemoryNotification Method](iclrmemorynotificationcallback-onmemorynotification-method.md)|Notifies the common language runtime (CLR) of the memory load on the computer.| - -## Remarks - - The host uses the `ICLRMemoryNotificationCallback` interface to request that the CLR free memory resources. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Allows the host to report memory pressure conditions using an approach similar to that of the Win32 `CreateMemoryResourceNotification` function. + +## Methods + +|Method|Description| +|------------|-----------------| +|[OnMemoryNotification Method](iclrmemorynotificationcallback-onmemorynotification-method.md)|Notifies the common language runtime (CLR) of the memory load on the computer.| + +## Remarks + + The host uses the `ICLRMemoryNotificationCallback` interface to request that the CLR free memory resources. + +## 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 2.0 + ## See also - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md b/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md index a0f9dc258b9d2..a50c2cfd3ea8d 100644 --- a/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md @@ -2,66 +2,65 @@ description: "Learn more about: ICLRMemoryNotificationCallback::OnMemoryNotification Method" title: "ICLRMemoryNotificationCallback::OnMemoryNotification Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRMemoryNotificationCallback.OnMemoryNotification" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRMemoryNotificationCallback::OnMemoryNotification" -helpviewer_keywords: +helpviewer_keywords: - "ICLRMemoryNotificationCallback::OnMemoryNotification method [.NET Framework hosting]" - "OnMemoryNotification method [.NET Framework hosting]" -ms.assetid: 5612a44d-56cc-4f34-af31-8c9809ba9431 -topic_type: +topic_type: - "apiref" --- # ICLRMemoryNotificationCallback::OnMemoryNotification Method -Notifies the common language runtime (CLR) of the memory load on the computer. - -## Syntax - -```cpp -HRESULT OnMemoryNotification ( - [in] EMemoryAvailable eMemoryAvailable -); -``` - -## Parameters - - `eMemoryAvailable` - [in] One of the [EMemoryAvailable](ememoryavailable-enumeration.md) values, indicating the memory pressure the computer is currently experiencing. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`OnMemoryNotification` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR registers a callback to `OnMemoryNotification` by using a call to the [IHostMemoryManager::RegisterMemoryNotificationCallback](ihostmemorymanager-registermemorynotificationcallback-method.md) method. The runtime uses the information returned in the callback to free additional memory when the host reports that memory resources are running low. - +Notifies the common language runtime (CLR) of the memory load on the computer. + +## Syntax + +```cpp +HRESULT OnMemoryNotification ( + [in] EMemoryAvailable eMemoryAvailable +); +``` + +## Parameters + + `eMemoryAvailable` + [in] One of the [EMemoryAvailable](ememoryavailable-enumeration.md) values, indicating the memory pressure the computer is currently experiencing. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`OnMemoryNotification` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR registers a callback to `OnMemoryNotification` by using a call to the [IHostMemoryManager::RegisterMemoryNotificationCallback](ihostmemorymanager-registermemorynotificationcallback-method.md) method. The runtime uses the information returned in the callback to free additional memory when the host reports that memory resources are running low. + > [!NOTE] -> Calls to `OnMemoryNotification` never block. They always return immediately. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> Calls to `OnMemoryNotification` never block. They always return immediately. + +## 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 2.0 + ## See also - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md index 5aa5706fe4520..a7717ad3f2fd8 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md @@ -2,56 +2,55 @@ description: "Learn more about: ICLRMetaHost::EnumerateInstalledRuntimes Method" title: "ICLRMetaHost::EnumerateInstalledRuntimes Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRMetaHost.EnumerateInstalledRuntimes" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRMetaHost::EnumerateInstalledRuntimes" -helpviewer_keywords: +helpviewer_keywords: - "ICLRMetaHost::EnumerateInstalledRuntimes method [.NET Framework hosting]" - "EnumerateInstalledRuntimes method [.NET Framework hosting]" -ms.assetid: 9e359384-0d3d-451c-807e-5d7fcebf2be7 -topic_type: +topic_type: - "apiref" --- # ICLRMetaHost::EnumerateInstalledRuntimes Method -Returns an enumeration that contains a valid [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface for each version of the common language runtime (CLR) that is installed on a computer. - -## Syntax - -```cpp -HRESULT EnumerateInstalledRuntimes ( - [out, retval] IEnumUnknown **ppEnumerator); -``` - -## Parameters - - `ppEnumerator` - [out] An enumeration of [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interfaces corresponding to each version of the CLR that is installed on the computer. - -## 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|`ppEnumerator` is null.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Returns an enumeration that contains a valid [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface for each version of the common language runtime (CLR) that is installed on a computer. + +## Syntax + +```cpp +HRESULT EnumerateInstalledRuntimes ( + [out, retval] IEnumUnknown **ppEnumerator); +``` + +## Parameters + + `ppEnumerator` + [out] An enumeration of [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interfaces corresponding to each version of the CLR that is installed on the computer. + +## 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|`ppEnumerator` is null.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRMetaHost Interface](iclrmetahost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md index 64475f5d22510..f9b25765de6b0 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md @@ -2,65 +2,64 @@ description: "Learn more about: ICLRMetaHost::EnumerateLoadedRuntimes Method" title: "ICLRMetaHost::EnumerateLoadedRuntimes Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRMetaHost.EnumerateLoadedRuntimes" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRMetaHost::EnumerateLoadedRuntimes" -helpviewer_keywords: +helpviewer_keywords: - "EnumerateLoadedRuntimes method [.NET Framework hosting]" - "ICLRMetaHost::EnumerateLoadedRuntimes method [.NET Framework hosting]" -ms.assetid: 22fc0a3f-dce4-4766-9a3c-9fab15f4b4ca -topic_type: +topic_type: - "apiref" --- # ICLRMetaHost::EnumerateLoadedRuntimes Method -Returns an enumeration that includes a valid [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface pointer for each version of the common language runtime (CLR) that is loaded in a given process. This method supersedes the [GetVersionFromProcess](getversionfromprocess-function.md) function. - -## Syntax - -```cpp -HRESULT EnumerateLoadedRuntimes ( - [in] HANDLE hndProcess, - [out, retval] IEnumUnknown **ppEnumerator -); -``` - -## Parameters - - `hndProcess` - [in] The handle of the process to inspect for loaded runtimes. - - `ppEnumerator` - [out] An enumeration of [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interfaces corresponding to each CLR that is loaded by the process. - -## 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|`ppEnumerator` is null.| - -## Remarks - - This method is lists all loaded runtimes, even if they were loaded with deprecated functions such as [CorBindToRuntime](corbindtoruntime-function.md). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Returns an enumeration that includes a valid [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface pointer for each version of the common language runtime (CLR) that is loaded in a given process. This method supersedes the [GetVersionFromProcess](getversionfromprocess-function.md) function. + +## Syntax + +```cpp +HRESULT EnumerateLoadedRuntimes ( + [in] HANDLE hndProcess, + [out, retval] IEnumUnknown **ppEnumerator +); +``` + +## Parameters + + `hndProcess` + [in] The handle of the process to inspect for loaded runtimes. + + `ppEnumerator` + [out] An enumeration of [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interfaces corresponding to each CLR that is loaded by the process. + +## 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|`ppEnumerator` is null.| + +## Remarks + + This method is lists all loaded runtimes, even if they were loaded with deprecated functions such as [CorBindToRuntime](corbindtoruntime-function.md). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRMetaHost Interface](iclrmetahost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md index d8a05d54a1615..8bfcccd44c00c 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md @@ -2,53 +2,52 @@ description: "Learn more about: ICLRMetaHost::ExitProcess Method" title: "ICLRMetaHost::ExitProcess Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRMetaHost.ExitProcess" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRMetaHost::ExitProcess" -helpviewer_keywords: +helpviewer_keywords: - "ICLRMetaHost::ExitProcess method [.NET Framework hosting]" - "ExitProcess method, ICLRMetaHost interface [.NET Framework hosting]" -ms.assetid: b4df98cc-4e4e-407b-b8f4-e0076afef3a4 -topic_type: +topic_type: - "apiref" --- # ICLRMetaHost::ExitProcess Method -Attempts to shut down all loaded runtimes gracefully and then terminates the process. Supersedes the [CorExitProcess](corexitprocess-function.md) function. - -## Syntax - -```cpp -HRESULT ExitProcess ( - [in] INT32 iExitCode); -``` - -## Parameters - - `iExitCode` - [in] The exit code for the process. - -## Return Value - - This method never returns, so its return value is undefined. - -## Remarks - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Attempts to shut down all loaded runtimes gracefully and then terminates the process. Supersedes the [CorExitProcess](corexitprocess-function.md) function. + +## Syntax + +```cpp +HRESULT ExitProcess ( + [in] INT32 iExitCode); +``` + +## Parameters + + `iExitCode` + [in] The exit code for the process. + +## Return Value + + This method never returns, so its return value is undefined. + +## Remarks + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRMetaHost Interface](iclrmetahost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md index f57b4f3566614..7ea076b68261c 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md @@ -2,74 +2,73 @@ description: "Learn more about: ICLRMetaHost::GetRuntime Method" title: "ICLRMetaHost::GetRuntime Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRMetaHost.GetRuntime" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRMetaHost::GetRuntime" -helpviewer_keywords: +helpviewer_keywords: - "GetRuntime method [.NET Framework hosting]" - "ICLRMetaHost::GetRuntime method [.NET Framework hosting]" -ms.assetid: a10749f1-ab91-47cf-982f-d8ccd2e81bd2 -topic_type: +topic_type: - "apiref" --- # ICLRMetaHost::GetRuntime Method -Gets the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface that corresponds to a particular version of the common language runtime (CLR). This method supersedes the [CorBindToRuntimeEx](corbindtoruntimeex-function.md) function used with the [STARTUP_LOADER_SAFEMODE](startup-flags-enumeration.md) flag. - -## Syntax - -```cpp -HRESULT GetRuntime ( - [in] LPCWSTR pwzVersion, - [in] REFIID riid, - [out,iid_is(riid), retval] LPVOID *ppRuntime -); -``` - -## Parameters - - `pwzVersion` - [in] The .NET Framework compilation version stored in the metadata, in the format "v*A*.*B*[.*X*]". *A*, *B*, and *X* are decimal numbers that correspond to the major version, the minor version, and the build number. - +Gets the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface that corresponds to a particular version of the common language runtime (CLR). This method supersedes the [CorBindToRuntimeEx](corbindtoruntimeex-function.md) function used with the [STARTUP_LOADER_SAFEMODE](startup-flags-enumeration.md) flag. + +## Syntax + +```cpp +HRESULT GetRuntime ( + [in] LPCWSTR pwzVersion, + [in] REFIID riid, + [out,iid_is(riid), retval] LPVOID *ppRuntime +); +``` + +## Parameters + + `pwzVersion` + [in] The .NET Framework compilation version stored in the metadata, in the format "v*A*.*B*[.*X*]". *A*, *B*, and *X* are decimal numbers that correspond to the major version, the minor version, and the build number. + > [!NOTE] -> This parameter must match the directory name for the .NET Framework version, as it appears under C:\Windows\Microsoft.NET\Framework or C:\Windows\Microsoft.NET\Framework64. - - Example values are "v1.0.3705", "v1.1.4322", "v2.0.50727", and "v4.0.*X*", where *X* depends on the build number installed. The "v" prefix is required. - - `riid` - [in] The identifier for the desired interface. Currently, the only valid value for this parameter is IID_ICLRRuntimeInfo. - - `ppRuntime` - [out] A pointer to the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface that corresponds to the requested runtime. - -## 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|`pwzVersion` or `ppRuntime` is null.| - -## Remarks - - This method interacts consistently with legacy interfaces such as the [ICorRuntimeHost](icorruntimehost-interface.md) interface and legacy functions such as the deprecated `CorBindTo*` functions (see [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) in the .NET Framework 2.0 hosting API). That is, runtimes that are loaded with the legacy API are visible to the new API, and runtimes that are loaded with the new API are visible to the legacy API. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> This parameter must match the directory name for the .NET Framework version, as it appears under C:\Windows\Microsoft.NET\Framework or C:\Windows\Microsoft.NET\Framework64. + + Example values are "v1.0.3705", "v1.1.4322", "v2.0.50727", and "v4.0.*X*", where *X* depends on the build number installed. The "v" prefix is required. + + `riid` + [in] The identifier for the desired interface. Currently, the only valid value for this parameter is IID_ICLRRuntimeInfo. + + `ppRuntime` + [out] A pointer to the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface that corresponds to the requested runtime. + +## 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|`pwzVersion` or `ppRuntime` is null.| + +## Remarks + + This method interacts consistently with legacy interfaces such as the [ICorRuntimeHost](icorruntimehost-interface.md) interface and legacy functions such as the deprecated `CorBindTo*` functions (see [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) in the .NET Framework 2.0 hosting API). That is, runtimes that are loaded with the legacy API are visible to the new API, and runtimes that are loaded with the new API are visible to the legacy API. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRMetaHost Interface](iclrmetahost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md index fbaabf4eccdfa..fcc7682cc3cc7 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md @@ -2,71 +2,70 @@ description: "Learn more about: ICLRMetaHost::GetVersionFromFile Method" title: "ICLRMetaHost::GetVersionFromFile Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRMetaHost.GetVersionFromFile" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRMetaHost::GetVersionFromFile" -helpviewer_keywords: +helpviewer_keywords: - "ICLRMetaHost::GetVersionFromFile method [.NET Framework hosting]" - "GetVersionFromFile method [.NET Framework hosting]" -ms.assetid: 55bb3eb4-f665-42fc-973c-465567570e82 -topic_type: +topic_type: - "apiref" --- # ICLRMetaHost::GetVersionFromFile Method -Gets an assembly's original .NET Framework compilation version (stored in the metadata), given its file path. This method supersedes the [GetFileVersion](getfileversion-function.md) function. - -## Syntax - -```cpp -HRESULT GetVersionFromFile ( - [in] LPCWSTR pwzFilePath, - [out, size_is(*pcchBuffer)] LPWSTR pwzBuffer, - [in, out] DWORD *pcchBuffer); -); -``` - -## Parameters - - `pwzFilePath` - [in] The complete assembly file path. - - `pwzbuffer` - [out] The .NET Framework compilation version stored in the metadata, in the format "v*A*.*B*[.*X*]". *A*, *B*, and *X* are decimal numbers that correspond to the major version, the minor version, and the build number. The length of this string is limited to MAX_PATH. - +Gets an assembly's original .NET Framework compilation version (stored in the metadata), given its file path. This method supersedes the [GetFileVersion](getfileversion-function.md) function. + +## Syntax + +```cpp +HRESULT GetVersionFromFile ( + [in] LPCWSTR pwzFilePath, + [out, size_is(*pcchBuffer)] LPWSTR pwzBuffer, + [in, out] DWORD *pcchBuffer); +); +``` + +## Parameters + + `pwzFilePath` + [in] The complete assembly file path. + + `pwzbuffer` + [out] The .NET Framework compilation version stored in the metadata, in the format "v*A*.*B*[.*X*]". *A*, *B*, and *X* are decimal numbers that correspond to the major version, the minor version, and the build number. The length of this string is limited to MAX_PATH. + > [!NOTE] -> This output matches the directory name for the .NET Framework version, as it appears under C:\Windows\Microsoft.NET\Framework. - - Example values are "v1.0.3705", "v1.1.4322", "v2.0.50727", and "v4.0.*X*", where *X* depends on the build number installed. Note that the "v" prefix is required. - - `pcchBuffer` - [in, out] The size of `pwzbuffer` to avoid buffer overruns. - -## 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|`pwzbuffer` or `pcchBuffer` is null.| -|HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)|The buffer is too small.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> This output matches the directory name for the .NET Framework version, as it appears under C:\Windows\Microsoft.NET\Framework. + + Example values are "v1.0.3705", "v1.1.4322", "v2.0.50727", and "v4.0.*X*", where *X* depends on the build number installed. Note that the "v" prefix is required. + + `pcchBuffer` + [in, out] The size of `pwzbuffer` to avoid buffer overruns. + +## 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|`pwzbuffer` or `pcchBuffer` is null.| +|HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)|The buffer is too small.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRMetaHost Interface](iclrmetahost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-interface.md b/docs/core/unmanaged-api/hosting/iclrmetahost-interface.md index 97efc8d478285..93b28f9c4be14 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-interface.md @@ -2,56 +2,55 @@ description: "Learn more about: ICLRMetaHost Interface" title: "ICLRMetaHost Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRMetaHost" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRMetaHost" -helpviewer_keywords: +helpviewer_keywords: - "ICLRMetaHost interface [.NET Framework hosting]" -ms.assetid: c627fcdd-fc4f-4b1c-8e91-df8536f627d8 -topic_type: +topic_type: - "apiref" --- # ICLRMetaHost Interface -Provides methods that return a specific version of the common language runtime (CLR) based on its version number, list all installed CLRs, list all runtimes that are loaded in a specified process, discover the CLR version used to compile an assembly, exit a process with a clean runtime shutdown, and query legacy API binding. - -## Methods - -|Method|Description| -|------------|-----------------| -|[EnumerateInstalledRuntimes Method](iclrmetahost-enumerateinstalledruntimes-method.md)|Returns an enumeration that contains a valid [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface pointer for each CLR version that is installed on a computer.| -|[EnumerateLoadedRuntimes Method](iclrmetahost-enumerateloadedruntimes-method.md)|Returns an enumeration that contains a valid [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface pointer for each CLR that is loaded in a given process. This method supersedes [GetVersionFromProcess](getversionfromprocess-function.md).| -|[ExitProcess Method](iclrmetahost-exitprocess-method.md)|Attempts to shut down all loaded runtimes gracefully and then terminates the process. Supersedes the [CorExitProcess](corexitprocess-function.md) function.| -|[GetRuntime Method](iclrmetahost-getruntime-method.md)|Gets the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface that corresponds to a particular CLR version. This method supersedes the [CorBindToRuntimeEx](corbindtoruntimeex-function.md) function used with the [STARTUP_LOADER_SAFEMODE](startup-flags-enumeration.md) flag.| -|[GetVersionFromFile Method](iclrmetahost-getversionfromfile-method.md)|Gets the assembly's original .NET Framework compilation version (stored in the metadata), given its file path. This method supersedes [GetFileVersion](getfileversion-function.md).| -|[QueryLegacyV2RuntimeBinding Method](iclrmetahost-querylegacyv2runtimebinding-method.md)|Returns an interface that represents a runtime to which legacy activation policy has been bound, for example by using the `useLegacyV2RuntimeActivationPolicy` attribute on the [\ Element](../../configure-apps/file-schema/startup/startup-element.md) configuration file entry, by direct use of the legacy activation APIs, or by calling the [ICLRRuntimeInfo::BindAsLegacyV2Runtime](iclrruntimeinfo-bindaslegacyv2runtime-method.md) method.| -|[RequestRuntimeLoadedNotification Method](iclrmetahost-requestruntimeloadednotification-method.md)|Guarantees a callback to the specified function pointer when a CLR version is first loaded, but not yet started. This method supersedes [LockClrVersion](lockclrversion-function.md)| - -## Remarks - - The only way to get an instance of this interface is by calling the [CLRCreateInstance](clrcreateinstance-function.md) function as follows: - -```cpp -ICLRMetaHost *pMetaHost = NULL; -HRESULT hr = CLRCreateInstance(CLSID_CLRMetaHost, - IID_ICLRMetaHost, (LPVOID*)&pMetaHost); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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 a specific version of the common language runtime (CLR) based on its version number, list all installed CLRs, list all runtimes that are loaded in a specified process, discover the CLR version used to compile an assembly, exit a process with a clean runtime shutdown, and query legacy API binding. + +## Methods + +|Method|Description| +|------------|-----------------| +|[EnumerateInstalledRuntimes Method](iclrmetahost-enumerateinstalledruntimes-method.md)|Returns an enumeration that contains a valid [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface pointer for each CLR version that is installed on a computer.| +|[EnumerateLoadedRuntimes Method](iclrmetahost-enumerateloadedruntimes-method.md)|Returns an enumeration that contains a valid [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface pointer for each CLR that is loaded in a given process. This method supersedes [GetVersionFromProcess](getversionfromprocess-function.md).| +|[ExitProcess Method](iclrmetahost-exitprocess-method.md)|Attempts to shut down all loaded runtimes gracefully and then terminates the process. Supersedes the [CorExitProcess](corexitprocess-function.md) function.| +|[GetRuntime Method](iclrmetahost-getruntime-method.md)|Gets the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface that corresponds to a particular CLR version. This method supersedes the [CorBindToRuntimeEx](corbindtoruntimeex-function.md) function used with the [STARTUP_LOADER_SAFEMODE](startup-flags-enumeration.md) flag.| +|[GetVersionFromFile Method](iclrmetahost-getversionfromfile-method.md)|Gets the assembly's original .NET Framework compilation version (stored in the metadata), given its file path. This method supersedes [GetFileVersion](getfileversion-function.md).| +|[QueryLegacyV2RuntimeBinding Method](iclrmetahost-querylegacyv2runtimebinding-method.md)|Returns an interface that represents a runtime to which legacy activation policy has been bound, for example by using the `useLegacyV2RuntimeActivationPolicy` attribute on the [\ Element](../../../framework/configure-apps/file-schema/startup/startup-element.md) configuration file entry, by direct use of the legacy activation APIs, or by calling the [ICLRRuntimeInfo::BindAsLegacyV2Runtime](iclrruntimeinfo-bindaslegacyv2runtime-method.md) method.| +|[RequestRuntimeLoadedNotification Method](iclrmetahost-requestruntimeloadednotification-method.md)|Guarantees a callback to the specified function pointer when a CLR version is first loaded, but not yet started. This method supersedes [LockClrVersion](lockclrversion-function.md)| + +## Remarks + + The only way to get an instance of this interface is by calling the [CLRCreateInstance](clrcreateinstance-function.md) function as follows: + +```cpp +ICLRMetaHost *pMetaHost = NULL; +HRESULT hr = CLRCreateInstance(CLSID_CLRMetaHost, + IID_ICLRMetaHost, (LPVOID*)&pMetaHost); +``` + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md index 9d5c7592e163e..6fba601d74307 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md @@ -2,63 +2,62 @@ description: "Learn more about: ICLRMetaHost::QueryLegacyV2RuntimeBinding Method" title: "ICLRMetaHost::QueryLegacyV2RuntimeBinding Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRMetaHost.RequestRuntimeLoadedNotification" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRMetaHost::QueryLegacyV2RuntimeBinding" -helpviewer_keywords: +helpviewer_keywords: - "QueryLegacyV2RuntimeBinding method [.NET Framework hosting]" - "ICLRMetaHost::QueryLegacyV2RuntimeBinding method [.NET Framework hosting]" -ms.assetid: 9929817e-acc9-40b7-960c-598664e04b60 -topic_type: +topic_type: - "apiref" --- # ICLRMetaHost::QueryLegacyV2RuntimeBinding Method -Returns an interface that represents a runtime to which legacy activation policy has been bound, for example, by using the `useLegacyV2RuntimeActivationPolicy` attribute on the [\ element](../../configure-apps/file-schema/startup/startup-element.md) configuration file entry, by direct use of the legacy activation APIs, or by calling the [ICLRRuntimeInfo::BindAsLegacyV2Runtime](iclrruntimeinfo-bindaslegacyv2runtime-method.md) method. - -## Syntax - -```cpp -HRESULT QueryLegacyV2RuntimeBinding ( - [in] REFIID riid, - [out, iid_is(riid), retval] LPVOID *ppUnk); -``` - -## Parameters - - `riid` - [in] Required.Currently the only valid value for this parameter is `IID_ICLRRuntimeInfo`. - - `ppUnk` - [out] Required. When this method returns, contains a pointer to the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface that represents a runtime that has been bound to legacy activation policy. - -## 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 and returned a runtime that was bound to legacy activation policy.| -|S_FALSE|The method completed successfully, but a legacy runtime has not yet been bound.| -|E_NOINTERFACE|The method found a runtime that was bound to legacy activation policy, but `riid` is not supported by that runtime.| - -## Remarks - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Returns an interface that represents a runtime to which legacy activation policy has been bound, for example, by using the `useLegacyV2RuntimeActivationPolicy` attribute on the [\ element](../../../framework/configure-apps/file-schema/startup/startup-element.md) configuration file entry, by direct use of the legacy activation APIs, or by calling the [ICLRRuntimeInfo::BindAsLegacyV2Runtime](iclrruntimeinfo-bindaslegacyv2runtime-method.md) method. + +## Syntax + +```cpp +HRESULT QueryLegacyV2RuntimeBinding ( + [in] REFIID riid, + [out, iid_is(riid), retval] LPVOID *ppUnk); +``` + +## Parameters + + `riid` + [in] Required.Currently the only valid value for this parameter is `IID_ICLRRuntimeInfo`. + + `ppUnk` + [out] Required. When this method returns, contains a pointer to the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface that represents a runtime that has been bound to legacy activation policy. + +## 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 and returned a runtime that was bound to legacy activation policy.| +|S_FALSE|The method completed successfully, but a legacy runtime has not yet been bound.| +|E_NOINTERFACE|The method found a runtime that was bound to legacy activation policy, but `riid` is not supported by that runtime.| + +## Remarks + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRMetaHost Interface](iclrmetahost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md index e346bd1441da3..eb0207f962bfd 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md @@ -2,100 +2,99 @@ description: "Learn more about: ICLRMetaHost::RequestRuntimeLoadedNotification Method" title: "ICLRMetaHost::RequestRuntimeLoadedNotification Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRMetaHost.RequestRuntimeLoadedNotification" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRMetaHost::RequestRuntimeLoadedNotification" -helpviewer_keywords: +helpviewer_keywords: - "RequestRuntimeLoadedNotification method [.NET Framework hosting]" - "ICLRMetaHost::RequestRuntimeLoadedNotification method [.NET Framework hosting]" -ms.assetid: 0d5ccc4d-0193-41f5-af54-45d7b70d5321 -topic_type: +topic_type: - "apiref" --- # ICLRMetaHost::RequestRuntimeLoadedNotification Method -Provides a callback function that is guaranteed to be called when a common language runtime (CLR) version is first loaded, but not yet started. This method supersedes the [LockClrVersion](lockclrversion-function.md) function. - -## Syntax - -```cpp -HRESULT RequestRuntimeLoadedNotification ( - [in] RuntimeLoadedCallbackFnPtr pCallbackFunction); -``` - -## Parameters - - `pCallbackFunction` - [in] The callback function that is invoked when a new runtime has been loaded. - -## 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|`pCallbackFunction` is null.| - -## Remarks - - The callback works in the following way: - -- The callback is invoked only when a runtime is loaded for the first time. - -- The callback is not invoked for reentrant loads of the same runtime. - -- For non-reentrant runtime loads, calls to the callback function are serialized. - - The callback function has the following prototype: - -```cpp -typedef void (__stdcall *RuntimeLoadedCallbackFnPtr)( - ICLRRuntimeInfo *pRuntimeInfo, - CallbackThreadSetFnPtr pfnCallbackThreadSet, - CallbackThreadUnsetFnPtr pfnCallbackThreadUnset); -``` - - The callback function prototypes are as follows: - -- `pfnCallbackThreadSet`: - - ```cpp - typedef HRESULT (__stdcall *CallbackThreadSetFnPtr)(); - ``` - -- `pfnCallbackThreadUnset`: - - ```cpp - typedef HRESULT (__stdcall *CallbackThreadUnsetFnPtr)(); - ``` - - If the host intends to load or cause another runtime to be loaded in a reentrant manner, the `pfnCallbackThreadSet` and `pfnCallbackThreadUnset` parameters that are provided in the callback function must be used in the following way: - -- `pfnCallbackThreadSet` must be called by the thread that might cause a runtime load before such a load is attempted. - -- `pfnCallbackThreadUnset` must be called when the thread will no longer cause such a runtime load (and before returning from the initial callback). - -- `pfnCallbackThreadSet` and `pfnCallbackThreadUnset` are both non-reentrant. - +Provides a callback function that is guaranteed to be called when a common language runtime (CLR) version is first loaded, but not yet started. This method supersedes the [LockClrVersion](lockclrversion-function.md) function. + +## Syntax + +```cpp +HRESULT RequestRuntimeLoadedNotification ( + [in] RuntimeLoadedCallbackFnPtr pCallbackFunction); +``` + +## Parameters + + `pCallbackFunction` + [in] The callback function that is invoked when a new runtime has been loaded. + +## 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|`pCallbackFunction` is null.| + +## Remarks + + The callback works in the following way: + +- The callback is invoked only when a runtime is loaded for the first time. + +- The callback is not invoked for reentrant loads of the same runtime. + +- For non-reentrant runtime loads, calls to the callback function are serialized. + + The callback function has the following prototype: + +```cpp +typedef void (__stdcall *RuntimeLoadedCallbackFnPtr)( + ICLRRuntimeInfo *pRuntimeInfo, + CallbackThreadSetFnPtr pfnCallbackThreadSet, + CallbackThreadUnsetFnPtr pfnCallbackThreadUnset); +``` + + The callback function prototypes are as follows: + +- `pfnCallbackThreadSet`: + + ```cpp + typedef HRESULT (__stdcall *CallbackThreadSetFnPtr)(); + ``` + +- `pfnCallbackThreadUnset`: + + ```cpp + typedef HRESULT (__stdcall *CallbackThreadUnsetFnPtr)(); + ``` + + If the host intends to load or cause another runtime to be loaded in a reentrant manner, the `pfnCallbackThreadSet` and `pfnCallbackThreadUnset` parameters that are provided in the callback function must be used in the following way: + +- `pfnCallbackThreadSet` must be called by the thread that might cause a runtime load before such a load is attempted. + +- `pfnCallbackThreadUnset` must be called when the thread will no longer cause such a runtime load (and before returning from the initial callback). + +- `pfnCallbackThreadSet` and `pfnCallbackThreadUnset` are both non-reentrant. + > [!NOTE] -> Host applications must not call `pfnCallbackThreadSet` and `pfnCallbackThreadUnset` outside the scope of the `pCallbackFunction` parameter. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> Host applications must not call `pfnCallbackThreadSet` and `pfnCallbackThreadUnset` outside the scope of the `pCallbackFunction` parameter. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRMetaHost Interface](iclrmetahost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md b/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md index 258907cb76f86..700dd4e653765 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md @@ -13,7 +13,6 @@ f1_keywords: helpviewer_keywords: - "GetRequestedRuntime method [.NET Framework hosting]" - "ICLRMetaHostPolicy::GetRequestedRuntime method [.NET Framework hosting]" -ms.assetid: 59ec1832-9cc1-4b5c-983d-03407e51de56 topic_type: - "apiref" --- @@ -49,7 +48,7 @@ HRESULT GetRequestedRuntime( |`pcchVersion`|[in, out] Required. Specifies the expected size of `pwzVersion` as input, to avoid buffer overruns. If `pwzVersion` is null, `pcchVersion` contains the expected size of `pwzVersion` when `GetRequestedRuntime` returns, to allow pre-allocation; otherwise, `pcchVersion` contains the number of characters written to `pwzVersion`.| |`pwzImageVersion`|[out] Optional. When `GetRequestedRuntime` returns, contains the CLR version corresponding to the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface that is returned.| |`pcchImageVersion`|[in, out] Optional. Specifies the size of `pwzImageVersion` as input to avoid buffer overruns. If `pwzImageVersion` is null, `pcchImageVersion` contains the required size of `pwzImageVersion` when `GetRequestedRuntime` returns, to allow pre-allocation.| -|`pdwConfigFlags`|[out] Optional. If `GetRequestedRuntime` uses a configuration file during the binding process, when it returns, `pdwConfigFlags` contains a [METAHOST_CONFIG_FLAGS](metahost-config-flags-enumeration.md) value that indicates whether the [\](../../configure-apps/file-schema/startup/startup-element.md) element has the `useLegacyV2RuntimeActivationPolicy` attribute set, and the value of the attribute. Apply the [METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_MASK](metahost-config-flags-enumeration.md) mask to `pdwConfigFlags` to get the values relevant to `useLegacyV2RuntimeActivationPolicy`.| +|`pdwConfigFlags`|[out] Optional. If `GetRequestedRuntime` uses a configuration file during the binding process, when it returns, `pdwConfigFlags` contains a [METAHOST_CONFIG_FLAGS](metahost-config-flags-enumeration.md) value that indicates whether the [\](../../../framework/configure-apps/file-schema/startup/startup-element.md) element has the `useLegacyV2RuntimeActivationPolicy` attribute set, and the value of the attribute. Apply the [METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_MASK](metahost-config-flags-enumeration.md) mask to `pdwConfigFlags` to get the values relevant to `useLegacyV2RuntimeActivationPolicy`.| |`riid`|[in] Specifies the interface identifier IID_ICLRRuntimeInfo for the requested [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface.| |`ppRuntime`|[out] When `GetRequestedRuntime` returns, contains a pointer to the corresponding [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface.| @@ -85,7 +84,7 @@ This method returns the following specific HRESULTs as well as HRESULT errors th **Library:** Included as a resource in MSCorEE.dll -**.NET Framework Versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] +**.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] ## See also diff --git a/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md b/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md index e424e4214bf2c..37259c3672086 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md @@ -2,55 +2,54 @@ description: "Learn more about: ICLRMetaHostPolicy Interface" title: "ICLRMetaHostPolicy Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRMetaHostPolicy" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRMetaHostPolicy" -helpviewer_keywords: +helpviewer_keywords: - "ICLRMetaHostPolicy interface [.NET Framework hosting]" -ms.assetid: 1bdeccb6-0698-4c97-ad69-eae2b69e59f1 -topic_type: +topic_type: - "apiref" --- # ICLRMetaHostPolicy Interface -Provides the [GetRequestedRuntime](iclrmetahostpolicy-getrequestedruntime-method.md) method, which returns a pointer to a common language runtime (CLR) interface based on a policy criteria, managed assembly, version and configuration file. - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetRequestedRuntime Method](iclrmetahostpolicy-getrequestedruntime-method.md)|Provides a preferred CLR interface based on a policy criteria, managed assembly, version, and configuration file.| - -## Remarks - - You can get a reference to this interface by calling the [CLRCreateInstance](clrcreateinstance-function.md) function as shown in the following code: - -```cpp -ICLRMetaHostPolicy *pMetaHostPolicy = NULL; -HRESULT hr = CLRCreateInstance(CLSID_CLRMetaHostPolicy, - IID_ICLRMetaHostPolicy, (LPVOID*)&pMetaHostPolicy); -``` - +Provides the [GetRequestedRuntime](iclrmetahostpolicy-getrequestedruntime-method.md) method, which returns a pointer to a common language runtime (CLR) interface based on a policy criteria, managed assembly, version and configuration file. + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetRequestedRuntime Method](iclrmetahostpolicy-getrequestedruntime-method.md)|Provides a preferred CLR interface based on a policy criteria, managed assembly, version, and configuration file.| + +## Remarks + + You can get a reference to this interface by calling the [CLRCreateInstance](clrcreateinstance-function.md) function as shown in the following code: + +```cpp +ICLRMetaHostPolicy *pMetaHostPolicy = NULL; +HRESULT hr = CLRCreateInstance(CLSID_CLRMetaHostPolicy, + IID_ICLRMetaHostPolicy, (LPVOID*)&pMetaHostPolicy); +``` + > [!NOTE] -> This interface does not actually load or activate the CLR, but simply returns the preferred CLR version based on the available versions that are installed or loaded. - - The .NET Framework 4 hosting API consolidates policies so that hosts with specific needs may use basic functionality without incurring unintended penalties. For example, many of the MSCorEE.dll exports will bind to a specific CLR, although a method might not logically require it. The [METAHOST_POLICY_FLAGS](metahost-policy-flags-enumeration.md) enumeration provides binding policies that are common to the majority of hosts. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> This interface does not actually load or activate the CLR, but simply returns the preferred CLR version based on the available versions that are installed or loaded. + + The .NET Framework 4 hosting API consolidates policies so that hosts with specific needs may use basic functionality without incurring unintended penalties. For example, many of the MSCorEE.dll exports will bind to a specific CLR, although a method might not logically require it. The [METAHOST_POLICY_FLAGS](metahost-policy-flags-enumeration.md) enumeration provides binding policies that are common to the majority of hosts. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5](clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md) diff --git a/docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md b/docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md index 5072c3700c275..7b2657391e65f 100644 --- a/docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md @@ -2,48 +2,47 @@ description: "Learn more about: ICLROnEventManager Interface" title: "ICLROnEventManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLROnEventManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLROnEventManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLROnEventManager interface [.NET Framework hosting]" -ms.assetid: 9e15a0c1-8ab6-43d0-ae28-6ec7a4edd913 -topic_type: +topic_type: - "apiref" --- # ICLROnEventManager Interface -Provides methods that allow the host to register and unregister callbacks for common language runtime (CLR) events. - -## Methods - -|Method|Description| -|------------|-----------------| -|[RegisterActionOnEvent Method](iclroneventmanager-registeractiononevent-method.md)|Registers a callback pointer for the specified event.| -|[UnregisterActionOnEvent Method](iclroneventmanager-unregisteractiononevent-method.md)|Unregisters a previously registered callback pointer for the specified event.| - -## Remarks - - To register and unregister event callbacks, the host gets a reference to `ICLROnEventManager` by calling the [ICLRControl::GetCLRManager](iclrcontrol-getclrmanager-method.md) method. - +Provides methods that allow the host to register and unregister callbacks for common language runtime (CLR) events. + +## Methods + +|Method|Description| +|------------|-----------------| +|[RegisterActionOnEvent Method](iclroneventmanager-registeractiononevent-method.md)|Registers a callback pointer for the specified event.| +|[UnregisterActionOnEvent Method](iclroneventmanager-unregisteractiononevent-method.md)|Unregisters a previously registered callback pointer for the specified event.| + +## Remarks + + To register and unregister event callbacks, the host gets a reference to `ICLROnEventManager` by calling the [ICLRControl::GetCLRManager](iclrcontrol-getclrmanager-method.md) method. + > [!NOTE] -> The events described by [EClrEvent](eclrevent-enumeration.md) can be fired more than once and from different threads to signal an unload or the disabling of the CLR. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> The events described by [EClrEvent](eclrevent-enumeration.md) can be fired more than once and from different threads to signal an unload or the disabling of the CLR. + +## 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 2.0 + ## See also - [EClrEvent Enumeration](eclrevent-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md b/docs/core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md index e10712aefa53d..170c9e3938949 100644 --- a/docs/core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md +++ b/docs/core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md @@ -2,70 +2,69 @@ description: "Learn more about: ICLROnEventManager::RegisterActionOnEvent Method" title: "ICLROnEventManager::RegisterActionOnEvent Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLROnEventManager.RegisterActionOnEvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLROnEventManager::RegisterActionOnEvent" -helpviewer_keywords: +helpviewer_keywords: - "ICLROnEventManager::RegisterActionOnEvent method [.NET Framework hosting]" - "RegisterActionOnEvent method [.NET Framework hosting]" -ms.assetid: b944cf49-918d-4c4e-993b-77d097a52550 -topic_type: +topic_type: - "apiref" --- # ICLROnEventManager::RegisterActionOnEvent Method -Registers a callback pointer for the specified event. - -## Syntax - -```cpp -HRESULT RegisterActionOnEvent ( - [in] EClrEvent event, - [in] IActionOnCLREvent *pAction -); -``` - -## Parameters - - `event` - [in] One of the [EClrEvent](eclrevent-enumeration.md) values, indicating the event for which to register the callback pointer described by `pAction`. - - `pAction` - [in] A pointer to an [IActionOnCLREvent](iactiononclrevent-interface.md) object that is called when the registered event fires. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`RegisterActionOnEvent` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The host can register callbacks for either or both of the two event types described by `EClrEvent`. The host gets the `ICLROnEventManager` interface by calling the [ICLRControl::GetCLRManager](iclrcontrol-getclrmanager-method.md) method. - +Registers a callback pointer for the specified event. + +## Syntax + +```cpp +HRESULT RegisterActionOnEvent ( + [in] EClrEvent event, + [in] IActionOnCLREvent *pAction +); +``` + +## Parameters + + `event` + [in] One of the [EClrEvent](eclrevent-enumeration.md) values, indicating the event for which to register the callback pointer described by `pAction`. + + `pAction` + [in] A pointer to an [IActionOnCLREvent](iactiononclrevent-interface.md) object that is called when the registered event fires. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`RegisterActionOnEvent` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The host can register callbacks for either or both of the two event types described by `EClrEvent`. The host gets the `ICLROnEventManager` interface by calling the [ICLRControl::GetCLRManager](iclrcontrol-getclrmanager-method.md) method. + > [!NOTE] -> The events that `RegisterActionOnEvent` registers can be fired more than once and from different threads to signal an unload or the disabling of the CLR. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> The events that `RegisterActionOnEvent` registers can be fired more than once and from different threads to signal an unload or the disabling of the CLR. + +## 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 2.0 + ## See also - [EClrEvent Enumeration](eclrevent-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md b/docs/core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md index 20bf70126abb4..4340df6e03e67 100644 --- a/docs/core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md +++ b/docs/core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md @@ -2,63 +2,62 @@ description: "Learn more about: ICLROnEventManager::UnregisterActionOnEvent Method" title: "ICLROnEventManager::UnregisterActionOnEvent Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLROnEventManager.UnregisterActionOnEvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLROnEventManager::UnregisterActionOnEvent" -helpviewer_keywords: +helpviewer_keywords: - "UnRegisterActionOnEvent method [.NET Framework hosting]" - "ICLROnEventManager::UnRegisterActionOnEvent method [.NET Framework hosting]" -ms.assetid: 4c02ec37-cdf0-46b2-890e-235092741236 -topic_type: +topic_type: - "apiref" --- # ICLROnEventManager::UnregisterActionOnEvent Method -Unregisters a previously registered callback pointer for the specified event. - -## Syntax - -```cpp -HRESULT UnregisterActionOnEvent ( - [in] EClrEvent event, - [in] IActionOnCLREvent *pAction -); -``` - -## Parameters +Unregisters a previously registered callback pointer for the specified event. - `event` - [in] One of the [EClrEvent](eclrevent-enumeration.md) values, indicating the event for which to unregister the callback pointer described by `pAction`. - - `pAction` - [in] A pointer to an [IActionOnCLREvent](iactiononclrevent-interface.md) object that was passed as a parameter to the [RegisterActionOnEvent](iclroneventmanager-registeractiononevent-method.md) method. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`UnregisterActionOnEvent` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Requirements +## Syntax + +```cpp +HRESULT UnregisterActionOnEvent ( + [in] EClrEvent event, + [in] IActionOnCLREvent *pAction +); +``` + +## Parameters + + `event` + [in] One of the [EClrEvent](eclrevent-enumeration.md) values, indicating the event for which to unregister the callback pointer described by `pAction`. + + `pAction` + [in] A pointer to an [IActionOnCLREvent](iactiononclrevent-interface.md) object that was passed as a parameter to the [RegisterActionOnEvent](iclroneventmanager-registeractiononevent-method.md) method. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`UnregisterActionOnEvent` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 2.0 - **Platforms:** See [System Requirements](../../../framework/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 - [EClrEvent Enumeration](eclrevent-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md index 3c3b2ea56e4f0..46b96b13d8b26 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md @@ -2,45 +2,44 @@ description: "Learn more about: ICLRPolicyManager Interface" title: "ICLRPolicyManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRPolicyManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRPolicyManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLRPolicyManager interface [.NET Framework hosting]" -ms.assetid: 5c834aa1-f2db-408a-b230-c7bec093d364 -topic_type: +topic_type: - "apiref" --- # ICLRPolicyManager Interface -Provides methods that allow the host to specify policy actions to be taken in the event of failures and timeouts. - -## Methods - -|Method|Description| -|------------|-----------------| -|[SetActionOnFailure Method](iclrpolicymanager-setactiononfailure-method.md)|Specifies the policy action the common language runtime (CLR) should take when the specified failure occurs.| -|[SetActionOnTimeout Method](iclrpolicymanager-setactionontimeout-method.md)|Specifies the policy action the CLR should take when the specified operation times out.| -|[SetDefaultAction Method](iclrpolicymanager-setdefaultaction-method.md)|Specifies the policy action the CLR should take when the specified operation occurs.| -|[SetTimeout Method](iclrpolicymanager-settimeout-method.md)|Sets a timeout value for the specified operation.| -|[SetTimeoutAndAction Method](iclrpolicymanager-settimeoutandaction-method.md)|Sets a timeout value for the specified operation, and specifies the policy action the CLR should take when the operation occurs.| -|[SetUnhandledExceptionPolicy Method](iclrpolicymanager-setunhandledexceptionpolicy-method.md)|Specifies the behavior of the CLR when an unhandled exception occurs.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods that allow the host to specify policy actions to be taken in the event of failures and timeouts. + +## Methods + +|Method|Description| +|------------|-----------------| +|[SetActionOnFailure Method](iclrpolicymanager-setactiononfailure-method.md)|Specifies the policy action the common language runtime (CLR) should take when the specified failure occurs.| +|[SetActionOnTimeout Method](iclrpolicymanager-setactionontimeout-method.md)|Specifies the policy action the CLR should take when the specified operation times out.| +|[SetDefaultAction Method](iclrpolicymanager-setdefaultaction-method.md)|Specifies the policy action the CLR should take when the specified operation occurs.| +|[SetTimeout Method](iclrpolicymanager-settimeout-method.md)|Sets a timeout value for the specified operation.| +|[SetTimeoutAndAction Method](iclrpolicymanager-settimeoutandaction-method.md)|Sets a timeout value for the specified operation, and specifies the policy action the CLR should take when the operation occurs.| +|[SetUnhandledExceptionPolicy Method](iclrpolicymanager-setunhandledexceptionpolicy-method.md)|Specifies the behavior of the CLR when an unhandled exception occurs.| + +## 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 2.0 + ## See also - [EClrFailure Enumeration](eclrfailure-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md index ff8afdca34e60..d7440346aa835 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md @@ -2,44 +2,43 @@ description: "Learn more about: ICLRPolicyManager::SetActionOnFailure Method" title: "ICLRPolicyManager::SetActionOnFailure Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRPolicyManager.SetActionOnFailure" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRPolicyManager::SetActionOnFailure" -helpviewer_keywords: +helpviewer_keywords: - "SetActionOnFailure method [.NET Framework hosting]" - "ICLRPolicyManager::SetActionOnFailure method [.NET Framework hosting]" -ms.assetid: 4664033f-db97-4388-b988-2ec470796e58 -topic_type: +topic_type: - "apiref" --- # ICLRPolicyManager::SetActionOnFailure Method -Specifies the policy action the common language runtime (CLR) should take when the specified failure occurs. - -## Syntax - -```cpp -HRESULT SetActionOnFailure ( - [in] EClrFailure failure, - [in] EPolicyAction action -); -``` - -## Parameters - - `failure` - [in] One of the [EClrFailure](eclrfailure-enumeration.md) values, indicating the type of failure for which to take action. - - `action` - [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the action to be taken when a failure occurs. For a list of supported values, see the Remarks section. - -## Return Value - +Specifies the policy action the common language runtime (CLR) should take when the specified failure occurs. + +## Syntax + +```cpp +HRESULT SetActionOnFailure ( + [in] EClrFailure failure, + [in] EPolicyAction action +); +``` + +## Parameters + + `failure` + [in] One of the [EClrFailure](eclrfailure-enumeration.md) values, indicating the type of failure for which to take action. + + `action` + [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the action to be taken when a failure occurs. For a list of supported values, see the Remarks section. + +## Return Value + | HRESULT | Description | | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | S_OK | `SetActionOnFailure` returned successfully. | @@ -49,11 +48,11 @@ HRESULT SetActionOnFailure ( | HOST_E_ABANDONED | An event was canceled while a blocked thread or fiber was waiting on it. | | E_FAIL | An unknown catastrophic failure occurred. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE. | | E_INVALIDARG | A policy action cannot be set for the specified operation, or an invalid policy action was specified for the operation. | - -## Remarks + +## Remarks By default, the CLR throws an exception when it fails to allocate a resource such as memory. `SetActionOnFailure` allows the host to override this behavior by specifying the policy action to take upon failure. The following table shows the combinations of [EClrFailure](eclrfailure-enumeration.md) (columns) and [EPolicyAction](epolicyaction-enumeration.md) (rows) values that are supported. - + | | `FAIL_NonCriticalResource` | `FAIL_CriticalResource` | `FAIL_FatalRuntime` | `FAIL_OrphanedLock` | `FAIL_StackOverflow` | `FAIL_AccessViolation` | `FAIL_CodeContract` | | -------------------------- | -------------------------- | ----------------------- | ------------------- | ------------------- | -------------------- | ---------------------- | ------------------- | | **`eNoAction`** | X | X | | | | N/A | | @@ -66,17 +65,17 @@ HRESULT SetActionOnFailure ( | **`eFastExitProcess`** | X | X | | X | X | N/A | | | **`eRudeExitProcess`** | X | X | X | X | X | N/A | | | **`eDisableRuntime`** | X | X | X | X | X | N/A | | - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - + +## 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 2.0 + ## See also - [EClrFailure Enumeration](eclrfailure-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md index 806bd414922f2..75ad097656c35 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md @@ -2,84 +2,83 @@ description: "Learn more about: ICLRPolicyManager::SetActionOnTimeout Method" title: "ICLRPolicyManager::SetActionOnTimeout Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRPolicyManager.SetActionOnTimeout" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRPolicyManager::SetActionOnTimeout" -helpviewer_keywords: +helpviewer_keywords: - "SetActionOnTimeout method [.NET Framework hosting]" - "ICLRPolicyManager::SetActionOnTimeout method [.NET Framework hosting]" -ms.assetid: 38439fa1-2b99-4fa8-a6ec-08afc0f83b9c -topic_type: +topic_type: - "apiref" --- # ICLRPolicyManager::SetActionOnTimeout Method -Specifies the policy action the common language runtime (CLR) should take when the specified operation times out. - -## Syntax - -```cpp -HRESULT SetActionOnTimeout ( - [in] EClrOperation operation, - [in] EPolicyAction action -); -``` - -## Parameters - - `operation` - [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the operation for which to specify the timeout action. The following values are supported: - -- OPR_AppDomainUnload - -- OPR_ProcessExit - -- OPR_ThreadRudeAbortInCriticalRegion - -- OPR_ThreadRudeAbortInNonCriticalRegion - - `action` - [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the policy action to be taken when the operation times out. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetActionOnTimeout` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_INVALIDARG|A timeout cannot be set for the specified `operation`, or an invalid value was supplied for `operation`.| - -## Remarks - - The timeout value can be either the default timeout set by the CLR, or a value specified by the host in a call to the [ICLRPolicyManager::SetTimeout](iclrpolicymanager-settimeout-method.md) method. - - Not all policy action values can be specified as the timeout behavior for CLR operations. `SetActionOnTimeout` is typically used only to escalate behavior. For example, a host can specify that thread aborts be turned into rude thread aborts, but cannot specify the opposite. The table below describes the valid `action` values for valid `operation` values. - -|Value for `operation`|Valid values for `action`| -|---------------------------|-------------------------------| -|OPR_ThreadRudeAbortInNonCriticalRegion

OPR_ThreadRudeAbortInCriticalRegion|- eRudeAbortThread
- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| -|OPR_AppDomainUnload|- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| -|OPR_ProcessExit|- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Specifies the policy action the common language runtime (CLR) should take when the specified operation times out. + +## Syntax + +```cpp +HRESULT SetActionOnTimeout ( + [in] EClrOperation operation, + [in] EPolicyAction action +); +``` + +## Parameters + + `operation` + [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the operation for which to specify the timeout action. The following values are supported: + +- OPR_AppDomainUnload + +- OPR_ProcessExit + +- OPR_ThreadRudeAbortInCriticalRegion + +- OPR_ThreadRudeAbortInNonCriticalRegion + + `action` + [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the policy action to be taken when the operation times out. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetActionOnTimeout` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_INVALIDARG|A timeout cannot be set for the specified `operation`, or an invalid value was supplied for `operation`.| + +## Remarks + + The timeout value can be either the default timeout set by the CLR, or a value specified by the host in a call to the [ICLRPolicyManager::SetTimeout](iclrpolicymanager-settimeout-method.md) method. + + Not all policy action values can be specified as the timeout behavior for CLR operations. `SetActionOnTimeout` is typically used only to escalate behavior. For example, a host can specify that thread aborts be turned into rude thread aborts, but cannot specify the opposite. The table below describes the valid `action` values for valid `operation` values. + +|Value for `operation`|Valid values for `action`| +|---------------------------|-------------------------------| +|OPR_ThreadRudeAbortInNonCriticalRegion

OPR_ThreadRudeAbortInCriticalRegion|- eRudeAbortThread
- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| +|OPR_AppDomainUnload|- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| +|OPR_ProcessExit|- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| + +## 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 2.0 + ## See also - [EClrOperation Enumeration](eclroperation-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md index a96156141c4e6..6c23bd17a5aa4 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md @@ -2,77 +2,76 @@ description: "Learn more about: ICLRPolicyManager::SetDefaultAction Method" title: "ICLRPolicyManager::SetDefaultAction Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRPolicyManager.SetDefaultAction" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRPolicyManager::SetDefaultAction" -helpviewer_keywords: +helpviewer_keywords: - "SetDefaultAction method [.NET Framework hosting]" - "ICLRPolicyManager::SetDefaultAction method [.NET Framework hosting]" -ms.assetid: f9411e7a-27df-451f-9f6c-d643d6a7a7ce -topic_type: +topic_type: - "apiref" --- # ICLRPolicyManager::SetDefaultAction Method -Specifies the policy action the common language runtime (CLR) should take when the specified operation occurs. - -## Syntax - -```cpp -HRESULT SetDefaultAction ( - [in] EClrOperation operation, - [in] EPolicyAction action -); -``` - -## Parameters - - `operation` - [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the action for which CLR behavior should be customized. - - `action` - [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the policy action the CLR should take when `operation` occurs. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetDefaultAction` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_INVALIDARG|An invalid `action` was specified for the `operation`, or an invalid value was supplied for `operation`.| - -## Remarks - - Not all policy action values can be specified as the default behavior for CLR operations. `SetDefaultAction` can typically be used only to escalate behavior. For example, a host can specify that thread aborts be turned into rude thread aborts, but cannot specify the opposite. The table below describes the valid `action` values for each possible `operation` value. - -|Value for `operation`|Valid values for `action`| -|---------------------------|-------------------------------| -|OPR_ThreadAbort|- eAbortThread
- eRudeAbortThread
- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| -|OPR_ThreadRudeAbortInNonCriticalRegion

OPR_ThreadRudeAbortInCriticalRegion|- eRudeAbortThread
- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| -|OPR_AppDomainUnload|- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| -|OPR_AppDomainRudeUnload|- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| -|OPR_ProcessExit|- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| -|OPR_FinalizerRun|- eNoAction
- eAbortThread
- eRudeAbortThread
- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Specifies the policy action the common language runtime (CLR) should take when the specified operation occurs. + +## Syntax + +```cpp +HRESULT SetDefaultAction ( + [in] EClrOperation operation, + [in] EPolicyAction action +); +``` + +## Parameters + + `operation` + [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the action for which CLR behavior should be customized. + + `action` + [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the policy action the CLR should take when `operation` occurs. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetDefaultAction` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_INVALIDARG|An invalid `action` was specified for the `operation`, or an invalid value was supplied for `operation`.| + +## Remarks + + Not all policy action values can be specified as the default behavior for CLR operations. `SetDefaultAction` can typically be used only to escalate behavior. For example, a host can specify that thread aborts be turned into rude thread aborts, but cannot specify the opposite. The table below describes the valid `action` values for each possible `operation` value. + +|Value for `operation`|Valid values for `action`| +|---------------------------|-------------------------------| +|OPR_ThreadAbort|- eAbortThread
- eRudeAbortThread
- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| +|OPR_ThreadRudeAbortInNonCriticalRegion

OPR_ThreadRudeAbortInCriticalRegion|- eRudeAbortThread
- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| +|OPR_AppDomainUnload|- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| +|OPR_AppDomainRudeUnload|- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| +|OPR_ProcessExit|- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| +|OPR_FinalizerRun|- eNoAction
- eAbortThread
- eRudeAbortThread
- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| + +## 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 2.0 + ## See also - [EClrOperation Enumeration](eclroperation-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md index 09e4dc8acec1c..9c0764e8ba77c 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md @@ -2,72 +2,71 @@ description: "Learn more about: ICLRPolicyManager::SetTimeout Method" title: "ICLRPolicyManager::SetTimeout Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRPolicyManager.SetTimeout" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRPolicyManager::SetTimeout" -helpviewer_keywords: +helpviewer_keywords: - "SetTimeout method [.NET Framework hosting]" - "ICLRPolicyManager::SetTimeout method [.NET Framework hosting]" -ms.assetid: 954404fd-d52d-4e68-b582-8692f3a5f608 -topic_type: +topic_type: - "apiref" --- # ICLRPolicyManager::SetTimeout Method -Sets a timeout value for the specified operation. - -## Syntax - -```cpp -HRESULT SetTimeout ( - [in] EClrOperation operation, - [in] DWORD dsMilliseconds -); -``` - -## Parameters - - `operation` - [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the common language runtime (CLR) operation for which to set a timeout. The following values are supported: - -- OPR_AppDomainUnload - -- OPR_ProcessExit - -- OPR_ThreadRudeAbortInCriticalRegion - -- OPR_ThreadRudeAbortInNonCriticalRegion - - `dwMilliseconds` - [in] The new timeout value, in milliseconds. A value of INFINITE causes the operation never to time out. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetTimeout` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_INVALIDARG|A timeout cannot be set for the specified `operation`, or an invalid value was supplied for `operation`.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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 a timeout value for the specified operation. + +## Syntax + +```cpp +HRESULT SetTimeout ( + [in] EClrOperation operation, + [in] DWORD dsMilliseconds +); +``` + +## Parameters + + `operation` + [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the common language runtime (CLR) operation for which to set a timeout. The following values are supported: + +- OPR_AppDomainUnload + +- OPR_ProcessExit + +- OPR_ThreadRudeAbortInCriticalRegion + +- OPR_ThreadRudeAbortInNonCriticalRegion + + `dwMilliseconds` + [in] The new timeout value, in milliseconds. A value of INFINITE causes the operation never to time out. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetTimeout` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_INVALIDARG|A timeout cannot be set for the specified `operation`, or an invalid value was supplied for `operation`.| + +## 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 2.0 + ## See also - [EClrOperation Enumeration](eclroperation-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md index d66843645e915..2b175ac93547a 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md @@ -2,83 +2,82 @@ description: "Learn more about: ICLRPolicyManager::SetTimeoutAndAction Method" title: "ICLRPolicyManager::SetTimeoutAndAction Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRPolicyManager.SetTimeoutAndAction" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRPolicyManager::SetTimeoutAndAction" -helpviewer_keywords: +helpviewer_keywords: - "ICLRPolicyManager::SetTimeoutAndAction method [.NET Framework hosting]" - "SetTimeoutAndAction method [.NET Framework hosting]" -ms.assetid: 60454f91-d855-4ddf-bb6d-60a02f5eabab -topic_type: +topic_type: - "apiref" --- # ICLRPolicyManager::SetTimeoutAndAction Method -Sets a timeout value for the specified operation, and specifies the policy action the common language runtime (CLR) should take when the operation occurs. - -## Syntax - -```cpp -HRESULT SetTimeoutAndAction ( - [in] EClrOperation operation, - [in] DWORD dwMilliseconds, - [in] EPolicyAction action -); -``` - -## Parameters - - `operation` - [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the operation for which to set the timeout and policy `action`. The following values are supported: - -- OPR_AppDomainUnload - -- OPR_ProcessExit - -- OPR_ThreadRudeAbortInCriticalRegion - -- OPR_ThreadRudeAbortInNonCriticalRegion - - `dwMilliseconds` - [in] The new timeout value, in milliseconds. A value of INFINITE causes `operation` never to time out. - - `action` - [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the policy action that the CLR should take when `operation` occurs. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetTimeoutAndAction` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_INVALIDARG|A timeout cannot be set for the specified `operation`, or an invalid value was supplied for `action`.| - -## Remarks - - `SetTimeoutAndAction` encapsulates the capabilities of the [ICLRPolicyManager::SetTimeout](iclrpolicymanager-settimeout-method.md) and [ICLRPolicyManager::SetActionOnTimeout](iclrpolicymanager-setactionontimeout-method.md) methods, and can be called in place of sequential calls to these two methods. - +Sets a timeout value for the specified operation, and specifies the policy action the common language runtime (CLR) should take when the operation occurs. + +## Syntax + +```cpp +HRESULT SetTimeoutAndAction ( + [in] EClrOperation operation, + [in] DWORD dwMilliseconds, + [in] EPolicyAction action +); +``` + +## Parameters + + `operation` + [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the operation for which to set the timeout and policy `action`. The following values are supported: + +- OPR_AppDomainUnload + +- OPR_ProcessExit + +- OPR_ThreadRudeAbortInCriticalRegion + +- OPR_ThreadRudeAbortInNonCriticalRegion + + `dwMilliseconds` + [in] The new timeout value, in milliseconds. A value of INFINITE causes `operation` never to time out. + + `action` + [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the policy action that the CLR should take when `operation` occurs. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetTimeoutAndAction` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_INVALIDARG|A timeout cannot be set for the specified `operation`, or an invalid value was supplied for `action`.| + +## Remarks + + `SetTimeoutAndAction` encapsulates the capabilities of the [ICLRPolicyManager::SetTimeout](iclrpolicymanager-settimeout-method.md) and [ICLRPolicyManager::SetActionOnTimeout](iclrpolicymanager-setactionontimeout-method.md) methods, and can be called in place of sequential calls to these two methods. + > [!IMPORTANT] -> Not all policy action values can be specified as the timeout behavior for CLR operations. See the Remarks sections of the topics for these two methods for valid values. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> Not all policy action values can be specified as the timeout behavior for CLR operations. See the Remarks sections of the topics for these two methods for valid values. + +## 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 2.0 + ## See also - [EClrOperation Enumeration](eclroperation-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md index 678fe70009ce4..c05e17be7898a 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md +++ b/docs/core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md @@ -2,63 +2,62 @@ description: "Learn more about: ICLRPolicyManager::SetUnhandledExceptionPolicy Method" title: "ICLRPolicyManager::SetUnhandledExceptionPolicy Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRPolicyManager.SetUnhandledExceptionPolicy" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRPolicyManager::SetUnhandledExceptionPolicy" -helpviewer_keywords: +helpviewer_keywords: - "ICLRPolicyManager::SetUnhandledExceptionPolicy method [.NET Framework hosting]" - "SetUnhandledExceptionPolicy method [.NET Framework hosting]" -ms.assetid: 5268480e-280a-4931-b7a3-dc3ffdf7f78f -topic_type: +topic_type: - "apiref" --- # ICLRPolicyManager::SetUnhandledExceptionPolicy Method -Specifies the behavior of the common language runtime (CLR) when an unhandled exception occurs. - -## Syntax - -```cpp -HRESULT SetUnhandledExceptionPolicy ( - [in] EClrUnhandledExceptionPolicy policy -); -``` - -## Parameters - - `policy` - [in] One of the [EClrUnhandledException](eclrunhandledexception-enumeration.md) values, indicating whether the behavior is set by the CLR or the host. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetUnhandledExceptionPolicy` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - By default, the CLR is the final handler for all unhandled exceptions, and its default behavior is to tear down the process. The host can change this behavior by setting the `policy` value to eHostDeterminedPolicy. This value allows the host to implement its own default behavior, as with earlier versions of the CLR. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Specifies the behavior of the common language runtime (CLR) when an unhandled exception occurs. + +## Syntax + +```cpp +HRESULT SetUnhandledExceptionPolicy ( + [in] EClrUnhandledExceptionPolicy policy +); +``` + +## Parameters + + `policy` + [in] One of the [EClrUnhandledException](eclrunhandledexception-enumeration.md) values, indicating whether the behavior is set by the CLR or the host. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetUnhandledExceptionPolicy` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + By default, the CLR is the final handler for all unhandled exceptions, and its default behavior is to tear down the process. The host can change this behavior by setting the `policy` value to eHostDeterminedPolicy. This value allows the host to implement its own default behavior, as with earlier versions of the CLR. + +## 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 2.0 + ## See also - [EClrUnhandledException Enumeration](eclrunhandledexception-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md b/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md index 298806cfab8c5..8531a7986a426 100644 --- a/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md +++ b/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md @@ -13,7 +13,6 @@ f1_keywords: helpviewer_keywords: - "Get method, ICLRProbingAssemblyEnum interface [.NET Framework hosting]" - "ICLRProbingAssemblyEnum::Get method [.NET Framework hosting]" -ms.assetid: fdb67a77-782f-44cf-a8a1-b75999b0f3c8 topic_type: - "apiref" --- @@ -69,7 +68,7 @@ HRESULT Get ( **Library:** Included 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/hosting/iclrprobingassemblyenum-interface.md b/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md index 031316c81ed25..db4b31ced334e 100644 --- a/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md @@ -2,44 +2,43 @@ description: "Learn more about: ICLRProbingAssemblyEnum Interface" title: "ICLRProbingAssemblyEnum Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRProbingAssemblyEnum" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRProbingAssemblyEnum" -helpviewer_keywords: +helpviewer_keywords: - "ICLRProbingAssemblyEnum interface [.NET Framework hosting]" -ms.assetid: e7d3ccab-b0f0-4872-8935-0ed72920171b -topic_type: +topic_type: - "apiref" --- # ICLRProbingAssemblyEnum Interface -Provides methods that enable the host to get the probing identities of an assembly by using the assembly's identity information that is internal to the common language runtime (CLR), without needing to create or understand that identity. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Get Method](iclrprobingassemblyenum-get-method.md)|Gets the assembly identity at the specified index.| - -## Remarks - - Methods such as [ICLRAssemblyIdentityManager::GetProbingAssembliesFromReference](iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md) return an `ICLRProbingAssemblyEnum` instance. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods that enable the host to get the probing identities of an assembly by using the assembly's identity information that is internal to the common language runtime (CLR), without needing to create or understand that identity. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Get Method](iclrprobingassemblyenum-get-method.md)|Gets the assembly identity at the specified index.| + +## Remarks + + Methods such as [ICLRAssemblyIdentityManager::GetProbingAssembliesFromReference](iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md) return an `ICLRProbingAssemblyEnum` instance. + +## 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 2.0 + ## See also - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md b/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md index 4a2ad69eb84be..cf64328c2f4e4 100644 --- a/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md +++ b/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md @@ -2,73 +2,72 @@ description: "Learn more about: ICLRReferenceAssemblyEnum::Get Method" title: "ICLRReferenceAssemblyEnum::Get Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRReferenceAssemblyEnum.Get" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRReferenceAssemblyEnum::Get" -helpviewer_keywords: +helpviewer_keywords: - "ICLRReferenceAssemblyEnum::Get method [.NET Framework hosting]" - "Get method, ICLRReferenceAssemblyEnum interface [.NET Framework hosting]" -ms.assetid: f21c1612-9c5d-4abc-a337-577086d29c17 -topic_type: +topic_type: - "apiref" --- # ICLRReferenceAssemblyEnum::Get Method -Gets the assembly identity at the supplied index. - -## Syntax - -```cpp -HRESULT Get ( - [in] DWORD dwIndex, - [out, size_is(*pcchBufferSize)] LPWSTR pwzBuffer, - [in, out] DWORD *pcchBufferSize -); -``` - -## Parameters - - `dwIndex` - [in] The zero-based index of the assembly identity to return. - - `pwzBuffer` - [out] A buffer containing the assembly identity data. - - `pcchBufferSize` - [in, out] The size of the `pwzBuffer` buffer. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Get` returned successfully.| -|ERROR_INSUFFICIENT_BUFFER|`pwzBuffer` is too small.| -|ERROR_NO_MORE_ITEMS|The enumeration contains no more items.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| - -## Remarks - - `Get` is typically called twice. The first call supplies a null value for `pwzBuffer`, and sets `pcchBufferSize` to the size appropriate for `pwzBuffer`. The second call supplies an appropriately sized `pwzBuffer`, and contains the canonical assembly identity data upon completion. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the assembly identity at the supplied index. + +## Syntax + +```cpp +HRESULT Get ( + [in] DWORD dwIndex, + [out, size_is(*pcchBufferSize)] LPWSTR pwzBuffer, + [in, out] DWORD *pcchBufferSize +); +``` + +## Parameters + + `dwIndex` + [in] The zero-based index of the assembly identity to return. + + `pwzBuffer` + [out] A buffer containing the assembly identity data. + + `pcchBufferSize` + [in, out] The size of the `pwzBuffer` buffer. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Get` returned successfully.| +|ERROR_INSUFFICIENT_BUFFER|`pwzBuffer` is too small.| +|ERROR_NO_MORE_ITEMS|The enumeration contains no more items.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| + +## Remarks + + `Get` is typically called twice. The first call supplies a null value for `pwzBuffer`, and sets `pcchBufferSize` to the size appropriate for `pwzBuffer`. The second call supplies an appropriately sized `pwzBuffer`, and contains the canonical assembly identity data upon completion. + +## 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 2.0 + ## See also - [ICLRAssemblyReferenceList Interface](iclrassemblyreferencelist-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md b/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md index 3b613b3237b30..09e323435aa1f 100644 --- a/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md @@ -2,40 +2,39 @@ description: "Learn more about: ICLRReferenceAssemblyEnum Interface" title: "ICLRReferenceAssemblyEnum Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRReferenceAssemblyEnum" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRReferenceAssemblyEnum" -helpviewer_keywords: +helpviewer_keywords: - "ICLRReferenceAssemblyEnum interface [.NET Framework hosting]" -ms.assetid: 8adbf092-c3ba-4bee-b25b-0de6e43a4ce5 -topic_type: +topic_type: - "apiref" --- # ICLRReferenceAssemblyEnum Interface -Provides methods that allow the host to manipulate the set of assemblies referenced by a file or stream using assembly identity data that is internal to the common language runtime (CLR), without needing to create or understand those identities. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Get Method](iclrreferenceassemblyenum-get-method.md)|Gets the assembly identity at the supplied index.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods that allow the host to manipulate the set of assemblies referenced by a file or stream using assembly identity data that is internal to the common language runtime (CLR), without needing to create or understand those identities. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Get Method](iclrreferenceassemblyenum-get-method.md)|Gets the assembly identity at the supplied index.| + +## 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 2.0 + ## See also - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md index ae1ee8c7ca9b6..eb9ddbfaad99b 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md @@ -2,88 +2,87 @@ description: "Learn more about: ICLRRuntimeHost::ExecuteApplication Method" title: "ICLRRuntimeHost::ExecuteApplication Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeHost.ExecuteApplication" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeHost::ExecuteApplication" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeHost::ExecuteApplication method [.NET Framework hosting]" - "ExecuteApplication method [.NET Framework hosting]" -ms.assetid: 5f28cc4e-7176-4e00-aa1f-58ae6ee52fe4 -topic_type: +topic_type: - "apiref" --- # ICLRRuntimeHost::ExecuteApplication Method -Used in manifest-based ClickOnce deployment scenarios to specify the application to be activated in a new domain. For more information about these scenarios, see [ClickOnce Security and Deployment](/visualstudio/deployment/clickonce-security-and-deployment). - -## Syntax - -```cpp -HRESULT ExecuteApplication( - [in] LPCWSTR pwzAppFullName, - [in] DWORD dwManifestPaths, - [in] LPCWSTR *ppwzManifestPaths, - [in] DWORD dwActivationData, - [in] LPCWSTR *ppwzActivationData, - [out] int *pReturnValue -); -``` - -## Parameters - - `pwzAppFullName` - [in] The full name of the application, as defined for . - - `dwManifestPaths` - [in] The number of strings contained in the `ppwzManifestPaths` array. - - `ppwzManifestPaths` - [in] Optional. A string array that contains manifest paths for the application. - - `dwActivationData` - [in] The number of strings contained in the `ppwzActivationData` array. - - `ppwzActivationData` - [in] Optional. A string array that contains the application's activation data, such as the query string portion of the URL for applications deployed over the Web. - - `pReturnValue` - [out] The value returned from the entry point of the application. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`ExecuteApplication` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| - -## Remarks - - `ExecuteApplication` is used to activate ClickOnce applications in a newly created application domain. - - The `pReturnValue` output parameter is set to the value returned by the application. If you supply a value of null for `pReturnValue`, `ExecuteApplication` does not fail, but it does not return a value. - +Used in manifest-based ClickOnce deployment scenarios to specify the application to be activated in a new domain. For more information about these scenarios, see [ClickOnce Security and Deployment](/visualstudio/deployment/clickonce-security-and-deployment). + +## Syntax + +```cpp +HRESULT ExecuteApplication( + [in] LPCWSTR pwzAppFullName, + [in] DWORD dwManifestPaths, + [in] LPCWSTR *ppwzManifestPaths, + [in] DWORD dwActivationData, + [in] LPCWSTR *ppwzActivationData, + [out] int *pReturnValue +); +``` + +## Parameters + + `pwzAppFullName` + [in] The full name of the application, as defined for . + + `dwManifestPaths` + [in] The number of strings contained in the `ppwzManifestPaths` array. + + `ppwzManifestPaths` + [in] Optional. A string array that contains manifest paths for the application. + + `dwActivationData` + [in] The number of strings contained in the `ppwzActivationData` array. + + `ppwzActivationData` + [in] Optional. A string array that contains the application's activation data, such as the query string portion of the URL for applications deployed over the Web. + + `pReturnValue` + [out] The value returned from the entry point of the application. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`ExecuteApplication` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| + +## Remarks + + `ExecuteApplication` is used to activate ClickOnce applications in a newly created application domain. + + The `pReturnValue` output parameter is set to the value returned by the application. If you supply a value of null for `pReturnValue`, `ExecuteApplication` does not fail, but it does not return a value. + > [!IMPORTANT] -> Do not call the [Start Method](iclrruntimehost-start-method.md) method before calling the `ExecuteApplication` method to activate a manifest-based application. If the `Start` method is called first, the `ExecuteApplication` method call will fail. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> Do not call the [Start Method](iclrruntimehost-start-method.md) method before calling the `ExecuteApplication` method to activate a manifest-based application. If the `Start` method is called first, the `ExecuteApplication` method call will fail. + +## 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 2.0 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md index 95b2992b2fb94..36d9dc8239c87 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md @@ -2,71 +2,70 @@ description: "Learn more about: ICLRRuntimeHost::ExecuteInAppDomain Method" title: "ICLRRuntimeHost::ExecuteInAppDomain Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeHost.ExecuteInAppDomain" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeHost::ExecuteInAppDomain" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeHost::ExecuteInAppDomain method [.NET Framework hosting]" - "ExecuteInAppDomain method [.NET Framework hosting]" -ms.assetid: e2b0e2db-3fae-4b56-844e-d30a125a660c -topic_type: +topic_type: - "apiref" --- # ICLRRuntimeHost::ExecuteInAppDomain Method -Specifies the in which to execute the specified managed code. - -## Syntax - -```cpp -HRESULT ExecuteInAppDomain( +Specifies the in which to execute the specified managed code. + +## Syntax + +```cpp +HRESULT ExecuteInAppDomain( [in] DWORD AppDomainId, [in] FExecuteInDomainCallback pCallback, - [in] void* cookie -); -``` - -## Parameters - - `AppDomainId` - [in] The numeric ID of the in which to execute the specified method. - - `pCallback` - [in] A pointer to the function to execute within the specified . - - `cookie` - [in] A pointer to opaque caller-allocated memory. This parameter is passed by the common language runtime (CLR) to the domain callback. It is not runtime-managed heap memory; both the allocation and lifetime of this memory are controlled by the caller. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`ExecuteInAppDomain` 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.| - -## Remarks - - `ExecuteInAppDomain` allows the host to exercise control over which managed the specified managed method should be executed in. You can get the value of an application domain's identifier, which corresponds to the value of the property, by calling [GetCurrentAppDomainId Method](iclrruntimehost-getcurrentappdomainid-method.md). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - + [in] void* cookie +); +``` + +## Parameters + + `AppDomainId` + [in] The numeric ID of the in which to execute the specified method. + + `pCallback` + [in] A pointer to the function to execute within the specified . + + `cookie` + [in] A pointer to opaque caller-allocated memory. This parameter is passed by the common language runtime (CLR) to the domain callback. It is not runtime-managed heap memory; both the allocation and lifetime of this memory are controlled by the caller. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`ExecuteInAppDomain` 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.| + +## Remarks + + `ExecuteInAppDomain` allows the host to exercise control over which managed the specified managed method should be executed in. You can get the value of an application domain's identifier, which corresponds to the value of the property, by calling [GetCurrentAppDomainId Method](iclrruntimehost-getcurrentappdomainid-method.md). + +## 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 2.0 + ## See also - [ICLRRuntimeHost Interface](iclrruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md index b7f13bbb8cb90..bbd0b36485894 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md @@ -2,85 +2,84 @@ description: "Learn more about: ICLRRuntimeHost::ExecuteInDefaultAppDomain Method" title: "ICLRRuntimeHost::ExecuteInDefaultAppDomain Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeHost.ExecuteInDefaultAppDomain" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeHost::ExecuteInDefaultAppDomain" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeHost::ExecuteInDefaultAppDomain method [.NET Framework hosting]" - "ExecuteInDefaultAppDomain method [.NET Framework hosting]" -ms.assetid: 30b5cf9a-a762-4bd4-be12-d6c1442b78b1 -topic_type: +topic_type: - "apiref" --- # ICLRRuntimeHost::ExecuteInDefaultAppDomain Method -Calls the specified method of the specified type in the specified managed assembly. - -## Syntax - -```cpp -HRESULT ExecuteInDefaultAppDomain ( - [in] LPCWSTR pwzAssemblyPath, +Calls the specified method of the specified type in the specified managed assembly. + +## Syntax + +```cpp +HRESULT ExecuteInDefaultAppDomain ( + [in] LPCWSTR pwzAssemblyPath, [in] LPCWSTR pwzTypeName, - [in] LPCWSTR pwzMethodName, - [in] LPCWSTR pwzArgument, - [out] DWORD *pReturnValue -); -``` - -## Parameters - - `pwzAssemblyPath` - [in] The path to the that defines the whose method is to be invoked. - - `pwzTypeName` - [in] The name of the that defines the method to invoke. - - `pwzMethodName` - [in] The name of the method to invoke. - - `pwzArgument` - [in] The string parameter to pass to the method. - - `pReturnValue` - [out] The integer value returned by the invoked method. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`ExecuteInDefaultAppDomain` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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 CRL is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The invoked method must have the following signature: - -```cpp -static int pwzMethodName (String pwzArgument) -``` - - where `pwzMethodName` represents the name of the invoked method, and `pwzArgument` represents the string value passed as a parameter to that method. If the HRESULT value is set to S_OK, `pReturnValue` is set to the integer value returned by the invoked method. Otherwise, `pReturnValue` is not set. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - + [in] LPCWSTR pwzMethodName, + [in] LPCWSTR pwzArgument, + [out] DWORD *pReturnValue +); +``` + +## Parameters + + `pwzAssemblyPath` + [in] The path to the that defines the whose method is to be invoked. + + `pwzTypeName` + [in] The name of the that defines the method to invoke. + + `pwzMethodName` + [in] The name of the method to invoke. + + `pwzArgument` + [in] The string parameter to pass to the method. + + `pReturnValue` + [out] The integer value returned by the invoked method. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`ExecuteInDefaultAppDomain` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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 CRL is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The invoked method must have the following signature: + +```cpp +static int pwzMethodName (String pwzArgument) +``` + + where `pwzMethodName` represents the name of the invoked method, and `pwzArgument` represents the string value passed as a parameter to that method. If the HRESULT value is set to S_OK, `pReturnValue` is set to the integer value returned by the invoked method. Otherwise, `pReturnValue` is not set. + +## 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 2.0 + ## See also - [ICLRRuntimeHost Interface](iclrruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md index e18c8296f859a..167dd80414642 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md @@ -2,64 +2,63 @@ description: "Learn more about: ICLRRuntimeHost::GetCLRControl Method" title: "ICLRRuntimeHost::GetCLRControl Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeHost.GetCLRControl" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeHost::GetCLRControl" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeHost::GetCLRControl method [.NET Framework hosting]" - "GetCLRControl method [.NET Framework hosting]" -ms.assetid: e47e3655-efd5-4572-a1dc-50c69bf2a468 -topic_type: +topic_type: - "apiref" --- # ICLRRuntimeHost::GetCLRControl Method -Gets an interface pointer of type [ICLRControl Interface](iclrcontrol-interface.md) that hosts can use to customize aspects of the common language runtime (CLR). - -## Syntax - -```cpp -HRESULT GetCLRControl( - [out] ICLRControl** pCLRControl -); -``` - -## Parameters - - `pCLRControl` - [out] An interface pointer of type [ICLRControl Interface](iclrcontrol-interface.md) that enables hosts to configure additional aspects of the CLR. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetCLRControl` 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.| -|HOST_E_INVALIDOPERATION|The CLR has already started.| - -## Remarks - - `ICLRControl` provides the [GetCLRManager Method](iclrcontrol-getclrmanager-method.md) method, which enables the host to get an interface pointer to one of the manager types. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets an interface pointer of type [ICLRControl Interface](iclrcontrol-interface.md) that hosts can use to customize aspects of the common language runtime (CLR). + +## Syntax + +```cpp +HRESULT GetCLRControl( + [out] ICLRControl** pCLRControl +); +``` + +## Parameters + + `pCLRControl` + [out] An interface pointer of type [ICLRControl Interface](iclrcontrol-interface.md) that enables hosts to configure additional aspects of the CLR. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetCLRControl` 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.| +|HOST_E_INVALIDOPERATION|The CLR has already started.| + +## Remarks + + `ICLRControl` provides the [GetCLRManager Method](iclrcontrol-getclrmanager-method.md) method, which enables the host to get an interface pointer to one of the manager types. + +## 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 2.0 + ## See also - [ICLRControl Interface](iclrcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md index e5671b742597e..ad765a2086294 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md @@ -2,63 +2,62 @@ description: "Learn more about: ICLRRuntimeHost::GetCurrentAppDomainId Method" title: "ICLRRuntimeHost::GetCurrentAppDomainId Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeHost.GetCurrentAppDomainId" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeHost::GetCurrentAppDomainId" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeHost::GetCurrentAppDomainId method [.NET Framework hosting]" - "GetCurrentAppDomainId method [.NET Framework hosting]" -ms.assetid: 33800475-7815-4976-8aca-a1038761a2ef -topic_type: +topic_type: - "apiref" --- # ICLRRuntimeHost::GetCurrentAppDomainId Method -Gets the numeric identifier of the that is currently executing. - -## Syntax - -```cpp -HRESULT GetCurrentAppDomainId( - [out] DWORD* pdwAppDomainId -); -``` - -## Parameters - - `pdwAppDomainId` - [out] The numeric identifier of the that is currently executing. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetCurrentAppDomainId` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| - -## Remarks - - The `pdwAppDomainId` parameter is set to the value of the property of the in which the current thread is executing. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the numeric identifier of the that is currently executing. + +## Syntax + +```cpp +HRESULT GetCurrentAppDomainId( + [out] DWORD* pdwAppDomainId +); +``` + +## Parameters + + `pdwAppDomainId` + [out] The numeric identifier of the that is currently executing. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetCurrentAppDomainId` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| + +## Remarks + + The `pdwAppDomainId` parameter is set to the value of the property of the in which the current thread is executing. + +## 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 2.0 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md index 411cc86455b1e..910063ceaec7a 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md @@ -2,59 +2,58 @@ description: "Learn more about: ICLRRuntimeHost Interface" title: "ICLRRuntimeHost Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeHost" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeHost" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeHost interface [.NET Framework hosting]" -ms.assetid: cb0c5f65-3791-47bc-b833-2f84f4101ba5 -topic_type: +topic_type: - "apiref" --- # ICLRRuntimeHost Interface -Provides functionality similar to that of the [ICorRuntimeHost](icorruntimehost-interface.md) interface provided in the .NET Framework version 1, with the following changes: - -- The addition of the [SetHostControl](iclrruntimehost-sethostcontrol-method.md) method to set the host control interface. - -- The omission of some methods provided by `ICorRuntimeHost`. - -## Methods - -|Method|Description| -|------------|-----------------| -|[ExecuteApplication Method](iclrruntimehost-executeapplication-method.md)|Used in manifest-based ClickOnce deployment scenarios to specify the application to be activated in a new domain.| -|[ExecuteInAppDomain Method](iclrruntimehost-executeinappdomain-method.md)|Specifies the in which to execute the specified managed code.| -|[ExecuteInDefaultAppDomain Method](iclrruntimehost-executeindefaultappdomain-method.md)|Invokes the specified method of the specified type in the specified assembly.| -|[GetCLRControl Method](iclrruntimehost-getclrcontrol-method.md)|Gets an interface pointer of type [ICLRControl](iclrcontrol-interface.md) that hosts can use to customize aspects of the common language runtime (CLR).| -|[GetCurrentAppDomainId Method](iclrruntimehost-getcurrentappdomainid-method.md)|Gets the numeric identifier of the that is currently executing.| -|[SetHostControl Method](iclrruntimehost-sethostcontrol-method.md)|Sets the host control interface. You must call `SetHostControl` before calling `Start`.| -|[Start Method](iclrruntimehost-start-method.md)|Initializes the CLR into a process.| -|[Stop Method](iclrruntimehost-stop-method.md)|Stops the execution of code by the runtime.| -|[UnloadAppDomain Method](iclrruntimehost-unloadappdomain-method.md)|Unloads the that corresponds to the specified numeric identifier.| - -## Remarks +Provides functionality similar to that of the [ICorRuntimeHost](icorruntimehost-interface.md) interface provided in the .NET Framework version 1, with the following changes: + +- The addition of the [SetHostControl](iclrruntimehost-sethostcontrol-method.md) method to set the host control interface. + +- The omission of some methods provided by `ICorRuntimeHost`. + +## Methods + +|Method|Description| +|------------|-----------------| +|[ExecuteApplication Method](iclrruntimehost-executeapplication-method.md)|Used in manifest-based ClickOnce deployment scenarios to specify the application to be activated in a new domain.| +|[ExecuteInAppDomain Method](iclrruntimehost-executeinappdomain-method.md)|Specifies the in which to execute the specified managed code.| +|[ExecuteInDefaultAppDomain Method](iclrruntimehost-executeindefaultappdomain-method.md)|Invokes the specified method of the specified type in the specified assembly.| +|[GetCLRControl Method](iclrruntimehost-getclrcontrol-method.md)|Gets an interface pointer of type [ICLRControl](iclrcontrol-interface.md) that hosts can use to customize aspects of the common language runtime (CLR).| +|[GetCurrentAppDomainId Method](iclrruntimehost-getcurrentappdomainid-method.md)|Gets the numeric identifier of the that is currently executing.| +|[SetHostControl Method](iclrruntimehost-sethostcontrol-method.md)|Sets the host control interface. You must call `SetHostControl` before calling `Start`.| +|[Start Method](iclrruntimehost-start-method.md)|Initializes the CLR into a process.| +|[Stop Method](iclrruntimehost-stop-method.md)|Stops the execution of code by the runtime.| +|[UnloadAppDomain Method](iclrruntimehost-unloadappdomain-method.md)|Unloads the that corresponds to the specified numeric identifier.| + +## Remarks + + Starting with the .NET Framework 4, use the [ICLRMetaHost](iclrmetahost-interface.md) interface to get a pointer to the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface, and then call the [ICLRRuntimeInfo::GetInterface](iclrruntimeinfo-getinterface-method.md) method to get a pointer to `ICLRRuntimeHost`. In earlier versions of the .NET Framework, the host gets a pointer to an `ICLRRuntimeHost` instance by calling [CorBindToRuntimeEx](corbindtoruntimeex-function.md) or [CorBindToCurrentRuntime](corbindtocurrentruntime-function.md). To provide implementations of any of the technologies provided in .NET Framework version 2.0, you must use `ICLRRuntimeHost` instead of `ICorRuntimeHost`. - Starting with the .NET Framework 4, use the [ICLRMetaHost](iclrmetahost-interface.md) interface to get a pointer to the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface, and then call the [ICLRRuntimeInfo::GetInterface](iclrruntimeinfo-getinterface-method.md) method to get a pointer to `ICLRRuntimeHost`. In earlier versions of the .NET Framework, the host gets a pointer to an `ICLRRuntimeHost` instance by calling [CorBindToRuntimeEx](corbindtoruntimeex-function.md) or [CorBindToCurrentRuntime](corbindtocurrentruntime-function.md). To provide implementations of any of the technologies provided in .NET Framework version 2.0, you must use `ICLRRuntimeHost` instead of `ICorRuntimeHost`. - > [!IMPORTANT] -> Do not call the [Start](iclrruntimehost-start-method.md) method before calling the [ExecuteApplication](iclrruntimehost-executeapplication-method.md) method to activate a manifest-based application. If the `Start` method is called first, the `ExecuteApplication` method call will fail. - -## Requirements +> Do not call the [Start](iclrruntimehost-start-method.md) method before calling the [ExecuteApplication](iclrruntimehost-executeapplication-method.md) method to activate a manifest-based application. If the `Start` method is called first, the `ExecuteApplication` method call will fail. + +## 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 2.0 - **Platforms:** See [System Requirements](../../../framework/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 - [CorBindToCurrentRuntime Function](corbindtocurrentruntime-function.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md index 1ddbf5392761d..19d78b0982ea5 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md @@ -2,64 +2,63 @@ 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](../../../framework/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](../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](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [ICLRRuntimeHost Interface](iclrruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md index 5059f7c01710d..2167871d70efc 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md @@ -2,56 +2,55 @@ description: "Learn more about: ICLRRuntimeHost::Start Method" title: "ICLRRuntimeHost::Start Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeHost.Start" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeHost::Start" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeHost::Start method [.NET Framework hosting]" - "Start method, ICLRRuntimeHost interface [.NET Framework hosting]" -ms.assetid: c0a6dce5-0a8d-42e8-808b-6ca14df9d289 -topic_type: +topic_type: - "apiref" --- # ICLRRuntimeHost::Start Method -Initializes the common language runtime (CLR) into a process. - -## Syntax - -```cpp -HRESULT Start(); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Start` 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.| - -## Remarks - - In many scenarios it is not necessary to call `Start`, because the runtime will initialize itself automatically upon the first request to run managed code. You can, however, use `Start` to specify exactly when the runtime should be initialized. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Initializes the common language runtime (CLR) into a process. + +## Syntax + +```cpp +HRESULT Start(); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Start` 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.| + +## Remarks + + In many scenarios it is not necessary to call `Start`, because the runtime will initialize itself automatically upon the first request to run managed code. You can, however, use `Start` to specify exactly when the runtime should be initialized. + +## 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 2.0 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md index 5842ca44f9490..ea77c1052600f 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md @@ -2,55 +2,54 @@ description: "Learn more about: ICLRRuntimeHost::Stop Method" title: "ICLRRuntimeHost::Stop Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeHost.Stop" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeHost::Stop" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeHost::Stop method [.NET Framework hosting]" - "Stop method, ICLRRuntimeHost interface [.NET Framework hosting]" -ms.assetid: b8fd7daf-8f8d-4ad7-92ae-019db244cec1 -topic_type: +topic_type: - "apiref" --- # ICLRRuntimeHost::Stop Method -Stops the execution of code by the common language runtime (CLR). - +Stops the execution of code by the common language runtime (CLR). + > [!IMPORTANT] -> This method does not release resources to the host, unload application domains, or destroy threads. You must terminate the process to release these resources. - -## Syntax - -```cpp -HRESULT Stop(); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Stop` 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.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> This method does not release resources to the host, unload application domains, or destroy threads. You must terminate the process to release these resources. + +## Syntax + +```cpp +HRESULT Stop(); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Stop` 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.| + +## 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 2.0 + ## See also - [ICLRRuntimeHost Interface](iclrruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md index 6c44c6b239ae2..5c08f21ab5ef4 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md @@ -2,67 +2,66 @@ description: "Learn more about: ICLRRuntimeHost::UnloadAppDomain Method" title: "ICLRRuntimeHost::UnloadAppDomain Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeHost.UnloadAppDomain" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeHost::UnloadAppDomain" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeHost::UnloadAppDomain method [.NET Framework hosting]" - "UnloadAppDomain method [.NET Framework hosting]" -ms.assetid: 571912bc-3429-4ff8-8eb2-ea993ffbd901 -topic_type: +topic_type: - "apiref" --- # ICLRRuntimeHost::UnloadAppDomain Method -Unloads the managed that corresponds to the specified numeric identifier. - -## Syntax - -```cpp -HRESULT UnloadAppDomain( - [in] DWORD dwAppDomainId - [in] BOOL fWaitUntilDone -); -``` - -## Parameters - - `dwAppDomainId` - [in] The numeric identifier of the application domain to unload. - - `fWaitUntilDone` - [in] `true` to indicate that the common language runtime( CLR) must wait until it has finished executing the application's current thread before attempting to unload the application domain. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`UnloadAppDomain` 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.| - -## Remarks - - You can get the numeric identifier of the application domain in which the current thread is executing by calling [GetCurrentAppDomainId](iclrruntimehost-getcurrentappdomainid-method.md). This identifier corresponds to the property of the managed type. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Unloads the managed that corresponds to the specified numeric identifier. + +## Syntax + +```cpp +HRESULT UnloadAppDomain( + [in] DWORD dwAppDomainId + [in] BOOL fWaitUntilDone +); +``` + +## Parameters + + `dwAppDomainId` + [in] The numeric identifier of the application domain to unload. + + `fWaitUntilDone` + [in] `true` to indicate that the common language runtime( CLR) must wait until it has finished executing the application's current thread before attempting to unload the application domain. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`UnloadAppDomain` 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.| + +## Remarks + + You can get the numeric identifier of the application domain in which the current thread is executing by calling [GetCurrentAppDomainId](iclrruntimehost-getcurrentappdomainid-method.md). This identifier corresponds to the property of the managed type. + +## 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 2.0 + ## See also - [ICLRRuntimeHost Interface](iclrruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md index ee579aa6b59fa..868512a0a59fe 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md @@ -2,57 +2,56 @@ description: "Learn more about: ICLRRuntimeInfo::BindAsLegacyV2Runtime Method" title: "ICLRRuntimeInfo::BindAsLegacyV2Runtime Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeInfo.BindAsLegacyV2Runtime" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeInfo::BindAsLegacyV2Runtime" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeInfo::BindAsLegacyV2Runtime method [.NET Framework hosting]" - "BindAsLegacyV2Runtime method [.NET Framework hosting]" -ms.assetid: 65fd55ac-4a24-4479-9384-a2e8013bfb2b -topic_type: +topic_type: - "apiref" --- # ICLRRuntimeInfo::BindAsLegacyV2Runtime Method -Binds the current runtime for all legacy common language runtime (CLR) version 2 activation policy decisions. - -## Syntax - -```cpp -HRESULT BindAsLegacyV2Runtime (); -``` - -## Return Value - - This method returns the following specific HRESULTs: - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|Either binding succeeded, or this runtime was already bound as the legacy CLR version 2 activation policy runtime.| -|CLR_E_SHIM_LEGACYRUNTIMEALREADYBOUND|A different runtime was already bound to the legacy CLR version 2 activation policy.| - -## Remarks - - If the current runtime is already bound for all legacy CLR version 2 activation policy decisions (for example, by using the `useLegacyV2RuntimeActivationPolicy` attribute on the [\ element](../../configure-apps/file-schema/startup/startup-element.md) in the configuration file), this method does not return an error result; instead, the result is S_OK, just as it would be if the method had successfully bound legacy activation policy. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Binds the current runtime for all legacy common language runtime (CLR) version 2 activation policy decisions. + +## Syntax + +```cpp +HRESULT BindAsLegacyV2Runtime (); +``` + +## Return Value + + This method returns the following specific HRESULTs: + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|Either binding succeeded, or this runtime was already bound as the legacy CLR version 2 activation policy runtime.| +|CLR_E_SHIM_LEGACYRUNTIMEALREADYBOUND|A different runtime was already bound to the legacy CLR version 2 activation policy.| + +## Remarks + + If the current runtime is already bound for all legacy CLR version 2 activation policy decisions (for example, by using the `useLegacyV2RuntimeActivationPolicy` attribute on the [\ element](../../../framework/configure-apps/file-schema/startup/startup-element.md) in the configuration file), this method does not return an error result; instead, the result is S_OK, just as it would be if the method had successfully bound legacy activation policy. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) - [Hosting Interfaces](hosting-interfaces.md) - [Hosting](index.md) -- [\ Element](../../configure-apps/file-schema/startup/startup-element.md) +- [\ Element](../../../framework/configure-apps/file-schema/startup/startup-element.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md index c9c416b3d3a72..3d25b2983712e 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md @@ -2,67 +2,66 @@ description: "Learn more about: ICLRRuntimeInfo::GetDefaultStartupFlags Method" title: "ICLRRuntimeInfo::GetDefaultStartupFlags Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeInfo.GetDefaultStartupFlags" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeInfo::GetDefaultStartupFlags" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeInfo::GetDefaultStartupFlags method [.NET Framework hosting]" - "GetDefaultStartupFlags method [.NET Framework hosting]" -ms.assetid: 35c2173e-3b0b-4b2a-950d-e0a01c6df052 -topic_type: +topic_type: - "apiref" --- # ICLRRuntimeInfo::GetDefaultStartupFlags Method -Gets the startup flags and host configuration file that will be used to start the runtime. - -## Syntax - -```cpp -HRESULT GetDefaultStartupFlags( - [out] DWORD *pdwStartupFlags, - [out, size_is(*pcchHostConfigFile)] LPWSTR pwzHostConfigFile, - [in, out] DWORD *pcchHostConfigFile); -``` - -## Parameters - - `pdwStartupFlags` - [out] A pointer to the host startup flags that are currently set. - - `pwzHostConfigFile` - [out] A pointer to the directory path of the current host configuration file. - - `pcchHostConfigFile` - [in, out] On input, the size of `pwzHostConfigFile`, to avoid buffer overruns. If `pwzHostConfigFile` is null, the method returns the required size of `pwzHostConfigFile` for pre-allocation. - -## Return Value - - This method returns the following specific HRESULT as well as HRESULT errors that indicate method failure. - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method completed successfully.| - -## Remarks - - This method returns the default flag values (`STARTUP_CONCURRENT_GC` and `NULL`), or the values provided by a previous call to the [ICLRRuntimeInfo::SetDefaultStartupFlags method](iclrruntimeinfo-setdefaultstartupflags-method.md), or the values set by any of the `CorBind*` methods if they are bound to this runtime. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the startup flags and host configuration file that will be used to start the runtime. + +## Syntax + +```cpp +HRESULT GetDefaultStartupFlags( + [out] DWORD *pdwStartupFlags, + [out, size_is(*pcchHostConfigFile)] LPWSTR pwzHostConfigFile, + [in, out] DWORD *pcchHostConfigFile); +``` + +## Parameters + + `pdwStartupFlags` + [out] A pointer to the host startup flags that are currently set. + + `pwzHostConfigFile` + [out] A pointer to the directory path of the current host configuration file. + + `pcchHostConfigFile` + [in, out] On input, the size of `pwzHostConfigFile`, to avoid buffer overruns. If `pwzHostConfigFile` is null, the method returns the required size of `pwzHostConfigFile` for pre-allocation. + +## Return Value + + This method returns the following specific HRESULT as well as HRESULT errors that indicate method failure. + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method completed successfully.| + +## Remarks + + This method returns the default flag values (`STARTUP_CONCURRENT_GC` and `NULL`), or the values provided by a previous call to the [ICLRRuntimeInfo::SetDefaultStartupFlags method](iclrruntimeinfo-setdefaultstartupflags-method.md), or the values set by any of the `CorBind*` methods if they are bound to this runtime. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md index 4e85f2095d5cd..a1ddd9d2b19b8 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md @@ -2,84 +2,83 @@ 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](../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](../../../framework/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](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md index e2fc2bb4cc718..ba576765e76f7 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md @@ -2,67 +2,66 @@ description: "Learn more about: ICLRRuntimeInfo::GetProcAddress Method" title: "ICLRRuntimeInfo::GetProcAddress Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeInfo.GetProcAddress" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeInfo::GetProcAddress" -helpviewer_keywords: +helpviewer_keywords: - "GetProcAddress method [.NET Framework hosting]" - "ICLRRuntimeInfo::GetProcAddress method [.NET Framework hosting]" -ms.assetid: a7732bfc-689a-4926-88fd-4f81e6f9ed78 -topic_type: +topic_type: - "apiref" --- # ICLRRuntimeInfo::GetProcAddress Method -Gets the address of a specified function that was exported from the common language runtime (CLR) associated with this interface. - - This method supersedes the [GetRealProcAddress](getrealprocaddress-function.md) function. - -## Syntax - -```cpp -HRESULT GetProcAddress( - [in] LPCSTR pszProcName, - [out, retval] LPVOID *ppProc); -``` - -## Parameters - - `pszProcName` - [in] The name of the exported function. - - `ppProc` - [out] The address of the exported function. - -## 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|`pszProcName` or `ppProc` is null.| -|CLR_E_SHIM_RUNTIMEEXPORT|The specified function is not an exported function.| - -## Remarks - - This method causes the CLR to be loaded but not initialized. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the address of a specified function that was exported from the common language runtime (CLR) associated with this interface. + + This method supersedes the [GetRealProcAddress](getrealprocaddress-function.md) function. + +## Syntax + +```cpp +HRESULT GetProcAddress( + [in] LPCSTR pszProcName, + [out, retval] LPVOID *ppProc); +``` + +## Parameters + + `pszProcName` + [in] The name of the exported function. + + `ppProc` + [out] The address of the exported function. + +## 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|`pszProcName` or `ppProc` is null.| +|CLR_E_SHIM_RUNTIMEEXPORT|The specified function is not an exported function.| + +## Remarks + + This method causes the CLR to be loaded but not initialized. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md index 0e1aebfe24860..d5dad26cf1499 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md @@ -2,64 +2,63 @@ description: "Learn more about: ICLRRuntimeInfo::GetRuntimeDirectory Method" title: "ICLRRuntimeInfo::GetRuntimeDirectory Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeInfo.GetRuntimeDirectory" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeInfo::GetRuntimeDirectory" -helpviewer_keywords: +helpviewer_keywords: - "GetRuntimeDirectory method [.NET Framework hosting]" - "ICLRRuntimeInfo::GetRuntimeDirectory method [.NET Framework hosting]" -ms.assetid: 4401546e-4d48-453f-a1fb-b2ebda54df5c -topic_type: +topic_type: - "apiref" --- # ICLRRuntimeInfo::GetRuntimeDirectory Method -Gets the installation directory of the common language runtime (CLR) associated with this interface. - - This method supersedes the [GetCORSystemDirectory](getcorsystemdirectory-function.md) function provided in the .NET Framework versions 2.0, 3.0, and 3.5. - -## Syntax - -```cpp -HRESULT GetRuntimeDirectory( -[out, size_is(*pcchBuffer)] LPWSTR pwzBuffer, -[in, out] DWORD *pcchBuffer); -``` - -## Parameters - - `pwzBuffer` - [out] Returns the CLR installation directory. The installation path is fully qualified; for example, "c:\windows\microsoft.net\framework\v1.0.3705\\". - - `pchBuffer` - [in, out] Specifies the size of `pwzBuffer` to avoid buffer overruns. If `pwzBuffer` is null, `pchBuffer` returns the required size of `pwzBuffer`. - -## 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|`pwzBuffer` or `pchBuffer` is null.| - -## Remarks - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the installation directory of the common language runtime (CLR) associated with this interface. + + This method supersedes the [GetCORSystemDirectory](getcorsystemdirectory-function.md) function provided in the .NET Framework versions 2.0, 3.0, and 3.5. + +## Syntax + +```cpp +HRESULT GetRuntimeDirectory( +[out, size_is(*pcchBuffer)] LPWSTR pwzBuffer, +[in, out] DWORD *pcchBuffer); +``` + +## Parameters + + `pwzBuffer` + [out] Returns the CLR installation directory. The installation path is fully qualified; for example, "c:\windows\microsoft.net\framework\v1.0.3705\\". + + `pchBuffer` + [in, out] Specifies the size of `pwzBuffer` to avoid buffer overruns. If `pwzBuffer` is null, `pchBuffer` returns the required size of `pwzBuffer`. + +## 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|`pwzBuffer` or `pchBuffer` is null.| + +## Remarks + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md index fd11a402bc7ce..bc68f4bd7c7b6 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md @@ -2,71 +2,70 @@ description: "Learn more about: ICLRRuntimeInfo::GetVersionString Method" title: "ICLRRuntimeInfo::GetVersionString Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeInfo.GetVersionString" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeInfo::GetVersionString" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeInfo::GetVersionString method [.NET Framework hosting]" - "GetVersionString method, ICLRRuntimeInfo interface [.NET Framework hosting]" -ms.assetid: 98b097ef-2276-4dd9-8551-b03c972e8179 -topic_type: +topic_type: - "apiref" --- # ICLRRuntimeInfo::GetVersionString Method -Gets common language runtime (CLR) version information associated with a given [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface. - - This method supersedes the following functions: - -- [GetRequestedRuntimeInfo](getrequestedruntimeinfo-function.md) - -- [GetRequestedRuntimeVersion](getrequestedruntimeversion-function.md) - -## Syntax - -```cpp -HRESULT GetVersionString( - [out, size_is(*pcchBuffer)] LPWSTR pwzBuffer, - [in, out] DWORD *pcchBuffer); -``` - -## Parameters - - `pwzBuffer` - [out] The .NET Framework compilation version in the format "v*A*.*B*[.*X*]". *A*, *B*, and *X* are decimal numbers that correspond to the major version, the minor version, and the build number. *X* is optional. If *X* is not present, there is no trailing period. - +Gets common language runtime (CLR) version information associated with a given [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface. + + This method supersedes the following functions: + +- [GetRequestedRuntimeInfo](getrequestedruntimeinfo-function.md) + +- [GetRequestedRuntimeVersion](getrequestedruntimeversion-function.md) + +## Syntax + +```cpp +HRESULT GetVersionString( + [out, size_is(*pcchBuffer)] LPWSTR pwzBuffer, + [in, out] DWORD *pcchBuffer); +``` + +## Parameters + + `pwzBuffer` + [out] The .NET Framework compilation version in the format "v*A*.*B*[.*X*]". *A*, *B*, and *X* are decimal numbers that correspond to the major version, the minor version, and the build number. *X* is optional. If *X* is not present, there is no trailing period. + > [!NOTE] -> This parameter must match the directory name for the .NET Framework version, as it appears under C:\Windows\Microsoft.NET\Framework. - - Example values are "v1.0.3705", "v1.1.4322", "v2.0.50727", and "v4.0.*x*", where *x* depends on the build number installed. Note that the "v" prefix is mandatory. - - `pchBuffer` - [in, out] Specifies the size of `pwzBuffer` to avoid buffer overruns. If `pwzBuffer` is `null`, `pchBuffer` returns the required size of `pwzBuffer` to allow preallocation. - -## 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|`pwzBuffer` or `pchBuffer` is null.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> This parameter must match the directory name for the .NET Framework version, as it appears under C:\Windows\Microsoft.NET\Framework. + + Example values are "v1.0.3705", "v1.1.4322", "v2.0.50727", and "v4.0.*x*", where *x* depends on the build number installed. Note that the "v" prefix is mandatory. + + `pchBuffer` + [in, out] Specifies the size of `pwzBuffer` to avoid buffer overruns. If `pwzBuffer` is `null`, `pchBuffer` returns the required size of `pwzBuffer` to allow preallocation. + +## 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|`pwzBuffer` or `pchBuffer` is null.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md index b486815968599..74de2f210f43f 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md @@ -2,51 +2,50 @@ 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](../../../framework/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](../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](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md index 0ae7f453f8dc7..eaf9162c17918 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md @@ -2,62 +2,61 @@ description: "Learn more about: ICLRRuntimeInfo::IsLoadable Method" title: "ICLRRuntimeInfo::IsLoadable Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeInfo.IsLoadable" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeInfo::IsLoadable" -helpviewer_keywords: +helpviewer_keywords: - "IsLoadable method [.NET Framework hosting]" - "ICLRRuntimeInfo::IsLoadable method [.NET Framework hosting]" -ms.assetid: 205ca53b-e78e-49b2-9a46-2a7823e96b8c -topic_type: +topic_type: - "apiref" --- # ICLRRuntimeInfo::IsLoadable Method -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. - -## Syntax - -```cpp -HRESULT IsLoadable( - [out, retval] BOOL *pbLoadable); -``` - -## Parameters - - `pbLoadable` - [out] `true` if this runtime could be loaded into the current process; otherwise, `false`. - -## 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|`pbLoadable` is null.| - -## Remarks - - If another runtime is already loaded into the process, and the runtime associated with this interface can be loaded for in-process side-by-side execution, `pbLoadable` returns `true`. If the two runtimes cannot run side-by-side in-process, `pbLoadable` returns `false`. For example, the common language runtime (CLR) version 4 can run side-by-side in the same process with CLR version 2.0 or CLR version 1.1. However, CLR version 1.1 and CLR version 2.0 cannot run side-by-side in-process. - - If no runtimes are loaded into the process, this method always returns `true`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +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. + +## Syntax + +```cpp +HRESULT IsLoadable( + [out, retval] BOOL *pbLoadable); +``` + +## Parameters + + `pbLoadable` + [out] `true` if this runtime could be loaded into the current process; otherwise, `false`. + +## 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|`pbLoadable` is null.| + +## Remarks + + If another runtime is already loaded into the process, and the runtime associated with this interface can be loaded for in-process side-by-side execution, `pbLoadable` returns `true`. If the two runtimes cannot run side-by-side in-process, `pbLoadable` returns `false`. For example, the common language runtime (CLR) version 4 can run side-by-side in the same process with CLR version 2.0 or CLR version 1.1. However, CLR version 1.1 and CLR version 2.0 cannot run side-by-side in-process. + + If no runtimes are loaded into the process, this method always returns `true`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md index 265eb243e9224..e765395ce09f7 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md @@ -2,74 +2,73 @@ description: "Learn more about: ICLRRuntimeInfo::IsLoaded Method" title: "ICLRRuntimeInfo::IsLoaded Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeInfo.IsLoaded" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeInfo::IsLoaded" -helpviewer_keywords: +helpviewer_keywords: - "IsLoaded method [.NET Framework hosting]" - "ICLRRuntimeInfo::IsLoaded method [.NET Framework hosting]" -ms.assetid: fdc5a3a7-71ff-4025-99a1-59e4ee0bfe1b -topic_type: +topic_type: - "apiref" --- # ICLRRuntimeInfo::IsLoaded Method -Indicates whether the common language runtime (CLR) associated with the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface is loaded into a process. A runtime can be loaded without also being started. - -## Syntax - -```cpp -HRESULT IsLoaded( -[in] HANDLE hndProcess, -[out, retval] BOOL *pbLoaded); -``` - -## Parameters - - `hndProcess` - [in] A handle to the process. - - `pbLoaded` - [out] `true` if the CLR is loaded into the process; otherwise, `false`. - -## 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|`pbLoaded` is null.| - -## Remarks - - This method is backward-compatible with the following functions and interfaces: - -- [ICorRuntimeHost](icorruntimehost-interface.md) interface (in the .NET Framework version 1 hosting API). - -- [ICLRRuntimeHost](iclrruntimehost-interface.md) interface (in the .NET Framework 2.0 hosting API). - -- Deprecated `CorBindTo*` functions (see [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) in the .NET Framework 2.0 hosting API). - - A host may call one of the deprecated `CorBindTo*` functions, such as the [CorBindToRuntime](corbindtoruntime-function.md) function, to instantiate a specific version of the CLR. The host could then call the [ICLRMetaHost::GetRuntime](iclrmetahost-getruntime-method.md) method and specify the same version number to obtain a [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface. - - If the host then calls the `IsLoaded` method on the returned [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface, `pbLoaded` returns `true`; otherwise, it returns `false`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Indicates whether the common language runtime (CLR) associated with the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface is loaded into a process. A runtime can be loaded without also being started. + +## Syntax + +```cpp +HRESULT IsLoaded( +[in] HANDLE hndProcess, +[out, retval] BOOL *pbLoaded); +``` + +## Parameters + + `hndProcess` + [in] A handle to the process. + + `pbLoaded` + [out] `true` if the CLR is loaded into the process; otherwise, `false`. + +## 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|`pbLoaded` is null.| + +## Remarks + + This method is backward-compatible with the following functions and interfaces: + +- [ICorRuntimeHost](icorruntimehost-interface.md) interface (in the .NET Framework version 1 hosting API). + +- [ICLRRuntimeHost](iclrruntimehost-interface.md) interface (in the .NET Framework 2.0 hosting API). + +- Deprecated `CorBindTo*` functions (see [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) in the .NET Framework 2.0 hosting API). + + A host may call one of the deprecated `CorBindTo*` functions, such as the [CorBindToRuntime](corbindtoruntime-function.md) function, to instantiate a specific version of the CLR. The host could then call the [ICLRMetaHost::GetRuntime](iclrmetahost-getruntime-method.md) method and specify the same version number to obtain a [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface. + + If the host then calls the `IsLoaded` method on the returned [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface, `pbLoaded` returns `true`; otherwise, it returns `false`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md index 348df3cfdaa85..c615511c88ea1 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md @@ -2,62 +2,61 @@ description: "Learn more about: ICLRRuntimeInfo::IsStarted Method" title: "ICLRRuntimeInfo::IsStarted Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeInfo.IsStarted" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeInfo::IsStarted" -helpviewer_keywords: +helpviewer_keywords: - "IsStarted method [.NET Framework hosting]" - "ICLRRuntimeInfo::IsStarted method [.NET Framework hosting]" -ms.assetid: ef6f2662-323b-4534-aa82-6d1afb7b9309 --- # ICLRRuntimeInfo::IsStarted Method -Indicates whether the runtime has been started (that is, whether the [ICLRRuntimeHost::Start method](iclrruntimehost-start-method.md) has been called and has succeeded). - -## Syntax - -```cpp -HRESULT IsStarted( - [out] BOOL *pbStarted, - [out] DWORD *pdwStartupFlags); -``` - -## Parameters - - `pbStarted` - [out] `true` if this runtime is started; otherwise, `false`. - - `pdwStartupFlags` - [out] Returns the flags that were used to start the runtime. - -## 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_NOTIMPL|The common language runtime (CLR) version is earlier than the CLR version in the .NET Framework 4.| - -## Remarks - - This method does not work with CLR versions earlier than the CLR version in the .NET Framework 4. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Indicates whether the runtime has been started (that is, whether the [ICLRRuntimeHost::Start method](iclrruntimehost-start-method.md) has been called and has succeeded). + +## Syntax + +```cpp +HRESULT IsStarted( + [out] BOOL *pbStarted, + [out] DWORD *pdwStartupFlags); +``` + +## Parameters + + `pbStarted` + [out] `true` if this runtime is started; otherwise, `false`. + + `pdwStartupFlags` + [out] Returns the flags that were used to start the runtime. + +## 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_NOTIMPL|The common language runtime (CLR) version is earlier than the CLR version in the .NET Framework 4.| + +## Remarks + + This method does not work with CLR versions earlier than the CLR version in the .NET Framework 4. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md index 2ba57a467add5..13ed1e2e30ed0 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md @@ -2,75 +2,74 @@ description: "Learn more about: ICLRRuntimeInfo::LoadErrorString Method" title: "ICLRRuntimeInfo::LoadErrorString Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeInfo.LoadErrorString" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeInfo::LoadErrorString" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeInfo::LoadErrorString method [.NET Framework hosting]" - "LoadErrorString method [.NET Framework hosting]" -ms.assetid: 52c543ab-9ef5-4ee7-b836-c0ffc35cd45b -topic_type: +topic_type: - "apiref" --- # ICLRRuntimeInfo::LoadErrorString Method -Translates an HRESULT value into an appropriate error message for the specified culture. - - This method supersedes the following functions: - -- [LoadStringRC](loadstringrc-function.md) - -- [LoadStringRCEx](loadstringrcex-function.md) - -## Syntax - -```cpp -HRESULT LoadErrorString( - [in] UINT iResourceID, - [out, size_is(*pcchBuffer)] LPWSTR pwzBuffer, - [in, out] DWORD *pcchBuffer, - [in, lcid] LONG iLocaleID); -``` - -## Parameters - - `iResourceID` - [in] The HRESULT to translate. - - `pwzBuffer` - [out] The message string associated with the given HRESULT. - - `pcchBuffer` - [in, out] The size of `pwzbuffer` to avoid buffer overruns. If `pwzbuffer` is null, `pcchBuffer` provides the expected size of `pwzbuffer` to allow preallocation. - - `iLocaleID` - [in] The culture identifier. To use the default culture, you must specify -1. - -## 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|`pcchBuffer` is null.| -|E_INVALIDARG|`pwzBuffer` is null.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Translates an HRESULT value into an appropriate error message for the specified culture. + + This method supersedes the following functions: + +- [LoadStringRC](loadstringrc-function.md) + +- [LoadStringRCEx](loadstringrcex-function.md) + +## Syntax + +```cpp +HRESULT LoadErrorString( + [in] UINT iResourceID, + [out, size_is(*pcchBuffer)] LPWSTR pwzBuffer, + [in, out] DWORD *pcchBuffer, + [in, lcid] LONG iLocaleID); +``` + +## Parameters + + `iResourceID` + [in] The HRESULT to translate. + + `pwzBuffer` + [out] The message string associated with the given HRESULT. + + `pcchBuffer` + [in, out] The size of `pwzbuffer` to avoid buffer overruns. If `pwzbuffer` is null, `pcchBuffer` provides the expected size of `pwzbuffer` to allow preallocation. + + `iLocaleID` + [in] The culture identifier. To use the default culture, you must specify -1. + +## 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|`pcchBuffer` is null.| +|E_INVALIDARG|`pwzBuffer` is null.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md index aab39430bc0d3..3a0681317ffe2 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md @@ -2,67 +2,66 @@ description: "Learn more about: ICLRRuntimeInfo::LoadLibrary Method" title: "ICLRRuntimeInfo::LoadLibrary Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeInfo.LoadLibrary" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeInfo::LoadLibrary" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeInfo::LoadLibrary method [.NET Framework hosting]" - "LoadLibrary method [.NET Framework hosting]" -ms.assetid: 4517ada3-4417-4ac5-a150-73da7a87c686 -topic_type: +topic_type: - "apiref" --- # ICLRRuntimeInfo::LoadLibrary Method -Loads a .NET Framework library from the common language runtime (CLR) represented by an [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface. - - This method supersedes the [LoadLibraryShim](loadlibraryshim-function.md) function. - -## Syntax - -```cpp -HRESULT LoadLibrary( - [in] LPCWSTR pwzDllName, - [out, retval] HMODULE *phndModule); -``` - -## Parameters - - `pwzDllName` - [in] The name of the assembly to be loaded. - - `phndModule` - [out] A handle to the loaded assembly. - -## 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|`pwzDllName` or `phndModule` is null.| -|E_OUTOFMEMORY|Not enough memory is available to handle the request.| - -## Remarks - - This method only loads DLLs included in the .NET Framework redistributable package. It can not load user-generated assemblies. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Loads a .NET Framework library from the common language runtime (CLR) represented by an [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface. + + This method supersedes the [LoadLibraryShim](loadlibraryshim-function.md) function. + +## Syntax + +```cpp +HRESULT LoadLibrary( + [in] LPCWSTR pwzDllName, + [out, retval] HMODULE *phndModule); +``` + +## Parameters + + `pwzDllName` + [in] The name of the assembly to be loaded. + + `phndModule` + [out] A handle to the loaded assembly. + +## 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|`pwzDllName` or `phndModule` is null.| +|E_OUTOFMEMORY|Not enough memory is available to handle the request.| + +## Remarks + + This method only loads DLLs included in the .NET Framework redistributable package. It can not load user-generated assemblies. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md index 0da48f7ce78f0..db5b91bfeec60 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md +++ b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md @@ -2,63 +2,62 @@ description: "Learn more about: ICLRRuntimeInfo::SetDefaultStartupFlags Method" title: "ICLRRuntimeInfo::SetDefaultStartupFlags Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeInfo.SetDefaultStartupFlags" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeInfo::SetDefaultStartupFlags" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeInfo::SetDefaultStartupFlags method [.NET Framework hosting]" - "SetDefaultStartupFlags method [.NET Framework hosting]" -ms.assetid: 98ae174f-bff0-48f1-9e05-6cb63b451824 -topic_type: +topic_type: - "apiref" --- # ICLRRuntimeInfo::SetDefaultStartupFlags Method -Sets the startup flags and the host configuration file that will be used to start the runtime. This method supersedes the use of the `startupFlags` parameter in the [CorBindToRuntimeEx](corbindtoruntimeex-function.md) and [CorBindToRuntimeHost](corbindtoruntimehost-function.md) functions. - -## Syntax - -```cpp -HRESULT SetDefaultStartupFlags( - [in] DWORD dwStartupFlags, - [in] LPCWSTR pwzHostConfigFile); -``` - -## Parameters - - `dwStartupFlags` - [in] The host startup flags to set. Use the same flags as with the [CorBindToRuntimeEx](corbindtoruntimeex-function.md) and [CorBindToRuntimeHost](corbindtoruntimehost-function.md) functions. - - `pwzHostConfigFile` - [in] The directory path of the host configuration file to set. - -## Return Value - - This method returns the following specific HRESULT as well as HRESULT errors that indicate method failure. - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method completed successfully.| - -## Remarks - - A multithreaded host should synchronize calls to this method. Otherwise, thread A might call the `SetStartupFlags` method after thread B completes a call to `SetStartupFlags` and before thread B starts the runtime. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Sets the startup flags and the host configuration file that will be used to start the runtime. This method supersedes the use of the `startupFlags` parameter in the [CorBindToRuntimeEx](corbindtoruntimeex-function.md) and [CorBindToRuntimeHost](corbindtoruntimehost-function.md) functions. + +## Syntax + +```cpp +HRESULT SetDefaultStartupFlags( + [in] DWORD dwStartupFlags, + [in] LPCWSTR pwzHostConfigFile); +``` + +## Parameters + + `dwStartupFlags` + [in] The host startup flags to set. Use the same flags as with the [CorBindToRuntimeEx](corbindtoruntimeex-function.md) and [CorBindToRuntimeHost](corbindtoruntimehost-function.md) functions. + + `pwzHostConfigFile` + [in] The directory path of the host configuration file to set. + +## Return Value + + This method returns the following specific HRESULT as well as HRESULT errors that indicate method failure. + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method completed successfully.| + +## Remarks + + A multithreaded host should synchronize calls to this method. Otherwise, thread A might call the `SetStartupFlags` method after thread B completes a call to `SetStartupFlags` and before thread B starts the runtime. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md index 0c8116fafefbc..7dc2cb550f153 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md @@ -2,68 +2,67 @@ description: "Learn more about: ICLRStrongName::GetHashFromAssemblyFile Method" title: "ICLRStrongName::GetHashFromAssemblyFile Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.GetHashFromAssemblyFile" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::GetHashFromAssemblyFile" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName::GetHashFromAssemblyFile method [.NET Framework hosting]" - "GetHashFromAssemblyFile method, ICLRStrongName interface [.NET Framework hosting]" -ms.assetid: 0b67ea03-d474-4605-acaa-57455790250c -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::GetHashFromAssemblyFile Method -Gets a hash of the specified assembly file, using the specified hash algorithm. - -## Syntax - -```cpp -HRESULT GetHashFromAssemblyFile ( - [in] LPCSTR szFilePath, - [in, out] unsigned int *piHashAlg, - [out] BYTE *pbHash, - [in] DWORD cchHash, - [out] DWORD *pchHash -); -``` - -## Parameters - - `szFilePath` - [in] The path to the file to be hashed. - - `piHashAlg` - [in, out] A constant that specifies the hash algorithm. Use zero for the default hash algorithm. - - `pbHash` - [out] The returned hash buffer. - - `cchHash` - [in] The requested maximum size of `pbHash`. - - `pchHash` - [out] The returned size, in bytes, of `pbHash`. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets a hash of the specified assembly file, using the specified hash algorithm. + +## Syntax + +```cpp +HRESULT GetHashFromAssemblyFile ( + [in] LPCSTR szFilePath, + [in, out] unsigned int *piHashAlg, + [out] BYTE *pbHash, + [in] DWORD cchHash, + [out] DWORD *pchHash +); +``` + +## Parameters + + `szFilePath` + [in] The path to the file to be hashed. + + `piHashAlg` + [in, out] A constant that specifies the hash algorithm. Use zero for the default hash algorithm. + + `pbHash` + [out] The returned hash buffer. + + `cchHash` + [in] The requested maximum size of `pbHash`. + + `pchHash` + [out] The returned size, in bytes, of `pbHash`. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [GetHashFromAssemblyFileW Method](iclrstrongname-gethashfromassemblyfilew-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md index 47232a21dad66..689a426435bf8 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md @@ -2,68 +2,67 @@ description: "Learn more about: ICLRStrongName::GetHashFromAssemblyFileW Method" title: "ICLRStrongName::GetHashFromAssemblyFileW Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.GetHashFromAssemblyFileW" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::GetHashFromAssemblyFileW" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName::GetHashFromAssemblyFileW method [.NET Framework hosting]" - "GetHashFromAssemblyFileW method, ICLRStrongName interface [.NET Framework hosting]" -ms.assetid: 5d0b44a2-5a14-44a2-9a0e-e8682fd4e106 -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::GetHashFromAssemblyFileW Method -Generates a hash over the contents of the file specified by a Unicode string. - -## Syntax - -```cpp -HRESULT GetHashFromAssemblyFileW ( - [in] LPCWSTR wszFilePath, - [in, out] unsigned int *piHashAlg, - [out] BYTE *pbHash, - [in] DWORD cchHash, - [out] DWORD *pchHash -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the file to be hashed. This parameter must be a Unicode string. - - `piHashAlg` - [in, out] A constant that specifies the hash algorithm. Use zero for the default hash algorithm. - - `pbHash` - [out] The returned hash buffer. - - `cchHash` - [in] The requested maximum size of `pbHash`. - - `pchHash` - [out] The returned size, in bytes, of `pbHash`. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Generates a hash over the contents of the file specified by a Unicode string. + +## Syntax + +```cpp +HRESULT GetHashFromAssemblyFileW ( + [in] LPCWSTR wszFilePath, + [in, out] unsigned int *piHashAlg, + [out] BYTE *pbHash, + [in] DWORD cchHash, + [out] DWORD *pchHash +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the file to be hashed. This parameter must be a Unicode string. + + `piHashAlg` + [in, out] A constant that specifies the hash algorithm. Use zero for the default hash algorithm. + + `pbHash` + [out] The returned hash buffer. + + `cchHash` + [in] The requested maximum size of `pbHash`. + + `pchHash` + [out] The returned size, in bytes, of `pbHash`. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [GetHashFromAssemblyFile Method](iclrstrongname-gethashfromassemblyfile-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md index 56e8b56aae06e..70f3a20791041 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md @@ -2,72 +2,71 @@ description: "Learn more about: ICLRStrongName::GetHashFromBlob Method" title: "ICLRStrongName::GetHashFromBlob Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.GetHashFromBlob" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::GetHashFromBlob" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName::GetHashFromBlob method [.NET Framework hosting]" - "GetHashFromBlob method, ICLRStrongName interface [.NET Framework hosting]" -ms.assetid: f91d0f89-f356-49ac-aafb-50fad963c13d -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::GetHashFromBlob Method -Gets a hash of the assembly at the specified memory address, using the specified hash algorithm. - -## Syntax - -```cpp -HRESULT GetHashFromBlob ( - [in] BYTE *pbBlob, - [in] DWORD cchBlob, - [in, out] unsigned int *piHashAlg, - [out] BYTE *pbHash, - [in] DWORD cchHash, - [out] DWORD *pchHash -); -``` - -## Parameters - - `pbBlob` - [in] A pointer to the address of the memory block to be hashed. - - `cchBlob` - [in] The length, in bytes, of the memory block. - - `piHashAlg` - [in, out] A constant that specifies the hash algorithm. Use zero for the default algorithm. - - `pbHash` - [out] The returned hash buffer. - - `cchHash` - [in] The requested maximum size of `pbHash`. - - `pchHash` - [out] The size, in bytes, of the returned `pbHash`. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets a hash of the assembly at the specified memory address, using the specified hash algorithm. + +## Syntax + +```cpp +HRESULT GetHashFromBlob ( + [in] BYTE *pbBlob, + [in] DWORD cchBlob, + [in, out] unsigned int *piHashAlg, + [out] BYTE *pbHash, + [in] DWORD cchHash, + [out] DWORD *pchHash +); +``` + +## Parameters + + `pbBlob` + [in] A pointer to the address of the memory block to be hashed. + + `cchBlob` + [in] The length, in bytes, of the memory block. + + `piHashAlg` + [in, out] A constant that specifies the hash algorithm. Use zero for the default algorithm. + + `pbHash` + [out] The returned hash buffer. + + `cchHash` + [in] The requested maximum size of `pbHash`. + + `pchHash` + [out] The size, in bytes, of the returned `pbHash`. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md index ba167c6fbad16..a568d4f1d8f3f 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md @@ -2,72 +2,71 @@ description: "Learn more about: ICLRStrongName::GetHashFromFile Method" title: "ICLRStrongName::GetHashFromFile Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.GetHashFromFile" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::GetHashFromFile" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName::GetHashFromFile method [.NET Framework hosting]" - "GetHashFromFile method, ICLRStrongName interface [.NET Framework hosting]" -ms.assetid: 9e50480a-8ada-4044-b2a5-97bb14ed3525 -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::GetHashFromFile Method -Generates a hash over the contents of the specified file. - -## Syntax - -```cpp -HRESULT GetHashFromFile ( - [in] LPCSTR szFilePath, +Generates a hash over the contents of the specified file. + +## Syntax + +```cpp +HRESULT GetHashFromFile ( + [in] LPCSTR szFilePath, [in, out] unsigned int *piHashAlg, [out] BYTE *pbHash, [in] DWORD cchHash, - [out] DWORD *pchHash -); -``` - -## Parameters - - `szFilePath` - [in] The name of the file to hash. - - `piHashAlg` - [in, out] The algorithm to use when generating the hash. Valid algorithms are those defined by the Win32 CryptoAPI. If `piHashAlg` is set to 0, the default algorithm CALG_SHA-1 is used. - - `pbHash` - [out] A byte array containing the generated hash. - - `cchHash` - [in] The maximum size of the buffer that `pbHash` points to. - - `pchHash` - [out] The size, in bytes, of the returned `pbHash`. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - This method is the same as the [ICLRStrongName::GetHashFromFileW](iclrstrongname-gethashfromfilew-method.md) method, except that the file name specification is ANSI instead of Unicode. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - + [out] DWORD *pchHash +); +``` + +## Parameters + + `szFilePath` + [in] The name of the file to hash. + + `piHashAlg` + [in, out] The algorithm to use when generating the hash. Valid algorithms are those defined by the Win32 CryptoAPI. If `piHashAlg` is set to 0, the default algorithm CALG_SHA-1 is used. + + `pbHash` + [out] A byte array containing the generated hash. + + `cchHash` + [in] The maximum size of the buffer that `pbHash` points to. + + `pchHash` + [out] The size, in bytes, of the returned `pbHash`. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + This method is the same as the [ICLRStrongName::GetHashFromFileW](iclrstrongname-gethashfromfilew-method.md) method, except that the file name specification is ANSI instead of Unicode. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [GetHashFromFileW Method](iclrstrongname-gethashfromfilew-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md index 537475f850e54..1c1a51297e3c2 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md @@ -2,72 +2,71 @@ description: "Learn more about: ICLRStrongName::GetHashFromFileW Method" title: "ICLRStrongName::GetHashFromFileW Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.GetHashFromFileW" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::GetHashFromFileW" -helpviewer_keywords: +helpviewer_keywords: - "GetHashFromFileW method, ICLRStrongName interface [.NET Framework hosting]" - "ICLRStrongName::GetHashFromFileW method [.NET Framework hosting]" -ms.assetid: c6ff45fc-905d-4c6e-b00c-97c6c7c55d99 -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::GetHashFromFileW Method -Generates a hash over the contents of the file specified by a Unicode string. - -## Syntax - -```cpp +Generates a hash over the contents of the file specified by a Unicode string. + +## Syntax + +```cpp HRESULT GetHashFromFileW ( - [in] LPCWSTR wszFilePath, - [in, out] unsigned int *piHashAlg, - [out] BYTE *pbHash, - [in] DWORD cchHash, - [out] DWORD *pchHash + [in] LPCWSTR wszFilePath, + [in, out] unsigned int *piHashAlg, + [out] BYTE *pbHash, + [in] DWORD cchHash, + [out] DWORD *pchHash ); -``` - -## Parameters - - `wszFilePath` - [in] The Unicode name of the file to hash. - - `piHashAlg` - [in, out] The algorithm to use when generating the hash. Valid algorithms are those defined by the Win32 CryptoAPI. If `piHashAlg` is set to 0, the default algorithm CALG_SHA-1 is used. - - `pbHash` - [out] A byte array containing the generated hash. - - `cchHash` - [in] The maximum size of the buffer pointed to by `pbHash`. - - `pchHash` - [out] The size, in bytes, of `pbHash`. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - This method is the same as the [ICLRStrongName::GetHashFromFile](iclrstrongname-gethashfromfile-method.md) method, except that the file name specification is Unicode instead of ANSI. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +``` + +## Parameters + + `wszFilePath` + [in] The Unicode name of the file to hash. + + `piHashAlg` + [in, out] The algorithm to use when generating the hash. Valid algorithms are those defined by the Win32 CryptoAPI. If `piHashAlg` is set to 0, the default algorithm CALG_SHA-1 is used. + + `pbHash` + [out] A byte array containing the generated hash. + + `cchHash` + [in] The maximum size of the buffer pointed to by `pbHash`. + + `pchHash` + [out] The size, in bytes, of `pbHash`. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + This method is the same as the [ICLRStrongName::GetHashFromFile](iclrstrongname-gethashfromfile-method.md) method, except that the file name specification is Unicode instead of ANSI. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [GetHashFromFile Method](iclrstrongname-gethashfromfile-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md index 8e4d20c79cd20..cfd1c2cb1a971 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md @@ -2,69 +2,68 @@ description: "Learn more about: ICLRStrongName::GetHashFromHandle Method" title: "ICLRStrongName::GetHashFromHandle Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.GetHashFromHandle" - "ICLRStrongName.StrongNameCompareAssemblies" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::GetHashFromHandle" -helpviewer_keywords: +helpviewer_keywords: - "GetHashFromHandle method, ICLRStrongName interface [.NET Framework hosting]" - "ICLRStrongName::GetHashFromHandle method [.NET Framework hosting]" -ms.assetid: 3bedbb7d-3cdd-4175-b370-10ae734062db -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::GetHashFromHandle Method -Generates a hash over the contents of the file that has the specified file handle, using the specified hash algorithm. - -## Syntax - -```cpp -HRESULT GetHashFromHandle ( - [in] HANDLE hFile, - [in, out] unsigned int *piHashAlg, - [out] BYTE *pbHash, - [in] DWORD cchHash, - [out] DWORD *pchHash -); -``` - -## Parameters - - `hFile` - [in] The handle of the file to be hashed. - - `piHashAlg` - [in, out] A constant that specifies the hash algorithm. Use zero for the default algorithm. - - `pbHash` - [out] The returned hash buffer. - - `cchHash` - [in] The requested maximum size of `pbHash`. - - `pchHash` - [out] The size, in bytes, of the returned `pbHash`. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Generates a hash over the contents of the file that has the specified file handle, using the specified hash algorithm. + +## Syntax + +```cpp +HRESULT GetHashFromHandle ( + [in] HANDLE hFile, + [in, out] unsigned int *piHashAlg, + [out] BYTE *pbHash, + [in] DWORD cchHash, + [out] DWORD *pchHash +); +``` + +## Parameters + + `hFile` + [in] The handle of the file to be hashed. + + `piHashAlg` + [in, out] A constant that specifies the hash algorithm. Use zero for the default algorithm. + + `pbHash` + [out] The returned hash buffer. + + `cchHash` + [in] The requested maximum size of `pbHash`. + + `pchHash` + [out] The size, in bytes, of the returned `pbHash`. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-interface.md b/docs/core/unmanaged-api/hosting/iclrstrongname-interface.md index efdcba6b889d6..ff9034c149b5c 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-interface.md @@ -2,68 +2,67 @@ description: "Learn more about: ICLRStrongName Interface" title: "ICLRStrongName Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName interface [.NET Framework hosting]" -ms.assetid: 2fac66fd-6b3b-4dbd-8baf-86038bd85526 -topic_type: +topic_type: - "apiref" --- # ICLRStrongName Interface -Provides basic global static functions for signing assemblies with strong names. All `ICLRStrongName` methods return standard COM HRESULTs. - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetHashFromAssemblyFile Method](iclrstrongname-gethashfromassemblyfile-method.md)|Gets a hash of the specified assembly file, using the specified hash algorithm.| -|[GetHashFromAssemblyFileW Method](iclrstrongname-gethashfromassemblyfilew-method.md)|Gets a hash of the assembly file specified as a Unicode string, using the specified hash algorithm.| -|[GetHashFromBlob Method](iclrstrongname-gethashfromblob-method.md)|Gets a hash of the assembly at the specified memory address, using the specified hash algorithm.| -|[GetHashFromFile Method](iclrstrongname-gethashfromfile-method.md)|Generates a hash over the contents of the specified file.| -|[GetHashFromFileW Method](iclrstrongname-gethashfromfilew-method.md)|Generates a hash over the contents of the file specified by a Unicode string.| -|[GetHashFromHandle Method](iclrstrongname-gethashfromhandle-method.md)|Generates a hash over the contents of the file with the specified file handle, using the specified hash algorithm.| -|[StrongNameCompareAssemblies Method](iclrstrongname-strongnamecompareassemblies-method.md)|Determines whether two assemblies differ only by their strong name signatures.| -|[StrongNameFreeBuffer Method](iclrstrongname-strongnamefreebuffer-method.md)|Frees memory that was allocated with a previous call to a strong name method such as [StrongNameGetPublicKey](iclrstrongname-strongnamegetpublickey-method.md), [StrongNameTokenFromPublicKey](iclrstrongname-strongnametokenfrompublickey-method.md), or [StrongNameSignatureGeneration](iclrstrongname-strongnamesignaturegeneration-method.md).| -|[StrongNameGetBlob Method](iclrstrongname-strongnamegetblob-method.md)|Fills the specified buffer with the binary representation of the executable file at the specified address.| -|[StrongNameGetBlobFromImage Method](iclrstrongname-strongnamegetblobfromimage-method.md)|Gets a binary representation of the assembly image at the specified memory address.| -|[StrongNameGetPublicKey Method](iclrstrongname-strongnamegetpublickey-method.md)|Gets the public key from a private/public key pair.| -|[StrongNameHashSize Method](iclrstrongname-strongnamehashsize-method.md)|Gets the buffer size required for a hash, using the specified hash algorithm.| -|[StrongNameKeyDelete Method](iclrstrongname-strongnamekeydelete-method.md)|Deletes the specified key container.| -|[StrongNameKeyGen Method](iclrstrongname-strongnamekeygen-method.md)|Creates a new public/private key pair for strong name use.| -|[StrongNameKeyGenEx Method](iclrstrongname-strongnamekeygenex-method.md)|Generates a new public/private key pair with the specified key size for strong name use.| -|[StrongNameKeyInstall Method](iclrstrongname-strongnamekeyinstall-method.md)|Imports a public/private key pair into a container.| -|[StrongNameSignatureGeneration Method](iclrstrongname-strongnamesignaturegeneration-method.md)|Generates a strong name signature for the specified assembly.| -|[StrongNameSignatureGenerationEx Method](iclrstrongname-strongnamesignaturegenerationex-method.md)|Generates a strong name signature for the specified assembly, based on the specified flags.| -|[StrongNameSignatureSize Method](iclrstrongname-strongnamesignaturesize-method.md)|Returns the size of the strong name signature.| -|[StrongNameSignatureVerification Method](iclrstrongname-strongnamesignatureverification-method.md)|Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature, which is verified according to the specified flags.| -|[StrongNameSignatureVerificationEx Method](iclrstrongname-strongnamesignatureverificationex-method.md)|Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature.| -|[StrongNameSignatureVerificationFromImage Method](iclrstrongname-strongnamesignatureverificationfromimage-method.md)|Verifies that an assembly that has already been mapped to memory is valid for the associated public key.| -|[StrongNameTokenFromAssembly Method](iclrstrongname-strongnametokenfromassembly-method.md)|Creates a strong name token from the specified assembly file.| -|[StrongNameTokenFromAssemblyEx Method](iclrstrongname-strongnametokenfromassemblyex-method.md)|Creates a strong name token from the specified assembly file, and returns the public key.| -|[StrongNameTokenFromPublicKey Method](iclrstrongname-strongnametokenfrompublickey-method.md)|Gets a token representing a public key.| - -## Remarks +Provides basic global static functions for signing assemblies with strong names. All `ICLRStrongName` methods return standard COM HRESULTs. - You can get an instance of the `ICLRStrongName` by calling the [ICLRRuntimeInfo::GetInterface](iclrruntimeinfo-getinterface-method.md) method using `CLSID_CLRStrongName` and `IID_ICLRStrongName` as parameters. - -## Requirements +## Methods + +|Method|Description| +|------------|-----------------| +|[GetHashFromAssemblyFile Method](iclrstrongname-gethashfromassemblyfile-method.md)|Gets a hash of the specified assembly file, using the specified hash algorithm.| +|[GetHashFromAssemblyFileW Method](iclrstrongname-gethashfromassemblyfilew-method.md)|Gets a hash of the assembly file specified as a Unicode string, using the specified hash algorithm.| +|[GetHashFromBlob Method](iclrstrongname-gethashfromblob-method.md)|Gets a hash of the assembly at the specified memory address, using the specified hash algorithm.| +|[GetHashFromFile Method](iclrstrongname-gethashfromfile-method.md)|Generates a hash over the contents of the specified file.| +|[GetHashFromFileW Method](iclrstrongname-gethashfromfilew-method.md)|Generates a hash over the contents of the file specified by a Unicode string.| +|[GetHashFromHandle Method](iclrstrongname-gethashfromhandle-method.md)|Generates a hash over the contents of the file with the specified file handle, using the specified hash algorithm.| +|[StrongNameCompareAssemblies Method](iclrstrongname-strongnamecompareassemblies-method.md)|Determines whether two assemblies differ only by their strong name signatures.| +|[StrongNameFreeBuffer Method](iclrstrongname-strongnamefreebuffer-method.md)|Frees memory that was allocated with a previous call to a strong name method such as [StrongNameGetPublicKey](iclrstrongname-strongnamegetpublickey-method.md), [StrongNameTokenFromPublicKey](iclrstrongname-strongnametokenfrompublickey-method.md), or [StrongNameSignatureGeneration](iclrstrongname-strongnamesignaturegeneration-method.md).| +|[StrongNameGetBlob Method](iclrstrongname-strongnamegetblob-method.md)|Fills the specified buffer with the binary representation of the executable file at the specified address.| +|[StrongNameGetBlobFromImage Method](iclrstrongname-strongnamegetblobfromimage-method.md)|Gets a binary representation of the assembly image at the specified memory address.| +|[StrongNameGetPublicKey Method](iclrstrongname-strongnamegetpublickey-method.md)|Gets the public key from a private/public key pair.| +|[StrongNameHashSize Method](iclrstrongname-strongnamehashsize-method.md)|Gets the buffer size required for a hash, using the specified hash algorithm.| +|[StrongNameKeyDelete Method](iclrstrongname-strongnamekeydelete-method.md)|Deletes the specified key container.| +|[StrongNameKeyGen Method](iclrstrongname-strongnamekeygen-method.md)|Creates a new public/private key pair for strong name use.| +|[StrongNameKeyGenEx Method](iclrstrongname-strongnamekeygenex-method.md)|Generates a new public/private key pair with the specified key size for strong name use.| +|[StrongNameKeyInstall Method](iclrstrongname-strongnamekeyinstall-method.md)|Imports a public/private key pair into a container.| +|[StrongNameSignatureGeneration Method](iclrstrongname-strongnamesignaturegeneration-method.md)|Generates a strong name signature for the specified assembly.| +|[StrongNameSignatureGenerationEx Method](iclrstrongname-strongnamesignaturegenerationex-method.md)|Generates a strong name signature for the specified assembly, based on the specified flags.| +|[StrongNameSignatureSize Method](iclrstrongname-strongnamesignaturesize-method.md)|Returns the size of the strong name signature.| +|[StrongNameSignatureVerification Method](iclrstrongname-strongnamesignatureverification-method.md)|Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature, which is verified according to the specified flags.| +|[StrongNameSignatureVerificationEx Method](iclrstrongname-strongnamesignatureverificationex-method.md)|Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature.| +|[StrongNameSignatureVerificationFromImage Method](iclrstrongname-strongnamesignatureverificationfromimage-method.md)|Verifies that an assembly that has already been mapped to memory is valid for the associated public key.| +|[StrongNameTokenFromAssembly Method](iclrstrongname-strongnametokenfromassembly-method.md)|Creates a strong name token from the specified assembly file.| +|[StrongNameTokenFromAssemblyEx Method](iclrstrongname-strongnametokenfromassemblyex-method.md)|Creates a strong name token from the specified assembly file, and returns the public key.| +|[StrongNameTokenFromPublicKey Method](iclrstrongname-strongnametokenfrompublickey-method.md)|Gets a token representing a public key.| + +## Remarks + + You can get an instance of the `ICLRStrongName` by calling the [ICLRRuntimeInfo::GetInterface](iclrruntimeinfo-getinterface-method.md) method using `CLSID_CLRStrongName` and `IID_ICLRStrongName` as parameters. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - **Platforms:** See [System Requirements](../../../framework/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/core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md index 04d8ee8546f91..e4311f6835dbc 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md @@ -2,70 +2,69 @@ description: "Learn more about: ICLRStrongName::StrongNameCompareAssemblies Method" title: "ICLRStrongName::StrongNameCompareAssemblies Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameCompareAssemblies" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameCompareAssemblies" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName::StrongNameCompareAssemblies method [.NET Framework hosting]" - "StrongNameCompareAssemblies method, ICLRStrongName interface [.NET Framework hosting]" -ms.assetid: b1fb356c-72cf-4aa4-8376-f291a6d97c01 -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::StrongNameCompareAssemblies Method -Determines whether two assemblies differ only by their strong name signatures. - -## Syntax - -```cpp -HRESULT StrongNameCompareAssemblies ( - [in] LPCWSTR wszAssembly1, - [in] LPCWSTR wszAssembly2, - [out] DWORD *pdwResult -); -``` - -## Parameters - - `wszAssembly1` - [in] The path to the first assembly. - - `wszAssembly2` - [in] The path to the second assembly. - - `pdwResult` - [out] One of the following values: - -- `SN_CMP_DIFFERENT` (0) - Specifies that the assemblies contain different data. - -- `SN_CMP_IDENTICAL` (1) - Specifies that the assemblies are exactly the same, including their signatures and checksum. - -- `SN_CMP_SIGONLY` (2) - Specifies that the assemblies differ only by signature and checksum. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - -## Remarks - - The strong name signature of an assembly consists of the assembly's text name, version, culture, and public key token. - +Determines whether two assemblies differ only by their strong name signatures. + +## Syntax + +```cpp +HRESULT StrongNameCompareAssemblies ( + [in] LPCWSTR wszAssembly1, + [in] LPCWSTR wszAssembly2, + [out] DWORD *pdwResult +); +``` + +## Parameters + + `wszAssembly1` + [in] The path to the first assembly. + + `wszAssembly2` + [in] The path to the second assembly. + + `pdwResult` + [out] One of the following values: + +- `SN_CMP_DIFFERENT` (0) - Specifies that the assemblies contain different data. + +- `SN_CMP_IDENTICAL` (1) - Specifies that the assemblies are exactly the same, including their signatures and checksum. + +- `SN_CMP_SIGONLY` (2) - Specifies that the assemblies differ only by signature and checksum. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + +## Remarks + + The strong name signature of an assembly consists of the assembly's text name, version, culture, and public key token. + ## See also - [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md index 3aca5f5ef5306..3253bd1bf3160 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md @@ -2,52 +2,51 @@ description: "Learn more about: ICLRStrongName::StrongNameFreeBuffer Method" title: "ICLRStrongName::StrongNameFreeBuffer Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameFreeBuffer" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameFreeBuffer" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameFreeBuffer method, ICLRStrongName interface [.NET Framework hosting]" - "ICLRStrongName::StrongNameFreeBuffer method [.NET Framework hosting]" -ms.assetid: 6148c508-bd1d-4a37-85c3-06ecb09cc857 -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::StrongNameFreeBuffer Method -Frees memory that was allocated with a previous call to a strong name method such as [ICLRStrongName::StrongNameGetPublicKey](iclrstrongname-strongnamegetpublickey-method.md), [ICLRStrongName::StrongNameTokenFromPublicKey](iclrstrongname-strongnametokenfrompublickey-method.md), or [ICLRStrongName::StrongNameSignatureGeneration](iclrstrongname-strongnamesignaturegeneration-method.md). - -## Syntax - -```cpp +Frees memory that was allocated with a previous call to a strong name method such as [ICLRStrongName::StrongNameGetPublicKey](iclrstrongname-strongnamegetpublickey-method.md), [ICLRStrongName::StrongNameTokenFromPublicKey](iclrstrongname-strongnametokenfrompublickey-method.md), or [ICLRStrongName::StrongNameSignatureGeneration](iclrstrongname-strongnamesignaturegeneration-method.md). + +## Syntax + +```cpp HRESULT StrongNameFreeBuffer ( - [in] BYTE *pbMemory -); -``` - -## Parameters - - `pbMemory` - [in] A pointer to the memory to free. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - + [in] BYTE *pbMemory +); +``` + +## Parameters + + `pbMemory` + [in] A pointer to the memory to free. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md index 6c3f3b0c14ba2..c165188bfdc34 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md @@ -2,61 +2,60 @@ description: "Learn more about: ICLRStrongName::StrongNameGetBlob Method" title: "ICLRStrongName::StrongNameGetBlob Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameGetBlob" - "ICLRStrongName.StrongNameGetBlob" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameGetBlob" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName::StrongNameGetBlob method [.NET Framework hosting]" - "StrongNameGetBlob method, ICLRStrongName interface [.NET Framework hosting]" -ms.assetid: a24218f8-7196-44be-b7a2-ee9cdd7a85c4 -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::StrongNameGetBlob Method -Fills the specified buffer with the binary representation of the executable file at the specified address. - -## Syntax - -```cpp -HRESULT StrongNameGetBlob ( - [in] LPCWSTR wszFilePath, - [in] BYTE *pbBlob, - [in, out] DWORD *pcbBlob -); -``` - -## Parameters - - `wszFilePath` - [in] A valid path to the executable file to be loaded. - - `pbBlob` - [in] The buffer into which to load the executable file. - - `pcbBlob` - [in, out] The requested maximum size, in bytes, of `pbBlob`. Upon return, the actual size, in bytes, of `pbBlob`. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Fills the specified buffer with the binary representation of the executable file at the specified address. + +## Syntax + +```cpp +HRESULT StrongNameGetBlob ( + [in] LPCWSTR wszFilePath, + [in] BYTE *pbBlob, + [in, out] DWORD *pcbBlob +); +``` + +## Parameters + + `wszFilePath` + [in] A valid path to the executable file to be loaded. + + `pbBlob` + [in] The buffer into which to load the executable file. + + `pcbBlob` + [in, out] The requested maximum size, in bytes, of `pbBlob`. Upon return, the actual size, in bytes, of `pbBlob`. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [StrongNameGetBlobFromImage Method](iclrstrongname-strongnamegetblobfromimage-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md index aa2aa338e9d8a..af96c9559b516 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md @@ -2,64 +2,63 @@ description: "Learn more about: ICLRStrongName::StrongNameGetBlobFromImage Method" title: "ICLRStrongName::StrongNameGetBlobFromImage Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameGetBlobFromImage" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameGetBlobFromImage" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameGetBlobFromImage method, ICLRStrongName interface [.NET Framework hosting]" - "ICLRStrongName::StrongNameGetBlobFromImage method [.NET Framework hosting]" -ms.assetid: 0f5a2ec8-e776-4fd8-bda6-937b6834575a -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::StrongNameGetBlobFromImage Method -Gets a binary representation of the assembly image at the specified memory address. - -## Syntax - -```cpp -HRESULT StrongNameGetBlobFromImage ( - [in] BYTE *pbBase, - [in] DWORD dwLength, - [in] BYTE *pbBlob, - [in, out] DWORD *pcbBlob -); -``` - -## Parameters - - `pbBase` - [in] The memory address of the mapped assembly manifest. - - `dwLength` - [in] The size, in bytes, of the image at `pbBase`. - - `pbBlob` - [in] A buffer to contain the binary representation of the image. - - `pcbBlob` - [in, out] The requested maximum size, in bytes, of `pbBlob`. Upon return, the actual size, in bytes, of `pbBlob`. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets a binary representation of the assembly image at the specified memory address. + +## Syntax + +```cpp +HRESULT StrongNameGetBlobFromImage ( + [in] BYTE *pbBase, + [in] DWORD dwLength, + [in] BYTE *pbBlob, + [in, out] DWORD *pcbBlob +); +``` + +## Parameters + + `pbBase` + [in] The memory address of the mapped assembly manifest. + + `dwLength` + [in] The size, in bytes, of the image at `pbBase`. + + `pbBlob` + [in] A buffer to contain the binary representation of the image. + + `pcbBlob` + [in, out] The requested maximum size, in bytes, of `pbBlob`. Upon return, the actual size, in bytes, of `pbBlob`. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [StrongNameGetBlob Method](iclrstrongname-strongnamegetblob-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md index 61059242c299c..d922df2e413fd 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md @@ -2,78 +2,77 @@ description: "Learn more about: ICLRStrongName::StrongNameGetPublicKey Method" title: "ICLRStrongName::StrongNameGetPublicKey Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameGetPublicKey" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameGetPublicKey" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameGetPublicKey method, ICLRStrongName interface [.NET Framework hosting]" - "ICLRStrongName::StrongNameGetPublicKey method [.NET Framework hosting]" -ms.assetid: a31dcaa9-a404-4c1d-8cc7-081827c52935 -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::StrongNameGetPublicKey Method -Gets the public key from a public/private key pair. The key pair can be supplied either as a key container name within a cryptographic service provider (CSP) or as a raw collection of bytes. - -## Syntax - -```cpp +Gets the public key from a public/private key pair. The key pair can be supplied either as a key container name within a cryptographic service provider (CSP) or as a raw collection of bytes. + +## Syntax + +```cpp HRESULT StrongNameGetPublicKey ( - [in] LPCWSTR szKeyContainer, - [in] BYTE *pbKeyBlob, - [in] ULONG cbKeyBlob, - [out] BYTE **ppbPublicKeyBlob, - [out] ULONG *pcbPublicKeyBlob -); -``` - -## Parameters - - `szKeyContainer` - [in] The name of the key container that contains the public/private key pair. If `pbKeyBlob` is null, `szKeyContainer` must specify a valid container within the CSP. In this case, the [ICLRStrongName::StrongNameGetPublicKey](iclrstrongname-strongnamegetpublickey-method.md) method extracts the public key from the key pair stored in the container. - - If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). - - The keys must be 1024-bit Rivest-Shamir-Adleman (RSA) signing keys. No other types of keys are supported at this time. - - `pbKeyBlob` - [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `szKeyContainer` is assumed to contain the key pair. - - `cbKeyBlob` - [in] The size, in bytes, of `pbKeyBlob`. - - `ppbPublicKeyBlob` - [out] The returned public key BLOB. The `ppbPublicKeyBlob` parameter is allocated by the common language runtime and returned to the caller. The caller must free the memory by using the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method. - - `pcbPublicKeyBlob` - [out] The size of the returned public key BLOB. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - The public key is contained in a [PublicKeyBlob](../strong-naming/publickeyblob-structure.md) structure. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - + [in] LPCWSTR szKeyContainer, + [in] BYTE *pbKeyBlob, + [in] ULONG cbKeyBlob, + [out] BYTE **ppbPublicKeyBlob, + [out] ULONG *pcbPublicKeyBlob +); +``` + +## Parameters + + `szKeyContainer` + [in] The name of the key container that contains the public/private key pair. If `pbKeyBlob` is null, `szKeyContainer` must specify a valid container within the CSP. In this case, the [ICLRStrongName::StrongNameGetPublicKey](iclrstrongname-strongnamegetpublickey-method.md) method extracts the public key from the key pair stored in the container. + + If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). + + The keys must be 1024-bit Rivest-Shamir-Adleman (RSA) signing keys. No other types of keys are supported at this time. + + `pbKeyBlob` + [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `szKeyContainer` is assumed to contain the key pair. + + `cbKeyBlob` + [in] The size, in bytes, of `pbKeyBlob`. + + `ppbPublicKeyBlob` + [out] The returned public key BLOB. The `ppbPublicKeyBlob` parameter is allocated by the common language runtime and returned to the caller. The caller must free the memory by using the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method. + + `pcbPublicKeyBlob` + [out] The size of the returned public key BLOB. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + The public key is contained in a [PublicKeyBlob]((../../../framework/unmanaged-api/strong-naming/publickeyblob-structure.md) structure. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [StrongNameTokenFromPublicKey Method](iclrstrongname-strongnametokenfrompublickey-method.md) -- [PublicKeyBlob Structure](../strong-naming/publickeyblob-structure.md) +- [PublicKeyBlob Structure]((../../../framework/unmanaged-api/strong-naming/publickeyblob-structure.md) - [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md index 8186db739c476..038bb5f71578f 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md @@ -2,56 +2,55 @@ description: "Learn more about: ICLRStrongName::StrongNameHashSize Method" title: "ICLRStrongName::StrongNameHashSize Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameHashSize" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameHashSize" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName::StrongNameHashSize method [.NET Framework hosting]" - "StrongNameHashSize method, ICLRStrongName interface [.NET Framework hosting]" -ms.assetid: 4a05ee56-08e4-4f3a-86a9-9b52083d5c0f -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::StrongNameHashSize Method -Gets the buffer size required for a hash, using the specified hash algorithm. - -## Syntax - -```cpp -HRESULT StrongNameHashSize ( - [in] ULONG ulHashAlg, - [out] DWORD *pcbSize -); -``` - -## Parameters - - `ulHashAlg` - [in] The hash algorithm used to compute the buffer size. - - `pcbSize` - [out] The returned buffer size, in bytes. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the buffer size required for a hash, using the specified hash algorithm. + +## Syntax + +```cpp +HRESULT StrongNameHashSize ( + [in] ULONG ulHashAlg, + [out] DWORD *pcbSize +); +``` + +## Parameters + + `ulHashAlg` + [in] The hash algorithm used to compute the buffer size. + + `pcbSize` + [out] The returned buffer size, in bytes. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md index 811ec4dc63598..d851f07ed9b06 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md @@ -2,56 +2,55 @@ description: "Learn more about: ICLRStrongName::StrongNameKeyDelete Method" title: "ICLRStrongName::StrongNameKeyDelete Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameKeyDelete" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameKeyDelete" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameKeyDelete method, ICLRStrongName interface [.NET Framework hosting]" - "ICLRStrongName::StrongNameKeyDelete method [.NET Framework hosting]" -ms.assetid: 0163412f-f617-4428-89e0-03992fec31e8 -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::StrongNameKeyDelete Method -Deletes the specified key container. - -## Syntax - -```cpp -HRESULT StrongNameKeyDelete ( - [in] LPCWSTR wszKeyContainer -); -``` - -## Parameters - - `wszKeyContainer` - [in] The name of the key container to delete. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - Use the [ICLRStrongName::StrongNameKeyInstall](iclrstrongname-strongnamekeyinstall-method.md) method to import a public/private key pair into a container. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Deletes the specified key container. + +## Syntax + +```cpp +HRESULT StrongNameKeyDelete ( + [in] LPCWSTR wszKeyContainer +); +``` + +## Parameters + + `wszKeyContainer` + [in] The name of the key container to delete. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + Use the [ICLRStrongName::StrongNameKeyInstall](iclrstrongname-strongnamekeyinstall-method.md) method to import a public/private key pair into a container. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [StrongNameKeyInstall Method](iclrstrongname-strongnamekeyinstall-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md index b60af767293ef..7958c4f3eaf2d 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md @@ -2,72 +2,71 @@ description: "Learn more about: ICLRStrongName::StrongNameKeyGen Method" title: "ICLRStrongName::StrongNameKeyGen Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameKeyGen" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameKeyGen" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameKeyGen method, ICLRStrongName interface [.NET Framework hosting]" - "ICLRStrongName::StrongNameKeyGen method [.NET Framework hosting]" -ms.assetid: ac5c1245-9acf-4271-9c08-3d9b7c670df3 -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::StrongNameKeyGen Method -Creates a new public/private key pair for strong name use. - -## Syntax - -```cpp -HRESULT StrongNameKeyGen ( - [in] LPCWSTR wszKeyContainer, - [in] DWORD dwFlags, - [out] BYTE **ppbKeyBlob, - [out] ULONG *pcbKeyBlob -); -``` - -## Parameters - - `wszKeyContainer` - [in] The requested key container name. `wszKeyContainer` must either be a non-empty string or null to generate a temporary name. - - `dwFlags` - [in] A value that specifies whether to leave the key registered. The following values are supported: - -- 0x00000000 - Used when `wszKeyContainer` is null to generate a temporary key container name. - -- 0x00000001 (`SN_LEAVE_KEY`) - Specifies that the key should be left registered. - - `ppbKeyBlob` - [out] The returned public/private key pair. - - `pcbKeyBlob` - [out] The size, in bytes, of `ppbKeyBlob`. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - The [ICLRStrongName::StrongNameKeyGen](iclrstrongname-strongnamekeygen-method.md) method creates a 1024-bit key. After the key is retrieved, you should call the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method to release the allocated memory. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Creates a new public/private key pair for strong name use. + +## Syntax + +```cpp +HRESULT StrongNameKeyGen ( + [in] LPCWSTR wszKeyContainer, + [in] DWORD dwFlags, + [out] BYTE **ppbKeyBlob, + [out] ULONG *pcbKeyBlob +); +``` + +## Parameters + + `wszKeyContainer` + [in] The requested key container name. `wszKeyContainer` must either be a non-empty string or null to generate a temporary name. + + `dwFlags` + [in] A value that specifies whether to leave the key registered. The following values are supported: + +- 0x00000000 - Used when `wszKeyContainer` is null to generate a temporary key container name. + +- 0x00000001 (`SN_LEAVE_KEY`) - Specifies that the key should be left registered. + + `ppbKeyBlob` + [out] The returned public/private key pair. + + `pcbKeyBlob` + [out] The size, in bytes, of `ppbKeyBlob`. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + The [ICLRStrongName::StrongNameKeyGen](iclrstrongname-strongnamekeygen-method.md) method creates a 1024-bit key. After the key is retrieved, you should call the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method to release the allocated memory. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [StrongNameKeyGenEx Method](iclrstrongname-strongnamekeygenex-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md index a3d2da1890d74..26070ca59e6e0 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md @@ -2,78 +2,77 @@ description: "Learn more about: ICLRStrongName::StrongNameKeyGenEx Method" title: "ICLRStrongName::StrongNameKeyGenEx Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameKeyGenEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameKeyGenEx" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName::StrongNameKeyGenEx method [.NET Framework hosting]" - "StrongNameKeyGenEx method, ICLRStrongName interface [.NET Framework hosting]" -ms.assetid: 1f8b59d0-5b72-45b8-ab74-c2b43ffc806e -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::StrongNameKeyGenEx Method -Generates a new public/private key pair with the specified key size, for strong name use. - -## Syntax - -```cpp -HRESULT StrongNameKeyGenEx ( - [in] LPCWSTR wszKeyContainer, - [in] DWORD dwFlags, - [in] DWORD dwKeySize, - [out] BYTE **ppbKeyBlob, - [out] ULONG *pcbKeyBlob -); -``` - -## Parameters - - `wszKeyContainer` - [in] The requested key container name. `wszKeyContainer` must either be a non-empty string or null to generate a temporary name. - - `dwFlags` - [in] A value that specifies whether to leave the key registered. The following values are supported: - -- 0x00000000 - Used when `wszKeyContainer` is null to generate a temporary key container name. - -- 0x00000001 (`SN_LEAVE_KEY`) - Specifies that the key should be left registered. - - `dwKeySize` - [in] The requested size of the key, in bits. - - `ppbKeyBlob` - [out] The returned public/private key pair. - - `pcbKeyBlob` - [out] The size, in bytes, of `ppbKeyBlob`. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - The .NET Framework versions 1.0 and 1.1 require a `dwKeySize` of 1024 bits to sign an assembly with a strong name; version 2.0 adds supports for 2048-bit keys. - - After the key is retrieved, you should call the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method to release the allocated memory. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Generates a new public/private key pair with the specified key size, for strong name use. + +## Syntax + +```cpp +HRESULT StrongNameKeyGenEx ( + [in] LPCWSTR wszKeyContainer, + [in] DWORD dwFlags, + [in] DWORD dwKeySize, + [out] BYTE **ppbKeyBlob, + [out] ULONG *pcbKeyBlob +); +``` + +## Parameters + + `wszKeyContainer` + [in] The requested key container name. `wszKeyContainer` must either be a non-empty string or null to generate a temporary name. + + `dwFlags` + [in] A value that specifies whether to leave the key registered. The following values are supported: + +- 0x00000000 - Used when `wszKeyContainer` is null to generate a temporary key container name. + +- 0x00000001 (`SN_LEAVE_KEY`) - Specifies that the key should be left registered. + + `dwKeySize` + [in] The requested size of the key, in bits. + + `ppbKeyBlob` + [out] The returned public/private key pair. + + `pcbKeyBlob` + [out] The size, in bytes, of `ppbKeyBlob`. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + The .NET Framework versions 1.0 and 1.1 require a `dwKeySize` of 1024 bits to sign an assembly with a strong name; version 2.0 adds supports for 2048-bit keys. + + After the key is retrieved, you should call the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method to release the allocated memory. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [StrongNameKeyGen Method](iclrstrongname-strongnamekeygen-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md index 45039d76231d8..14fe0932b9f44 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md @@ -2,64 +2,63 @@ description: "Learn more about: ICLRStrongName::StrongNameKeyInstall Method" title: "ICLRStrongName::StrongNameKeyInstall Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameKeyInstall" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameKeyInstall" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName::StrongNameKeyInstall method [.NET Framework hosting]" - "StrongNameKeyInstall method, ICLRStrongName interface [.NET Framework hosting]" -ms.assetid: 5c15cf3b-164c-49d1-8e57-e42949d55acf -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::StrongNameKeyInstall Method -Imports a public/private key pair into a container. - -## Syntax - -```cpp -HRESULT StrongNameKeyInstall ( - [in] LPCWSTR wszKeyContainer, - [in] BYTE *pbKeyBlob, - [in] ULONG cbKeyBlob -); -``` - -## Parameters - - `wszKeyContainer` - [in] The name of the key container. `wszKeyContainer` must be a non-empty string. - - `pbKeyBlob` - [in] The binary key pair. - - `cbKeyBlob` - [in] The size, in bytes, of `pbKeyBlob`. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - Use the [ICLRStrongName::StrongNameKeyDelete](iclrstrongname-strongnamekeydelete-method.md) method to delete the key container. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Imports a public/private key pair into a container. + +## Syntax + +```cpp +HRESULT StrongNameKeyInstall ( + [in] LPCWSTR wszKeyContainer, + [in] BYTE *pbKeyBlob, + [in] ULONG cbKeyBlob +); +``` + +## Parameters + + `wszKeyContainer` + [in] The name of the key container. `wszKeyContainer` must be a non-empty string. + + `pbKeyBlob` + [in] The binary key pair. + + `cbKeyBlob` + [in] The size, in bytes, of `pbKeyBlob`. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + Use the [ICLRStrongName::StrongNameKeyDelete](iclrstrongname-strongnamekeydelete-method.md) method to delete the key container. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [StrongNameKeyDelete Method](iclrstrongname-strongnamekeydelete-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md index bcbc73e7bda17..7fbec3ea9b4b5 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md @@ -2,86 +2,85 @@ description: "Learn more about: ICLRStrongName::StrongNameSignatureGeneration Method" title: "ICLRStrongName::StrongNameSignatureGeneration Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameSignatureGeneration" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameSignatureGeneration" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameSignatureGeneration method, ICLRStrongName interface [.NET Framework hosting]" - "ICLRStrongName::StrongNameSignatureGeneration method [.NET Framework hosting]" -ms.assetid: 4cdb1284-947a-4ed4-94c1-c5ff5cdfce56 -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::StrongNameSignatureGeneration Method -Generates a strong name signature for the specified assembly. - -## Syntax - -```cpp +Generates a strong name signature for the specified assembly. + +## Syntax + +```cpp HRESULT StrongNameSignatureGeneration ( - [in] LPCWSTR wszFilePath, - [in] LPCWSTR wszKeyContainer, - [in] BYTE *pbKeyBlob, - [in] ULONG cbKeyBlob, - [out] BYTE **ppbSignatureBlob, - [out] ULONG *pcbSignatureBlob -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the file that contains the manifest of the assembly for which the strong name signature will be generated. - - `wszKeyContainer` - [in] The name of the key container that contains the public/private key pair. - - If `pbKeyBlob` is null, `wszKeyContainer` must specify a valid container within the cryptographic service provider (CSP). In this case, the key pair stored in the container is used to sign the file. - - If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). - - The keys must be 1024-bit Rivest-Shamir-Adleman (RSA) signing keys. No other types of keys are supported at this time. - - `pbKeyBlob` - [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `wszKeyContainer` is assumed to contain the key pair. - - `cbKeyBlob` - [in] The size, in bytes, of `pbKeyBlob`. - - `ppbSignatureBlob` - [out] A pointer to the location to which the common language runtime returns the signature. If `ppbSignatureBlob` is null, the runtime stores the signature in the file specified by `wszFilePath`. - - If `ppbSignatureBlob` is not null, the common language runtime allocates space in which to return the signature. The caller must free this space by using the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method. - - `pcbSignatureBlob` - [out] The size, in bytes, of the returned signature. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - Specify null for `wszFilePath` to calculate the size of the signature without creating the signature. - - The signature can be stored either directly in the file, or returned to the caller. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - + [in] LPCWSTR wszFilePath, + [in] LPCWSTR wszKeyContainer, + [in] BYTE *pbKeyBlob, + [in] ULONG cbKeyBlob, + [out] BYTE **ppbSignatureBlob, + [out] ULONG *pcbSignatureBlob +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the file that contains the manifest of the assembly for which the strong name signature will be generated. + + `wszKeyContainer` + [in] The name of the key container that contains the public/private key pair. + + If `pbKeyBlob` is null, `wszKeyContainer` must specify a valid container within the cryptographic service provider (CSP). In this case, the key pair stored in the container is used to sign the file. + + If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). + + The keys must be 1024-bit Rivest-Shamir-Adleman (RSA) signing keys. No other types of keys are supported at this time. + + `pbKeyBlob` + [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `wszKeyContainer` is assumed to contain the key pair. + + `cbKeyBlob` + [in] The size, in bytes, of `pbKeyBlob`. + + `ppbSignatureBlob` + [out] A pointer to the location to which the common language runtime returns the signature. If `ppbSignatureBlob` is null, the runtime stores the signature in the file specified by `wszFilePath`. + + If `ppbSignatureBlob` is not null, the common language runtime allocates space in which to return the signature. The caller must free this space by using the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method. + + `pcbSignatureBlob` + [out] The size, in bytes, of the returned signature. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + Specify null for `wszFilePath` to calculate the size of the signature without creating the signature. + + The signature can be stored either directly in the file, or returned to the caller. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [StrongNameSignatureGenerationEx Method](iclrstrongname-strongnamesignaturegenerationex-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md index 9ce7e8e367ce2..fde466d3972e5 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md @@ -2,96 +2,95 @@ description: "Learn more about: ICLRStrongName::StrongNameSignatureGenerationEx Method" title: "ICLRStrongName::StrongNameSignatureGenerationEx Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameSignatureGenerationEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameSignatureGenerationEx" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName::StrongNameSignatureGenerationEx method [.NET Framework hosting]" - "StrongNameSignatureGenerationEx method, ICLRStrongName interface [.NET Framework hosting]" -ms.assetid: c3f34584-c6e2-41fd-bb44-e44da8546309 -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::StrongNameSignatureGenerationEx Method -Generates a strong name signature for the specified assembly, according to the specified flags. - -## Syntax - +Generates a strong name signature for the specified assembly, according to the specified flags. + +## Syntax + ```cpp -HRESULT StrongNameSignatureGenerationEx ( - [in] LPCWSTR wszFilePath, - [in] LPCWSTR wszKeyContainer, - [in] BYTE *pbKeyBlob, - [in] ULONG cbKeyBlob, - [out] BYTE **ppbSignatureBlob, - [out] ULONG *pcbSignatureBlob, - [in] DWORD dwFlags -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the file that contains the manifest of the assembly for which the strong name signature will be generated. - - `wszKeyContainer` - [in] The name of the key container that contains the public/private key pair. - - If `pbKeyBlob` is null, `wszKeyContainer` must specify a valid container within the cryptographic service provider (CSP). In this case, the key pair stored in the container is used to sign the file. - - If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). - - `pbKeyBlob` - [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `wszKeyContainer` is assumed to contain the key pair. - - `cbKeyBlob` - [in] The size, in bytes, of `pbKeyBlob`. - - `ppbSignatureBlob` - [out] A pointer to the location to which the common language runtime returns the signature. If `ppbSignatureBlob` is null, the runtime stores the signature in the file specified by `wszFilePath`. - - If `ppbSignatureBlob` is not null, the common language runtime allocates space in which to return the signature. The caller must free this space using the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method. - - `pcbSignatureBlob` - [out] The size, in bytes, of the returned signature. - - `dwFlags` - [in] One or more of the following values: - -- `SN_SIGN_ALL_FILES` (0x00000001) - Recompute all hashes for linked modules. - -- `SN_TEST_SIGN` (0x00000002) - Test-sign the assembly. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - Specify null for `wszFilePath` to calculate the size of the signature without creating the signature. - - The signature can be either stored directly in the file, or returned to the caller. - - If `SN_SIGN_ALL_FILES` is specified but a public key is not included (both `pbKeyBlob` and `wszFilePath` are null), hashes for linked modules are recomputed, but the assembly is not re-signed. - - If `SN_TEST_SIGN` is specified, the common language runtime header is not modified to indicate that the assembly is signed with a strong name. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +HRESULT StrongNameSignatureGenerationEx ( + [in] LPCWSTR wszFilePath, + [in] LPCWSTR wszKeyContainer, + [in] BYTE *pbKeyBlob, + [in] ULONG cbKeyBlob, + [out] BYTE **ppbSignatureBlob, + [out] ULONG *pcbSignatureBlob, + [in] DWORD dwFlags +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the file that contains the manifest of the assembly for which the strong name signature will be generated. + + `wszKeyContainer` + [in] The name of the key container that contains the public/private key pair. + + If `pbKeyBlob` is null, `wszKeyContainer` must specify a valid container within the cryptographic service provider (CSP). In this case, the key pair stored in the container is used to sign the file. + + If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). + + `pbKeyBlob` + [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `wszKeyContainer` is assumed to contain the key pair. + + `cbKeyBlob` + [in] The size, in bytes, of `pbKeyBlob`. + + `ppbSignatureBlob` + [out] A pointer to the location to which the common language runtime returns the signature. If `ppbSignatureBlob` is null, the runtime stores the signature in the file specified by `wszFilePath`. + + If `ppbSignatureBlob` is not null, the common language runtime allocates space in which to return the signature. The caller must free this space using the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method. + + `pcbSignatureBlob` + [out] The size, in bytes, of the returned signature. + + `dwFlags` + [in] One or more of the following values: + +- `SN_SIGN_ALL_FILES` (0x00000001) - Recompute all hashes for linked modules. + +- `SN_TEST_SIGN` (0x00000002) - Test-sign the assembly. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + Specify null for `wszFilePath` to calculate the size of the signature without creating the signature. + + The signature can be either stored directly in the file, or returned to the caller. + + If `SN_SIGN_ALL_FILES` is specified but a public key is not included (both `pbKeyBlob` and `wszFilePath` are null), hashes for linked modules are recomputed, but the assembly is not re-signed. + + If `SN_TEST_SIGN` is specified, the common language runtime header is not modified to indicate that the assembly is signed with a strong name. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [StrongNameSignatureGeneration Method](iclrstrongname-strongnamesignaturegeneration-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md index 5e68c04580ea2..7046e1a6b96b1 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md @@ -2,60 +2,59 @@ description: "Learn more about: ICLRStrongName::StrongNameSignatureSize Method" title: "ICLRStrongName::StrongNameSignatureSize Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameSignatureSize" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameSignatureSize" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName::StrongNameSignatureSize method [.NET Framework hosting]" - "StrongNameSignatureSize method, ICLRStrongName interface [.NET Framework hosting]" -ms.assetid: 76d4f93a-5e25-4399-abcc-a1389549481d -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::StrongNameSignatureSize Method -Returns the size of the strong name signature. This method is typically used by compilers to determine how much space to reserve in the file when creating a delay-signed assembly. - -## Syntax - -```cpp +Returns the size of the strong name signature. This method is typically used by compilers to determine how much space to reserve in the file when creating a delay-signed assembly. + +## Syntax + +```cpp HRESULT StrongNameSignatureSize ( - [in] BYTE *pbPublicKeyBlob, + [in] BYTE *pbPublicKeyBlob, [in] ULONG cbPublicKeyBlob, - [in] DWORD *pcbSize + [in] DWORD *pcbSize ); -``` - -## Parameters - - `pbPublicKeyBlob` - [in] A structure of type [PublicKeyBlob](../strong-naming/publickeyblob-structure.md) that contains the public portion of the key pair used to generate the strong name signature. - - `cbPublicKeyBlob` - [in] The size, in bytes, of `pbPublicKeyBlob`. - - `pcbSize` - [in] The number of bytes required to store the strong name signature. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +``` + +## Parameters + + `pbPublicKeyBlob` + [in] A structure of type [PublicKeyBlob]((../../../framework/unmanaged-api/strong-naming/publickeyblob-structure.md) that contains the public portion of the key pair used to generate the strong name signature. + + `cbPublicKeyBlob` + [in] The size, in bytes, of `pbPublicKeyBlob`. + + `pcbSize` + [in] The number of bytes required to store the strong name signature. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md index f9573607a30f7..4369d2a778fc8 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md @@ -2,74 +2,73 @@ description: "Learn more about: ICLRStrongName::StrongNameSignatureVerification Method" title: "ICLRStrongName::StrongNameSignatureVerification Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameSignatureVerification" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameSignatureVerification" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName::StrongNameSignatureVerification method [.NET Framework hosting]" - "StrongNameSignatureVerification method, ICLRStrongName interface [.NET Framework hosting]" -ms.assetid: 734dc4d1-0a76-4736-b5ac-cb4253b3dd49 -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::StrongNameSignatureVerification Method -Gets a value that indicates whether the assembly manifest at the supplied path contains a strong name signature, which is verified according to the specified flags. - -## Syntax - -```cpp -HRESULT StrongNameSignatureVerification ( - [in] LPCWSTR wszFilePath, - [in] DWORD dwInFlags, - [out] DWORD *pdwOutFlags -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the portable executable (.dll or .exe) file for the assembly to verify. - - `dwInFlags` - [in] Flags to modify the verification behavior. The following values are supported: - -- `SN_INFLAG_FORCE_VER` (0x00000001) - Forces verification even if it is necessary to override registry settings. - -- `SN_INFLAG_INSTALL` (0x00000002) - Specifies that this is the first time the manifest is verified. - -- `SN_INFLAG_ADMIN_ACCESS` (0x00000004) - Specifies that the cache will allow access only to users who have administrative privileges. - -- `SN_INFLAG_USER_ACCESS` (0x00000008) - Specifies that the assembly will be accessible only to the current user. - -- `SN_INFLAG_ALL_ACCESS` (0x00000010) - Specifies that the cache will provide no guarantees of access restriction. - -- `SN_INFLAG_RUNTIME` (0x80000000) - Reserved for internal debugging. - - `pdwOutFlags` - [out] Flags indicating whether the strong name signature was verified. The following value is supported: - -- `SN_OUTFLAG_WAS_VERIFIED` (0x00000001) - This value is set to `false` to specify that the verification succeeded due to registry settings. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets a value that indicates whether the assembly manifest at the supplied path contains a strong name signature, which is verified according to the specified flags. + +## Syntax + +```cpp +HRESULT StrongNameSignatureVerification ( + [in] LPCWSTR wszFilePath, + [in] DWORD dwInFlags, + [out] DWORD *pdwOutFlags +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the portable executable (.dll or .exe) file for the assembly to verify. + + `dwInFlags` + [in] Flags to modify the verification behavior. The following values are supported: + +- `SN_INFLAG_FORCE_VER` (0x00000001) - Forces verification even if it is necessary to override registry settings. + +- `SN_INFLAG_INSTALL` (0x00000002) - Specifies that this is the first time the manifest is verified. + +- `SN_INFLAG_ADMIN_ACCESS` (0x00000004) - Specifies that the cache will allow access only to users who have administrative privileges. + +- `SN_INFLAG_USER_ACCESS` (0x00000008) - Specifies that the assembly will be accessible only to the current user. + +- `SN_INFLAG_ALL_ACCESS` (0x00000010) - Specifies that the cache will provide no guarantees of access restriction. + +- `SN_INFLAG_RUNTIME` (0x80000000) - Reserved for internal debugging. + + `pdwOutFlags` + [out] Flags indicating whether the strong name signature was verified. The following value is supported: + +- `SN_OUTFLAG_WAS_VERIFIED` (0x00000001) - This value is set to `false` to specify that the verification succeeded due to registry settings. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [StrongNameSignatureVerificationEx Method](iclrstrongname-strongnamesignatureverificationex-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md index 66088aa1777f5..06abcd18602e8 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md @@ -2,64 +2,63 @@ description: "Learn more about: ICLRStrongName::StrongNameSignatureVerificationEx Method" title: "ICLRStrongName::StrongNameSignatureVerificationEx Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameSignatureVerificationEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameSignatureVerificationEx" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameSignatureVerificationEx method, ICLRStrongName interface [.NET Framework hosting]" - "ICLRStrongName::StrongNameSignatureVerificationEx method [.NET Framework hosting]" -ms.assetid: dbd2f662-208b-4174-b301-5c99af91040f -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::StrongNameSignatureVerificationEx Method -Gets a value that indicates whether the assembly manifest at the supplied path contains a strong name signature. - -## Syntax - -```cpp -HRESULT StrongNameSignatureVerificationEx ( - [in] LPCWSTR wszFilePath, - [in] BOOLEAN fForceVerification, - [out] BOOLEAN *pfWasVerified -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the portable executable (.exe or .dll) file for the assembly to be verified. - - `fForceVerification` - [in] `true` to perform verification, even if it is necessary to override registry settings; otherwise, `false`. - - `pfWasVerified` - [out] `true` if the strong name signature was verified; otherwise, `false`. `pfWasVerified` is also set to `false` if the verification was successful due to registry settings. - -## Return Value - - `S_OK` if the verification was successful; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - The [ICLRStrongName::StrongNameSignatureVerificationEx](iclrstrongname-strongnamesignatureverificationex-method.md) method provides a capability similar to the [ICLRStrongName::StrongNameSignatureVerification](iclrstrongname-strongnamesignatureverification-method.md) method. However, the second input parameter and the output parameter for [ICLRStrongName::StrongNameSignatureVerificationEx](iclrstrongname-strongnamesignatureverificationex-method.md) are of type `BOOLEAN` instead of `DWORD`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets a value that indicates whether the assembly manifest at the supplied path contains a strong name signature. + +## Syntax + +```cpp +HRESULT StrongNameSignatureVerificationEx ( + [in] LPCWSTR wszFilePath, + [in] BOOLEAN fForceVerification, + [out] BOOLEAN *pfWasVerified +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the portable executable (.exe or .dll) file for the assembly to be verified. + + `fForceVerification` + [in] `true` to perform verification, even if it is necessary to override registry settings; otherwise, `false`. + + `pfWasVerified` + [out] `true` if the strong name signature was verified; otherwise, `false`. `pfWasVerified` is also set to `false` if the verification was successful due to registry settings. + +## Return Value + + `S_OK` if the verification was successful; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + The [ICLRStrongName::StrongNameSignatureVerificationEx](iclrstrongname-strongnamesignatureverificationex-method.md) method provides a capability similar to the [ICLRStrongName::StrongNameSignatureVerification](iclrstrongname-strongnamesignatureverification-method.md) method. However, the second input parameter and the output parameter for [ICLRStrongName::StrongNameSignatureVerificationEx](iclrstrongname-strongnamesignatureverificationex-method.md) are of type `BOOLEAN` instead of `DWORD`. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [StrongNameSignatureVerification Method](iclrstrongname-strongnamesignatureverification-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md index fbe13dc31e788..a66c07e2a51ab 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md @@ -2,78 +2,77 @@ description: "Learn more about: ICLRStrongName::StrongNameSignatureVerificationFromImage Method" title: "ICLRStrongName::StrongNameSignatureVerificationFromImage Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameSignatureVerificationFromImage" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameSignatureVerificationFromImage" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName::StrongNameSignatureVerificationFromImage method [.NET Framework hosting]" - "StrongNameSignatureVerificationFromImage method, ICLRStrongName interface [.NET Framework hosting]" -ms.assetid: da91c138-ee30-4fd4-a040-464d97d7e41a -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::StrongNameSignatureVerificationFromImage Method -Verifies that an assembly that has already been mapped to memory is valid for the associated public key. - -## Syntax - -```cpp -HRESULT StrongNameSignatureVerificationFromImage ( - [in] BYTE *pbBase, - [in] DWORD dwLength, - [in] DWORD dwInFlags, - [out] DWORD *pdwOutFlags -); -``` - -## Parameters - - `pbBase` - [in] The relative virtual address of the mapped assembly manifest. - - `dwLength` - [in] The size, in bytes, of the mapped image. - - `dwInFlags` - [in] Flags that influence verification behavior. The following values are supported: - -- `SN_INFLAG_FORCE_VER` (0x00000001) - Forces verification even if it is necessary to override registry settings. - -- `SN_INFLAG_INSTALL` (0x00000002) - Specifies that this is the first verification performed on this image. - -- `SN_INFLAG_ADMIN_ACCESS` (0x00000004) - Specifies that the cache will allow access only to users who have administrative privileges. - -- `SN_INFLAG_USER_ACCESS` (0x00000008) - Specifies that the assembly will be accessible only to the current user. - -- `SN_INFLAG_ALL_ACCESS` (0x00000010) - Specifies that the cache will provide no guarantees of access restriction. - -- `SN_INFLAG_RUNTIME` (0x80000000) - Reserved for internal debugging. - - `pdwOutFlags` - [out] A flag for additional output information. The following value is supported: - -- `SN_OUTFLAG_WAS_VERIFIED` (0x00000001) - This value is set to `false` to specify that the verification succeeded due to registry settings. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Verifies that an assembly that has already been mapped to memory is valid for the associated public key. + +## Syntax + +```cpp +HRESULT StrongNameSignatureVerificationFromImage ( + [in] BYTE *pbBase, + [in] DWORD dwLength, + [in] DWORD dwInFlags, + [out] DWORD *pdwOutFlags +); +``` + +## Parameters + + `pbBase` + [in] The relative virtual address of the mapped assembly manifest. + + `dwLength` + [in] The size, in bytes, of the mapped image. + + `dwInFlags` + [in] Flags that influence verification behavior. The following values are supported: + +- `SN_INFLAG_FORCE_VER` (0x00000001) - Forces verification even if it is necessary to override registry settings. + +- `SN_INFLAG_INSTALL` (0x00000002) - Specifies that this is the first verification performed on this image. + +- `SN_INFLAG_ADMIN_ACCESS` (0x00000004) - Specifies that the cache will allow access only to users who have administrative privileges. + +- `SN_INFLAG_USER_ACCESS` (0x00000008) - Specifies that the assembly will be accessible only to the current user. + +- `SN_INFLAG_ALL_ACCESS` (0x00000010) - Specifies that the cache will provide no guarantees of access restriction. + +- `SN_INFLAG_RUNTIME` (0x80000000) - Reserved for internal debugging. + + `pdwOutFlags` + [out] A flag for additional output information. The following value is supported: + +- `SN_OUTFLAG_WAS_VERIFIED` (0x00000001) - This value is set to `false` to specify that the verification succeeded due to registry settings. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md index 15e357cc6fc1f..33d5a0c161149 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md @@ -2,66 +2,65 @@ description: "Learn more about: ICLRStrongName::StrongNameTokenFromAssembly Method" title: "ICLRStrongName::StrongNameTokenFromAssembly Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameTokenFromAssembly" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameTokenFromAssembly" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName::StrongNameTokenFromAssembly method [.NET Framework hosting]" - "StrongNameTokenFromAssembly method, ICLRStrongName interface [.NET Framework hosting]" -ms.assetid: fc725afb-b66b-4015-aa44-1c0d1304197f -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::StrongNameTokenFromAssembly Method -Creates a strong name token from the specified assembly file. - -## Syntax - -```cpp -HRESULT StrongNameTokenFromAssembly ( - [in] LPCWSTR wszFilePath, - [out] BYTE **ppbStrongNameToken, - [out] ULONG *pcbStrongNameToken -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the portable executable (PE) file for the assembly. - - `ppbStrongNameToken` - [out] The returned strong name token. - - `pcbStrongNameToken` - [out] The size, in bytes, of the strong name token. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - A strong name token is the shortened form of a public key. The token is a 64-bit hash that is created from the public key used to sign the assembly. The token is a part of the strong name for the assembly, and can be read from the assembly metadata. - - After the token is created, you should call the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method to release the allocated memory. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Creates a strong name token from the specified assembly file. + +## Syntax + +```cpp +HRESULT StrongNameTokenFromAssembly ( + [in] LPCWSTR wszFilePath, + [out] BYTE **ppbStrongNameToken, + [out] ULONG *pcbStrongNameToken +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the portable executable (PE) file for the assembly. + + `ppbStrongNameToken` + [out] The returned strong name token. + + `pcbStrongNameToken` + [out] The size, in bytes, of the strong name token. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + A strong name token is the shortened form of a public key. The token is a 64-bit hash that is created from the public key used to sign the assembly. The token is a part of the strong name for the assembly, and can be read from the assembly metadata. + + After the token is created, you should call the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method to release the allocated memory. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [StrongNameTokenFromAssemblyEx Method](iclrstrongname-strongnametokenfromassemblyex-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md index ed6385ebcbbe7..cf244d5edaba7 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md @@ -2,74 +2,73 @@ description: "Learn more about: ICLRStrongName::StrongNameTokenFromAssemblyEx Method" title: "ICLRStrongName::StrongNameTokenFromAssemblyEx Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameTokenFromAssemblyEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameTokenFromAssemblyEx" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameTokenFromAssemblyEx method, ICLRStrongName interface [.NET Framework hosting]" - "ICLRStrongName::StrongNameTokenFromAssemblyEx method [.NET Framework hosting]" -ms.assetid: 648ea90e-5e60-40a0-a56a-3e61bf2fba7c -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::StrongNameTokenFromAssemblyEx Method -Creates a strong name token from the specified assembly file, and returns the public key that the token represents. - -## Syntax - -```cpp -HRESULT StrongNameTokenFromAssemblyEx ( - [in] LPCWSTR wszFilePath, - [out] BYTE **ppbStrongNameToken, - [out] ULONG *pcbStrongNameToken, - [out] BYTE **ppbPublicKeyBlob, - [out] ULONG *pcbPublicKeyBlob -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the portable executable (PE) file for the assembly. - - `ppbStrongNameToken` - [out] The returned strong name token. - - `pcbStrongNameToken` - [out] The size, in bytes, of the strong name token. - - `ppbPublicKeyBlob` - [out] The returned public key. - - `pcbPublicKeyBlob` - [out] The size, in bytes, of the public key. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - A strong name token is the shortened form of a public key. The token is a 64-bit hash that is created from the public key used to sign the assembly. The token is a part of the strong name for the assembly, and can be read from the assembly metadata. - - After the key is retrieved and the token is created, you should call the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method to release the allocated memory. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Creates a strong name token from the specified assembly file, and returns the public key that the token represents. + +## Syntax + +```cpp +HRESULT StrongNameTokenFromAssemblyEx ( + [in] LPCWSTR wszFilePath, + [out] BYTE **ppbStrongNameToken, + [out] ULONG *pcbStrongNameToken, + [out] BYTE **ppbPublicKeyBlob, + [out] ULONG *pcbPublicKeyBlob +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the portable executable (PE) file for the assembly. + + `ppbStrongNameToken` + [out] The returned strong name token. + + `pcbStrongNameToken` + [out] The size, in bytes, of the strong name token. + + `ppbPublicKeyBlob` + [out] The returned public key. + + `pcbPublicKeyBlob` + [out] The size, in bytes, of the public key. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + A strong name token is the shortened form of a public key. The token is a 64-bit hash that is created from the public key used to sign the assembly. The token is a part of the strong name for the assembly, and can be read from the assembly metadata. + + After the key is retrieved and the token is created, you should call the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method to release the allocated memory. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [StrongNameTokenFromAssembly Method](iclrstrongname-strongnametokenfromassembly-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md index 2e87400225c39..31f7d82579047 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md @@ -2,70 +2,69 @@ description: "Learn more about: ICLRStrongName::StrongNameTokenFromPublicKey Method" title: "ICLRStrongName::StrongNameTokenFromPublicKey Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameTokenFromPublicKey" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameTokenFromPublicKey" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName::StrongNameTokenFromPublicKey method [.NET Framework hosting]" - "StrongNameTokenFromPublicKey method, ICLRStrongName interface [.NET Framework hosting]" -ms.assetid: 7962ce88-7e86-4a6f-8298-621b01ffc3c2 -topic_type: +topic_type: - "apiref" --- # ICLRStrongName::StrongNameTokenFromPublicKey Method -Gets a token that represents a public key. A strong name token is the shortened form of a public key. - -## Syntax - -```cpp +Gets a token that represents a public key. A strong name token is the shortened form of a public key. + +## Syntax + +```cpp HRESULT StrongNameTokenFromPublicKey ( - [in] BYTE *pbPublicKeyBlob, - [in] ULONG cbPublicKeyBlob, - [out] BYTE **ppbStrongNameToken, - [out] ULONG *pcbStrongNameToken -); -``` - -## Parameters - - `pbPublicKeyBlob` - [in] A structure of type [PublicKeyBlob](../strong-naming/publickeyblob-structure.md) that contains the public portion of the key pair used to generate the strong name signature. - - `cbPublicKeyBlob` - [in] The size, in bytes, of `pbPublicKeyBlob`. - - `ppbStrongNameToken` - [out] The strong name token corresponding to the key passed in `pbPublicKeyBlob`. The common language runtime allocates the memory in which to return the token. The caller must free this memory by using the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method. - - `pcbStrongNameToken` - [out] The size, in bytes, of the returned strong name token. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - A strong name token is the shortened form of a public key that is used to save space when storing key information in metadata. Specifically, strong name tokens are used in assembly references to refer to the dependent assembly. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - + [in] BYTE *pbPublicKeyBlob, + [in] ULONG cbPublicKeyBlob, + [out] BYTE **ppbStrongNameToken, + [out] ULONG *pcbStrongNameToken +); +``` + +## Parameters + + `pbPublicKeyBlob` + [in] A structure of type [PublicKeyBlob]((../../../framework/unmanaged-api/strong-naming/publickeyblob-structure.md) that contains the public portion of the key pair used to generate the strong name signature. + + `cbPublicKeyBlob` + [in] The size, in bytes, of `pbPublicKeyBlob`. + + `ppbStrongNameToken` + [out] The strong name token corresponding to the key passed in `pbPublicKeyBlob`. The common language runtime allocates the memory in which to return the token. The caller must free this memory by using the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method. + + `pcbStrongNameToken` + [out] The size, in bytes, of the returned strong name token. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + A strong name token is the shortened form of a public key that is used to save space when storing key information in metadata. Specifically, strong name tokens are used in assembly references to refer to the dependent assembly. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in mscoree.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [StrongNameGetPublicKey Method](iclrstrongname-strongnamegetpublickey-method.md) -- [PublicKeyBlob Structure](../strong-naming/publickeyblob-structure.md) +- [PublicKeyBlob Structure]((../../../framework/unmanaged-api/strong-naming/publickeyblob-structure.md) - [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md b/docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md index e6e0540e02d29..892ee27078df8 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md @@ -2,39 +2,38 @@ description: "Learn more about: ICLRStrongName2 Interface" title: "ICLRStrongName2 Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName2" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName2" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName2 interface [.NET Framework hosting]" -ms.assetid: 9f098a74-201e-4628-a468-8dee9ab99b4a -topic_type: +topic_type: - "apiref" --- # ICLRStrongName2 Interface -Provides the ability to create strong names using the SHA-2 group of Secure Hash Algorithms (SHA-256, SHA-384, and SHA-512). - -## Methods - -|Method|Description| -|------------|-----------------| -|[StrongNameGetPublicKeyEx Method](strongnamegetpublickeyex-method.md)|Gets the public key from a public/private key pair, and specifies a hash algorithm and a signature algorithm.| -|[StrongNameSignatureVerificationEx2 Method](strongnamesignatureverificationex2-method.md)|Verifies the signature of a strongly named assembly, and provides a mapping from the ECMA key to a real key.| - -## Remarks - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] +Provides the ability to create strong names using the SHA-2 group of Secure Hash Algorithms (SHA-256, SHA-384, and SHA-512). + +## Methods + +|Method|Description| +|------------|-----------------| +|[StrongNameGetPublicKeyEx Method](strongnamegetpublickeyex-method.md)|Gets the public key from a public/private key pair, and specifies a hash algorithm and a signature algorithm.| +|[StrongNameSignatureVerificationEx2 Method](strongnamesignatureverificationex2-method.md)|Verifies the signature of a strongly named assembly, and provides a mapping from the ECMA key to a real key.| + +## Remarks + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md index 2e250d88a1809..a6cb754c616a4 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md +++ b/docs/core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md @@ -2,75 +2,74 @@ description: "Learn more about: ICLRSyncManager::CreateRWLockOwnerIterator Method" title: "ICLRSyncManager::CreateRWLockOwnerIterator Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRSyncManager.CreateRWLockOwnerIterator" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRSyncManager::CreateRWLockOwnerIterator" -helpviewer_keywords: +helpviewer_keywords: - "ICLRSyncManager::CreateRWLockOwnerIterator method [.NET Framework hosting]" - "CreateRWLockOwnerIterator method [.NET Framework hosting]" -ms.assetid: b5535b87-9439-424e-b9b3-7d6fafb9819e -topic_type: +topic_type: - "apiref" --- # ICLRSyncManager::CreateRWLockOwnerIterator Method -Requests that the common language runtime (CLR) create an iterator for the host to use to determine the set of tasks waiting on a reader-writer lock. - -## Syntax - -```cpp -HRESULT CreateRWLockOwnerIterator ( - [in] SIZE_T cookie, - [out] SIZE_T *pIterator -); -``` - -## Parameters - - `cookie` - [in] The cookie associated with the desired reader-writer lock. - - `pIterator` - [out] A pointer to an iterator that can be passed to the [GetRWLockOwnerNext](iclrsyncmanager-getrwlockownernext-method.md) and [DeleteRWLockOwnerIterator](iclrsyncmanager-deleterwlockowneriterator-method.md) methods. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateRWLockOwnerIterator` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|HOST_E_INVALIDOPERATION|`CreateRWLockOwnerIterator` was called on a thread that is currently running managed code.| - -## Remarks - - Hosts typically call the `CreateRWLockOwnerIterator`, `DeleteRWLockOwnerIterator`, and `GetRWLockOwnerNext` methods during deadlock detection. The host is responsible for ensuring that the reader-writer lock is still valid, because the CLR makes no attempt to keep the reader-writer lock alive. Several strategies are available for the host to ensure the validity of the lock: - -- The host can block release calls on the reader-writer lock (for example, [IHostSemaphore::ReleaseSemaphore](ihostsemaphore-releasesemaphore-method.md)) while ensuring that this block does not cause deadlock. - -- The host can block the exit from waiting on the event object associated with the reader-writer lock, again ensuring that this block does not cause deadlock. - +Requests that the common language runtime (CLR) create an iterator for the host to use to determine the set of tasks waiting on a reader-writer lock. + +## Syntax + +```cpp +HRESULT CreateRWLockOwnerIterator ( + [in] SIZE_T cookie, + [out] SIZE_T *pIterator +); +``` + +## Parameters + + `cookie` + [in] The cookie associated with the desired reader-writer lock. + + `pIterator` + [out] A pointer to an iterator that can be passed to the [GetRWLockOwnerNext](iclrsyncmanager-getrwlockownernext-method.md) and [DeleteRWLockOwnerIterator](iclrsyncmanager-deleterwlockowneriterator-method.md) methods. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateRWLockOwnerIterator` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|HOST_E_INVALIDOPERATION|`CreateRWLockOwnerIterator` was called on a thread that is currently running managed code.| + +## Remarks + + Hosts typically call the `CreateRWLockOwnerIterator`, `DeleteRWLockOwnerIterator`, and `GetRWLockOwnerNext` methods during deadlock detection. The host is responsible for ensuring that the reader-writer lock is still valid, because the CLR makes no attempt to keep the reader-writer lock alive. Several strategies are available for the host to ensure the validity of the lock: + +- The host can block release calls on the reader-writer lock (for example, [IHostSemaphore::ReleaseSemaphore](ihostsemaphore-releasesemaphore-method.md)) while ensuring that this block does not cause deadlock. + +- The host can block the exit from waiting on the event object associated with the reader-writer lock, again ensuring that this block does not cause deadlock. + > [!NOTE] -> `CreateRWLockOwnerIterator` must be called only on threads that are currently executing unmanaged code. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> `CreateRWLockOwnerIterator` must be called only on threads that are currently executing unmanaged code. + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md index 3ff11fe0bc4f5..3d26dbbc608d2 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md +++ b/docs/core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md @@ -2,63 +2,62 @@ description: "Learn more about: ICLRSyncManager::DeleteRWLockOwnerIterator Method" title: "ICLRSyncManager::DeleteRWLockOwnerIterator Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRSyncManager.DeleteRWLockOwnerIterator" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRSyncManager::DeleteRWLockOwnerIterator" -helpviewer_keywords: +helpviewer_keywords: - "ICLRSyncManager::DeleteRWLockOwnerIterator method [.NET Framework hosting]" - "DeleteRWLockOwnerIterator method [.NET Framework hosting]" -ms.assetid: fcfd340a-b7d6-44e4-8167-2c05b789d483 -topic_type: +topic_type: - "apiref" --- # ICLRSyncManager::DeleteRWLockOwnerIterator Method -Requests that the common language runtime (CLR) destroy an iterator that was created by a call to [ICLRSyncManager::CreateRWLockOwnerIterator](iclrsyncmanager-createrwlockowneriterator-method.md). - -## Syntax - -```cpp -HRESULT DeleteRWLockOwnerIterator ( - [in] SIZE_T Iterator -); -``` - -## Parameters - - `Iterator` - [in] The iterator that was created by using a call to `CreateRWLockOwnerIterator`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`DeleteRWLockOwnerIterator` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The CLR has not been loaded into a process, or is in a state in which it cannot run managed code or successfully process the call.| -|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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The host can call this method and `CreateRWLockOwnerIterator` to ensure that its threading implementation remains synchronized. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Requests that the common language runtime (CLR) destroy an iterator that was created by a call to [ICLRSyncManager::CreateRWLockOwnerIterator](iclrsyncmanager-createrwlockowneriterator-method.md). + +## Syntax + +```cpp +HRESULT DeleteRWLockOwnerIterator ( + [in] SIZE_T Iterator +); +``` + +## Parameters + + `Iterator` + [in] The iterator that was created by using a call to `CreateRWLockOwnerIterator`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`DeleteRWLockOwnerIterator` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The CLR has not been loaded into a process, or is in a state in which it cannot run managed code or successfully process the call.| +|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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The host can call this method and `CreateRWLockOwnerIterator` to ensure that its threading implementation remains synchronized. + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md index d77a7886f5b64..ff6d6633f29a3 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md +++ b/docs/core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md @@ -2,72 +2,71 @@ description: "Learn more about: ICLRSyncManager::GetMonitorOwner Method" title: "ICLRSyncManager::GetMonitorOwner Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRSyncManager.GetMonitorOwner" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRSyncManager::GetMonitorOwner" -helpviewer_keywords: +helpviewer_keywords: - "ICLRSyncManager::GetMonitorOwner method [.NET Framework hosting]" - "GetMonitorOwner method [.NET Framework hosting]" -ms.assetid: 840983a4-396d-47b4-86a0-d35f9b437cdb -topic_type: +topic_type: - "apiref" --- # ICLRSyncManager::GetMonitorOwner Method -Gets the [IHostTask](ihosttask-interface.md) instance that owns the monitor identified by the specified cookie. - -## Syntax - -```cpp -HRESULT GetMonitorOwner ( - [in] SIZE_T cookie, - [out] IHostTask *ppOwnerHostTask -); -``` - -## Parameters - - `cookie` - [in] The cookie associated with the monitor. - - `ppOwnerHostTask` - [out] A pointer to the `IHostTask` that currently owns the monitor, or null if no task has ownership. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetMonitorOwner` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The host typically calls `GetMonitorOwner` as part of a deadlock-detection mechanism. The cookie is associated with a monitor when it is created by using a call to [IHostSyncManager::CreateMonitorEvent](ihostsyncmanager-createmonitorevent-method.md). - +Gets the [IHostTask](ihosttask-interface.md) instance that owns the monitor identified by the specified cookie. + +## Syntax + +```cpp +HRESULT GetMonitorOwner ( + [in] SIZE_T cookie, + [out] IHostTask *ppOwnerHostTask +); +``` + +## Parameters + + `cookie` + [in] The cookie associated with the monitor. + + `ppOwnerHostTask` + [out] A pointer to the `IHostTask` that currently owns the monitor, or null if no task has ownership. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetMonitorOwner` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The host typically calls `GetMonitorOwner` as part of a deadlock-detection mechanism. The cookie is associated with a monitor when it is created by using a call to [IHostSyncManager::CreateMonitorEvent](ihostsyncmanager-createmonitorevent-method.md). + > [!NOTE] -> A call to release the event underlying the monitor might block—but will not deadlock—if a call to this method is currently in effect on the cookie associated with that monitor. Other tasks might also block if they attempt to acquire this monitor. - - `GetMonitorOwner` always returns immediately and can be called any time after a call to `CreateMonitorEvent`. The host does not need to wait until a task is waiting on the event. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> A call to release the event underlying the monitor might block—but will not deadlock—if a call to this method is currently in effect on the cookie associated with that monitor. Other tasks might also block if they attempt to acquire this monitor. + + `GetMonitorOwner` always returns immediately and can be called any time after a call to `CreateMonitorEvent`. The host does not need to wait until a task is waiting on the event. + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md index a89a38e04b9f1..a183bd35db2c7 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md +++ b/docs/core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md @@ -2,70 +2,69 @@ description: "Learn more about: ICLRSyncManager::GetRWLockOwnerNext Method" title: "ICLRSyncManager::GetRWLockOwnerNext Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRSyncManager.GetRWLockOwnerNext" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRSyncManager::GetRWLockOwnerNext" -helpviewer_keywords: +helpviewer_keywords: - "ICLRSyncManager::GetRWLockOwnerNext method [.NET Framework hosting]" - "GetRWLockOwnerNext method [.NET Framework hosting]" -ms.assetid: 0e025b6a-280e-40a2-a2d0-b15f58777b81 -topic_type: +topic_type: - "apiref" --- # ICLRSyncManager::GetRWLockOwnerNext Method -Gets the next [IHostTask](ihosttask-interface.md) instance that is blocked on the current reader-writer lock. - -## Syntax - +Gets the next [IHostTask](ihosttask-interface.md) instance that is blocked on the current reader-writer lock. + +## Syntax + ```cpp -HRESULT GetRWLockOwnerNext ( - [in] SIZE_T Iterator, - [out] IHostTask *ppOwnerHostTask -); -``` - -## Parameters - - `Iterator` - [in] The iterator that was created by using a call to [CreateRWLockOwnerIterator](iclrsyncmanager-createrwlockowneriterator-method.md). - - `ppOwnerHostTask` - [out] A pointer to the next `IHostTask` that is waiting on the lock, or null if no task is waiting. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetRWLockOwnerNext` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - If `ppOwnerHostTask` is set to null, the iteration has terminated, and the host should call the [DeleteRWLockOwnerIterator](iclrsyncmanager-deleterwlockowneriterator-method.md) method. - +HRESULT GetRWLockOwnerNext ( + [in] SIZE_T Iterator, + [out] IHostTask *ppOwnerHostTask +); +``` + +## Parameters + + `Iterator` + [in] The iterator that was created by using a call to [CreateRWLockOwnerIterator](iclrsyncmanager-createrwlockowneriterator-method.md). + + `ppOwnerHostTask` + [out] A pointer to the next `IHostTask` that is waiting on the lock, or null if no task is waiting. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetRWLockOwnerNext` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + If `ppOwnerHostTask` is set to null, the iteration has terminated, and the host should call the [DeleteRWLockOwnerIterator](iclrsyncmanager-deleterwlockowneriterator-method.md) method. + > [!NOTE] -> The CLR calls `AddRef` on the `IHostTask` to which `ppOwnerHostTask` points to prevent this task from exiting while the host holds the pointer. The host must call `Release` to decrement the reference count when it is finished. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> The CLR calls `AddRef` on the `IHostTask` to which `ppOwnerHostTask` points to prevent this task from exiting while the host holds the pointer. The host must call `Release` to decrement the reference count when it is finished. + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md index 7dd4517c81b60..15bcc274dd952 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md @@ -2,43 +2,42 @@ description: "Learn more about: ICLRSyncManager Interface" title: "ICLRSyncManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRSyncManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRSyncManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLRSyncManager interface [.NET Framework hosting]" -ms.assetid: a49f9d80-1c76-4ddd-8c49-34f913a5c596 -topic_type: +topic_type: - "apiref" --- # ICLRSyncManager Interface -Defines methods that allow the host to get information about requested tasks and to detect deadlocks in its synchronization implementation. - -## Methods - -|Method|Description| -|------------|-----------------| -|[CreateRWLockOwnerIterator Method](iclrsyncmanager-createrwlockowneriterator-method.md)|Requests that the common language runtime (CLR) create an iterator for the host to use to determine the set of tasks waiting on a reader-writer lock.| -|[DeleteRWLockOwnerIterator Method](iclrsyncmanager-deleterwlockowneriterator-method.md)|Requests that the CLR destroy an iterator that was created by a call to `CreateRWLockOwnerIterator`.| -|[GetMonitorOwner Method](iclrsyncmanager-getmonitorowner-method.md)|Gets the task that owns the specified monitor.| -|[GetRWLockOwnerNext Method](iclrsyncmanager-getrwlockownernext-method.md)|Gets the next task that is waiting on the current reader-writer lock.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Defines methods that allow the host to get information about requested tasks and to detect deadlocks in its synchronization implementation. + +## Methods + +|Method|Description| +|------------|-----------------| +|[CreateRWLockOwnerIterator Method](iclrsyncmanager-createrwlockowneriterator-method.md)|Requests that the common language runtime (CLR) create an iterator for the host to use to determine the set of tasks waiting on a reader-writer lock.| +|[DeleteRWLockOwnerIterator Method](iclrsyncmanager-deleterwlockowneriterator-method.md)|Requests that the CLR destroy an iterator that was created by a call to `CreateRWLockOwnerIterator`.| +|[GetMonitorOwner Method](iclrsyncmanager-getmonitorowner-method.md)|Gets the task that owns the specified monitor.| +|[GetRWLockOwnerNext Method](iclrsyncmanager-getrwlockownernext-method.md)|Gets the next task that is waiting on the current reader-writer lock.| + +## 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 2.0 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/iclrtask-abort-method.md b/docs/core/unmanaged-api/hosting/iclrtask-abort-method.md index 69b2c6eb8604d..0c0d0a1036fd8 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-abort-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-abort-method.md @@ -2,56 +2,55 @@ description: "Learn more about: ICLRTask::Abort Method" title: "ICLRTask::Abort Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask.Abort" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask::Abort" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTask::Abort method [.NET Framework hosting]" - "Abort method, ICLRTask interface [.NET Framework hosting]" -ms.assetid: b3594b5f-2e41-4e36-9096-3586276a138c -topic_type: +topic_type: - "apiref" --- # ICLRTask::Abort Method -Requests that the common language runtime (CLR) abort the task that the current [ICLRTask](iclrtask-interface.md) instance represents. - -## Syntax - -```cpp -HRESULT Abort (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Abort` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR raises a when the host calls `Abort`. It returns immediately after the exception information is initialized, without waiting for user code, such as finalizers or exception handling mechanisms, to execute. Calls to `Abort` thus return quickly. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Requests that the common language runtime (CLR) abort the task that the current [ICLRTask](iclrtask-interface.md) instance represents. + +## Syntax + +```cpp +HRESULT Abort (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Abort` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR raises a when the host calls `Abort`. It returns immediately after the exception information is initialized, without waiting for user code, such as finalizers or exception handling mechanisms, to execute. Calls to `Abort` thus return quickly. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md b/docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md index aefecbd748cc1..0aae775af077e 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md @@ -2,56 +2,55 @@ description: "Learn more about: ICLRTask::ExitTask Method" title: "ICLRTask::ExitTask Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask.ExitTask" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask::ExitTask" -helpviewer_keywords: +helpviewer_keywords: - "ExitTask method [.NET Framework hosting]" - "ICLRTask::ExitTask method [.NET Framework hosting]" -ms.assetid: 746c85a6-4b33-4f72-a2e9-379fdf2e96af -topic_type: +topic_type: - "apiref" --- # ICLRTask::ExitTask Method -Notifies the common language runtime (CLR) that the task represented by the current [ICLRTask](iclrtask-interface.md) instance is ending, and attempts to shut the task down gracefully. - -## Syntax - -```cpp -HRESULT ExitTask (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`ExitTask` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `ExitTask` attempts a clean shutdown of a task, in a manner analogous to detaching a thread from an unmanaged type library. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Notifies the common language runtime (CLR) that the task represented by the current [ICLRTask](iclrtask-interface.md) instance is ending, and attempts to shut the task down gracefully. + +## Syntax + +```cpp +HRESULT ExitTask (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`ExitTask` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `ExitTask` attempts a clean shutdown of a task, in a manner analogous to detaching a thread from an unmanaged type library. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md b/docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md index f598edc568482..dd76a53a297db 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md @@ -2,59 +2,58 @@ description: "Learn more about: ICLRTask::GetMemStats Method" title: "ICLRTask::GetMemStats Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask.GetMemStats" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask::GetMemStats" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTask::GetMemStats method [.NET Framework hosting]" - "GetMemStats method [.NET Framework hosting]" -ms.assetid: c9e07657-1682-4c30-a336-f8658ff1a125 -topic_type: +topic_type: - "apiref" --- # ICLRTask::GetMemStats Method -Gets statistical memory usage information related to the task that the current [ICLRTask](iclrtask-interface.md) instance represents. - -## Syntax - -```cpp -HRESULT GetMemStats ( - [out] COR_GC_THREAD_STATS *pMemUsage -); -``` - -## Parameters - - `pMemUsage` - [out] A pointer to a [COR_GC_THREAD_STATS](cor-gc-thread-stats-structure.md) instance that contains details about the memory usage of the task, including the number of bytes allocated. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetMemStats` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets statistical memory usage information related to the task that the current [ICLRTask](iclrtask-interface.md) instance represents. + +## Syntax + +```cpp +HRESULT GetMemStats ( + [out] COR_GC_THREAD_STATS *pMemUsage +); +``` + +## Parameters + + `pMemUsage` + [out] A pointer to a [COR_GC_THREAD_STATS](cor-gc-thread-stats-structure.md) instance that contains details about the memory usage of the task, including the number of bytes allocated. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetMemStats` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask-interface.md b/docs/core/unmanaged-api/hosting/iclrtask-interface.md index 7aae80d23f6b1..1fdb372e50310 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-interface.md @@ -2,56 +2,55 @@ description: "Learn more about: ICLRTask Interface" title: "ICLRTask Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTask interface [.NET Framework hosting]" -ms.assetid: b3a44df3-578a-4451-b55e-70c8e7695f5e -topic_type: +topic_type: - "apiref" --- # ICLRTask Interface -Provides methods that allow the host to make requests of the common language runtime (CLR), or to provide notification to the CLR about the associated task. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Abort Method](iclrtask-abort-method.md)|Requests that the CLR abort the task that the current `ICLRTask` instance represents.| -|[ExitTask Method](iclrtask-exittask-method.md)|Notifies the CLR that the task associated with the current `ICLRTask` instance is ending, and attempts to shut the task down gracefully.| -|[GetMemStats Method](iclrtask-getmemstats-method.md)|Gets statistical information on the use of memory resources by the task represented by the current `ICLRTask` instance.| -|[LocksHeld Method](iclrtask-locksheld-method.md)|Gets the number of locks currently held on the task.| -|[NeedsPriorityScheduling Method](iclrtask-needspriorityscheduling-method.md)|Gets a value indicating whether the host should assign a high priority to rescheduling the task represented by the current `ICLRTask` instance.| -|[Reset Method](iclrtask-reset-method.md)|Informs the CLR that the host has completed a task, and enables the CLR to reuse the current `ICLRTask` instance to represent another task.| -|[RudeAbort Method](iclrtask-rudeabort-method.md)|Causes the CLR to abort the task represented by the current `ICLRTask` instance immediately, without a guarantee that finalizers will be executed.| -|[SetTaskIdentifier Method](iclrtask-settaskidentifier-method.md)|Sets a unique identifier for the task represented by the current `ICLRTask` instance, for use in debugging.| -|[SwitchIn Method](iclrtask-switchin-method.md)|Notifies the CLR that the task represented by the current `ICLRTask` instance is in an operable state.| -|[SwitchOut Method](iclrtask-switchout-method.md)|Notifies the CLR that the task represented by the current `ICLRTask` instance is no longer in an operable state.| -|[YieldTask Method](iclrtask-yieldtask-method.md)|Requests that the CLR make processor time available to other tasks. The CLR makes no guarantee that the task will be put in a state where it can yield processing time.| - -## Remarks - - An `ICLRTask` is the representation of a task for the CLR. At any point during code execution, a task can be described either as running or waiting to run. The host calls the `ICLRTask::SwitchIn` method to notify the CLR that the task that the current `ICLRTask` instance represents is now in an operable state. After a call to `ICLRTask::SwitchIn`, the host can schedule the task on any operating system thread, except in cases where the runtime requires thread-affinity, as specified by calls to the [IHostTaskManager::BeginThreadAffinity](ihosttaskmanager-beginthreadaffinity-method.md) and [IHostTaskManager::EndThreadAffinity](ihosttaskmanager-endthreadaffinity-method.md) methods. Some time later, the operating system might decide to remove the task from the thread and place it in a non-running state. For example, this might happen whenever the task blocks on synchronization primitives, or waits for I/O operations to complete. The host calls [SwitchOut](iclrtask-switchout-method.md) to notify the CLR that the task represented by the current `ICLRTask` instance is no longer in an operable state. - - A task typically terminates at the end of code execution. At that time, the host calls `ICLRTask::ExitTask` to destroy the associated `ICLRTask`. However, tasks can also be recycled by using a call to `ICLRTask::Reset`, which allows the `ICLRTask` instance to be used again. This approach prevents the overhead of repeatedly creating and destroying instances. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods that allow the host to make requests of the common language runtime (CLR), or to provide notification to the CLR about the associated task. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Abort Method](iclrtask-abort-method.md)|Requests that the CLR abort the task that the current `ICLRTask` instance represents.| +|[ExitTask Method](iclrtask-exittask-method.md)|Notifies the CLR that the task associated with the current `ICLRTask` instance is ending, and attempts to shut the task down gracefully.| +|[GetMemStats Method](iclrtask-getmemstats-method.md)|Gets statistical information on the use of memory resources by the task represented by the current `ICLRTask` instance.| +|[LocksHeld Method](iclrtask-locksheld-method.md)|Gets the number of locks currently held on the task.| +|[NeedsPriorityScheduling Method](iclrtask-needspriorityscheduling-method.md)|Gets a value indicating whether the host should assign a high priority to rescheduling the task represented by the current `ICLRTask` instance.| +|[Reset Method](iclrtask-reset-method.md)|Informs the CLR that the host has completed a task, and enables the CLR to reuse the current `ICLRTask` instance to represent another task.| +|[RudeAbort Method](iclrtask-rudeabort-method.md)|Causes the CLR to abort the task represented by the current `ICLRTask` instance immediately, without a guarantee that finalizers will be executed.| +|[SetTaskIdentifier Method](iclrtask-settaskidentifier-method.md)|Sets a unique identifier for the task represented by the current `ICLRTask` instance, for use in debugging.| +|[SwitchIn Method](iclrtask-switchin-method.md)|Notifies the CLR that the task represented by the current `ICLRTask` instance is in an operable state.| +|[SwitchOut Method](iclrtask-switchout-method.md)|Notifies the CLR that the task represented by the current `ICLRTask` instance is no longer in an operable state.| +|[YieldTask Method](iclrtask-yieldtask-method.md)|Requests that the CLR make processor time available to other tasks. The CLR makes no guarantee that the task will be put in a state where it can yield processing time.| + +## Remarks + + An `ICLRTask` is the representation of a task for the CLR. At any point during code execution, a task can be described either as running or waiting to run. The host calls the `ICLRTask::SwitchIn` method to notify the CLR that the task that the current `ICLRTask` instance represents is now in an operable state. After a call to `ICLRTask::SwitchIn`, the host can schedule the task on any operating system thread, except in cases where the runtime requires thread-affinity, as specified by calls to the [IHostTaskManager::BeginThreadAffinity](ihosttaskmanager-beginthreadaffinity-method.md) and [IHostTaskManager::EndThreadAffinity](ihosttaskmanager-endthreadaffinity-method.md) methods. Some time later, the operating system might decide to remove the task from the thread and place it in a non-running state. For example, this might happen whenever the task blocks on synchronization primitives, or waits for I/O operations to complete. The host calls [SwitchOut](iclrtask-switchout-method.md) to notify the CLR that the task represented by the current `ICLRTask` instance is no longer in an operable state. + + A task typically terminates at the end of code execution. At that time, the host calls `ICLRTask::ExitTask` to destroy the associated `ICLRTask`. However, tasks can also be recycled by using a call to `ICLRTask::Reset`, which allows the `ICLRTask` instance to be used again. This approach prevents the overhead of repeatedly creating and destroying instances. + +## 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 2.0 + ## See also - [ICLRTaskManager Interface](iclrtaskmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md b/docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md index 2e70a904da78a..2e15d950e92bf 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md @@ -2,59 +2,58 @@ description: "Learn more about: ICLRTask::LocksHeld Method" title: "ICLRTask::LocksHeld Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask.LocksHeld" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask::LocksHeld" -helpviewer_keywords: +helpviewer_keywords: - "LocksHeld method [.NET Framework hosting]" - "ICLRTask::LocksHeld method [.NET Framework hosting]" -ms.assetid: e88a4dc3-02cc-4703-a474-292b71c40657 -topic_type: +topic_type: - "apiref" --- # ICLRTask::LocksHeld Method -Gets the number of locks currently held on the task. - -## Syntax - -```cpp -HRESULT LocksHeld ( - [out] SIZE_T *pLockCount -); -``` - -## Parameters - - `pLockCount` - [out] The number of locks held on the task at the time of the method call. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`LocksHeld` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the number of locks currently held on the task. + +## Syntax + +```cpp +HRESULT LocksHeld ( + [out] SIZE_T *pLockCount +); +``` + +## Parameters + + `pLockCount` + [out] The number of locks held on the task at the time of the method call. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`LocksHeld` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md b/docs/core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md index 16b873671f468..159cdeda9e990 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md @@ -2,63 +2,62 @@ description: "Learn more about: ICLRTask::NeedsPriorityScheduling Method" title: "ICLRTask::NeedsPriorityScheduling Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask.NeedsPriorityScheduling" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask::NeedsPriorityScheduling" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTask::NeedsPriorityScheduling method [.NET Framework hosting]" - "NeedsPriorityScheduling method [.NET Framework hosting]" -ms.assetid: 9c9db3f3-26bf-4317-88de-5eb926a22a1d -topic_type: +topic_type: - "apiref" --- # ICLRTask::NeedsPriorityScheduling Method -Gets a value that indicates whether the current task, which is being switched out, needs to be marked as a high priority for rescheduling. - -## Syntax - -```cpp -HRESULT NeedsPriorityScheduling ( - [out] BOOL *pbNeedsPriorityScheduling -); -``` - -## Parameters - - `pbNeedsPriorityRescheduling` - [out] `true`, if the host should attempt to reschedule the current task instance as soon as possible; otherwise, `false`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`NeedsPriorityRescheduling` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - In situations where the task is close to being collected by the garbage collector, the CLR sets the value of `pbNeedsPriorityScheduling` to `true`, indicating high-priority rescheduling. This allows the host to reschedule the task quickly, thereby minimizing the potential for delays in garbage collection, and enabling the host and the runtime to cooperate in conserving memory resources. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets a value that indicates whether the current task, which is being switched out, needs to be marked as a high priority for rescheduling. + +## Syntax + +```cpp +HRESULT NeedsPriorityScheduling ( + [out] BOOL *pbNeedsPriorityScheduling +); +``` + +## Parameters + + `pbNeedsPriorityRescheduling` + [out] `true`, if the host should attempt to reschedule the current task instance as soon as possible; otherwise, `false`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`NeedsPriorityRescheduling` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + In situations where the task is close to being collected by the garbage collector, the CLR sets the value of `pbNeedsPriorityScheduling` to `true`, indicating high-priority rescheduling. This allows the host to reschedule the task quickly, thereby minimizing the potential for delays in garbage collection, and enabling the host and the runtime to cooperate in conserving memory resources. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask-reset-method.md b/docs/core/unmanaged-api/hosting/iclrtask-reset-method.md index 55bcdf41282fd..31da7e7a1944e 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-reset-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-reset-method.md @@ -2,79 +2,78 @@ description: "Learn more about: ICLRTask::Reset Method" title: "ICLRTask::Reset Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask.Reset" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask::Reset" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTask::Reset method [.NET Framework hosting]" - "Reset method, ICLRTask interface [.NET Framework hosting]" -ms.assetid: 1bfb5d3a-0ffd-4bb4-9bf6-aec00cb675b7 -topic_type: +topic_type: - "apiref" --- # ICLRTask::Reset Method -Informs the common language runtime (CLR) that the host has completed a task, and enables the CLR to reuse the current [ICLRTask](iclrtask-interface.md) instance to represent another task. - -## Syntax - -```cpp -HRESULT Reset ( - [in] BOOL fFull -); -``` - -## Parameters - - `fFull` - [in] `true`, if the runtime should reset all thread-related static values in addition to the security and locale information related to the current `ICLRTask` instance; otherwise, `false`. - - If the value is `true`, the runtime resets data that was stored using or . - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Reset` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR can recycle previously created `ICLRTask` instances to avoid the overhead of repeatedly creating new instances every time it needs a fresh task. The host enables this feature by calling `ICLRTask::Reset` instead of [ICLRTask::ExitTask](iclrtask-exittask-method.md) when it has completed a task. The following list summarizes the normal life cycle of an `ICLRTask` instance: - -1. The runtime creates a new `ICLRTask` instance. - -2. The runtime calls [IHostTaskManager::GetCurrentTask](ihosttaskmanager-getcurrenttask-method.md) to get a reference to the current host task. - -3. The runtime calls [IHostTask::SetCLRTask](ihosttask-setclrtask-method.md) to associate the new instance with the host task. - -4. The task executes and completes. - -5. The host destroys the task by calling `ICLRTask::ExitTask`. - - `Reset` alters this scenario in two ways. In step 5 above, the host calls `Reset` to reset the task to a clean state, and then decouples the `ICLRTask` instance from its associated [IHostTask](ihosttask-interface.md) instance. If desired, the host can also cache the `IHostTask` instance for reuse. In step 1 above, the runtime pulls a recycled `ICLRTask` from the cache instead of creating a new instance. - - This approach works well when the host also has a pool of reusable worker tasks. When the host destroys one of its `IHostTask` instances, it destroys the corresponding `ICLRTask` by calling `ExitTask`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Informs the common language runtime (CLR) that the host has completed a task, and enables the CLR to reuse the current [ICLRTask](iclrtask-interface.md) instance to represent another task. + +## Syntax + +```cpp +HRESULT Reset ( + [in] BOOL fFull +); +``` + +## Parameters + + `fFull` + [in] `true`, if the runtime should reset all thread-related static values in addition to the security and locale information related to the current `ICLRTask` instance; otherwise, `false`. + + If the value is `true`, the runtime resets data that was stored using or . + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Reset` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR can recycle previously created `ICLRTask` instances to avoid the overhead of repeatedly creating new instances every time it needs a fresh task. The host enables this feature by calling `ICLRTask::Reset` instead of [ICLRTask::ExitTask](iclrtask-exittask-method.md) when it has completed a task. The following list summarizes the normal life cycle of an `ICLRTask` instance: + +1. The runtime creates a new `ICLRTask` instance. + +2. The runtime calls [IHostTaskManager::GetCurrentTask](ihosttaskmanager-getcurrenttask-method.md) to get a reference to the current host task. + +3. The runtime calls [IHostTask::SetCLRTask](ihosttask-setclrtask-method.md) to associate the new instance with the host task. + +4. The task executes and completes. + +5. The host destroys the task by calling `ICLRTask::ExitTask`. + + `Reset` alters this scenario in two ways. In step 5 above, the host calls `Reset` to reset the task to a clean state, and then decouples the `ICLRTask` instance from its associated [IHostTask](ihosttask-interface.md) instance. If desired, the host can also cache the `IHostTask` instance for reuse. In step 1 above, the runtime pulls a recycled `ICLRTask` from the cache instead of creating a new instance. + + This approach works well when the host also has a pool of reusable worker tasks. When the host destroys one of its `IHostTask` instances, it destroys the corresponding `ICLRTask` by calling `ExitTask`. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md b/docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md index 89a4a4d1b0aaa..c62cec9eb13a1 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md @@ -2,56 +2,55 @@ description: "Learn more about: ICLRTask::RudeAbort Method" title: "ICLRTask::RudeAbort Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask.RudeAbort" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask::RudeAbort" -helpviewer_keywords: +helpviewer_keywords: - "RudeAbort method, ICLRTask interface [.NET Framework hosting]" - "ICLRTask::RudeAbort method [.NET Framework hosting]" -ms.assetid: b5785468-fcd7-4cc3-8a5d-8796337b53fc -topic_type: +topic_type: - "apiref" --- # ICLRTask::RudeAbort Method -Instructs the common language runtime (CLR) to abort the task represented by the current [ICLRTask Interface](iclrtask-interface.md) instance immediately and unconditionally. - -## Syntax - -```cpp +Instructs the common language runtime (CLR) to abort the task represented by the current [ICLRTask Interface](iclrtask-interface.md) instance immediately and unconditionally. + +## Syntax + +```cpp HRESULT RudeAbort (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`RudeAbort` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - A host calls `RudeAbort` to abort a task immediately. Finalizers and exception handling routines are not guaranteed to be executed. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`RudeAbort` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + A host calls `RudeAbort` to abort a task immediately. Finalizers and exception handling routines are not guaranteed to be executed. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md b/docs/core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md index 86b87f1e6e4a8..183123174ddde 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md @@ -2,63 +2,62 @@ description: "Learn more about: ICLRTask::SetTaskIdentifier Method" title: "ICLRTask::SetTaskIdentifier Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask.SetTaskIdentifier" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask::SetTaskIdentifier" -helpviewer_keywords: +helpviewer_keywords: - "SetTaskIdentifier method [.NET Framework hosting]" - "ICLRTask::SetTaskIdentifier method [.NET Framework hosting]" -ms.assetid: bdb7f047-1e90-40fc-9e3b-d44a16509073 -topic_type: +topic_type: - "apiref" --- # ICLRTask::SetTaskIdentifier Method -Instructs the common language runtime (CLR) to associate the specified identifier value with the task represented by the current [ICLRTask](iclrtask-interface.md) instance. - -## Syntax - -```cpp -HRESULT SetTaskIdentifier ( - [in] DWORD Asked -); -``` - -## Parameters - - `Asked` - [in] The unique identifier for the common language runtime to associate with the task represented by the current `ICLRTask` instance. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetTaskIdentifier` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The host can associate an identifier with a task to help integrate the CLR and the host in a debugging environment. The identifier has no meaning for the CLR. The CLR passes it along to a debugger application. The debugger can use this identifier to associate a CLR call stack with a host call stack, and enable their respective trace information to be unified when viewed in the debugger's user interface. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Instructs the common language runtime (CLR) to associate the specified identifier value with the task represented by the current [ICLRTask](iclrtask-interface.md) instance. + +## Syntax + +```cpp +HRESULT SetTaskIdentifier ( + [in] DWORD Asked +); +``` + +## Parameters + + `Asked` + [in] The unique identifier for the common language runtime to associate with the task represented by the current `ICLRTask` instance. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetTaskIdentifier` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The host can associate an identifier with a task to help integrate the CLR and the host in a debugging environment. The identifier has no meaning for the CLR. The CLR passes it along to a debugger application. The debugger can use this identifier to associate a CLR call stack with a host call stack, and enable their respective trace information to be unified when viewed in the debugger's user interface. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md b/docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md index 145d2763913e3..2f954d52f0558 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md @@ -2,67 +2,66 @@ description: "Learn more about: ICLRTask::SwitchIn Method" title: "ICLRTask::SwitchIn Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask.SwitchIn" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask::SwitchIn" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTask::SwitchIn method [.NET Framework hosting]" - "SwitchIn method [.NET Framework hosting]" -ms.assetid: 3d37ce20-aa65-4043-8f13-7c728b5d8a52 -topic_type: +topic_type: - "apiref" --- # ICLRTask::SwitchIn Method -Notifies the common language runtime (CLR) that the task that the current [ICLRTask](iclrtask-interface.md) instance represents is now in an operable state. - -## Syntax - -```cpp -HRESULT SwitchIn ( - [in] HANDLE threadHandle -); -``` - -## Parameters - - `threadHandle` - [in] A handle to the physical thread on which the task represented by the current `ICLRTask` instance is executing. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SwitchIn` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|HOST_E_INVALIDOPERATION|`SwitchIn` was called without an earlier call to [SwitchOut Method](iclrtask-switchout-method.md).| - -## Remarks - - The `threadHandle` parameter represents a handle to the operating system thread on which the task represented by the current `ICLRTask` instance has been scheduled. If impersonation has occurred on this thread, you must call [IHostSecurityManager::RevertToSelf](ihostsecuritymanager-reverttoself-method.md) before switching in the task. - +Notifies the common language runtime (CLR) that the task that the current [ICLRTask](iclrtask-interface.md) instance represents is now in an operable state. + +## Syntax + +```cpp +HRESULT SwitchIn ( + [in] HANDLE threadHandle +); +``` + +## Parameters + + `threadHandle` + [in] A handle to the physical thread on which the task represented by the current `ICLRTask` instance is executing. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SwitchIn` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|HOST_E_INVALIDOPERATION|`SwitchIn` was called without an earlier call to [SwitchOut Method](iclrtask-switchout-method.md).| + +## Remarks + + The `threadHandle` parameter represents a handle to the operating system thread on which the task represented by the current `ICLRTask` instance has been scheduled. If impersonation has occurred on this thread, you must call [IHostSecurityManager::RevertToSelf](ihostsecuritymanager-reverttoself-method.md) before switching in the task. + > [!NOTE] -> A call to `SwitchIn` without an earlier call to `SwitchOut` fails with an HRESULT value of HOST_E_INVALIDOPERATION. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> A call to `SwitchIn` without an earlier call to `SwitchOut` fails with an HRESULT value of HOST_E_INVALIDOPERATION. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md b/docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md index b37b508ab30de..e930ab72edb22 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md @@ -2,56 +2,55 @@ description: "Learn more about: ICLRTask::SwitchOut Method" title: "ICLRTask::SwitchOut Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask.SwitchOut" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask::SwitchOut" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTask::SwitchOut method [.NET Framework hosting]" - "SwitchOut method [.NET Framework hosting]" -ms.assetid: b6fb168c-b24b-4ecf-a390-2b5ba3317ae6 -topic_type: +topic_type: - "apiref" --- # ICLRTask::SwitchOut Method -Notifies the common language runtime (CLR) that the task represented by the current [ICLRTask](iclrtask-interface.md) instance is no longer in an operable state. - -## Syntax - -```cpp -HRESULT SwitchOut (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SwitchOut` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - A host calls `SwitchOut` to inform the CLR that it has temporarily stopped executing the task that the current `ICLRTask` instance represents, and will reschedule the task. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Notifies the common language runtime (CLR) that the task represented by the current [ICLRTask](iclrtask-interface.md) instance is no longer in an operable state. + +## Syntax + +```cpp +HRESULT SwitchOut (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SwitchOut` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + A host calls `SwitchOut` to inform the CLR that it has temporarily stopped executing the task that the current `ICLRTask` instance represents, and will reschedule the task. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md b/docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md index e5d8285d33fb5..c7142b733d5f4 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md @@ -2,56 +2,55 @@ description: "Learn more about: ICLRTask::YieldTask Method" title: "ICLRTask::YieldTask Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask.YieldTask" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask::YieldTask" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTask::YieldTask method [.NET Framework hosting]" - "YieldTask method [.NET Framework hosting]" -ms.assetid: b8eb4095-3a8f-4be3-9446-63e9893dce7d -topic_type: +topic_type: - "apiref" --- # ICLRTask::YieldTask Method -Requests that the common language runtime (CLR) put aside the task that the current [ICLRTask](iclrtask-interface.md) instance represents, and make the processor time available to other tasks. - -## Syntax - -```cpp -HRESULT YieldTask (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`YieldTask` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - A host calls `YieldTask` to request processor resources for other tasks or processes. This method is primarily intended to allow long-running code to give up CPU time. The runtime attempts to put the task that the current `ICLRTask` instance represents in a state where it can yield processing time, but makes no guarantee of success. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Requests that the common language runtime (CLR) put aside the task that the current [ICLRTask](iclrtask-interface.md) instance represents, and make the processor time available to other tasks. + +## Syntax + +```cpp +HRESULT YieldTask (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`YieldTask` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + A host calls `YieldTask` to request processor resources for other tasks or processes. This method is primarily intended to allow long-running code to give up CPU time. The runtime attempts to put the task that the current `ICLRTask` instance represents in a state where it can yield processing time, but makes no guarantee of success. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md b/docs/core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md index ed69060c5d0b4..136474fc335aa 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md @@ -2,60 +2,59 @@ description: "Learn more about: ICLRTask2::BeginPreventAsyncAbort Method" title: "ICLRTask2::BeginPreventAsyncAbort Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask2.BeginPreventAsyncAbort" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask2::BeginPreventAsyncAbort" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTask2::BeginPreventAsyncAbort method [.NET Framework hosting]" - "BeginPreventAsyncAbort method [.NET Framework hosting]" -ms.assetid: 75754c2f-38c7-4707-85fe-559db4542729 -topic_type: +topic_type: - "apiref" --- # ICLRTask2::BeginPreventAsyncAbort Method -Delays new thread abort requests from resulting in thread aborts on the current thread. - -## Syntax - -```cpp -HRESULT BeginPreventAsyncAbort(); -``` - -## 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.| -|HOST_E_INVALIDOPERATION|The method was called on a thread which is not the current thread.| - -## Remarks - - Calling this method increments the delay-thread-abort counter for the current thread by one. - - Calls to `BeginPreventAsyncAbort` and [ICLRTask2::EndPreventAsyncAbort](iclrtask2-endpreventasyncabort-method.md) can be nested. As long as the counter is greater than zero, thread aborts for the current thread are delayed. If this call is not paired with a call to the `EndPreventAsyncAbort` method, it is possible to reach a state in which thread aborts cannot be delivered to the current thread. - - The delay is not honored for a thread that aborts itself. - - The functionality that is exposed by this feature is used internally by the virtual machine (VM). Misuse of these methods may cause unspecified behavior in the VM. For example, calling `EndPreventAsyncAbort` without first calling `BeginPreventAsyncAbort` could set the counter to zero when the VM has previously incremented it. Similarly, the internal counter is not checked for overflow. If it exceeds its integral limit because it is incremented by both the host and the VM, the resulting behavior is unspecified. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Delays new thread abort requests from resulting in thread aborts on the current thread. + +## Syntax + +```cpp +HRESULT BeginPreventAsyncAbort(); +``` + +## 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.| +|HOST_E_INVALIDOPERATION|The method was called on a thread which is not the current thread.| + +## Remarks + + Calling this method increments the delay-thread-abort counter for the current thread by one. + + Calls to `BeginPreventAsyncAbort` and [ICLRTask2::EndPreventAsyncAbort](iclrtask2-endpreventasyncabort-method.md) can be nested. As long as the counter is greater than zero, thread aborts for the current thread are delayed. If this call is not paired with a call to the `EndPreventAsyncAbort` method, it is possible to reach a state in which thread aborts cannot be delivered to the current thread. + + The delay is not honored for a thread that aborts itself. + + The functionality that is exposed by this feature is used internally by the virtual machine (VM). Misuse of these methods may cause unspecified behavior in the VM. For example, calling `EndPreventAsyncAbort` without first calling `BeginPreventAsyncAbort` could set the counter to zero when the VM has previously incremented it. Similarly, the internal counter is not checked for overflow. If it exceeds its integral limit because it is incremented by both the host and the VM, the resulting behavior is unspecified. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [EndPreventAsyncAbort Method](iclrtask2-endpreventasyncabort-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md b/docs/core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md index 66b1ffa2c626c..b93549cf450a7 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md @@ -2,58 +2,57 @@ description: "Learn more about: ICLRTask2::EndPreventAsyncAbort Method" title: "ICLRTask2::EndPreventAsyncAbort Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask2.EndPreventAsyncAbort" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask2::EndPreventAsyncAbort" -helpviewer_keywords: +helpviewer_keywords: - "EndPreventAsyncAbort method [.NET Framework hosting]" - "ICLRTask2::EndPreventAsyncAbort method [.NET Framework hosting]" -ms.assetid: d8013659-e3df-44b3-814f-a6b534ce62f8 -topic_type: +topic_type: - "apiref" --- # ICLRTask2::EndPreventAsyncAbort Method -Allows new or pending thread abort requests to result in thread aborts on the current thread. - -## Syntax - -```cpp -HRESULT EndPreventAsyncAbort(); -``` - -## 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.| -|HOST_E_INVALIDOPERATION|The method was called on a thread which is not the current thread.| - -## Remarks - - Calling this method decrements the delay-thread-abort counter for the current thread by one. - - Calls to [ICLRTask2::BeginPreventAsyncAbort](iclrtask2-beginpreventasyncabort-method.md) and `EndPreventAsyncAbort` can be nested. As long as the counter is greater than zero, thread aborts for the current thread are delayed. - - The functionality that is exposed by this feature is used internally by the virtual machine (VM). Misuse of these methods may cause unspecified behavior in the VM. For example, calling `EndPreventAsyncAbort` without first calling `BeginPreventAsyncAbort` could set the counter to zero when the VM has previously incremented it. Similarly, the internal counter is not checked for overflow. If it exceeds its integral limit because it is incremented by both the host and the VM, the resulting behavior is unspecified. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Allows new or pending thread abort requests to result in thread aborts on the current thread. + +## Syntax + +```cpp +HRESULT EndPreventAsyncAbort(); +``` + +## 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.| +|HOST_E_INVALIDOPERATION|The method was called on a thread which is not the current thread.| + +## Remarks + + Calling this method decrements the delay-thread-abort counter for the current thread by one. + + Calls to [ICLRTask2::BeginPreventAsyncAbort](iclrtask2-beginpreventasyncabort-method.md) and `EndPreventAsyncAbort` can be nested. As long as the counter is greater than zero, thread aborts for the current thread are delayed. + + The functionality that is exposed by this feature is used internally by the virtual machine (VM). Misuse of these methods may cause unspecified behavior in the VM. For example, calling `EndPreventAsyncAbort` without first calling `BeginPreventAsyncAbort` could set the counter to zero when the VM has previously incremented it. Similarly, the internal counter is not checked for overflow. If it exceeds its integral limit because it is incremented by both the host and the VM, the resulting behavior is unspecified. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [BeginPreventAsyncAbort Method](iclrtask2-beginpreventasyncabort-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask2-interface.md b/docs/core/unmanaged-api/hosting/iclrtask2-interface.md index 5d8d8ba2c26c5..606ebe99496fc 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask2-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrtask2-interface.md @@ -2,53 +2,52 @@ description: "Learn more about: ICLRTask2 Interface" title: "ICLRTask2 Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask2" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask2" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTask2 interface [.NET Framework hosting]" -ms.assetid: b5a22ebc-0582-49de-91f9-97a3d9789290 -topic_type: +topic_type: - "apiref" --- # ICLRTask2 Interface -Provides all the functionality of the [ICLRTask](iclrtask-interface.md) interface; in addition, provides methods that allow thread aborts to be delayed on the current thread. - -## Methods - -|Method|Description| -|------------|-----------------| -|[BeginPreventAsyncAbort Method](iclrtask2-beginpreventasyncabort-method.md)|Delays new thread abort requests on the current thread.| -|[EndPreventAsyncAbort Method](iclrtask2-endpreventasyncabort-method.md)|Allows new or pending thread abort requests to result in thread aborts on the current thread.| - -## Remarks - - The `ICLRTask2` interface inherits the `ICLRTask` interface and adds methods that allow the host to delay thread aborts, to protect a region of code that must not fail. Calling `BeginPreventAsyncAbort` increments the delay-thread-abort counter for the current thread, and calling `EndPreventAsyncAbort` decrements it. Calls to `BeginPreventAsyncAbort` and `EndPreventAsyncAbort` can be nested. As long as the counter is greater than zero, thread aborts for the current thread are delayed. - - If calls to `BeginPreventAsyncAbort` and `EndPreventAsyncAbort` are not paired, it is possible to reach a state in which thread aborts cannot be delivered to the current thread. - - The delay is not honored for a thread that aborts itself. - - The functionality that is exposed by this feature is used internally by the virtual machine (VM). Misuse of these methods may cause unspecified behavior in the VM. For example, calling `EndPreventAsyncAbort` without first calling `BeginPreventAsyncAbort` could set the counter to zero when the VM has previously incremented it. Similarly, the internal counter is not checked for overflow. If it exceeds its integral limit because it is incremented by both the host and the VM, the resulting behavior is unspecified. - - For information about members inherited from `ICLRTask` and about the other uses of this interface, see the [ICLRTask](iclrtask-interface.md) interface. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Provides all the functionality of the [ICLRTask](iclrtask-interface.md) interface; in addition, provides methods that allow thread aborts to be delayed on the current thread. + +## Methods + +|Method|Description| +|------------|-----------------| +|[BeginPreventAsyncAbort Method](iclrtask2-beginpreventasyncabort-method.md)|Delays new thread abort requests on the current thread.| +|[EndPreventAsyncAbort Method](iclrtask2-endpreventasyncabort-method.md)|Allows new or pending thread abort requests to result in thread aborts on the current thread.| + +## Remarks + + The `ICLRTask2` interface inherits the `ICLRTask` interface and adds methods that allow the host to delay thread aborts, to protect a region of code that must not fail. Calling `BeginPreventAsyncAbort` increments the delay-thread-abort counter for the current thread, and calling `EndPreventAsyncAbort` decrements it. Calls to `BeginPreventAsyncAbort` and `EndPreventAsyncAbort` can be nested. As long as the counter is greater than zero, thread aborts for the current thread are delayed. + + If calls to `BeginPreventAsyncAbort` and `EndPreventAsyncAbort` are not paired, it is possible to reach a state in which thread aborts cannot be delivered to the current thread. + + The delay is not honored for a thread that aborts itself. + + The functionality that is exposed by this feature is used internally by the virtual machine (VM). Misuse of these methods may cause unspecified behavior in the VM. For example, calling `EndPreventAsyncAbort` without first calling `BeginPreventAsyncAbort` could set the counter to zero when the VM has previously incremented it. Similarly, the internal counter is not checked for overflow. If it exceeds its integral limit because it is incremented by both the host and the VM, the resulting behavior is unspecified. + + For information about members inherited from `ICLRTask` and about the other uses of this interface, see the [ICLRTask](iclrtask-interface.md) interface. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md index c8f9aaa8446a8..c31da2a2f1a6a 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md @@ -2,69 +2,68 @@ description: "Learn more about: ICLRTaskManager::CreateTask Method" title: "ICLRTaskManager::CreateTask Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTaskManager.CreateTask" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTaskManager::CreateTask" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTaskManager::CreateTask method [.NET Framework hosting]" - "CreateTask method, ICLRTaskManager interface [.NET Framework hosting]" -ms.assetid: eea570d9-2e53-4320-9ea0-eb777bf9dcf3 -topic_type: +topic_type: - "apiref" --- # ICLRTaskManager::CreateTask Method -Requests explicitly that the common language runtime (CLR) create a new task. - -## Syntax - -```cpp -HRESULT CreateTask ( - [out] ICLRTask **pTask -); -``` - -## Parameters - - `pTask` - [out] A pointer to the address of a newly created [ICLRTask](iclrtask-interface.md), or null, if the task could not be created. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory is available to allocate the requested resource.| - -## Remarks - - The CLR creates a new task automatically upon initialization, when user code creates a thread by using types in the namespace, or when the size of the thread pool is increased. It also creates tasks when unmanaged code makes a call to a managed function. - - `CreateTask` allows the host to make an explicit request that the CLR create a new task. For example, the host can invoke this method to preinitialize data structures. - +Requests explicitly that the common language runtime (CLR) create a new task. + +## Syntax + +```cpp +HRESULT CreateTask ( + [out] ICLRTask **pTask +); +``` + +## Parameters + + `pTask` + [out] A pointer to the address of a newly created [ICLRTask](iclrtask-interface.md), or null, if the task could not be created. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory is available to allocate the requested resource.| + +## Remarks + + The CLR creates a new task automatically upon initialization, when user code creates a thread by using types in the namespace, or when the size of the thread pool is increased. It also creates tasks when unmanaged code makes a call to a managed function. + + `CreateTask` allows the host to make an explicit request that the CLR create a new task. For example, the host can invoke this method to preinitialize data structures. + > [!IMPORTANT] -> The new task is returned in a suspended state and remains suspended until the host explicitly calls [IHostTask::Start](ihosttask-start-method.md). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> The new task is returned in a suspended state and remains suspended until the host explicitly calls [IHostTask::Start](ihosttask-start-method.md). + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md index 936c0a96e47c6..1646586916675 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md @@ -2,63 +2,62 @@ description: "Learn more about: ICLRTaskManager::GetCurrentTask Method" title: "ICLRTaskManager::GetCurrentTask Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTaskManager.GetCurrentTask" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTaskManager::GetCurrentTask" -helpviewer_keywords: +helpviewer_keywords: - "GetCurrentTask method, ICLRTaskManager interface [.NET Framework hosting]" - "ICLRTaskManager::GetCurrentTask method [.NET Framework hosting]" -ms.assetid: c0b82a9f-edc6-4878-9c81-48de53c02142 -topic_type: +topic_type: - "apiref" --- # ICLRTaskManager::GetCurrentTask Method -Gets the [ICLRTask](iclrtask-interface.md) instance that is currently running on the operating system thread from which the method call originated. - -## Syntax - -```cpp -HRESULT GetCurrentTask ( - [out] ICLRTask **ppTask -); -``` - -## Parameters - - `ppTask` - [out] A pointer to the address of an `ICLRTask` instance that is currently executing on the operating system thread from which the call originated, or null if no task is currently executing on this thread. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The `ICLRTask` instance that the `ppTask` parameter points to represents the currently executing task for the CLR. The `ICLRTask` instance is associated with a corresponding [IHostTask](ihosttask-interface.md) instance that represents the task for the host. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the [ICLRTask](iclrtask-interface.md) instance that is currently running on the operating system thread from which the method call originated. + +## Syntax + +```cpp +HRESULT GetCurrentTask ( + [out] ICLRTask **ppTask +); +``` + +## Parameters + + `ppTask` + [out] A pointer to the address of an `ICLRTask` instance that is currently executing on the operating system thread from which the call originated, or null if no task is currently executing on this thread. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The `ICLRTask` instance that the `ppTask` parameter points to represents the currently executing task for the CLR. The `ICLRTask` instance is associated with a corresponding [IHostTask](ihosttask-interface.md) instance that represents the task for the host. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md index 86620740376cb..3952b3ce9cd5e 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md @@ -2,48 +2,47 @@ description: "Learn more about: ICLRTaskManager::GetCurrentTaskType Method" title: "ICLRTaskManager::GetCurrentTaskType Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTaskManager.GetCurrentTaskType" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTaskManager::GetCurrentTaskType" -helpviewer_keywords: +helpviewer_keywords: - "GetCurrentTaskType method [.NET Framework hosting]" - "ICLRTaskManager::GetCurrentTaskType method [.NET Framework hosting]" -ms.assetid: 6b0d9259-dbe2-45bb-b34d-990f60c73424 -topic_type: +topic_type: - "apiref" --- # ICLRTaskManager::GetCurrentTaskType Method -Gets the type of the task that is currently executing. - -## Syntax - -```cpp -HRESULT GetCurrentTaskType( - [out] ETaskType *pTaskType -); -``` - -## Parameters - - `pTaskType` - [out] A pointer to a value of the [ETaskType](etasktype-enumeration.md) enumeration that indicates the type of task that is currently executing. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the type of the task that is currently executing. + +## Syntax + +```cpp +HRESULT GetCurrentTaskType( + [out] ETaskType *pTaskType +); +``` + +## Parameters + + `pTaskType` + [out] A pointer to a value of the [ETaskType](etasktype-enumeration.md) enumeration that indicates the type of task that is currently executing. + +## 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 2.0 + ## See also - [ICLRTaskManager Interface](iclrtaskmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md index 4ebf059edec36..3264f1cd7337e 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md @@ -2,48 +2,47 @@ description: "Learn more about: ICLRTaskManager Interface" title: "ICLRTaskManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTaskManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTaskManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTaskManager interface [.NET Framework hosting]" -ms.assetid: 2bd55e0c-001b-41fd-b29d-f01670fe8216 -topic_type: +topic_type: - "apiref" --- # ICLRTaskManager Interface -Provides methods that allow the host to request explicitly that the common language runtime (CLR) create a new task, get the currently executing task, and set the geographic language and culture for the task. - -## Methods - -|Method|Description| -|------------|-----------------| -|[CreateTask Method](iclrtaskmanager-createtask-method.md)|Requests explicitly that the CLR create a new [ICLRTask](iclrtask-interface.md) instance.| -|[GetCurrentTask Method](iclrtaskmanager-getcurrenttask-method.md)|Gets the `ICLRTask` instance that represents the task that is currently executing.| -|[GetCurrentTaskType Method](iclrtaskmanager-getcurrenttasktype-method.md)|Gets the type of the task that is currently executing.| -|[SetLocale Method](iclrtaskmanager-setlocale-method.md)|Notifies the CLR that the host has modified the locale identifier on the currently executing task.| -|[SetUILocale Method](iclrtaskmanager-setuilocale-method.md)|Notifies the common language runtime that the host has modified the user interface locale identifier on the currently executing task.| - -## Remarks - - Each task that is running in a hosted environment has representations both on the host side (an instance of [IHostTask](ihosttask-interface.md)) and on the CLR side (an instance of [ICLRTask](iclrtask-interface.md)). Either the host or the CLR can initiate the creation of a task, but the host-side representation must be associated with a corresponding CLR-side representation to ensure successful communication between the host and the CLR regarding the task. The two objects must be created and instantiated before managed code can execute on an operating system thread. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods that allow the host to request explicitly that the common language runtime (CLR) create a new task, get the currently executing task, and set the geographic language and culture for the task. + +## Methods + +|Method|Description| +|------------|-----------------| +|[CreateTask Method](iclrtaskmanager-createtask-method.md)|Requests explicitly that the CLR create a new [ICLRTask](iclrtask-interface.md) instance.| +|[GetCurrentTask Method](iclrtaskmanager-getcurrenttask-method.md)|Gets the `ICLRTask` instance that represents the task that is currently executing.| +|[GetCurrentTaskType Method](iclrtaskmanager-getcurrenttasktype-method.md)|Gets the type of the task that is currently executing.| +|[SetLocale Method](iclrtaskmanager-setlocale-method.md)|Notifies the CLR that the host has modified the locale identifier on the currently executing task.| +|[SetUILocale Method](iclrtaskmanager-setuilocale-method.md)|Notifies the common language runtime that the host has modified the user interface locale identifier on the currently executing task.| + +## Remarks + + Each task that is running in a hosted environment has representations both on the host side (an instance of [IHostTask](ihosttask-interface.md)) and on the CLR side (an instance of [ICLRTask](iclrtask-interface.md)). Either the host or the CLR can initiate the creation of a task, but the host-side representation must be associated with a corresponding CLR-side representation to ensure successful communication between the host and the CLR regarding the task. The two objects must be created and instantiated before managed code can execute on an operating system thread. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md index 15cd845eda5da..5710b839f8b69 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md @@ -2,63 +2,62 @@ description: "Learn more about: ICLRTaskManager::SetLocale Method" title: "ICLRTaskManager::SetLocale Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTaskManager.SetLocale" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTaskManager::SetLocale" -helpviewer_keywords: +helpviewer_keywords: - "SetLocale method, ICLRTaskManager interface [.NET Framework hosting]" - "ICLRTaskManager::SetLocale method [.NET Framework hosting]" -ms.assetid: ed16bb7f-4206-43a8-b9e9-c5737b69e3af -topic_type: +topic_type: - "apiref" --- # ICLRTaskManager::SetLocale Method -Notifies the common language runtime (CLR) that the host has modified the value of the locale identifier (which maps to the geographical culture and language) on the currently executing task. - -## Syntax - -```cpp -HRESULT SetLocale ( - [in] LCID lcid -); -``` - -## Parameters - - `lcid` - [in] The locale identifier value that maps to the newly assigned geographical culture and language. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `SetLocale` gives the host an opportunity to execute any mechanisms it might have for the synchronization of locales. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Notifies the common language runtime (CLR) that the host has modified the value of the locale identifier (which maps to the geographical culture and language) on the currently executing task. + +## Syntax + +```cpp +HRESULT SetLocale ( + [in] LCID lcid +); +``` + +## Parameters + + `lcid` + [in] The locale identifier value that maps to the newly assigned geographical culture and language. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `SetLocale` gives the host an opportunity to execute any mechanisms it might have for the synchronization of locales. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md b/docs/core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md index ab7be24bdae22..a0ab5544cf3f1 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md +++ b/docs/core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md @@ -2,63 +2,62 @@ description: "Learn more about: ICLRTaskManager::SetUILocale Method" title: "ICLRTaskManager::SetUILocale Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTaskManager.SetUILocale" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTaskManager::SetUILocale" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTaskManager::SetUILocale method [.NET Framework hosting]" - "SetUILocale method, ICLRTaskManager interface [.NET Framework hosting]" -ms.assetid: 03adaa9a-2beb-49b3-b2c4-6b4fc3f10715 -topic_type: +topic_type: - "apiref" --- # ICLRTaskManager::SetUILocale Method -Notifies the common language runtime (CLR) that the host has modified the user interface (UI) locale, or culture, on the currently executing task. - -## Syntax - -```cpp -HRESULT SetUILocale ( - [in] LCID lcid -); -``` - -## Parameters - - `lcid` - [in] The locale identifier value that maps to the newly assigned geographical culture and language for the user interface. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetUILocale` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `SetUILocale` provides an opportunity for the host to execute any mechanisms it might have for the synchronization of locales. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Notifies the common language runtime (CLR) that the host has modified the user interface (UI) locale, or culture, on the currently executing task. + +## Syntax + +```cpp +HRESULT SetUILocale ( + [in] LCID lcid +); +``` + +## Parameters + + `lcid` + [in] The locale identifier value that maps to the newly assigned geographical culture and language for the user interface. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetUILocale` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `SetUILocale` provides an opportunity for the host to execute any mechanisms it might have for the synchronization of locales. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md b/docs/core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md index 27959d39b248c..46efaf2c2dc2d 100644 --- a/docs/core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md +++ b/docs/core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md @@ -2,75 +2,74 @@ description: "Learn more about: ICLRValidator::FormatEventInfo Method" title: "ICLRValidator::FormatEventInfo Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRValidator.FormatEventInfo" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRValidator::FormatEventInfo" -helpviewer_keywords: +helpviewer_keywords: - "FormatEventInfo method, ICLRValidator interface [.NET Framework hosting]" - "ICLRValidator::FormatEventInfo method [.NET Framework hosting]" -ms.assetid: 808e1f1d-52f4-47c4-83cc-dcf47d075219 -topic_type: +topic_type: - "apiref" --- # ICLRValidator::FormatEventInfo Method -Gets a detailed message about the specified validation error. - -## Syntax - -```cpp -HRESULT FormatEventInfo ( - [in] HRESULT hVECode, - [in] VEContext Context, - [in, out] LPWSTR msg, - [in] unsigned long ulMaxLength, - [in] SAFEARRAY(VARIANT) psa -); -``` - -## Parameters - - `hVECode` - [in] The HRESULT value that was passed to the validation error handler. - - `Context` - [in] A `VEContext` instance that contains context information about the validation errors. - - `msg` - [in, out] The friendly error message. - - `ulMaxLength` - [in] The maximum length of the error message. - - `psa` - [in] A safe array of additional parameters to be used in the message. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`FormatEventInfo` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** IValidator.idl, IValidator.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Gets a detailed message about the specified validation error. + +## Syntax + +```cpp +HRESULT FormatEventInfo ( + [in] HRESULT hVECode, + [in] VEContext Context, + [in, out] LPWSTR msg, + [in] unsigned long ulMaxLength, + [in] SAFEARRAY(VARIANT) psa +); +``` + +## Parameters + + `hVECode` + [in] The HRESULT value that was passed to the validation error handler. + + `Context` + [in] A `VEContext` instance that contains context information about the validation errors. + + `msg` + [in, out] The friendly error message. + + `ulMaxLength` + [in] The maximum length of the error message. + + `psa` + [in] A safe array of additional parameters to be used in the message. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`FormatEventInfo` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** IValidator.idl, IValidator.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [ICLRErrorReportingManager Interface](iclrerrorreportingmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrvalidator-interface.md b/docs/core/unmanaged-api/hosting/iclrvalidator-interface.md index 38eac0621b34e..4495318c6893d 100644 --- a/docs/core/unmanaged-api/hosting/iclrvalidator-interface.md +++ b/docs/core/unmanaged-api/hosting/iclrvalidator-interface.md @@ -12,7 +12,6 @@ f1_keywords: - "ICLRValidator" helpviewer_keywords: - "ICLRValidator interface [.NET Framework hosting]" -ms.assetid: 2edd0a10-77fb-4173-91eb-f2970cc364d0 topic_type: - "apiref" --- @@ -35,7 +34,7 @@ Provides methods for validating portable executable (PE) images and reporting va **Library:** Included 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/hosting/iclrvalidator-validate-method.md b/docs/core/unmanaged-api/hosting/iclrvalidator-validate-method.md index 39838eb5d8686..79ec33bbfabee 100644 --- a/docs/core/unmanaged-api/hosting/iclrvalidator-validate-method.md +++ b/docs/core/unmanaged-api/hosting/iclrvalidator-validate-method.md @@ -13,7 +13,6 @@ f1_keywords: helpviewer_keywords: - "Validate method, ICLRValidator interface [.NET Framework hosting]" - "ICLRValidator::Validate method [.NET Framework hosting]" -ms.assetid: 0b1b432a-d234-4002-839b-81366c3a8bdc topic_type: - "apiref" --- @@ -81,7 +80,7 @@ HRESULT Validate ( **Library:** Included 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/hosting/icorconfiguration-adddebuggerspecialthread-method.md b/docs/core/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md index 3941e39688c29..c4d59d9ee066d 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md +++ b/docs/core/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md @@ -2,52 +2,51 @@ description: "Learn more about: ICorConfiguration::AddDebuggerSpecialThread Method" title: "ICorConfiguration::AddDebuggerSpecialThread Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorConfiguration.AddDebuggerSpecialThread" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "AddDebuggerSpecialThread" -helpviewer_keywords: +helpviewer_keywords: - "AddDebuggerSpecialThread method [.NET Framework hosting]" - "ICorConfiguration::AddDebuggerSpecialThread method [.NET Framework hosting]" -ms.assetid: 1f1e3239-438e-4be9-a3bb-7d0722d3a76d -topic_type: +topic_type: - "apiref" --- # ICorConfiguration::AddDebuggerSpecialThread Method -Indicates to the debugging services that a particular thread should be allowed to continue executing while the debugger has an application stopped during managed or unmanaged debugging scenarios. - -## Syntax - -```cpp -HRESULT AddDebuggerSpecialThread ( - [in] DWORD dwSpecialThreadId -); -``` - -## Parameters - - `dwSpecialThreadId` - [in] The ID of the thread that should be allowed to continue executing. - -## Remarks - - The specified thread will not be allowed to run managed code or enter the runtime in any way. An example of such a thread would be an in-process thread to support legacy script debuggers. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Indicates to the debugging services that a particular thread should be allowed to continue executing while the debugger has an application stopped during managed or unmanaged debugging scenarios. + +## Syntax + +```cpp +HRESULT AddDebuggerSpecialThread ( + [in] DWORD dwSpecialThreadId +); +``` + +## Parameters + + `dwSpecialThreadId` + [in] The ID of the thread that should be allowed to continue executing. + +## Remarks + + The specified thread will not be allowed to run managed code or enter the runtime in any way. An example of such a thread would be an in-process thread to support legacy script debuggers. + +## 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 2.0 + ## See also - [ICorConfiguration Interface](icorconfiguration-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-interface.md b/docs/core/unmanaged-api/hosting/icorconfiguration-interface.md index a63e430aab317..4750eabe4a000 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-interface.md +++ b/docs/core/unmanaged-api/hosting/icorconfiguration-interface.md @@ -2,43 +2,42 @@ description: "Learn more about: ICorConfiguration Interface" title: "ICorConfiguration Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICorConfiguration" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorConfiguration" -helpviewer_keywords: +helpviewer_keywords: - "ICorConfiguration interface [.NET Framework hosting]" -ms.assetid: aaf96116-372b-4538-afb1-9e0fcdac1f98 -topic_type: +topic_type: - "apiref" --- # ICorConfiguration Interface -Provides methods for configuring the common language runtime (CLR). - -## Methods - -|Method|Description| -|------------|-----------------| -|[AddDebuggerSpecialThread Method](icorconfiguration-adddebuggerspecialthread-method.md)|Indicates to the debugging services that a particular thread should be allowed to continue executing while the debugger has an application stopped during managed or unmanaged debugging scenarios.| -|[SetDebuggerThreadControl Method](icorconfiguration-setdebuggerthreadcontrol-method.md)|Sets the callback interface that the debugging services will call as CLR threads are blocked and unblocked for debugging.| -|[SetGCHostControl Method](icorconfiguration-setgchostcontrol-method.md)|Sets the callback interface to be used by the garbage collector to request the host to change the limits of virtual memory.| -|[SetGCThreadControl Method](icorconfiguration-setgcthreadcontrol-method.md)|Sets the callback interface for scheduling threads for non-runtime tasks that would otherwise be blocked for a garbage collection.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods for configuring the common language runtime (CLR). + +## Methods + +|Method|Description| +|------------|-----------------| +|[AddDebuggerSpecialThread Method](icorconfiguration-adddebuggerspecialthread-method.md)|Indicates to the debugging services that a particular thread should be allowed to continue executing while the debugger has an application stopped during managed or unmanaged debugging scenarios.| +|[SetDebuggerThreadControl Method](icorconfiguration-setdebuggerthreadcontrol-method.md)|Sets the callback interface that the debugging services will call as CLR threads are blocked and unblocked for debugging.| +|[SetGCHostControl Method](icorconfiguration-setgchostcontrol-method.md)|Sets the callback interface to be used by the garbage collector to request the host to change the limits of virtual memory.| +|[SetGCThreadControl Method](icorconfiguration-setgcthreadcontrol-method.md)|Sets the callback interface for scheduling threads for non-runtime tasks that would otherwise be blocked for a garbage collection.| + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md b/docs/core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md index 02d64d44fe775..cd5ac23b37a99 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md +++ b/docs/core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md @@ -2,48 +2,47 @@ description: "Learn more about: ICorConfiguration::SetDebuggerThreadControl Method" title: "ICorConfiguration::SetDebuggerThreadControl Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorConfiguration.SetDebuggerThreadControl" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "SetDebuggerThreadControl" -helpviewer_keywords: +helpviewer_keywords: - "SetDebuggerThreadControl method [.NET Framework hosting]" - "ICorConfiguration::SetDebuggerThreadControl method [.NET Framework hosting]" -ms.assetid: 1ded7639-dacb-4db1-961c-d1ceaec01959 -topic_type: +topic_type: - "apiref" --- # ICorConfiguration::SetDebuggerThreadControl Method -Sets the callback interface that the debugging services will call as common language runtime (CLR) threads are blocked and unblocked for debugging. - -## Syntax - -```cpp -HRESULT SetDebuggerThreadControl ( - [in] IDebuggerThreadControl* pDebuggerThreadControl -); -``` - -## Parameters - - `pDebuggerThreadControl` - [in] A pointer to an [IDebuggerThreadControl](idebuggerthreadcontrol-interface.md) object that notifies the host about the blocking and unblocking of threads by the debugging services. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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 callback interface that the debugging services will call as common language runtime (CLR) threads are blocked and unblocked for debugging. + +## Syntax + +```cpp +HRESULT SetDebuggerThreadControl ( + [in] IDebuggerThreadControl* pDebuggerThreadControl +); +``` + +## Parameters + + `pDebuggerThreadControl` + [in] A pointer to an [IDebuggerThreadControl](idebuggerthreadcontrol-interface.md) object that notifies the host about the blocking and unblocking of threads by the debugging services. + +## 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 2.0 + ## See also - [ICorConfiguration Interface](icorconfiguration-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md b/docs/core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md index d23c42ef2234b..946963bde38b5 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md +++ b/docs/core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md @@ -2,48 +2,47 @@ description: "Learn more about: ICorConfiguration::SetGCHostControl Method" title: "ICorConfiguration::SetGCHostControl Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorConfiguration.SetGCHostControl" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "SetGCHostControl" -helpviewer_keywords: +helpviewer_keywords: - "ICorConfiguration::SetGCHostControl method [.NET Framework hosting]" - "SetGCHostControl method [.NET Framework hosting]" -ms.assetid: bca6bd79-e288-475a-aa46-6bf81541d966 -topic_type: +topic_type: - "apiref" --- # ICorConfiguration::SetGCHostControl Method -Sets the callback interface to be used by the garbage collector to request the host to change the limits of virtual memory. - -## Syntax - -```cpp -HRESULT SetGCHostControl ( - [in] IGCHostControl* pGCHostControl -); -``` - -## Parameters - - `pGCHostControl` - [in] A pointer to an [IGCHostControl](igchostcontrol-interface.md) object that allows the garbage collector to request the host to change the limits of virtual memory. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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 callback interface to be used by the garbage collector to request the host to change the limits of virtual memory. + +## Syntax + +```cpp +HRESULT SetGCHostControl ( + [in] IGCHostControl* pGCHostControl +); +``` + +## Parameters + + `pGCHostControl` + [in] A pointer to an [IGCHostControl](igchostcontrol-interface.md) object that allows the garbage collector to request the host to change the limits of virtual memory. + +## 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 2.0 + ## See also - [ICorConfiguration Interface](icorconfiguration-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md b/docs/core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md index 455b9d07563b9..77160f5c85c55 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md +++ b/docs/core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md @@ -2,52 +2,51 @@ description: "Learn more about: ICorConfiguration::SetGCThreadControl Method" title: "ICorConfiguration::SetGCThreadControl Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorConfiguration.SetGCThreadControl" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "SetGCThreadControl" -helpviewer_keywords: +helpviewer_keywords: - "ICorConfiguration::SetGCThreadControl method [.NET Framework hosting]" - "SetGCThreadControl method [.NET Framework hosting]" -ms.assetid: 72e38e61-3d56-4ae3-b8f6-0ab7922aaf11 -topic_type: +topic_type: - "apiref" --- # ICorConfiguration::SetGCThreadControl Method -Sets the callback interface for scheduling threads for non-runtime tasks that would otherwise be blocked for a garbage collection. - -## Syntax - -```cpp -HRESULT SetGCThreadControl ( - [in] IGCThreadControl* pGCThreadControl -); -``` - -## Parameters - - `pGCThreadControl` - [in] A pointer to an [IGCThreadControl](igcthreadcontrol-interface.md) object that notifies the host about the suspension of threads for non-runtime tasks. - -## Remarks - - The host may choose within the [IGCThreadControl::ThreadIsBlockingForSuspension](igcthreadcontrol-threadisblockingforsuspension-method.md) callback whether to reschedule a thread. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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 callback interface for scheduling threads for non-runtime tasks that would otherwise be blocked for a garbage collection. + +## Syntax + +```cpp +HRESULT SetGCThreadControl ( + [in] IGCThreadControl* pGCThreadControl +); +``` + +## Parameters + + `pGCThreadControl` + [in] A pointer to an [IGCThreadControl](igcthreadcontrol-interface.md) object that notifies the host about the suspension of threads for non-runtime tasks. + +## Remarks + + The host may choose within the [IGCThreadControl::ThreadIsBlockingForSuspension](igcthreadcontrol-threadisblockingforsuspension-method.md) callback whether to reschedule a thread. + +## 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 2.0 + ## See also - [ICorConfiguration Interface](icorconfiguration-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md index e8498251637eb..86c3a749d1dc6 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md @@ -2,57 +2,56 @@ description: "Learn more about: ICorRuntimeHost::CloseEnum Method" title: "ICorRuntimeHost::CloseEnum Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.CloseEnum" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::CloseEnum" -helpviewer_keywords: +helpviewer_keywords: - "CloseEnum method, ICorRuntimeHost interface [.NET Framework hosting]" - "ICorRuntimeHost::CloseEnum method [.NET Framework hosting]" -ms.assetid: f7ce7e8c-0a3e-4587-a180-063e2b85940e -topic_type: +topic_type: - "apiref" --- # ICorRuntimeHost::CloseEnum Method -Resets a domain enumerator back to the beginning of the domain list. - -## Syntax - -```cpp -HRESULT CloseEnum ( - [in] HCORENUM hEnum -); -``` - -## Parameters - - `hEnum` - [in] The enumerator to reset. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** 1.0, 1.1 - +Resets a domain enumerator back to the beginning of the domain list. + +## Syntax + +```cpp +HRESULT CloseEnum ( + [in] HCORENUM hEnum +); +``` + +## Parameters + + `hEnum` + [in] The enumerator to reset. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** 1.0, 1.1 + ## See also - [CorBindToRuntimeEx Function](corbindtoruntimeex-function.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md index 8a5fbf851086a..22c5989fe5cd4 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md @@ -2,65 +2,64 @@ description: "Learn more about: ICorRuntimeHost::CreateDomain Method" title: "ICorRuntimeHost::CreateDomain Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.CreateDomain" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::CreateDomain" -helpviewer_keywords: +helpviewer_keywords: - "CreateDomain method [.NET Framework hosting]" - "ICorRuntimeHost::CreateDomain method [.NET Framework hosting]" -ms.assetid: b96c5ef3-a9df-4c7c-9952-432d3272cb5c -topic_type: +topic_type: - "apiref" --- # ICorRuntimeHost::CreateDomain Method -Creates an application domain. The caller receives an interface pointer of type to an instance of type . - -## Syntax - -```cpp -HRESULT CreateDomain ( - [in] LPWSTR pwzFriendlyName, - [in] IUnknown* pIdentityArray, - [out] void **pAppDomain -); -``` - -## Parameters - - `pwzFriendlyName` - [in] An optional parameter used to give a friendly name to the domain. This friendly name can be displayed in user interfaces such as debuggers to identify the domain. - - `pIdentityArray` - [in] An optional array of pointers to `IIdentity` instances that represent evidence mapped through security policy to establish a permission set. An `IIdentity` object can be obtained by calling the [CreateEvidence](icorruntimehost-createevidence-method.md) method. - - `pAppDomain` - [out] An interface pointer of type to an instance of that can be used to further control the domain. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** 1.0, 1.1 - +Creates an application domain. The caller receives an interface pointer of type to an instance of type . + +## Syntax + +```cpp +HRESULT CreateDomain ( + [in] LPWSTR pwzFriendlyName, + [in] IUnknown* pIdentityArray, + [out] void **pAppDomain +); +``` + +## Parameters + + `pwzFriendlyName` + [in] An optional parameter used to give a friendly name to the domain. This friendly name can be displayed in user interfaces such as debuggers to identify the domain. + + `pIdentityArray` + [in] An optional array of pointers to `IIdentity` instances that represent evidence mapped through security policy to establish a permission set. An `IIdentity` object can be obtained by calling the [CreateEvidence](icorruntimehost-createevidence-method.md) method. + + `pAppDomain` + [out] An interface pointer of type to an instance of that can be used to further control the domain. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** 1.0, 1.1 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md index 7cc138ad9be00..ac562afa919e8 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md @@ -2,73 +2,72 @@ description: "Learn more about: ICorRuntimeHost::CreateDomainEx Method" title: "ICorRuntimeHost::CreateDomainEx Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.CreateDomainEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::CreateDomainEx" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost::CreateDomainEx method [.NET Framework hosting]" - "CreateDomainEx method [.NET Framework hosting]" -ms.assetid: 1bdde382-f8ba-4cc8-94b2-d1ac919c585e -topic_type: +topic_type: - "apiref" --- # ICorRuntimeHost::CreateDomainEx Method -Creates an application domain. The caller receives an interface pointer, of type , to an instance of type . This method allows the caller to pass an IAppDomainSetup instance to configure additional features of the returned instance. - -## Syntax - -```cpp -HRESULT CreateDomainEx ( - [in] LPCWSTR pwzFriendlyName, - [in] IUnknown* pSetup, - [in] IUnknown* pIdentityArray, - [out] IUnknown** pAppDomain -); -``` - -## Parameters - - `pwzFriendlyName` - [in] An optional parameter used to give a friendly name to the domain. This friendly name can be displayed in user interfaces such as debuggers to identify the domain. - - `pSetup` - [in] An optional interface pointer of type `IAppDomainSetup`, obtained by a call to the [ICorRuntimeHost::CreateDomainSetup](icorruntimehost-createdomainsetup-method.md) method. - - `pIdentityArray` - [in] An optional array of pointers to `IIdentity` instances that represent evidence mapped through security policy to establish a permission set. An `IIdentity` object can be obtained by calling the [CreateEvidence](icorruntimehost-createevidence-method.md) method. - - `pAppDomain` - [out] An interface pointer of type to an instance of that can be used to further control the domain. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Remarks - - `CreateDomainEx` extends the capabilities of [CreateDomain](icorruntimehost-createdomain-method.md) by allowing the caller to pass in an `IAppDomainSetup` instance with property values for configuring the application domain. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Version:** 1.0, 1.1 - +Creates an application domain. The caller receives an interface pointer, of type , to an instance of type . This method allows the caller to pass an IAppDomainSetup instance to configure additional features of the returned instance. + +## Syntax + +```cpp +HRESULT CreateDomainEx ( + [in] LPCWSTR pwzFriendlyName, + [in] IUnknown* pSetup, + [in] IUnknown* pIdentityArray, + [out] IUnknown** pAppDomain +); +``` + +## Parameters + + `pwzFriendlyName` + [in] An optional parameter used to give a friendly name to the domain. This friendly name can be displayed in user interfaces such as debuggers to identify the domain. + + `pSetup` + [in] An optional interface pointer of type `IAppDomainSetup`, obtained by a call to the [ICorRuntimeHost::CreateDomainSetup](icorruntimehost-createdomainsetup-method.md) method. + + `pIdentityArray` + [in] An optional array of pointers to `IIdentity` instances that represent evidence mapped through security policy to establish a permission set. An `IIdentity` object can be obtained by calling the [CreateEvidence](icorruntimehost-createevidence-method.md) method. + + `pAppDomain` + [out] An interface pointer of type to an instance of that can be used to further control the domain. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Remarks + + `CreateDomainEx` extends the capabilities of [CreateDomain](icorruntimehost-createdomain-method.md) by allowing the caller to pass in an `IAppDomainSetup` instance with property values for configuring the application domain. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Version:** 1.0, 1.1 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md index b9302e92beace..0beb0735ad632 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md @@ -2,61 +2,60 @@ description: "Learn more about: ICorRuntimeHost::CreateDomainSetup Method" title: "ICorRuntimeHost::CreateDomainSetup Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.CreateDomainSetup" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::CreateDomainSetup" -helpviewer_keywords: +helpviewer_keywords: - "CreateDomainSetup method [.NET Framework hosting]" - "ICorRuntimeHost::CreateDomainSetup method [.NET Framework hosting]" -ms.assetid: c21dab60-fb65-47d9-8a94-7fd47ca53b48 -topic_type: +topic_type: - "apiref" --- # ICorRuntimeHost::CreateDomainSetup Method -Gets an interface pointer of type IAppDomainSetup to an instance. `IAppDomainSetup` provides methods to configure aspects of an application domain before it is created. - -## Syntax - -```cpp -HRESULT CreateDomainSetup ( - [out] IUnknown** pAppDomainSetup -); -``` - -## Parameters - - `pAppDomainSetup` - [out] An interface pointer to an instance. This parameter is typed as `IUnknown`, so callers should generally call `QueryInterface` on this pointer to obtain an interface pointer of type `IAppDomainSetup`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Remarks - - The pointer returned from this method is typically passed as a parameter to the [CreateDomainEx](icorruntimehost-createdomainex-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Version:** 1.0, 1.1 - +Gets an interface pointer of type IAppDomainSetup to an instance. `IAppDomainSetup` provides methods to configure aspects of an application domain before it is created. + +## Syntax + +```cpp +HRESULT CreateDomainSetup ( + [out] IUnknown** pAppDomainSetup +); +``` + +## Parameters + + `pAppDomainSetup` + [out] An interface pointer to an instance. This parameter is typed as `IUnknown`, so callers should generally call `QueryInterface` on this pointer to obtain an interface pointer of type `IAppDomainSetup`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Remarks + + The pointer returned from this method is typically passed as a parameter to the [CreateDomainEx](icorruntimehost-createdomainex-method.md) method. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Version:** 1.0, 1.1 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md index 7307b87334ef1..3095e8880eead 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md @@ -2,61 +2,60 @@ description: "Learn more about: ICorRuntimeHost::CreateEvidence Method" title: "ICorRuntimeHost::CreateEvidence Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.CreateEvidence" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::CreateEvidence" -helpviewer_keywords: +helpviewer_keywords: - "CreateEvidence method [.NET Framework hosting]" - "ICorRuntimeHost::CreateEvidence method [.NET Framework hosting]" -ms.assetid: e235ea80-b84c-4442-a4c3-fc96c25a8eb9 -topic_type: +topic_type: - "apiref" --- # ICorRuntimeHost::CreateEvidence Method -Gets an interface pointer of type , which allows the host to create security evidence to pass to the [CreateDomain](icorruntimehost-createdomain-method.md) or [CreateDomainEx](icorruntimehost-createdomainex-method.md) method. - -## Syntax - -```cpp -HRESULT CreateEvidence ( - [out] IUnknown** pEvidence -); -``` - -## Parameters - - `pEvidence` - [out] A interface pointer to an instance used to create security evidence. This pointer is typed `IUnknown`, so callers should typically call `QueryInterface` on this interface to obtain a pointer to an . - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Remarks - - This method returns an empty collection that cannot be populated from native code. You should use the method instead. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Version:** 1.0, 1.1 - +Gets an interface pointer of type , which allows the host to create security evidence to pass to the [CreateDomain](icorruntimehost-createdomain-method.md) or [CreateDomainEx](icorruntimehost-createdomainex-method.md) method. + +## Syntax + +```cpp +HRESULT CreateEvidence ( + [out] IUnknown** pEvidence +); +``` + +## Parameters + + `pEvidence` + [out] A interface pointer to an instance used to create security evidence. This pointer is typed `IUnknown`, so callers should typically call `QueryInterface` on this interface to obtain a pointer to an . + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Remarks + + This method returns an empty collection that cannot be populated from native code. You should use the method instead. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Version:** 1.0, 1.1 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md index fa06adc5aa06c..96bff315decbc 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md @@ -2,41 +2,40 @@ description: "Learn more about: ICorRuntimeHost::CreateLogicalThreadState Method" title: "ICorRuntimeHost::CreateLogicalThreadState Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.CreateLogicalThreadState" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::CreateLogicalThreadState" -helpviewer_keywords: +helpviewer_keywords: - "CreateLogicalThreadState method [.NET Framework hosting]" - "ICorRuntimeHost::CreateLogicalThreadState method [.NET Framework hosting]" -ms.assetid: 90f5e791-038b-4b05-9bc5-8d4367d0173e -topic_type: +topic_type: - "apiref" --- # ICorRuntimeHost::CreateLogicalThreadState Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CreateLogicalThreadState ( ); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Version:** 1.0, 1.1 - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CreateLogicalThreadState ( ); +``` + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Version:** 1.0, 1.1 + ## See also - [ICorRuntimeHost Interface](icorruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md index aaedb46ef19f5..fee824374f5cf 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md @@ -2,57 +2,56 @@ description: "Learn more about: ICorRuntimeHost::CurrentDomain Method" title: "ICorRuntimeHost::CurrentDomain Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.CurrentDomain" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::CurrentDomain" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost::CreateDomain method [.NET Framework hosting]" - "CurrentDomain method [.NET Framework hosting]" -ms.assetid: dd2afb38-675b-4c3c-a9f3-8ab3b133eb02 -topic_type: +topic_type: - "apiref" --- # ICorRuntimeHost::CurrentDomain Method -Gets an interface pointer of type that represents the domain loaded on the current thread. - -## Syntax - -```cpp -HRESULT CurrentDomain ( - [out] IUnknown** pAppDomain -); -``` - -## Parameters - - `pAppDomain` - [out] A pointer of type that represents the thread's current application domain. This pointer is typed `IUnknown`, so callers should generally call `QueryInterface` to obtain a pointer of type . - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** 1.0, 1.1 - +Gets an interface pointer of type that represents the domain loaded on the current thread. + +## Syntax + +```cpp +HRESULT CurrentDomain ( + [out] IUnknown** pAppDomain +); +``` + +## Parameters + + `pAppDomain` + [out] A pointer of type that represents the thread's current application domain. This pointer is typed `IUnknown`, so callers should generally call `QueryInterface` to obtain a pointer of type . + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** 1.0, 1.1 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md index 2aa19be5d7612..e40d25ebbe43a 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md @@ -2,41 +2,40 @@ description: "Learn more about: ICorRuntimeHost::DeleteLogicalThreadState Method" title: "ICorRuntimeHost::DeleteLogicalThreadState Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.DeleteLogicalThreadState" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::DeleteLogicalThreadState" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost::DeleteLogicalThreadState method [.NET Framework hosting]" - "DeleteLogicalThreadState method [.NET Framework hosting]" -ms.assetid: 34ffc4a6-6553-43df-9b43-779effb67e2c -topic_type: +topic_type: - "apiref" --- # ICorRuntimeHost::DeleteLogicalThreadState Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT DeleteLogicalThreadState ( ); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** 1.0, 1.1 - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT DeleteLogicalThreadState ( ); +``` + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** 1.0, 1.1 + ## See also - [ICorRuntimeHost Interface](icorruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md index 3552ba9e60b5d..aa55dfe2db060 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md @@ -2,57 +2,56 @@ description: "Learn more about: ICorRuntimeHost::EnumDomains Method" title: "ICorRuntimeHost::EnumDomains Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.EnumDomains" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::EnumDomains" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost::EnumDomains method [.NET Framework hosting]" - "EnumDomains method [.NET Framework hosting]" -ms.assetid: 96b74995-0cde-4876-b6df-7fc164e6a5d1 -topic_type: +topic_type: - "apiref" --- # ICorRuntimeHost::EnumDomains Method -Gets an enumerator for the domains in the current process. - -## Syntax - -```cpp -HRESULT EnumDomains ( - [out] HCORENUM *hEnum -); -``` - -## Parameters - - `hEnum` - [out] An enumerator for the domains. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Version:** 1.0, 1.1 - +Gets an enumerator for the domains in the current process. + +## Syntax + +```cpp +HRESULT EnumDomains ( + [out] HCORENUM *hEnum +); +``` + +## Parameters + + `hEnum` + [out] An enumerator for the domains. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Version:** 1.0, 1.1 + ## See also - [ICorRuntimeHost Interface](icorruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md index 499e7beebb99b..f7c735a271bbd 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md @@ -2,52 +2,51 @@ description: "Learn more about: ICorRuntimeHost::GetConfiguration Method" title: "ICorRuntimeHost::GetConfiguration Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.GetConfiguration" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::GetConfiguration" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost::GetConfiguration method [.NET Framework hosting]" - "GetConfiguration method [.NET Framework hosting]" -ms.assetid: c431617a-b055-44a0-8730-48b7a86d9610 -topic_type: +topic_type: - "apiref" --- # ICorRuntimeHost::GetConfiguration Method -Gets an object that allows the host to specify the callback configuration of the common language runtime (CLR). - -## Syntax - -```cpp -HRESULT GetConfiguration( - [out] ICorConfiguration** pConfiguration -); -``` - -## Parameters - - `pConfiguration` - [out] A pointer to the address of an [ICorConfiguration](icorconfiguration-interface.md) object that can be used to configure the CLR. - -## Remarks - - The CLR must be configured prior to its initialization; otherwise, the `GetConfiguration` method returns an HRESULT indicating an error. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** 1.0, 1.1 - +Gets an object that allows the host to specify the callback configuration of the common language runtime (CLR). + +## Syntax + +```cpp +HRESULT GetConfiguration( + [out] ICorConfiguration** pConfiguration +); +``` + +## Parameters + + `pConfiguration` + [out] A pointer to the address of an [ICorConfiguration](icorconfiguration-interface.md) object that can be used to configure the CLR. + +## Remarks + + The CLR must be configured prior to its initialization; otherwise, the `GetConfiguration` method returns an HRESULT indicating an error. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** 1.0, 1.1 + ## See also - [ICorRuntimeHost Interface](icorruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md index 5ee29050c8bd2..e4abfd0524a95 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md @@ -2,59 +2,58 @@ description: "Learn more about: ICorRuntimeHost::GetDefaultDomain Method" title: "ICorRuntimeHost::GetDefaultDomain Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.GetDefaultDomain" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::GetDefaultDomain" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost::GetDefaultDomain method [.NET Framework hosting]" - "GetDefaultDomain method [.NET Framework hosting]" -ms.assetid: 5e17a6fc-f335-4aae-9bb0-c3e1271a9426 -topic_type: +topic_type: - "apiref" --- # ICorRuntimeHost::GetDefaultDomain Method -Gets an interface pointer of type that represents the default domain for the current process. - -## Syntax - -```cpp -HRESULT GetDefaultDomain ( - [out] IUnknown** pAppDomain -); -``` - -## Parameters - - `pAppDomain` - [out] An interface pointer of type to the instance that represents the default application domain for the process. - - This pointer is typed `IUnknown`, so callers should generally call `QueryInterface` to obtain an interface pointer of type . - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** 1.0, 1.1 - +Gets an interface pointer of type that represents the default domain for the current process. + +## Syntax + +```cpp +HRESULT GetDefaultDomain ( + [out] IUnknown** pAppDomain +); +``` + +## Parameters + + `pAppDomain` + [out] An interface pointer of type to the instance that represents the default application domain for the process. + + This pointer is typed `IUnknown`, so callers should generally call `QueryInterface` to obtain an interface pointer of type . + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** 1.0, 1.1 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-interface.md b/docs/core/unmanaged-api/hosting/icorruntimehost-interface.md index f6f7e59d099fc..e780bc695ccde 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-interface.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-interface.md @@ -2,60 +2,59 @@ description: "Learn more about: ICorRuntimeHost Interface" title: "ICorRuntimeHost Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost interface [.NET Framework hosting]" -ms.assetid: 4369533d-7834-4497-bc37-bfea0ad737b1 -topic_type: +topic_type: - "apiref" --- # ICorRuntimeHost Interface -Provides methods that enable the host to start and stop the common language runtime (CLR) explicitly, to create and configure application domains, to access the default domain, and to enumerate all domains running in the process. - - In .NET Framework version 2.0, this interface is superseded by [ICLRRuntimeHost](iclrruntimehost-interface.md). - -## Methods - -|Method|Description| -|------------|-----------------| -|[CloseEnum Method](icorruntimehost-closeenum-method.md)|Resets a domain enumerator back to the beginning of the domain list.| -|[CreateDomain Method](icorruntimehost-createdomain-method.md)|Creates an application domain. The caller receives an interface pointer of type to an instance of type .| -|[CreateDomainEx Method](icorruntimehost-createdomainex-method.md)|Creates an application domain. This method allows the caller to pass an IAppDomainSetup instance to configure additional features of the returned instance.| -|[CreateDomainSetup Method](icorruntimehost-createdomainsetup-method.md)|Gets an interface pointer of type `IAppDomainSetup` to an instance. `IAppDomainSetup` provides methods to configure aspects of an application domain before it is created.| -|[CreateEvidence Method](icorruntimehost-createevidence-method.md)|Gets an interface pointer of type , which allows the host to create security evidence to pass to [CreateDomain](icorruntimehost-createdomain-method.md) or [CreateDomainEx](icorruntimehost-createdomainex-method.md).| -|[CreateLogicalThreadState Method](icorruntimehost-createlogicalthreadstate-method.md)|Do not use.| -|[CurrentDomain Method](icorruntimehost-currentdomain-method.md)|Gets an interface pointer of type that represents the domain loaded on the current thread.| -|[DeleteLogicalThreadState Method](icorruntimehost-deletelogicalthreadstate-method.md)|Do not use.| -|[EnumDomains Method](icorruntimehost-enumdomains-method.md)|Gets an enumerator for the domains in the current process.| -|[GetConfiguration Method](icorruntimehost-getconfiguration-method.md)|Gets an object that allows the host to specify the callback configuration of the CLR.| -|[GetDefaultDomain Method](icorruntimehost-getdefaultdomain-method.md)|Gets an interface pointer of type that represents the default domain for the current process.| -|[LocksHeldByLogicalThread Method](icorruntimehost-locksheldbylogicalthread-method.md)|Do not use.| -|[MapFile Method](icorruntimehost-mapfile-method.md)|Maps the specified file into memory. This method is obsolete.| -|[NextDomain Method](icorruntimehost-nextdomain-method.md)|Gets an interface pointer to the next domain in the enumeration.| -|[Start Method](icorruntimehost-start-method.md)|Starts the CLR.| -|[Stop Method](icorruntimehost-stop-method.md)|Stops the execution of code in the runtime for the current process.| -|[SwitchInLogicalThreadState Method](icorruntimehost-switchinlogicalthreadstate-method.md)|Do not use.| -|[SwitchOutLogicalThreadState Method](icorruntimehost-switchoutlogicalthreadstate-method.md)|Do not use.| -|[UnloadDomain Method](icorruntimehost-unloaddomain-method.md)|Unloads the specified application domain from the current process.| - -## Requirements +Provides methods that enable the host to start and stop the common language runtime (CLR) explicitly, to create and configure application domains, to access the default domain, and to enumerate all domains running in the process. + + In .NET Framework version 2.0, this interface is superseded by [ICLRRuntimeHost](iclrruntimehost-interface.md). + +## Methods + +|Method|Description| +|------------|-----------------| +|[CloseEnum Method](icorruntimehost-closeenum-method.md)|Resets a domain enumerator back to the beginning of the domain list.| +|[CreateDomain Method](icorruntimehost-createdomain-method.md)|Creates an application domain. The caller receives an interface pointer of type to an instance of type .| +|[CreateDomainEx Method](icorruntimehost-createdomainex-method.md)|Creates an application domain. This method allows the caller to pass an IAppDomainSetup instance to configure additional features of the returned instance.| +|[CreateDomainSetup Method](icorruntimehost-createdomainsetup-method.md)|Gets an interface pointer of type `IAppDomainSetup` to an instance. `IAppDomainSetup` provides methods to configure aspects of an application domain before it is created.| +|[CreateEvidence Method](icorruntimehost-createevidence-method.md)|Gets an interface pointer of type , which allows the host to create security evidence to pass to [CreateDomain](icorruntimehost-createdomain-method.md) or [CreateDomainEx](icorruntimehost-createdomainex-method.md).| +|[CreateLogicalThreadState Method](icorruntimehost-createlogicalthreadstate-method.md)|Do not use.| +|[CurrentDomain Method](icorruntimehost-currentdomain-method.md)|Gets an interface pointer of type that represents the domain loaded on the current thread.| +|[DeleteLogicalThreadState Method](icorruntimehost-deletelogicalthreadstate-method.md)|Do not use.| +|[EnumDomains Method](icorruntimehost-enumdomains-method.md)|Gets an enumerator for the domains in the current process.| +|[GetConfiguration Method](icorruntimehost-getconfiguration-method.md)|Gets an object that allows the host to specify the callback configuration of the CLR.| +|[GetDefaultDomain Method](icorruntimehost-getdefaultdomain-method.md)|Gets an interface pointer of type that represents the default domain for the current process.| +|[LocksHeldByLogicalThread Method](icorruntimehost-locksheldbylogicalthread-method.md)|Do not use.| +|[MapFile Method](icorruntimehost-mapfile-method.md)|Maps the specified file into memory. This method is obsolete.| +|[NextDomain Method](icorruntimehost-nextdomain-method.md)|Gets an interface pointer to the next domain in the enumeration.| +|[Start Method](icorruntimehost-start-method.md)|Starts the CLR.| +|[Stop Method](icorruntimehost-stop-method.md)|Stops the execution of code in the runtime for the current process.| +|[SwitchInLogicalThreadState Method](icorruntimehost-switchinlogicalthreadstate-method.md)|Do not use.| +|[SwitchOutLogicalThreadState Method](icorruntimehost-switchoutlogicalthreadstate-method.md)|Do not use.| +|[UnloadDomain Method](icorruntimehost-unloaddomain-method.md)|Unloads the specified application domain from the current process.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** 1.0, 1.1 - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** 1.0, 1.1 - ## See also - diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md index 9e5afa11be3a1..59501bf907924 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md @@ -2,50 +2,49 @@ description: "Learn more about: ICorRuntimeHost::LocksHeldByLogicalThread Method" title: "ICorRuntimeHost::LocksHeldByLogicalThread Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.LocksHeldByLogicalThread" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::LocksHeldByLogicalThread" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost::LocksHeldByLogicalThread method [.NET Framework hosting]" - "LocksHeldByLogicalThread method [.NET Framework hosting]" -ms.assetid: c3601255-d894-4d7c-b1df-c31334551700 -topic_type: +topic_type: - "apiref" --- # ICorRuntimeHost::LocksHeldByLogicalThread Method -Retrieves the number of locks that current thread holds. - - This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT LocksHeldByLogicalThread( - [out] DWORD *pCount -); -``` - -## Parameters - - `pCount` - [out] A pointer to the number of locks that the current thread holds. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** 1.0, 1.1 - +Retrieves the number of locks that current thread holds. + + This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT LocksHeldByLogicalThread( + [out] DWORD *pCount +); +``` + +## Parameters + + `pCount` + [out] A pointer to the number of locks that the current thread holds. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** 1.0, 1.1 + ## See also - [ICorRuntimeHost Interface](icorruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md index d8bd759c99b4a..42758d05f9f0f 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md @@ -2,52 +2,51 @@ description: "Learn more about: ICorRuntimeHost::MapFile Method" title: "ICorRuntimeHost::MapFile Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.MapFile" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::MapFile" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost::MapFile method [.NET Framework hosting]" - "MapFile method [.NET Framework hosting]" -ms.assetid: 45ae0502-0a31-4342-b7e3-f36e1cf738f3 -topic_type: +topic_type: - "apiref" --- # ICorRuntimeHost::MapFile Method -Maps the specified file into memory. This method is obsolete. - -## Syntax - -```cpp -HRESULT MapFile( - [in] HANDLE hFile, - [out] HMODULE* hMapAddress -); -``` - -## Parameters - - `hFile` - [in] The handle of the file to be mapped. - - `hMapAddress` - [out] The starting memory address at which to begin mapping the file. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Version:** 1.0, 1.1 - +Maps the specified file into memory. This method is obsolete. + +## Syntax + +```cpp +HRESULT MapFile( + [in] HANDLE hFile, + [out] HMODULE* hMapAddress +); +``` + +## Parameters + + `hFile` + [in] The handle of the file to be mapped. + + `hMapAddress` + [out] The starting memory address at which to begin mapping the file. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Version:** 1.0, 1.1 + ## See also - [ICorRuntimeHost Interface](icorruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md index 2d8485fbf5163..7db675bbe7e66 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md @@ -2,61 +2,60 @@ description: "Learn more about: ICorRuntimeHost::NextDomain Method" title: "ICorRuntimeHost::NextDomain Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.NextDomain" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::NextDomain" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost::NextDomain method [.NET Framework hosting]" - "NextDomain method [.NET Framework hosting]" -ms.assetid: fe07a05b-f6d6-44b5-ab01-b9a6eb15c350 -topic_type: +topic_type: - "apiref" --- # ICorRuntimeHost::NextDomain Method -Gets an interface pointer to the next domain in the enumeration. - -## Syntax - -```cpp -HRESULT NextDomain ( - [in] HCORENUM hEnum, - [out] void** pAppDomain -); -``` - -## Parameters +Gets an interface pointer to the next domain in the enumeration. - `hEnum` - [in] The enumerator that was obtained through a call to [EnumDomains](icorruntimehost-enumdomains-method.md). - - `pAppDomain` - [out] An interface pointer to the type that represents the next domain in the enumeration, or null, if no more domains exist. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete, or there are no more domains in the enumeration.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Requirements +## Syntax + +```cpp +HRESULT NextDomain ( + [in] HCORENUM hEnum, + [out] void** pAppDomain +); +``` + +## Parameters + + `hEnum` + [in] The enumerator that was obtained through a call to [EnumDomains](icorruntimehost-enumdomains-method.md). + + `pAppDomain` + [out] An interface pointer to the type that represents the next domain in the enumeration, or null, if no more domains exist. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete, or there are no more domains in the enumeration.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** 1.0, 1.1 - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** 1.0, 1.1 - ## See also - diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md index 95d3313fadd92..34615626a1cce 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md @@ -2,54 +2,53 @@ description: "Learn more about: ICorRuntimeHost::Start Method" title: "ICorRuntimeHost::Start Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.Start" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::Start" -helpviewer_keywords: +helpviewer_keywords: - "Start method, ICorRuntimeHost interface [.NET Framework hosting]" - "ICorRuntimeHost::Start method [.NET Framework hosting]" -ms.assetid: c66f3ac5-6489-484a-9bed-c31b711cee01 -topic_type: +topic_type: - "apiref" --- # ICorRuntimeHost::Start Method -Starts the common language runtime (CLR). - -## Syntax - -```cpp -HRESULT Start (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the CLR is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Remarks - - It is typically not necessary to call the `Start` method, because the CLR starts automatically upon the first request to run managed code. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** 1.0, 1.1 - +Starts the common language runtime (CLR). + +## Syntax + +```cpp +HRESULT Start (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the CLR is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Remarks + + It is typically not necessary to call the `Start` method, because the CLR starts automatically upon the first request to run managed code. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** 1.0, 1.1 + ## See also - [ICorRuntimeHost Interface](icorruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md index 4e40f550129af..648503cbee12f 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md @@ -2,57 +2,56 @@ description: "Learn more about: ICorRuntimeHost::Stop Method" title: "ICorRuntimeHost::Stop Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.Stop" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::Stop" -helpviewer_keywords: +helpviewer_keywords: - "Stop method, ICorRuntimeHost interface [.NET Framework hosting]" - "ICorRuntimeHost::Stop method [.NET Framework hosting]" -ms.assetid: 46a0d450-b516-4bef-8b71-8d3bf265cbed -topic_type: +topic_type: - "apiref" --- # ICorRuntimeHost::Stop Method -Stops the execution of code in the runtime for the current process. - -## Syntax - -```cpp -HRESULT Stop (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Remarks - - It is typically unnecessary to call the `Stop` method, because the code stops executing when the process exits. - +Stops the execution of code in the runtime for the current process. + +## Syntax + +```cpp +HRESULT Stop (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Remarks + + It is typically unnecessary to call the `Stop` method, because the code stops executing when the process exits. + > [!NOTE] -> After a call to `Stop`, the CLR cannot be reinitialized into the same process. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** 1.0, 1.1 - +> After a call to `Stop`, the CLR cannot be reinitialized into the same process. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** 1.0, 1.1 + ## See also - [ICorRuntimeHost Interface](icorruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md index 3db3ce4a83435..2d13ef877009a 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md @@ -2,48 +2,47 @@ description: "Learn more about: ICorRuntimeHost::SwitchInLogicalThreadState Method" title: "ICorRuntimeHost::SwitchInLogicalThreadState Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.SwitchInLogicalThreadState" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::SwitchInLogicalThreadState" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost::SwitchInLogicalThreadState method [.NET Framework hosting]" - "SwitchInLogicalThreadState method [.NET Framework hosting]" -ms.assetid: 7df1e492-8014-43ea-80d1-a4743e9b1c17 -topic_type: +topic_type: - "apiref" --- # ICorRuntimeHost::SwitchInLogicalThreadState Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT SwitchInLogicalThreadState( - [in] DWORD *pFiberCookie -); -``` - -## Parameters - - `pFiberCookie` - [in] Cookie that indicates the fiber to use. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Version:** 1.0, 1.1 - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT SwitchInLogicalThreadState( + [in] DWORD *pFiberCookie +); +``` + +## Parameters + + `pFiberCookie` + [in] Cookie that indicates the fiber to use. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Version:** 1.0, 1.1 + ## See also - [ICorRuntimeHost Interface](icorruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md index 8784e9301e70c..2afb488e7d234 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md @@ -2,48 +2,47 @@ description: "Learn more about: ICorRuntimeHost::SwitchOutLogicalThreadState Method" title: "ICorRuntimeHost::SwitchOutLogicalThreadState Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.SwitchOutLogicalThreadState" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::SwitchOutLogicalThreadState" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost::SwitchOutLogicalThreadState method [.NET Framework hosting]" - "SwitchOutLogicalThreadState method [.NET Framework hosting]" -ms.assetid: e1968f0b-2675-4dc2-8507-46164e1df154 -topic_type: +topic_type: - "apiref" --- # ICorRuntimeHost::SwitchOutLogicalThreadState Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT SwitchOutLogicalThreadState( - [out] DWORD **pFiberCookie -); -``` - -## Parameters - - `pFiberCookie` - [out] Cookie that indicates the fiber being switched out. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Version:** 1.0, 1.1 - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT SwitchOutLogicalThreadState( + [out] DWORD **pFiberCookie +); +``` + +## Parameters + + `pFiberCookie` + [out] Cookie that indicates the fiber being switched out. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Version:** 1.0, 1.1 + ## See also - [ICorRuntimeHost Interface](icorruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md index c347ac66fafa3..9344ee25dc50f 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md +++ b/docs/core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md @@ -2,57 +2,56 @@ description: "Learn more about: ICorRuntimeHost::UnloadDomain Method" title: "ICorRuntimeHost::UnloadDomain Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.UnloadDomain" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::UnloadDomain" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost::UnloadDomain method [.NET Framework hosting]" - "UnloadDomain method [.NET Framework hosting]" -ms.assetid: dd9e9204-a80d-44f3-8192-779224b35056 -topic_type: +topic_type: - "apiref" --- # ICorRuntimeHost::UnloadDomain Method -Unloads the specified application domain from the current process. - -## Syntax - -```cpp -HRESULT UnloadDomain ( - [in] IUnknown* pAppDomain -); -``` - -## Parameters - - `pAppDomain` - [in] A pointer of type that represents the domain to be unloaded. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Version:** 1.0, 1.1 - +Unloads the specified application domain from the current process. + +## Syntax + +```cpp +HRESULT UnloadDomain ( + [in] IUnknown* pAppDomain +); +``` + +## Parameters + + `pAppDomain` + [in] A pointer of type that represents the domain to be unloaded. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Version:** 1.0, 1.1 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md index bc25b0e40cedc..546533d5445de 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md @@ -2,44 +2,43 @@ description: "Learn more about: ICorThreadpool::CorBindIoCompletionCallback Method" title: "ICorThreadpool::CorBindIoCompletionCallback Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorThreadpool.CorBindIoCompletionCallback" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorBindIoCompletionCallback" -helpviewer_keywords: +helpviewer_keywords: - "CorBindIoCompletionCallback method [.NET Framework hosting]" - "ICorThreadpool::CorBindIoCompletionCallback method [.NET Framework hosting]" -ms.assetid: 2b159225-f09c-42f1-aa7c-44087e121249 -topic_type: +topic_type: - "apiref" --- # ICorThreadpool::CorBindIoCompletionCallback Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CorBindIoCompletionCallback ( - [in] HANDLE fileHandle, - [in] LPOVERLAPPED_COMPLETION_ROUTINE callback -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CorBindIoCompletionCallback ( + [in] HANDLE fileHandle, + [in] LPOVERLAPPED_COMPLETION_ROUTINE callback +); +``` + +## 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 2.0 + ## See also - [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md index 3df9f06b4f641..bc81303f4af39 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md @@ -2,45 +2,44 @@ description: "Learn more about: ICorThreadpool::CorCallOrQueueUserWorkItem Method" title: "ICorThreadpool::CorCallOrQueueUserWorkItem Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorThreadpool.CorCallOrQueueUserWorkItem" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorCallOrQueueUserWorkItem" -helpviewer_keywords: +helpviewer_keywords: - "ICorThreadpool::CorCallOrQueueUserWorkItem method [.NET Framework hosting]" - "CorCallOrQueueUserWorkItem method [.NET Framework hosting]" -ms.assetid: a2081223-84ca-4331-a8d3-9352f422f3e7 -topic_type: +topic_type: - "apiref" --- # ICorThreadpool::CorCallOrQueueUserWorkItem Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CorCallOrQueueUserWorkItem ( - [in] LPTHREAD_START_ROUTINE Function, - [in] PVOID Context, - [out] BOOL* result -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CorCallOrQueueUserWorkItem ( + [in] LPTHREAD_START_ROUTINE Function, + [in] PVOID Context, + [out] BOOL* result +); +``` + +## 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 2.0 + ## See also - [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md index 982782247c33c..88b813e8c9231 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md @@ -2,46 +2,45 @@ description: "Learn more about: ICorThreadpool::CorChangeTimer Method" title: "ICorThreadpool::CorChangeTimer Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorThreadpool.CorChangeTimer" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorChangeTimer" -helpviewer_keywords: +helpviewer_keywords: - "CorChangeTimer method [.NET Framework hosting]" - "ICorThreadpool::CorChangeTimer method [.NET Framework hosting]" -ms.assetid: 82b03a59-5a87-43ed-9b75-e04b256e1a46 -topic_type: +topic_type: - "apiref" --- # ICorThreadpool::CorChangeTimer Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CorChangeTimer ( +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CorChangeTimer ( [in] HANDLE Timer, [in] ULONG DueTime, - [in] ULONG Period, - [out] BOOL* result -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - + [in] ULONG Period, + [out] BOOL* result +); +``` + +## 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 2.0 + ## See also - [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md index e8256d5575635..81e1d32bcf73b 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md @@ -2,48 +2,47 @@ description: "Learn more about: ICorThreadpool::CorCreateTimer Method" title: "ICorThreadpool::CorCreateTimer Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorThreadpool.CorCreateTimer" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorCreateTimer" -helpviewer_keywords: +helpviewer_keywords: - "CorCreateTimer method [.NET Framework hosting]" - "ICorThreadpool::CorCreateTimer method [.NET Framework hosting]" -ms.assetid: 0d56ef25-30f1-4499-8a1f-76e7654ec614 -topic_type: +topic_type: - "apiref" --- # ICorThreadpool::CorCreateTimer Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CorCreateTimer ( - [in] HANDLE* phNewTimer, - [in] WAITORTIMERCALLBACK Callback, - [in] PVOID Parameter, - [in] DWORD DueTime, - [in] DWORD Period, - [out] BOOL* result -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CorCreateTimer ( + [in] HANDLE* phNewTimer, + [in] WAITORTIMERCALLBACK Callback, + [in] PVOID Parameter, + [in] DWORD DueTime, + [in] DWORD Period, + [out] BOOL* result +); +``` + +## 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 2.0 + ## See also - [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md index 5925ceb5b6bd6..a05bbb92b7750 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md @@ -2,45 +2,44 @@ description: "Learn more about: ICorThreadpool::CorDeleteTimer Method" title: "ICorThreadpool::CorDeleteTimer Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorThreadpool.CorDeleteTimer" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorDeleteTimer" -helpviewer_keywords: +helpviewer_keywords: - "ICorThreadpool::CorDeleteTimer method [.NET Framework hosting]" - "CorDeleteTimer method [.NET Framework hosting]" -ms.assetid: 74847c35-7ca1-466a-b750-b25e7b03d100 -topic_type: +topic_type: - "apiref" --- # ICorThreadpool::CorDeleteTimer Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CorDeleteTimer ( - [in] HANDLE Timer, - [in] HANDLE CompletionEvent, - [out] BOOL* result -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CorDeleteTimer ( + [in] HANDLE Timer, + [in] HANDLE CompletionEvent, + [out] BOOL* result +); +``` + +## 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 2.0 + ## See also - [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md index 31a8243ab82b1..be44305de034e 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md @@ -2,44 +2,43 @@ description: "Learn more about: ICorThreadpool::CorGetAvailableThreads Method" title: "ICorThreadpool::CorGetAvailableThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorThreadpool.CorGetAvailableThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorGetAvailableThreads" -helpviewer_keywords: +helpviewer_keywords: - "CorGetAvailableThreads method [.NET Framework hosting]" - "ICorThreadpool::CorGetAvailableThreads method [.NET Framework hosting]" -ms.assetid: 0b09b750-0b86-4ba4-9621-041857cfe8ba -topic_type: +topic_type: - "apiref" --- # ICorThreadpool::CorGetAvailableThreads Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CorGetAvailableThreads ( - [out] DWORD *AvailableWorkerThreads, - [out] DWORD *AvailableIOCompletionThreads -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CorGetAvailableThreads ( + [out] DWORD *AvailableWorkerThreads, + [out] DWORD *AvailableIOCompletionThreads +); +``` + +## 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 2.0 + ## See also - [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md index 33d9754440ffa..e5be8ee736f97 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md @@ -2,44 +2,43 @@ description: "Learn more about: ICorThreadpool::CorGetMaxThreads Method" title: "ICorThreadpool::CorGetMaxThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorThreadpool.CorGetMaxThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorGetMaxThreads" -helpviewer_keywords: +helpviewer_keywords: - "CorGetMaxThreads method [.NET Framework hosting]" - "ICorThreadpool::CorGetMaxThreads method [.NET Framework hosting]" -ms.assetid: 2861533a-cda0-47b3-b716-0d363505289b -topic_type: +topic_type: - "apiref" --- # ICorThreadpool::CorGetMaxThreads Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CorGetMaxThreads ( - [out] DWORD *MaxWorkerThreads, - [out] DWORD *MaxIOCompletionThreads -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CorGetMaxThreads ( + [out] DWORD *MaxWorkerThreads, + [out] DWORD *MaxIOCompletionThreads +); +``` + +## 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 2.0 + ## See also - [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md index 4093398dad747..755cab2afb74e 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md @@ -2,46 +2,45 @@ description: "Learn more about: ICorThreadpool::CorQueueUserWorkItem Method" title: "ICorThreadpool::CorQueueUserWorkItem Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorThreadpool.CorQueueUserWorkItem" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorQueueUserWorkItem" -helpviewer_keywords: +helpviewer_keywords: - "ICorThreadpool::CorQueueUserWorkItem method [.NET Framework hosting]" - "CorQueueUserWorkItem method [.NET Framework hosting]" -ms.assetid: 29ac7898-a7c7-433e-8f79-cd5237e0bab8 -topic_type: +topic_type: - "apiref" --- # ICorThreadpool::CorQueueUserWorkItem Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CorQueueUserWorkItem ( - [in] LPTHREAD_START_ROUTINE Function, - [in] PVOID Context, - [in] BOOL executeOnlyOnce, - [out] BOOL* result -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CorQueueUserWorkItem ( + [in] LPTHREAD_START_ROUTINE Function, + [in] PVOID Context, + [in] BOOL executeOnlyOnce, + [out] BOOL* result +); +``` + +## 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 2.0 + ## See also - [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md index c1e20b17592ed..d98bb23a1abbe 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md @@ -2,49 +2,48 @@ description: "Learn more about: ICorThreadpool::CorRegisterWaitForSingleObject Method" title: "ICorThreadpool::CorRegisterWaitForSingleObject Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorThreadpool.CorRegisterWaitForSingleObject" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorRegisterWaitForSingleObject" -helpviewer_keywords: +helpviewer_keywords: - "ICorThreadpool::CorRegisterWaitForSingleObject method [.NET Framework hosting]" - "CorRegisterWaitForSingleObject method [.NET Framework hosting]" -ms.assetid: cade1feb-71d2-43ed-85ca-7b2e9da12994 -topic_type: +topic_type: - "apiref" --- # ICorThreadpool::CorRegisterWaitForSingleObject Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CorRegisterWaitForSingleObject ( - [in] HANDLE* phNewWaitObject, - [in] HANDLE hWaitObject, - [in] WAITORTIMERCALLBACK Callback, - [in] PVOID Context, - [in] ULONG timeout, - [in] BOOL executeOnlyOnce, - [out] BOOL* result -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CorRegisterWaitForSingleObject ( + [in] HANDLE* phNewWaitObject, + [in] HANDLE hWaitObject, + [in] WAITORTIMERCALLBACK Callback, + [in] PVOID Context, + [in] ULONG timeout, + [in] BOOL executeOnlyOnce, + [out] BOOL* result +); +``` + +## 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 2.0 + ## See also - [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md index 57974eb76c6ba..fda3afdbdbb51 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md @@ -2,44 +2,43 @@ description: "Learn more about: ICorThreadpool::CorSetMaxThreads Method" title: "ICorThreadpool::CorSetMaxThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorThreadpool.CorSetMaxThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorSetMaxThreads" -helpviewer_keywords: +helpviewer_keywords: - "ICorThreadpool::CorSetMaxThreads method [.NET Framework hosting]" - "CorSetMaxThreads method [.NET Framework hosting]" -ms.assetid: 4a846238-df4e-4060-ba3b-5173f6a51e85 -topic_type: +topic_type: - "apiref" --- # ICorThreadpool::CorSetMaxThreads Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CorSetMaxThreads ( - [in] DWORD MaxWorkerThreads, - [in] DWORD MaxIOCompletionThreads -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CorSetMaxThreads ( + [in] DWORD MaxWorkerThreads, + [in] DWORD MaxIOCompletionThreads +); +``` + +## 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 2.0 + ## See also - [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md index c69ab656fdb46..0730f69fcda8d 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md @@ -2,45 +2,44 @@ description: "Learn more about: ICorThreadpool::CorUnregisterWait Method" title: "ICorThreadpool::CorUnregisterWait Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorThreadpool.CorUnregisterWait" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorUnregisterWait" -helpviewer_keywords: +helpviewer_keywords: - "CorUnregisterWait method [.NET Framework hosting]" - "ICorThreadpool::CorUnregisterWait method [.NET Framework hosting]" -ms.assetid: 42c933f1-30a8-4011-bdea-e117f3c3265e -topic_type: +topic_type: - "apiref" --- # ICorThreadpool::CorUnregisterWait Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CorUnregisterWait ( - [in] HANDLE hWaitObject, - [in] HANDLE CompletionEvent, - [out] BOOL* result -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CorUnregisterWait ( + [in] HANDLE hWaitObject, + [in] HANDLE CompletionEvent, + [out] BOOL* result +); +``` + +## 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 2.0 + ## See also - [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-interface.md b/docs/core/unmanaged-api/hosting/icorthreadpool-interface.md index fb552ae35aede..f6baa1cec3d2a 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-interface.md +++ b/docs/core/unmanaged-api/hosting/icorthreadpool-interface.md @@ -2,53 +2,52 @@ description: "Learn more about: ICorThreadpool Interface" title: "ICorThreadpool Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICorThreadpool" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorThreadpool" -helpviewer_keywords: +helpviewer_keywords: - "ICorThreadpool interface [.NET Framework hosting]" -ms.assetid: 18485a27-cae3-4c6a-baa8-f7df601122d5 -topic_type: +topic_type: - "apiref" --- # ICorThreadpool Interface -Provides methods for accessing the thread pool. - +Provides methods for accessing the thread pool. + > [!NOTE] -> This interface is reserved for internal use only. - -## Methods - -|Method|Description| -|------------|-----------------| -|[CorRegisterWaitForSingleObject Method](icorthreadpool-corregisterwaitforsingleobject-method.md)|Reserved for internal use only.| -|[CorUnregisterWait Method](icorthreadpool-corunregisterwait-method.md)|Reserved for internal use only.| -|[CorQueueUserWorkItem Method](icorthreadpool-corqueueuserworkitem-method.md)|Reserved for internal use only.| -|[CorCreateTimer Method](icorthreadpool-corcreatetimer-method.md)|Reserved for internal use only.| -|[CorChangeTimer Method](icorthreadpool-corchangetimer-method.md)|Reserved for internal use only.| -|[CorDeleteTimer Method](icorthreadpool-cordeletetimer-method.md)|Reserved for internal use only.| -|[CorBindIoCompletionCallback Method](icorthreadpool-corbindiocompletioncallback-method.md)|Reserved for internal use only.| -|[CorCallOrQueueUserWorkItem Method](icorthreadpool-corcallorqueueuserworkitem-method.md)|Reserved for internal use only.| -|[CorSetMaxThreads Method](icorthreadpool-corsetmaxthreads-method.md)|Reserved for internal use only.| -|[CorGetMaxThreads Method](icorthreadpool-corgetmaxthreads-method.md)|Reserved for internal use only.| -|[CorGetAvailableThreads Method](icorthreadpool-corgetavailablethreads-method.md)|Reserved for internal use only.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> This interface is reserved for internal use only. + +## Methods + +|Method|Description| +|------------|-----------------| +|[CorRegisterWaitForSingleObject Method](icorthreadpool-corregisterwaitforsingleobject-method.md)|Reserved for internal use only.| +|[CorUnregisterWait Method](icorthreadpool-corunregisterwait-method.md)|Reserved for internal use only.| +|[CorQueueUserWorkItem Method](icorthreadpool-corqueueuserworkitem-method.md)|Reserved for internal use only.| +|[CorCreateTimer Method](icorthreadpool-corcreatetimer-method.md)|Reserved for internal use only.| +|[CorChangeTimer Method](icorthreadpool-corchangetimer-method.md)|Reserved for internal use only.| +|[CorDeleteTimer Method](icorthreadpool-cordeletetimer-method.md)|Reserved for internal use only.| +|[CorBindIoCompletionCallback Method](icorthreadpool-corbindiocompletioncallback-method.md)|Reserved for internal use only.| +|[CorCallOrQueueUserWorkItem Method](icorthreadpool-corcallorqueueuserworkitem-method.md)|Reserved for internal use only.| +|[CorSetMaxThreads Method](icorthreadpool-corsetmaxthreads-method.md)|Reserved for internal use only.| +|[CorGetMaxThreads Method](icorthreadpool-corgetmaxthreads-method.md)|Reserved for internal use only.| +|[CorGetAvailableThreads Method](icorthreadpool-corgetavailablethreads-method.md)|Reserved for internal use only.| + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md b/docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md index 9e4c333dda9fa..a411c74a480c3 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md +++ b/docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md @@ -2,40 +2,39 @@ description: "Learn more about: IDebuggerInfo Interface" title: "IDebuggerInfo Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IDebuggerInfo" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IDebuggerInfo" -helpviewer_keywords: +helpviewer_keywords: - "IDebuggerInfo interface [.NET Framework hosting]" -ms.assetid: 9395a8a0-ffb9-475f-8da6-890999ae4bb6 -topic_type: +topic_type: - "apiref" --- # IDebuggerInfo Interface -Provides methods for obtaining information about the state of the debugging services. - -## Methods - -|Method|Description| -|------------|-----------------| -|[IsDebuggerAttached Method](idebuggerinfo-isdebuggerattached-method.md)|Gets a value that indicates whether a managed debugger is attached to this process.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods for obtaining information about the state of the debugging services. + +## Methods + +|Method|Description| +|------------|-----------------| +|[IsDebuggerAttached Method](idebuggerinfo-isdebuggerattached-method.md)|Gets a value that indicates whether a managed debugger is attached to this process.| + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md b/docs/core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md index b42c74f8da20b..73638c6723a2d 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md +++ b/docs/core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md @@ -2,48 +2,47 @@ description: "Learn more about: IDebuggerInfo::IsDebuggerAttached Method" title: "IDebuggerInfo::IsDebuggerAttached Method" ms.date: "03/30/2017" -api_name: +api_name: - "IDebuggerInfo.IsDebuggerAttached" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IsDebuggerAttached" -helpviewer_keywords: +helpviewer_keywords: - "IDebuggerInfo::IsDebuggerAttached method [.NET Framework hosting]" - "IsDebuggerAttached method, IDebuggerInfo interface [.NET Framework hosting]" -ms.assetid: 6e21872f-602f-411a-a423-bff5cdf27000 -topic_type: +topic_type: - "apiref" --- # IDebuggerInfo::IsDebuggerAttached Method -Gets a value that indicates whether a managed debugger is attached to this process. - -## Syntax - -```cpp -HRESULT IsDebuggerAttached ( - [out] BOOL *pbAttached -); -``` - -## Parameters - - `pbAttached` - [out] A pointer to a value that is `true` if a managed debugger is attached to the process; otherwise, `false`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets a value that indicates whether a managed debugger is attached to this process. + +## Syntax + +```cpp +HRESULT IsDebuggerAttached ( + [out] BOOL *pbAttached +); +``` + +## Parameters + + `pbAttached` + [out] A pointer to a value that is `true` if a managed debugger is attached to the process; otherwise, `false`. + +## 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 2.0 + ## See also - [IDebuggerInfo Interface](idebuggerinfo-interface.md) diff --git a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md index 611af58734a61..44e6049687d54 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md +++ b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md @@ -2,42 +2,41 @@ description: "Learn more about: IDebuggerThreadControl Interface" title: "IDebuggerThreadControl Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IDebuggerThreadControl" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IDebuggerThreadControl" -helpviewer_keywords: +helpviewer_keywords: - "IDebuggerThreadControl interface [.NET Framework hosting]" -ms.assetid: 0a270c42-a7d1-45f1-a64d-fa3e84d14532 -topic_type: +topic_type: - "apiref" --- # IDebuggerThreadControl Interface -Provides methods for notifying the host about the blocking and unblocking of threads by the debugging services. - -## Methods - -|Method|Description| -|------------|-----------------| -|[ThreadIsBlockingForDebugger Method](idebuggerthreadcontrol-threadisblockingfordebugger-method.md)|Notifies the host that the thread that is sending this callback is about to block within the debugging services.| -|[ReleaseAllRuntimeThreads Method](idebuggerthreadcontrol-releaseallruntimethreads-method.md)|Notifies the host that the debugging services are about to release all threads that are blocked.| -|[StartBlockingForDebugger Method](idebuggerthreadcontrol-startblockingfordebugger-method.md)|Notifies the host that the debugging services are about to start blocking all threads.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods for notifying the host about the blocking and unblocking of threads by the debugging services. + +## Methods + +|Method|Description| +|------------|-----------------| +|[ThreadIsBlockingForDebugger Method](idebuggerthreadcontrol-threadisblockingfordebugger-method.md)|Notifies the host that the thread that is sending this callback is about to block within the debugging services.| +|[ReleaseAllRuntimeThreads Method](idebuggerthreadcontrol-releaseallruntimethreads-method.md)|Notifies the host that the debugging services are about to release all threads that are blocked.| +|[StartBlockingForDebugger Method](idebuggerthreadcontrol-startblockingfordebugger-method.md)|Notifies the host that the debugging services are about to start blocking all threads.| + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md index 5f523073b913e..f7ba31c9a9b87 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md +++ b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md @@ -2,45 +2,44 @@ description: "Learn more about: IDebuggerThreadControl::ReleaseAllRuntimeThreads Method" title: "IDebuggerThreadControl::ReleaseAllRuntimeThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "IDebuggerThreadControl.ReleaseAllRuntimeThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ReleaseAllRuntimeThreads" -helpviewer_keywords: +helpviewer_keywords: - "ReleaseAllRuntimeThreads method [.NET Framework hosting]" - "IDebuggerThreadControl::ReleaseAllRuntimeThreads method [.NET Framework hosting]" -ms.assetid: 1a2995ff-5f02-4b49-84dc-3a5f9cfd7d55 -topic_type: +topic_type: - "apiref" --- # IDebuggerThreadControl::ReleaseAllRuntimeThreads Method -Notifies the host that the debugging services are about to release all threads that are blocked. - -## Syntax - -```cpp -HRESULT ReleaseAllRuntimeThreads ( ); -``` - -## Remarks - - The `ReleaseAllRuntimeThreads` method will never be called on a runtime thread. If the host has a runtime thread blocked, it should release it now. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Notifies the host that the debugging services are about to release all threads that are blocked. + +## Syntax + +```cpp +HRESULT ReleaseAllRuntimeThreads ( ); +``` + +## Remarks + + The `ReleaseAllRuntimeThreads` method will never be called on a runtime thread. If the host has a runtime thread blocked, it should release it now. + +## 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 2.0 + ## See also - [IDebuggerThreadControl Interface](idebuggerthreadcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md index e12cba1997362..efcd1d62a6706 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md +++ b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IDebuggerThreadControl::StartBlockingForDebugger Method" title: "IDebuggerThreadControl::StartBlockingForDebugger Method" ms.date: "03/30/2017" -api_name: +api_name: - "IDebuggerThreadControl.StartBlockingForDebugger" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "StartBlockingForDebugger" -helpviewer_keywords: +helpviewer_keywords: - "IDebuggerThreadControl::StartBlockingForDebugger method [.NET Framework hosting]" - "StartBlockingForDebugger method [.NET Framework hosting]" -ms.assetid: 5c8f11b4-35d3-4c39-9bbd-58b896ba5ba6 -topic_type: +topic_type: - "apiref" --- # IDebuggerThreadControl::StartBlockingForDebugger Method -Notifies the host that the debugging services are about to start blocking all threads. - -## Syntax - -```cpp -HRESULT StartBlockingForDebugger ( - [in] DWORD dwUnused -); -``` - -## Parameters - - `dwUnused` - [in] Reserved for future use. - -## Remarks - - The `StartBlockingForDebugger` method could be called on a runtime thread. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Notifies the host that the debugging services are about to start blocking all threads. + +## Syntax + +```cpp +HRESULT StartBlockingForDebugger ( + [in] DWORD dwUnused +); +``` + +## Parameters + + `dwUnused` + [in] Reserved for future use. + +## Remarks + + The `StartBlockingForDebugger` method could be called on a runtime thread. + +## 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 2.0 + ## See also - [IDebuggerThreadControl Interface](idebuggerthreadcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md index b284ff205850b..3a8528289e837 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md +++ b/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md @@ -2,47 +2,46 @@ description: "Learn more about: IDebuggerThreadControl::ThreadIsBlockingForDebugger Method" title: "IDebuggerThreadControl::ThreadIsBlockingForDebugger Method" ms.date: "03/30/2017" -api_name: +api_name: - "IDebuggerThreadControl.ThreadIsBlockingForDebugger" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ThreadIsBlockingForDebugger" -helpviewer_keywords: +helpviewer_keywords: - "ThreadIsBlockingForDebugger method [.NET Framework hosting]" - "IDebuggerThreadControl::ThreadIsBlockingForDebugger method [.NET Framework hosting]" -ms.assetid: d4d7cb2d-69da-48b3-879a-1a8a68c9bfa8 -topic_type: +topic_type: - "apiref" --- # IDebuggerThreadControl::ThreadIsBlockingForDebugger Method -Notifies the host that the thread that is sending this callback is about to block within the debugging services. - -## Syntax - -```cpp -HRESULT ThreadIsBlockingForDebugger ( ); -``` - -## Remarks - - The `ThreadIsBlockingForDebugger` method will always be called on a runtime thread. - - The `ThreadIsBlockingForDebugger` method gives the host an opportunity to perform another action while the thread blocks. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Notifies the host that the thread that is sending this callback is about to block within the debugging services. + +## Syntax + +```cpp +HRESULT ThreadIsBlockingForDebugger ( ); +``` + +## Remarks + + The `ThreadIsBlockingForDebugger` method will always be called on a runtime thread. + + The `ThreadIsBlockingForDebugger` method gives the host an opportunity to perform another action while the thread blocks. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **NET Framework Versions:** Available since .NET Framework 2.0 + ## See also - [IDebuggerThreadControl Interface](idebuggerthreadcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/igchost-collect-method.md b/docs/core/unmanaged-api/hosting/igchost-collect-method.md index 98a46f854636b..cd7adabf43e7f 100644 --- a/docs/core/unmanaged-api/hosting/igchost-collect-method.md +++ b/docs/core/unmanaged-api/hosting/igchost-collect-method.md @@ -2,48 +2,47 @@ description: "Learn more about: IGCHost::Collect Method" title: "IGCHost::Collect Method" ms.date: "03/30/2017" -api_name: +api_name: - "IGCHost.Collect" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "Collect" -helpviewer_keywords: +helpviewer_keywords: - "Collect method, IGCHost interface [.NET Framework hosting]" - "IGCHost::Collect method [.NET Framework hosting]" -ms.assetid: fc7d9448-3186-494d-9f0d-ea39717e9a82 -topic_type: +topic_type: - "apiref" --- # IGCHost::Collect Method -Forces a collection to occur for the given generation, regardless of the state of the current garbage collection. - -## Syntax - -```cpp -HRESULT Collect ( - [in] LONG Generation -); -``` - -## Parameters - - `Generation` - [in] The generation on which to perform the garbage collection. A value of -1 indicates that all generations will undergo a garbage collection. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl, GCHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Forces a collection to occur for the given generation, regardless of the state of the current garbage collection. + +## Syntax + +```cpp +HRESULT Collect ( + [in] LONG Generation +); +``` + +## Parameters + + `Generation` + [in] The generation on which to perform the garbage collection. A value of -1 indicates that all generations will undergo a garbage collection. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** GCHost.idl, GCHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [IGCHost Interface](igchost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/igchost-getstats-method.md b/docs/core/unmanaged-api/hosting/igchost-getstats-method.md index c8c919d8443d3..907623a69c150 100644 --- a/docs/core/unmanaged-api/hosting/igchost-getstats-method.md +++ b/docs/core/unmanaged-api/hosting/igchost-getstats-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IGCHost::GetStats Method" title: "IGCHost::GetStats Method" ms.date: "03/30/2017" -api_name: +api_name: - "IGCHost.GetStats" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "GetStats" -helpviewer_keywords: +helpviewer_keywords: - "GetStats method, IGCHost interface [.NET Framework hosting]" - "IGCHost::GetStats method [.NET Framework hosting]" -ms.assetid: c4ae022c-46ac-4f19-9ddd-09b955f19412 -topic_type: +topic_type: - "apiref" --- # IGCHost::GetStats Method -Gets the statistics for the current state of the garbage collection system. - -## Syntax - -```cpp -HRESULT GetStats ( - [in, out] COR_GC_STATS *pStats -); -``` - -## Parameters - - `pStats` - [in, out] A pointer to a [COR_GC_STATS](cor-gc-stats-structure.md) structure that contains the statistics for the current state of the garbage collection system. - -## Remarks - - The statistics can be used by a smart allocation system to help the garbage collection system operate. For example, the allocation system may determine, after reviewing the statistics, that it needs to add more memory or force a collection. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl, GCHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Gets the statistics for the current state of the garbage collection system. + +## Syntax + +```cpp +HRESULT GetStats ( + [in, out] COR_GC_STATS *pStats +); +``` + +## Parameters + + `pStats` + [in, out] A pointer to a [COR_GC_STATS](cor-gc-stats-structure.md) structure that contains the statistics for the current state of the garbage collection system. + +## Remarks + + The statistics can be used by a smart allocation system to help the garbage collection system operate. For example, the allocation system may determine, after reviewing the statistics, that it needs to add more memory or force a collection. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** GCHost.idl, GCHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [IGCHost Interface](igchost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/igchost-getthreadstats-method.md b/docs/core/unmanaged-api/hosting/igchost-getthreadstats-method.md index fb3aa500286c1..1cdda0c832894 100644 --- a/docs/core/unmanaged-api/hosting/igchost-getthreadstats-method.md +++ b/docs/core/unmanaged-api/hosting/igchost-getthreadstats-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IGCHost::GetThreadStats Method" title: "IGCHost::GetThreadStats Method" ms.date: "03/30/2017" -api_name: +api_name: - "IGCHost.GetThreadStats" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "GetThreadStats" -helpviewer_keywords: +helpviewer_keywords: - "IGCHost::GetThreadStats method [.NET Framework hosting]" - "GetThreadStats method [.NET Framework hosting]" -ms.assetid: 826baa9b-9218-4736-a509-7ab193b125a0 -topic_type: +topic_type: - "apiref" --- # IGCHost::GetThreadStats Method -Gets the per-thread statistics for garbage collection. - -## Syntax - -```cpp -HRESULT GetThreadStats ( - [in] DWORD *pFiberCookie, - [in, out] COR_GC_THREAD_STATS *pStats -); -``` - -## Parameters - - `pFiberCookie` - [in] A pointer to a fiber cookie that specifies the thread for which to retrieve the statistics. - - `pStats` - [in, out] A pointer to a [COR_GC_THREAD_STATS](cor-gc-thread-stats-structure.md) structure that contains the garbage collection statistics for the specified thread. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl, GCHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Gets the per-thread statistics for garbage collection. + +## Syntax + +```cpp +HRESULT GetThreadStats ( + [in] DWORD *pFiberCookie, + [in, out] COR_GC_THREAD_STATS *pStats +); +``` + +## Parameters + + `pFiberCookie` + [in] A pointer to a fiber cookie that specifies the thread for which to retrieve the statistics. + + `pStats` + [in, out] A pointer to a [COR_GC_THREAD_STATS](cor-gc-thread-stats-structure.md) structure that contains the garbage collection statistics for the specified thread. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** GCHost.idl, GCHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [IGCHost Interface](igchost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/igchost-interface.md b/docs/core/unmanaged-api/hosting/igchost-interface.md index 4d1024ce85f73..4fd676eb35da6 100644 --- a/docs/core/unmanaged-api/hosting/igchost-interface.md +++ b/docs/core/unmanaged-api/hosting/igchost-interface.md @@ -2,50 +2,49 @@ description: "Learn more about: IGCHost Interface" title: "IGCHost Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IGCHost" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IGCHost" -helpviewer_keywords: +helpviewer_keywords: - "IGCHost interface [.NET Framework hosting]" -ms.assetid: 9ad70ffd-6963-4ab2-8c84-3d86c3fb8deb -topic_type: +topic_type: - "apiref" --- # IGCHost Interface -Provides methods for obtaining information about the garbage collection system and for controlling some aspects of garbage collection. - +Provides methods for obtaining information about the garbage collection system and for controlling some aspects of garbage collection. + > [!NOTE] -> Starting with .NET Framework 4.5, you can use the [IGCHost2::SetGCStartupLimitsEx](igchost2-setgcstartuplimitsex-method.md) method to set the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0 to values greater than the `DWORD` limit that is imposed by the [SetGCStartupLimits](igchost-setgcstartuplimits-method.md) method. - +> Starting with .NET Framework 4.5, you can use the [IGCHost2::SetGCStartupLimitsEx](igchost2-setgcstartuplimitsex-method.md) method to set the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0 to values greater than the `DWORD` limit that is imposed by the [SetGCStartupLimits](igchost-setgcstartuplimits-method.md) method. + > [!NOTE] -> This interface is for expert usage only. It can affect the performance of an application if used improperly. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Collect Method](igchost-collect-method.md)|Forces a collection to occur for the given generation, regardless of the state of the current garbage collection.| -|[GetStats Method](igchost-getstats-method.md)|Gets the statistics for the current state of the garbage collection system.| -|[GetThreadStats Method](igchost-getthreadstats-method.md)|Gets the per-thread statistics for garbage collection.| -|[SetGCStartupLimits Method](igchost-setgcstartuplimits-method.md)|Sets the segment size and the maximum size for generation 0.| -|[SetVirtualMemLimit Method](igchost-setvirtualmemlimit-method.md)|Sets the maximum size of the runtime's virtual memory.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl, GCHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +> This interface is for expert usage only. It can affect the performance of an application if used improperly. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Collect Method](igchost-collect-method.md)|Forces a collection to occur for the given generation, regardless of the state of the current garbage collection.| +|[GetStats Method](igchost-getstats-method.md)|Gets the statistics for the current state of the garbage collection system.| +|[GetThreadStats Method](igchost-getthreadstats-method.md)|Gets the per-thread statistics for garbage collection.| +|[SetGCStartupLimits Method](igchost-setgcstartuplimits-method.md)|Sets the segment size and the maximum size for generation 0.| +|[SetVirtualMemLimit Method](igchost-setvirtualmemlimit-method.md)|Sets the maximum size of the runtime's virtual memory.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** GCHost.idl, GCHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md b/docs/core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md index 6db23d7c0e941..ae6dc579ee1ad 100644 --- a/docs/core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md +++ b/docs/core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md @@ -2,59 +2,58 @@ description: "Learn more about: IGCHost::SetGCStartupLimits Method" title: "IGCHost::SetGCStartupLimits Method" ms.date: "03/30/2017" -api_name: +api_name: - "IGCHost.SetGCStartupLimits" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "SetGCStartupLimits" -helpviewer_keywords: +helpviewer_keywords: - "SetGCStartupLimits method, IGCHost interface [.NET Framework hosting]" - "IGCHost::SetGCStartupLimits method [.NET Framework hosting]" -ms.assetid: cae53926-82ac-4d1d-b297-0bde0bd1bebb -topic_type: +topic_type: - "apiref" --- # IGCHost::SetGCStartupLimits Method -Sets the segment size and the maximum size for generation 0. - +Sets the segment size and the maximum size for generation 0. + > [!IMPORTANT] -> Starting with .NET Framework 4.5, you can set segment size and maximum generation 0 size to values greater than `DWORD` by using the [IGCHost2::SetGCStartupLimitsEx](igchost2-setgcstartuplimitsex-method.md) method. - -## Syntax - -```cpp -HRESULT SetGCStartupLimits ( - [in] DWORD SegmentSize, - [in] DWORD MaxGen0Size -); -``` - -## Parameters - - `SegmentSize` - [in] The size of the segment used by the garbage collection system. - - `MaxGen0Size` - [in] The maximum size for generation 0. - -## Remarks - - The `SetGCStartupLimits` method may be called only once. These values cannot be changed later. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl, GCHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +> Starting with .NET Framework 4.5, you can set segment size and maximum generation 0 size to values greater than `DWORD` by using the [IGCHost2::SetGCStartupLimitsEx](igchost2-setgcstartuplimitsex-method.md) method. + +## Syntax + +```cpp +HRESULT SetGCStartupLimits ( + [in] DWORD SegmentSize, + [in] DWORD MaxGen0Size +); +``` + +## Parameters + + `SegmentSize` + [in] The size of the segment used by the garbage collection system. + + `MaxGen0Size` + [in] The maximum size for generation 0. + +## Remarks + + The `SetGCStartupLimits` method may be called only once. These values cannot be changed later. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** GCHost.idl, GCHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [IGCHost Interface](igchost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md b/docs/core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md index 196f3827b24d3..cea9113a35a95 100644 --- a/docs/core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md +++ b/docs/core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IGCHost::SetVirtualMemLimit Method" title: "IGCHost::SetVirtualMemLimit Method" ms.date: "03/30/2017" -api_name: +api_name: - "IGCHost.SetVirtualMemLimit" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "SetVirtualMemLimit" -helpviewer_keywords: +helpviewer_keywords: - "IGCHost::SetVirtualMemLimit method [.NET Framework hosting]" - "SetVirtualMemLimit method [.NET Framework hosting]" -ms.assetid: c7e7c2d0-e58c-4650-b40c-47b2be2cda45 -topic_type: +topic_type: - "apiref" --- # IGCHost::SetVirtualMemLimit Method -Sets the maximum size of the runtime's virtual memory. - -## Syntax - -```cpp -HRESULT SetVirtualMemLimit ( - [in] SIZE_T sztMaxVirtualMemMB -); -``` - -## Parameters - - `sztMaxVirtualMemMB` - [in] The maximum size, in megabytes, of the runtime's virtual memory. - -## Remarks - - The maximum size of the runtime's virtual memory can be changed dynamically. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl, GCHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Sets the maximum size of the runtime's virtual memory. + +## Syntax + +```cpp +HRESULT SetVirtualMemLimit ( + [in] SIZE_T sztMaxVirtualMemMB +); +``` + +## Parameters + + `sztMaxVirtualMemMB` + [in] The maximum size, in megabytes, of the runtime's virtual memory. + +## Remarks + + The maximum size of the runtime's virtual memory can be changed dynamically. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** GCHost.idl, GCHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [IGCHost Interface](igchost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/igchost2-interface.md b/docs/core/unmanaged-api/hosting/igchost2-interface.md index d3fa86ee4443f..306f3358fc49f 100644 --- a/docs/core/unmanaged-api/hosting/igchost2-interface.md +++ b/docs/core/unmanaged-api/hosting/igchost2-interface.md @@ -2,43 +2,42 @@ description: "Learn more about: IGCHost2 Interface" title: "IGCHost2 Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IGCHost2" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IGCHost2" -helpviewer_keywords: +helpviewer_keywords: - "IGCHost2 interface [.NET Framework hosting]" -ms.assetid: e5323fa4-18ac-424d-859d-a65a550d08d9 -topic_type: +topic_type: - "apiref" --- # IGCHost2 Interface -Provides methods for obtaining information about the garbage collection system and for controlling some aspects of garbage collection. - +Provides methods for obtaining information about the garbage collection system and for controlling some aspects of garbage collection. + > [!NOTE] -> For new development, we recommend that you use the [ICLRGCManager2](iclrgcmanager2-interface.md) interface instead. - -## Methods - -|Method|Description| -|------------|-----------------| -|[SetGCStartupLimitsEx Method](igchost2-setgcstartuplimitsex-method.md)|Sets the segment size and the maximum size for generation 0. Enables generation 0 and segment sizes larger than `DWORD`.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl, GCHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] - +> For new development, we recommend that you use the [ICLRGCManager2](iclrgcmanager2-interface.md) interface instead. + +## Methods + +|Method|Description| +|------------|-----------------| +|[SetGCStartupLimitsEx Method](igchost2-setgcstartuplimitsex-method.md)|Sets the segment size and the maximum size for generation 0. Enables generation 0 and segment sizes larger than `DWORD`.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** GCHost.idl, GCHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md b/docs/core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md index c79e2d508e631..1350127d847ec 100644 --- a/docs/core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md +++ b/docs/core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IGCHost2::SetGCStartupLimitsEx Method" title: "IGCHost2::SetGCStartupLimitsEx Method" ms.date: "03/30/2017" -api_name: +api_name: - "IGCHost2.SetGCStartupLimitsEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IGCHost2::SetGCStartupLimitsEx" -helpviewer_keywords: +helpviewer_keywords: - "IGCHost2::SetGCStartupLimitsEx method [.NET Framework hosting]" - "SetGCStartupLimitsEx method, IGCHost2 interface [.NET Framework hosting]" -ms.assetid: bba941c2-1c57-46d3-bbf5-5fb92700c490 -topic_type: +topic_type: - "apiref" --- # IGCHost2::SetGCStartupLimitsEx Method -Sets the segment size and the maximum size for generation 0. - -## Syntax - -```cpp -HRESULT SetGCStartupLimitsEx ( - [in] SIZE_T SegmentSize, - [in] SIZE_T MaxGen0Size -); -``` - -## Parameters - - `SegmentSize` - [in] The size of the segment used by the garbage collection system. - - `MaxGen0Size` - [in] The maximum size for generation 0. - -## Remarks - - The values that `SetGCStartupLimitsEx` sets can be specified only before the host is started. These values cannot be changed later. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl, GCHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] - +Sets the segment size and the maximum size for generation 0. + +## Syntax + +```cpp +HRESULT SetGCStartupLimitsEx ( + [in] SIZE_T SegmentSize, + [in] SIZE_T MaxGen0Size +); +``` + +## Parameters + + `SegmentSize` + [in] The size of the segment used by the garbage collection system. + + `MaxGen0Size` + [in] The maximum size for generation 0. + +## Remarks + + The values that `SetGCStartupLimitsEx` sets can be specified only before the host is started. These values cannot be changed later. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** GCHost.idl, GCHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] + ## See also - [IGCHost2 Interface](igchost2-interface.md) diff --git a/docs/core/unmanaged-api/hosting/igchostcontrol-interface.md b/docs/core/unmanaged-api/hosting/igchostcontrol-interface.md index e054868425e5a..989cbb0f7b39c 100644 --- a/docs/core/unmanaged-api/hosting/igchostcontrol-interface.md +++ b/docs/core/unmanaged-api/hosting/igchostcontrol-interface.md @@ -2,40 +2,39 @@ description: "Learn more about: IGCHostControl Interface" title: "IGCHostControl Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IGCHostControl" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IGCHostControl" -helpviewer_keywords: +helpviewer_keywords: - "IGCHostControl interface [.NET Framework hosting]" -ms.assetid: 2eb56ea9-8b7e-452b-a209-3d2be719fca6 -topic_type: +topic_type: - "apiref" --- # IGCHostControl Interface -Provides a method that allows the garbage collector to request the host to change the limits of virtual memory. - -## Methods - -|Method|Description| -|------------|-----------------| -|[RequestVirtualMemLimit Method](igchostcontrol-requestvirtualmemlimit-method.md)|Requests the host to change the limits of virtual memory.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides a method that allows the garbage collector to request the host to change the limits of virtual memory. + +## Methods + +|Method|Description| +|------------|-----------------| +|[RequestVirtualMemLimit Method](igchostcontrol-requestvirtualmemlimit-method.md)|Requests the host to change the limits of virtual memory.| + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md b/docs/core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md index e5a3bd65674c5..887e2609521c7 100644 --- a/docs/core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md +++ b/docs/core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IGCHostControl::RequestVirtualMemLimit Method" title: "IGCHostControl::RequestVirtualMemLimit Method" ms.date: "03/30/2017" -api_name: +api_name: - "IGCHostControl.RequestVirtualMemLimit" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "RequestVirtualMemLimit" -helpviewer_keywords: +helpviewer_keywords: - "IGCHostControl::RequestVirtualMemLimit method [.NET Framework hosting]" - "RequestVirtualMemLimit method [.NET Framework hosting]" -ms.assetid: f4984a8c-4c0e-4460-9aa1-d022b3621228 -topic_type: +topic_type: - "apiref" --- # IGCHostControl::RequestVirtualMemLimit Method -Requests the host to change the limits of virtual memory. - -## Syntax - -```cpp -HRESULT RequestVirtualMemLimit ( - [in] SIZE_T sztMaxVirtualMemMB, - [in, out] SIZE_T* psztNewMaxVirtualMemMB -); -``` - -## Parameters - - `sztMaxVirtualMemMB` - [in] The requested size of memory to be allocated. - - `psztNewMaxVirtualMemMB` - [in, out] A pointer to the actual size of memory allocated. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Requests the host to change the limits of virtual memory. + +## Syntax + +```cpp +HRESULT RequestVirtualMemLimit ( + [in] SIZE_T sztMaxVirtualMemMB, + [in, out] SIZE_T* psztNewMaxVirtualMemMB +); +``` + +## Parameters + + `sztMaxVirtualMemMB` + [in] The requested size of memory to be allocated. + + `psztNewMaxVirtualMemMB` + [in, out] A pointer to the actual size of memory allocated. + +## 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 2.0 + ## See also - [IGCHostControl Interface](igchostcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md b/docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md index 5c7d7ca35d31c..edff57212777d 100644 --- a/docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md +++ b/docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md @@ -2,42 +2,41 @@ description: "Learn more about: IGCThreadControl Interface" title: "IGCThreadControl Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IGCThreadControl" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IGCThreadControl" -helpviewer_keywords: +helpviewer_keywords: - "IGCThreadControl interface [.NET Framework hosting]" -ms.assetid: 3ff04d75-85ac-4df9-886d-dbaa037c0552 -topic_type: +topic_type: - "apiref" --- # IGCThreadControl Interface -Provides methods for participating in the scheduling of threads that would otherwise be blocked for a garbage collection. - -## Methods - -|Method|Description| -|------------|-----------------| -|[SuspensionEnding Method](igcthreadcontrol-suspensionending-method.md)|Notifies the host that the runtime is resuming threads after a garbage collection or other suspension.| -|[SuspensionStarting Method](igcthreadcontrol-suspensionstarting-method.md)|Notifies the host that the runtime is beginning a thread suspension for a garbage collection or other suspension.| -|[ThreadIsBlockingForSuspension Method](igcthreadcontrol-threadisblockingforsuspension-method.md)|Notifies the host that the thread making the call is about to block, perhaps for a garbage collection or other suspension.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods for participating in the scheduling of threads that would otherwise be blocked for a garbage collection. + +## Methods + +|Method|Description| +|------------|-----------------| +|[SuspensionEnding Method](igcthreadcontrol-suspensionending-method.md)|Notifies the host that the runtime is resuming threads after a garbage collection or other suspension.| +|[SuspensionStarting Method](igcthreadcontrol-suspensionstarting-method.md)|Notifies the host that the runtime is beginning a thread suspension for a garbage collection or other suspension.| +|[ThreadIsBlockingForSuspension Method](igcthreadcontrol-threadisblockingforsuspension-method.md)|Notifies the host that the thread making the call is about to block, perhaps for a garbage collection or other suspension.| + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md b/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md index 1935736a53c99..1df7e5cf425ed 100644 --- a/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md +++ b/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IGCThreadControl::SuspensionEnding Method" title: "IGCThreadControl::SuspensionEnding Method" ms.date: "03/30/2017" -api_name: +api_name: - "IGCThreadControl.SuspensionEnding" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "SuspensionEnding" -helpviewer_keywords: +helpviewer_keywords: - "IGCThreadControl::SuspensionEnding method [.NET Framework hosting]" - "SuspensionEnding method, IGCThreadControl interface [.NET Framework hosting]" -ms.assetid: 70814265-c734-4ddc-9502-fe8b28d2b414 -topic_type: +topic_type: - "apiref" --- # IGCThreadControl::SuspensionEnding Method -Notifies the host that the runtime is resuming threads after a garbage collection or other suspension. - -## Syntax - -```cpp -HRESULT SuspensionEnding ( - [in] DWORD Generation -); -``` - -## Parameters - - `Generation` - [in] The generation on which a garbage collection has been performed. - -## Remarks - - Do not reschedule any threads during the `SuspensionEnding` callback. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Notifies the host that the runtime is resuming threads after a garbage collection or other suspension. + +## Syntax + +```cpp +HRESULT SuspensionEnding ( + [in] DWORD Generation +); +``` + +## Parameters + + `Generation` + [in] The generation on which a garbage collection has been performed. + +## Remarks + + Do not reschedule any threads during the `SuspensionEnding` callback. + +## 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 2.0 + ## See also - [IGCThreadControl Interface](igcthreadcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md b/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md index 6cae9e72379af..7565d9deb4881 100644 --- a/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md +++ b/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md @@ -2,45 +2,44 @@ description: "Learn more about: IGCThreadControl::SuspensionStarting Method" title: "IGCThreadControl::SuspensionStarting Method" ms.date: "03/30/2017" -api_name: +api_name: - "IGCThreadControl.SuspensionStarting" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "SuspensionStarting" -helpviewer_keywords: +helpviewer_keywords: - "IGCThreadControl::SuspensionStarting method [.NET Framework hosting]" - "SuspensionStarting method, IGCThreadControl interface [.NET Framework hosting]" -ms.assetid: 0af312af-98e9-415e-b182-42e80a1aee51 -topic_type: +topic_type: - "apiref" --- # IGCThreadControl::SuspensionStarting Method -Notifies the host that the runtime is beginning a thread suspension for a garbage collection or other suspension. - -## Syntax - -```cpp -HRESULT SuspensionStarting ( ); -``` - -## Remarks - - Do not reschedule any threads during the `SuspensionStarting` callback. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Notifies the host that the runtime is beginning a thread suspension for a garbage collection or other suspension. + +## Syntax + +```cpp +HRESULT SuspensionStarting ( ); +``` + +## Remarks + + Do not reschedule any threads during the `SuspensionStarting` callback. + +## 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 2.0 + ## See also - [IGCThreadControl Interface](igcthreadcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md b/docs/core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md index 2a1f5109e85bf..6de822eb98d5e 100644 --- a/docs/core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md +++ b/docs/core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md @@ -2,45 +2,44 @@ description: "Learn more about: IGCThreadControl::ThreadIsBlockingForSuspension Method" title: "IGCThreadControl::ThreadIsBlockingForSuspension Method" ms.date: "03/30/2017" -api_name: +api_name: - "IGCThreadControl.ThreadIsBlockingForSuspension" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ThreadIsBlockingForSuspension" -helpviewer_keywords: +helpviewer_keywords: - "IGCThreadControl::ThreadIsBlockingForSuspension method [.NET Framework hosting]" - "ThreadIsBlockingForSuspension method [.NET Framework hosting]" -ms.assetid: ed5b5b58-7db7-46b5-9e2c-278db7159cee -topic_type: +topic_type: - "apiref" --- # IGCThreadControl::ThreadIsBlockingForSuspension Method -Notifies the host that the thread that is making the call is about to block, perhaps for a garbage collection or other suspension. - -## Syntax - -```cpp -HRESULT ThreadIsBlockingForSuspension ( ); -``` - -## Remarks - - The host may choose within the `ThreadIsBlockingForSuspension` callback whether to reschedule a thread. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Notifies the host that the thread that is making the call is about to block, perhaps for a garbage collection or other suspension. + +## Syntax + +```cpp +HRESULT ThreadIsBlockingForSuspension ( ); +``` + +## Remarks + + The host may choose within the `ThreadIsBlockingForSuspension` callback whether to reschedule a thread. + +## 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 2.0 + ## See also - [IGCThreadControl Interface](igcthreadcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md b/docs/core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md index 35e1f1cc6ef7c..f7c4844251f76 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md @@ -2,67 +2,66 @@ description: "Learn more about: IHostAssemblyManager::GetAssemblyStore Method" title: "IHostAssemblyManager::GetAssemblyStore Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostAssemblyManager.GetAssemblyStore" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostAssemblyManager::GetAssemblyStore" -helpviewer_keywords: +helpviewer_keywords: - "IHostAssemblyManager::GetAssemblyStore method [.NET Framework hosting]" - "GetAssemblyStore method [.NET Framework hosting]" -ms.assetid: d0f74593-9bb1-4a11-8096-e29734b20698 -topic_type: +topic_type: - "apiref" --- # IHostAssemblyManager::GetAssemblyStore Method -Gets an interface pointer to an [IHostAssemblyStore](ihostassemblystore-interface.md) that represents the list of assemblies loaded by the host. - -## Syntax - -```cpp -HRESULT GetAssemblyStore ( - [out] IHostAssemblyStore **ppAssemblyStore -); -``` - -## Parameters - - `ppAssemblyStore` - [out] A function pointer to an `IHostAssemblyStore` instance, or null, if the host does not implement `IHostAssemblyStore`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetAssemblyStore` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOINTERFACE|The host does not provide an implementation of `IHostAssemblyStore`.| - -## Remarks - - `IHostAssemblyStore` provides methods that allow a host to bind to assemblies and modules independently of the CLR. Hosts typically provide assembly stores to allow assemblies to be loaded from formats other than the file system. - +Gets an interface pointer to an [IHostAssemblyStore](ihostassemblystore-interface.md) that represents the list of assemblies loaded by the host. + +## Syntax + +```cpp +HRESULT GetAssemblyStore ( + [out] IHostAssemblyStore **ppAssemblyStore +); +``` + +## Parameters + + `ppAssemblyStore` + [out] A function pointer to an `IHostAssemblyStore` instance, or null, if the host does not implement `IHostAssemblyStore`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetAssemblyStore` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOINTERFACE|The host does not provide an implementation of `IHostAssemblyStore`.| + +## Remarks + + `IHostAssemblyStore` provides methods that allow a host to bind to assemblies and modules independently of the CLR. Hosts typically provide assembly stores to allow assemblies to be loaded from formats other than the file system. + > [!NOTE] -> If the host does not implement `IHostAssemblyStore`, `GetAssemblyStore` should return an HRESULT value of E_NOINTERFACE, and should set `ppAssemblyStore` to null. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> If the host does not implement `IHostAssemblyStore`, `GetAssemblyStore` should return an HRESULT value of E_NOINTERFACE, and should set `ppAssemblyStore` to null. + +## 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 2.0 + ## See also - [IHostAssemblyManager Interface](ihostassemblymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md b/docs/core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md index d28d57d91c507..7466c9222591b 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md @@ -2,77 +2,76 @@ description: "Learn more about: IHostAssemblyManager::GetNonHostStoreAssemblies Method" title: "IHostAssemblyManager::GetNonHostStoreAssemblies Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostAssemblyManager.GetNonHostStoreAssemblies" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostAssemblyManager::GetNonHostStoreAssemblies" -helpviewer_keywords: +helpviewer_keywords: - "IHostAssemblyManager::GetNonHostStoreAssemblies method [.NET Framework hosting]" - "GetNonHostStoreAssemblies method [.NET Framework hosting]" -ms.assetid: d2250b38-c76a-40ce-80c8-ba45149886e8 -topic_type: +topic_type: - "apiref" --- # IHostAssemblyManager::GetNonHostStoreAssemblies Method -Gets an interface pointer to an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) that represents the list of assemblies that the host expects the common language runtime (CLR) to load. - -## Syntax - -```cpp -HRESULT GetNonHostStoreAssemblies ( - [out] ICLRAssemblyReferenceList **ppReferenceList -); -``` - -## Parameters - - `ppReferenceList` - [out] A pointer to the address of an `ICLRAssemblyReferenceList` that contains a list of references to assemblies that the host expects the CLR to load. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetNonHostStoreAssemblies` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to create the list of references for the requested `ICLRAssemblyReferenceList`.| - -## Remarks - - The CLR resolves references using the following set of guidelines: - -- First, it consults the list of assembly references returned by `GetNonHostStoreAssemblies`. - -- If the assembly appears in the list, the CLR binds to it normally. - -- If the assembly does not appear in the list and the host has provided an implementation of [IHostAssemblyStore](ihostassemblystore-interface.md), the CLR calls [IHostAssemblyStore::ProvideAssembly](ihostassemblystore-provideassembly-method.md) to allow the host to supply the assembly to bind to. - -- Otherwise, the CLR fails to bind to the assembly. - - If the host sets `ppReferenceList` to null, the CLR first probes the global assembly cache, calls `ProvideAssembly`, and then probes the application base to resolve an assembly reference. - +Gets an interface pointer to an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) that represents the list of assemblies that the host expects the common language runtime (CLR) to load. + +## Syntax + +```cpp +HRESULT GetNonHostStoreAssemblies ( + [out] ICLRAssemblyReferenceList **ppReferenceList +); +``` + +## Parameters + + `ppReferenceList` + [out] A pointer to the address of an `ICLRAssemblyReferenceList` that contains a list of references to assemblies that the host expects the CLR to load. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetNonHostStoreAssemblies` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to create the list of references for the requested `ICLRAssemblyReferenceList`.| + +## Remarks + + The CLR resolves references using the following set of guidelines: + +- First, it consults the list of assembly references returned by `GetNonHostStoreAssemblies`. + +- If the assembly appears in the list, the CLR binds to it normally. + +- If the assembly does not appear in the list and the host has provided an implementation of [IHostAssemblyStore](ihostassemblystore-interface.md), the CLR calls [IHostAssemblyStore::ProvideAssembly](ihostassemblystore-provideassembly-method.md) to allow the host to supply the assembly to bind to. + +- Otherwise, the CLR fails to bind to the assembly. + + If the host sets `ppReferenceList` to null, the CLR first probes the global assembly cache, calls `ProvideAssembly`, and then probes the application base to resolve an assembly reference. + > [!NOTE] -> Upon initialization, the CLR calls `GetNonHostStoreAssemblies` only once. The method is not called again. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> Upon initialization, the CLR calls `GetNonHostStoreAssemblies` only once. The method is not called again. + +## 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 2.0 + ## See also - [ICLRAssemblyReferenceList Interface](iclrassemblyreferencelist-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostassemblymanager-interface.md b/docs/core/unmanaged-api/hosting/ihostassemblymanager-interface.md index d0f694f7b4aa7..52991bcd87c8c 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblymanager-interface.md @@ -2,47 +2,46 @@ description: "Learn more about: IHostAssemblyManager Interface" title: "IHostAssemblyManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostAssemblyManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostAssemblyManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostAssemblyManager interface [.NET Framework hosting]" -ms.assetid: dfec05bb-3cd7-4bd5-b396-a4f097c3a636 -topic_type: +topic_type: - "apiref" --- # IHostAssemblyManager Interface -Provides methods that allow a host to specify sets of assemblies that should be loaded by the common language runtime (CLR) or by the host. - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetAssemblyStore Method](ihostassemblymanager-getassemblystore-method.md)|Gets an interface pointer to an [IHostAssemblyStore](ihostassemblystore-interface.md) that represents the list of assemblies loaded by the host.| -|[GetNonHostStoreAssemblies Method](ihostassemblymanager-getnonhoststoreassemblies-method.md)|Gets an interface pointer to an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) that represents the list of assemblies that the host expects the CLR to load.| - -## Remarks - - The host is not required to implement `IHostAssemblyManager` or `IHostAssemblyStore`. If the host does implement `IHostAssemblyManager`, it must also implement `IHostAssemblyStore`. - - The runtime queries for an `IHostAssemblyManager` by calling [IHostControl::GetHostManager](ihostcontrol-gethostmanager-method.md) upon initialization with an `IID` of IID_IHostAssemblyManager. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods that allow a host to specify sets of assemblies that should be loaded by the common language runtime (CLR) or by the host. + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetAssemblyStore Method](ihostassemblymanager-getassemblystore-method.md)|Gets an interface pointer to an [IHostAssemblyStore](ihostassemblystore-interface.md) that represents the list of assemblies loaded by the host.| +|[GetNonHostStoreAssemblies Method](ihostassemblymanager-getnonhoststoreassemblies-method.md)|Gets an interface pointer to an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) that represents the list of assemblies that the host expects the CLR to load.| + +## Remarks + + The host is not required to implement `IHostAssemblyManager` or `IHostAssemblyStore`. If the host does implement `IHostAssemblyManager`, it must also implement `IHostAssemblyStore`. + + The runtime queries for an `IHostAssemblyManager` by calling [IHostControl::GetHostManager](ihostcontrol-gethostmanager-method.md) upon initialization with an `IID` of IID_IHostAssemblyManager. + +## 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 2.0 + ## See also - [ICLRAssemblyReferenceList Interface](iclrassemblyreferencelist-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md b/docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md index 4fa91aff836ac..59e952e848728 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md @@ -2,53 +2,52 @@ description: "Learn more about: IHostAssemblyStore Interface" title: "IHostAssemblyStore Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostAssemblyStore" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostAssemblyStore" -helpviewer_keywords: +helpviewer_keywords: - "IHostAssemblyStore interface [.NET Framework hosting]" -ms.assetid: cccb650f-abe0-41e2-9fd1-b383788eb1f6 -topic_type: +topic_type: - "apiref" --- # IHostAssemblyStore Interface -Provides methods that allow a host to load assemblies and modules independently of the common language runtime (CLR). - -## Methods - -|Method|Description| -|------------|-----------------| -|[ProvideAssembly Method](ihostassemblystore-provideassembly-method.md)|Gets a reference to an assembly that is not referenced by the [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) returned from a call to [IHostAssemblyManager::GetNonHostStoreAssemblies](ihostassemblymanager-getnonhoststoreassemblies-method.md).| -|[ProvideModule Method](ihostassemblystore-providemodule-method.md)|Resolves a module within an assembly or a linked (not embedded) resource file.| - -## Remarks - - `IHostAssemblyStore` provides a way for a host to load assemblies efficiently based on assembly identity. The host loads assemblies by returning `IStream` instances that point directly at the bytes. - - The CLR determines whether a host has implemented `IHostAssemblyStore` by calling `IHostAssemblyManager::GetNonHostAssemblyStores` upon initialization. This allows the host, for example, to control binding to user assemblies, but to rely on the runtime to bind to .NET Framework assemblies. - +Provides methods that allow a host to load assemblies and modules independently of the common language runtime (CLR). + +## Methods + +| Method | Description | +|--------|-------------| +|[ProvideAssembly Method](ihostassemblystore-provideassembly-method.md)|Gets a reference to an assembly that is not referenced by the [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) returned from a call to [IHostAssemblyManager::GetNonHostStoreAssemblies](ihostassemblymanager-getnonhoststoreassemblies-method.md).| +|[ProvideModule Method](ihostassemblystore-providemodule-method.md)|Resolves a module within an assembly or a linked (not embedded) resource file.| + +## Remarks + + `IHostAssemblyStore` provides a way for a host to load assemblies efficiently based on assembly identity. The host loads assemblies by returning `IStream` instances that point directly at the bytes. + + The CLR determines whether a host has implemented `IHostAssemblyStore` by calling `IHostAssemblyManager::GetNonHostAssemblyStores` upon initialization. This allows the host, for example, to control binding to user assemblies, but to rely on the runtime to bind to .NET Framework assemblies. + > [!NOTE] -> In providing an implementation of `IHostAssemblyStore`, the host specifies its intent to resolve all assemblies that are not referenced by the `ICLRAssemblyReferenceList` returned from `IHostAssemblyManager::GetNonHostStoreAssemblies`. - +> In providing an implementation of `IHostAssemblyStore`, the host specifies its intent to resolve all assemblies that are not referenced by the `ICLRAssemblyReferenceList` returned from `IHostAssemblyManager::GetNonHostStoreAssemblies`. + > [!NOTE] -> The .NET Framework version 2.0 does not provide a way for the host to load the native image of an assembly, as provided by the [Native Image Generator (Ngen.exe)](../../tools/ngen-exe-native-image-generator.md) utility. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> .NET Framework version 2.0 does not provide a way for the host to load the native image of an assembly, as provided by the [Native Image Generator (Ngen.exe)](../../../framework/tools/ngen-exe-native-image-generator.md) utility. + +## 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 2.0 + ## See also - [ICLRAssemblyReferenceList Interface](iclrassemblyreferencelist-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md b/docs/core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md index 349f0c74253bf..4947dcd8a654e 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md @@ -2,81 +2,80 @@ description: "Learn more about: IHostAssemblyStore::ProvideAssembly Method" title: "IHostAssemblyStore::ProvideAssembly Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostAssemblyStore.ProvideAssembly" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostAssemblyStore::ProvideAssembly" -helpviewer_keywords: +helpviewer_keywords: - "ProvideAssembly method [.NET Framework hosting]" - "IHostAssemblyStore::ProvideAssembly method [.NET Framework hosting]" -ms.assetid: 625c3dd5-a3f0-442c-adde-310dadbb5054 -topic_type: +topic_type: - "apiref" --- # IHostAssemblyStore::ProvideAssembly Method -Gets a reference to an assembly that is not referenced by the [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) that is returned from [IHostAssemblyManager::GetNonHostStoreAssemblies](ihostassemblymanager-getnonhoststoreassemblies-method.md). The common language runtime (CLR) calls `ProvideAssembly` for each assembly that does not appear in the list. - -## Syntax - -```cpp -HRESULT ProvideAssembly ( - [in] AssemblyBindInfo *pBindInfo, - [out] UINT64 *pAssemblyId, - [out] UINT64 *pHostContext, - [out] IStream **ppStmAssemblyImage, - [out] IStream **ppStmPDB -); -``` - -## Parameters - - `pBindInfo` - [in] A pointer to an [AssemblyBindInfo](assemblybindinfo-structure.md) instance that the host uses to determine certain bind characteristics, including the presence or absence of any versioning policy, and which assembly to bind to. - - `pAssemblyId` - [out] A pointer to a unique identifier for the requested assembly for this `IStream`. - - `pHostContext` - [out] A pointer to host-specific data that is used to determine the evidence of the requested assembly without the need of a platform invoke call. `pHostContext` corresponds to the property of the managed class. - - `ppStmAssemblyImage` - [out] A pointer to the address of an `IStream` that contains the portable executable (PE) image to be loaded, or null if the assembly could not be found. - - `ppStmPDB` - [out] A pointer to the address of an `IStream` that contains the program debug (PDB) information, or null if the .pdb file could not be found. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`ProvideAssembly` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|COR_E_FILENOTFOUND (0x80070002)|The requested assembly could not be located.| -|E_NOT_SUFFICIENT_BUFFER|The buffer size specified by `pAssemblyId` is not large enough to hold the identifier that the host wants to return.| - -## Remarks - - The identity value returned for `pAssemblyId` is specified by the host. Identifiers must be unique within the lifetime of a process. The CLR uses this value as a unique identifier for the stream. It checks each value against the values for `pAssemblyId` returned by other calls to `ProvideAssembly`. If the host returns the same `pAssemblyId` value for another `IStream`, the CLR checks whether the contents of that stream have already been mapped. If so, the runtime loads the existing copy of the image instead of mapping a new one. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets a reference to an assembly that is not referenced by the [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) that is returned from [IHostAssemblyManager::GetNonHostStoreAssemblies](ihostassemblymanager-getnonhoststoreassemblies-method.md). The common language runtime (CLR) calls `ProvideAssembly` for each assembly that does not appear in the list. + +## Syntax + +```cpp +HRESULT ProvideAssembly ( + [in] AssemblyBindInfo *pBindInfo, + [out] UINT64 *pAssemblyId, + [out] UINT64 *pHostContext, + [out] IStream **ppStmAssemblyImage, + [out] IStream **ppStmPDB +); +``` + +## Parameters + + `pBindInfo` + [in] A pointer to an [AssemblyBindInfo](assemblybindinfo-structure.md) instance that the host uses to determine certain bind characteristics, including the presence or absence of any versioning policy, and which assembly to bind to. + + `pAssemblyId` + [out] A pointer to a unique identifier for the requested assembly for this `IStream`. + + `pHostContext` + [out] A pointer to host-specific data that is used to determine the evidence of the requested assembly without the need of a platform invoke call. `pHostContext` corresponds to the property of the managed class. + + `ppStmAssemblyImage` + [out] A pointer to the address of an `IStream` that contains the portable executable (PE) image to be loaded, or null if the assembly could not be found. + + `ppStmPDB` + [out] A pointer to the address of an `IStream` that contains the program debug (PDB) information, or null if the .pdb file could not be found. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`ProvideAssembly` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|COR_E_FILENOTFOUND (0x80070002)|The requested assembly could not be located.| +|E_NOT_SUFFICIENT_BUFFER|The buffer size specified by `pAssemblyId` is not large enough to hold the identifier that the host wants to return.| + +## Remarks + + The identity value returned for `pAssemblyId` is specified by the host. Identifiers must be unique within the lifetime of a process. The CLR uses this value as a unique identifier for the stream. It checks each value against the values for `pAssemblyId` returned by other calls to `ProvideAssembly`. If the host returns the same `pAssemblyId` value for another `IStream`, the CLR checks whether the contents of that stream have already been mapped. If so, the runtime loads the existing copy of the image instead of mapping a new one. + +## 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 2.0 + ## See also - [ICLRAssemblyReferenceList Interface](iclrassemblyreferencelist-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md b/docs/core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md index 0bd00b1db5f38..0fb2d3ef5d02a 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md +++ b/docs/core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md @@ -2,77 +2,76 @@ description: "Learn more about: IHostAssemblyStore::ProvideModule Method" title: "IHostAssemblyStore::ProvideModule Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostAssemblyStore.ProvideModule" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostAssemblyStore::ProvideModule" -helpviewer_keywords: +helpviewer_keywords: - "IHostAssemblyStore::ProvideModule method [.NET Framework hosting]" - "ProvideModule method [.NET Framework hosting]" -ms.assetid: f42e3dd0-c88e-4748-b6c0-4c515a633180 -topic_type: +topic_type: - "apiref" --- # IHostAssemblyStore::ProvideModule Method -Resolves a module within an assembly or a linked (but not an embedded) resource file. - -## Syntax - -```cpp -HRESULT ProvideModule ( - [in] ModuleBindInfo *pBindInfo, - [out] DWORD *pdwModuleId, - [out] IStream **ppStmModuleImage, - [out] IStream **ppStmPDB -); -``` - -## Parameters - - `pBindInfo` - [in] A pointer to a [ModuleBindInfo](modulebindinfo-structure.md) instance that describes the requested module's , assembly, and module name. - - `pdwModuleId` - [out] A pointer to a unique identifier for the `IStream` containing the loaded module. - - `ppStmModuleImage` - [out] A pointer to the address of an `IStream` object, which contains the portable executable (PE) image to be loaded, or null if the module could not be found. - - `ppStmPDB` - [out] A pointer to the address of an `IStream` object, which contains the program debug (PDB) information for the requested module, or null if the .pdb file could not be found. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`ProvideModule` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|COR_E_FILENOTFOUND (0x80070002)|The requested assembly or linked resource could not be located.| -|E_NOT_SUFFICIENT_BUFFER|`pdwModuleId` is not large enough to contain the identifier that the host wants to return.| - -## Remarks - - The identity value returned for `pdwModuleId` is specified by the host. Identifiers must be unique within the lifetime of a process. The CLR uses this value as the unique identifier for the associated stream. It checks each value against the values for `pAssemblyId` returned by calls to [ProvideAssembly](ihostassemblystore-provideassembly-method.md) and against the values for `pdwModuleId` returned by other calls to `ProvideModule`. If the host returns the same identifier value for another `IStream`, the CLR checks whether the contents of that stream have already been mapped. If so, the CLR loads the existing copy of the image instead of mapping a new one. Therefore, the identifier must also not overlap with the assembly identifiers returned from `ProvideAssembly`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Resolves a module within an assembly or a linked (but not an embedded) resource file. + +## Syntax + +```cpp +HRESULT ProvideModule ( + [in] ModuleBindInfo *pBindInfo, + [out] DWORD *pdwModuleId, + [out] IStream **ppStmModuleImage, + [out] IStream **ppStmPDB +); +``` + +## Parameters + + `pBindInfo` + [in] A pointer to a [ModuleBindInfo](modulebindinfo-structure.md) instance that describes the requested module's , assembly, and module name. + + `pdwModuleId` + [out] A pointer to a unique identifier for the `IStream` containing the loaded module. + + `ppStmModuleImage` + [out] A pointer to the address of an `IStream` object, which contains the portable executable (PE) image to be loaded, or null if the module could not be found. + + `ppStmPDB` + [out] A pointer to the address of an `IStream` object, which contains the program debug (PDB) information for the requested module, or null if the .pdb file could not be found. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`ProvideModule` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|COR_E_FILENOTFOUND (0x80070002)|The requested assembly or linked resource could not be located.| +|E_NOT_SUFFICIENT_BUFFER|`pdwModuleId` is not large enough to contain the identifier that the host wants to return.| + +## Remarks + + The identity value returned for `pdwModuleId` is specified by the host. Identifiers must be unique within the lifetime of a process. The CLR uses this value as the unique identifier for the associated stream. It checks each value against the values for `pAssemblyId` returned by calls to [ProvideAssembly](ihostassemblystore-provideassembly-method.md) and against the values for `pdwModuleId` returned by other calls to `ProvideModule`. If the host returns the same identifier value for another `IStream`, the CLR checks whether the contents of that stream have already been mapped. If so, the CLR loads the existing copy of the image instead of mapping a new one. Therefore, the identifier must also not overlap with the assembly identifiers returned from `ProvideAssembly`. + +## 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 2.0 + ## See also - [ICLRAssemblyReferenceList Interface](iclrassemblyreferencelist-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostautoevent-interface.md b/docs/core/unmanaged-api/hosting/ihostautoevent-interface.md index 2f4b0c3c088db..bb5829d876f4b 100644 --- a/docs/core/unmanaged-api/hosting/ihostautoevent-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostautoevent-interface.md @@ -2,41 +2,40 @@ description: "Learn more about: IHostAutoEvent Interface" title: "IHostAutoEvent Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostAutoEvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostAutoEvent" -helpviewer_keywords: +helpviewer_keywords: - "IHostAutoEvent interface [.NET Framework hosting]" -ms.assetid: 6c1d15c1-a80a-4ee9-b1e4-6e859db6575a -topic_type: +topic_type: - "apiref" --- # IHostAutoEvent Interface -Provides a representation of the host's implementation of an auto-reset event. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Set Method](ihostautoevent-set-method.md)|Sets the current `IHostAutoEvent` instance to a signaled state.| -|[Wait Method](ihostautoevent-wait-method.md)|Causes the current `IHostAutoEvent` instance to wait until the event is owned or a specified amount of time elapses.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides a representation of the host's implementation of an auto-reset event. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Set Method](ihostautoevent-set-method.md)|Sets the current `IHostAutoEvent` instance to a signaled state.| +|[Wait Method](ihostautoevent-wait-method.md)|Causes the current `IHostAutoEvent` instance to wait until the event is owned or a specified amount of time elapses.| + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md b/docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md index a0323c37c01ea..e683e1c6e5850 100644 --- a/docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md +++ b/docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IHostAutoEvent::Set Method" title: "IHostAutoEvent::Set Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostAutoEvent.Set" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostAutoEvent::Set" -helpviewer_keywords: +helpviewer_keywords: - "Set method, IHostAutoEvent interface [.NET Framework hosting]" - "IHostAutoEvent::Set method [.NET Framework hosting]" -ms.assetid: 46becf3e-bc0e-4338-85c0-9ab0df76a1d0 -topic_type: +topic_type: - "apiref" --- # IHostAutoEvent::Set Method -Sets the current [IHostAutoEvent](ihostautoevent-interface.md) instance to a signaled state. - -## Syntax - -```cpp -HRESULT Set (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Set` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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 current [IHostAutoEvent](ihostautoevent-interface.md) instance to a signaled state. + +## Syntax + +```cpp +HRESULT Set (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Set` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md b/docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md index ca23493a2229a..aba7bae829da3 100644 --- a/docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md +++ b/docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IHostAutoEvent::Wait Method" title: "IHostAutoEvent::Wait Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostAutoEvent.Wait" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostAutoEvent::Wait" -helpviewer_keywords: +helpviewer_keywords: - "Wait method, IHostAutoEvent interface [.NET Framework hosting]" - "IHostAutoEvent::Wait method [.NET Framework hosting]" -ms.assetid: 535d51c5-9112-401b-8c36-85f35d7ee609 -topic_type: +topic_type: - "apiref" --- # IHostAutoEvent::Wait Method -Causes the current [IHostAutoEvent](ihostautoevent-interface.md) instance to wait until it is owned or a specified amount of time elapses. - -## Syntax - -```cpp -HRESULT Wait ( - [in] DWORD dwMilliseconds, - [in] DWORD option -); -``` - -## Parameters +Causes the current [IHostAutoEvent](ihostautoevent-interface.md) instance to wait until it is owned or a specified amount of time elapses. - `dwMilliseconds` - [in] The number of milliseconds the current `IHostAutoEvent` instance should wait before returning, if no thread or fiber takes ownership. - - `option` - [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values, specifying the action the host should take if this operation blocks. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Wait` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|HOST_E_DEADLOCK|The host detected a deadlock during the wait interval, and chose the event represented by the current `IHostAutoEvent` instance as the deadlock victim.| - -## Requirements +## Syntax + +```cpp +HRESULT Wait ( + [in] DWORD dwMilliseconds, + [in] DWORD option +); +``` + +## Parameters + + `dwMilliseconds` + [in] The number of milliseconds the current `IHostAutoEvent` instance should wait before returning, if no thread or fiber takes ownership. + + `option` + [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values, specifying the action the host should take if this operation blocks. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Wait` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|HOST_E_DEADLOCK|The host detected a deadlock during the wait interval, and chose the event represented by the current `IHostAutoEvent` instance as the deadlock victim.| + +## 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 2.0 - **Platforms:** See [System Requirements](../../../framework/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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md b/docs/core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md index 3df163daf77c5..5ae6eeaa4a9f0 100644 --- a/docs/core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md @@ -2,91 +2,90 @@ description: "Learn more about: IHostControl::GetHostManager Method" title: "IHostControl::GetHostManager Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostControl.GetHostManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostControl::GetHostManager" -helpviewer_keywords: +helpviewer_keywords: - "GetHostManager method [.NET Framework hosting]" - "IHostControl::GetHostManager method [.NET Framework hosting]" -ms.assetid: 0fa34bca-ed18-4626-9e78-d33684d18edb -topic_type: +topic_type: - "apiref" --- # IHostControl::GetHostManager Method -Gets an interface pointer to the host's implementation of the interface with the specified `IID`. - -## Syntax - -```cpp -HRESULT GetHostManager ( - [in] REFIID riid, - [out, iid_is(riid)] void** ppObject -); -``` - -## Parameters - - `riid` - [in] The `IID` of the interface that the common language runtime (CLR) is querying for. - - `ppObject` - [out] A pointer to the host-implemented interface, or null if the host does not support this interface. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetHostManager` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_INVALIDARG|The requested `IID` is not valid.| -|E_NOINTERFACE|The requested interface is not supported.| - -## Remarks - - The CLR queries the host to determine whether it supports one or more of the following interfaces: - -- [IHostMemoryManager](ihostmemorymanager-interface.md) - -- [IHostTaskManager](ihosttaskmanager-interface.md) - -- [IHostThreadPoolManager](ihostthreadpoolmanager-interface.md) - -- [IHostIoCompletionManager](ihostiocompletionmanager-interface.md) - -- [IHostSyncManager](ihostsyncmanager-interface.md) - -- [IHostAssemblyManager](ihostassemblymanager-interface.md) - -- [IHostGCManager](ihostgcmanager-interface.md) - -- [IHostPolicyManager](ihostpolicymanager-interface.md) - -- [IHostSecurityManager](ihostsecuritymanager-interface.md) - - If the host supports the specified interface, it sets `ppObject` to its implementation of that interface. Otherwise, it sets `ppObject` to null. - - The CLR does not call `Release` on host managers, even when you shut it down. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets an interface pointer to the host's implementation of the interface with the specified `IID`. + +## Syntax + +```cpp +HRESULT GetHostManager ( + [in] REFIID riid, + [out, iid_is(riid)] void** ppObject +); +``` + +## Parameters + + `riid` + [in] The `IID` of the interface that the common language runtime (CLR) is querying for. + + `ppObject` + [out] A pointer to the host-implemented interface, or null if the host does not support this interface. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetHostManager` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_INVALIDARG|The requested `IID` is not valid.| +|E_NOINTERFACE|The requested interface is not supported.| + +## Remarks + + The CLR queries the host to determine whether it supports one or more of the following interfaces: + +- [IHostMemoryManager](ihostmemorymanager-interface.md) + +- [IHostTaskManager](ihosttaskmanager-interface.md) + +- [IHostThreadPoolManager](ihostthreadpoolmanager-interface.md) + +- [IHostIoCompletionManager](ihostiocompletionmanager-interface.md) + +- [IHostSyncManager](ihostsyncmanager-interface.md) + +- [IHostAssemblyManager](ihostassemblymanager-interface.md) + +- [IHostGCManager](ihostgcmanager-interface.md) + +- [IHostPolicyManager](ihostpolicymanager-interface.md) + +- [IHostSecurityManager](ihostsecuritymanager-interface.md) + + If the host supports the specified interface, it sets `ppObject` to its implementation of that interface. Otherwise, it sets `ppObject` to null. + + The CLR does not call `Release` on host managers, even when you shut it down. + +## 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 2.0 + ## See also - [IHostControl Interface](ihostcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostcontrol-interface.md b/docs/core/unmanaged-api/hosting/ihostcontrol-interface.md index ca31d0412f528..e54bb3744423b 100644 --- a/docs/core/unmanaged-api/hosting/ihostcontrol-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostcontrol-interface.md @@ -2,41 +2,40 @@ description: "Learn more about: IHostControl Interface" title: "IHostControl Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostControl" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostControl" -helpviewer_keywords: +helpviewer_keywords: - "IHostControl interface [.NET Framework hosting]" -ms.assetid: a4ae0d1f-ade9-4b0a-a122-93ed11a5e6b3 -topic_type: +topic_type: - "apiref" --- # IHostControl Interface -Provides methods for configuring the loading of assemblies, and for determining which hosting interfaces the host supports. - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetHostManager Method](ihostcontrol-gethostmanager-method.md)|Gets an interface pointer to the host's implementation of the interface with the specified `IID`.| -|[SetAppDomainManager Method](ihostcontrol-setappdomainmanager-method.md)|Notifies the host that an application domain has been created.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods for configuring the loading of assemblies, and for determining which hosting interfaces the host supports. + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetHostManager Method](ihostcontrol-gethostmanager-method.md)|Gets an interface pointer to the host's implementation of the interface with the specified `IID`.| +|[SetAppDomainManager Method](ihostcontrol-setappdomainmanager-method.md)|Notifies the host that an application domain has been created.| + +## 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 2.0 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md b/docs/core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md index d4ffcbcf468c8..fd06113742447 100644 --- a/docs/core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md @@ -2,69 +2,68 @@ description: "Learn more about: IHostControl::SetAppDomainManager Method" title: "IHostControl::SetAppDomainManager Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostControl.SetAppDomainManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostControl::SetAppDomainManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostControl::SetAppDomainManager method [.NET Framework hosting]" - "SetAppDomainManager method [.NET Framework hosting]" -ms.assetid: 6562bbe7-0d67-4c50-a958-3a18cf680375 -topic_type: +topic_type: - "apiref" --- # IHostControl::SetAppDomainManager Method -Notifies the host that an application domain has been created. - -## Syntax - -```cpp -HRESULT SetAppDomainManager ( - [in] DWORD dwAppDomainID, - [in] IUnknown* pUnkAppDomainManager -); -``` - -## Parameters - - `dwAppDomainID` - [in] The numeric identifier of the selected . - - `pUnkAppDomainManager` - [in] A pointer to the object that the host implements as `IUnknown`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetAppDomainManager` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The provides the host with a mechanism to bootstrap into managed code and to control the creation and settings of each . The is loaded into each when that is created. If it chooses, the CLR notifies the host that the application domain has been created by setting the value of the `pUnkAppDomainManager` parameter. - - In its implementation of the `SetAppDomainManager` method, the host can set the assembly name and type for the application domain manager. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Notifies the host that an application domain has been created. + +## Syntax + +```cpp +HRESULT SetAppDomainManager ( + [in] DWORD dwAppDomainID, + [in] IUnknown* pUnkAppDomainManager +); +``` + +## Parameters + + `dwAppDomainID` + [in] The numeric identifier of the selected . + + `pUnkAppDomainManager` + [in] A pointer to the object that the host implements as `IUnknown`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetAppDomainManager` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The provides the host with a mechanism to bootstrap into managed code and to control the creation and settings of each . The is loaded into each when that is created. If it chooses, the CLR notifies the host that the application domain has been created by setting the value of the `pUnkAppDomainManager` parameter. + + In its implementation of the `SetAppDomainManager` method, the host can set the assembly name and type for the application domain manager. + +## 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 2.0 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md b/docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md index 7b1e96aa8935c..06601df34fb6b 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md @@ -2,66 +2,65 @@ description: "Learn more about: IHostCrst::Enter Method" title: "IHostCrst::Enter Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostCrst.Enter" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostCrst::Enter" -helpviewer_keywords: +helpviewer_keywords: - "Enter method [.NET Framework hosting]" - "IHostCrst::Enter method [.NET Framework hosting]" -ms.assetid: 100dd7eb-7053-4295-9bb3-32ba47f6ec79 -topic_type: +topic_type: - "apiref" --- # IHostCrst::Enter Method -Enters the critical section that is represented by the current [IHostCrst](ihostcrst-interface.md) instance. - -## Syntax - -```cpp -HRESULT Enter ( - [in] DWORD option -); -``` - -## Parameters - - `option` - [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values, indicating what action the host should take if the operation blocks. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Enter` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `Enter` mirrors the Win32 `EnterCriticalSection` function. - +Enters the critical section that is represented by the current [IHostCrst](ihostcrst-interface.md) instance. + +## Syntax + +```cpp +HRESULT Enter ( + [in] DWORD option +); +``` + +## Parameters + + `option` + [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values, indicating what action the host should take if the operation blocks. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Enter` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `Enter` mirrors the Win32 `EnterCriticalSection` function. + > [!NOTE] -> This method does not return until the critical section is entered. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> This method does not return until the critical section is entered. + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-interface.md b/docs/core/unmanaged-api/hosting/ihostcrst-interface.md index 5e86185351650..93f590c91fb0d 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostcrst-interface.md @@ -2,47 +2,46 @@ description: "Learn more about: IHostCrst Interface" title: "IHostCrst Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostCrst" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostCrst" -helpviewer_keywords: +helpviewer_keywords: - "IHostCrst interface [.NET Framework hosting]" -ms.assetid: ac298ebd-0815-47e4-a823-30b31baab903 -topic_type: +topic_type: - "apiref" --- # IHostCrst Interface -Serves as the host's representation of a critical section for threading. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Enter Method](ihostcrst-enter-method.md)|Enters the critical section.| -|[Leave Method](ihostcrst-leave-method.md)|Leaves the critical section.| -|[SetSpinCount Method](ihostcrst-setspincount-method.md)|Sets the spin count for the critical section.| -|[TryEnter Method](ihostcrst-tryenter-method.md)|Attempts to enter the critical section, and reports success or failure immediately.| - -## Remarks - - `IHostCrst` allows the common language runtime (CLR) to communicate directly with the host's representation of a critical section, rather than using Win32 functions such as `EnterCriticalSection` or `LeaveCriticalSection`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Serves as the host's representation of a critical section for threading. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Enter Method](ihostcrst-enter-method.md)|Enters the critical section.| +|[Leave Method](ihostcrst-leave-method.md)|Leaves the critical section.| +|[SetSpinCount Method](ihostcrst-setspincount-method.md)|Sets the spin count for the critical section.| +|[TryEnter Method](ihostcrst-tryenter-method.md)|Attempts to enter the critical section, and reports success or failure immediately.| + +## Remarks + + `IHostCrst` allows the common language runtime (CLR) to communicate directly with the host's representation of a critical section, rather than using Win32 functions such as `EnterCriticalSection` or `LeaveCriticalSection`. + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md b/docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md index 9a7ee7ce9e954..719c66f6bd3ae 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IHostCrst::Leave Method" title: "IHostCrst::Leave Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostCrst.Leave" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostCrst::Leave" -helpviewer_keywords: +helpviewer_keywords: - "IHostCrst::Leave method [.NET Framework hosting]" - "Leave method [.NET Framework hosting]" -ms.assetid: dfc51d9e-b36d-4dba-9ea1-4f63fa0601ae -topic_type: +topic_type: - "apiref" --- # IHostCrst::Leave Method -Leaves the critical section that is represented by the current instance of [IHostCrst](ihostcrst-interface.md). - -## Syntax - -```cpp -HRESULT Leave (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Leave` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `Leave` allows the CLR to communicate directly with the host's threading implementation, rather than using the corresponding Win32 `LeaveCriticalSection` function. A thread that takes ownership of the critical section represented by the current `IHostCrst` instance must call `Leave` once for each time it enters that critical section. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Leaves the critical section that is represented by the current instance of [IHostCrst](ihostcrst-interface.md). + +## Syntax + +```cpp +HRESULT Leave (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Leave` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `Leave` allows the CLR to communicate directly with the host's threading implementation, rather than using the corresponding Win32 `LeaveCriticalSection` function. A thread that takes ownership of the critical section represented by the current `IHostCrst` instance must call `Leave` once for each time it enters that critical section. + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-setspincount-method.md b/docs/core/unmanaged-api/hosting/ihostcrst-setspincount-method.md index 1cc5a71a5789d..2e2b9f6d55b05 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-setspincount-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcrst-setspincount-method.md @@ -2,65 +2,64 @@ description: "Learn more about: IHostCrst::SetSpinCount Method" title: "IHostCrst::SetSpinCount Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostCrst.SetSpinCount" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostCrst::SetSpinCount" -helpviewer_keywords: +helpviewer_keywords: - "IHostCrst::SetSpinCount method [.NET Framework hosting]" - "SetSpinCount method [.NET Framework hosting]" -ms.assetid: 863fc8ce-9b8a-477e-8dd8-75c8544bb43a -topic_type: +topic_type: - "apiref" --- # IHostCrst::SetSpinCount Method -Sets the spin count for the current [IHostCrst](ihostcrst-interface.md) instance. - -## Syntax - -```cpp -HRESULT SetSpinCount ( - [in] DWORD dwSpinCount -); -``` - -## Parameters - - `dwSpinCount` - [in] The new spin count for the current `IHostCrst` instance. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetSpinCount` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - On multi-processor systems, if the critical section represented by the current `IHostCrst` instance is unavailable, a calling thread spins `dwSpinCount` times before calling [IHostSemaphore::Wait](ihostsemaphore-wait-method.md) on a semaphore associated with the critical section. If the critical section becomes free during the spin operation, the calling thread avoids the wait operation. - - The usage of `dwSpinCount` is identical to the usage of the parameter of the same name in the Win32 `InitializeCriticalSectionAndSpinCount` function. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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 spin count for the current [IHostCrst](ihostcrst-interface.md) instance. + +## Syntax + +```cpp +HRESULT SetSpinCount ( + [in] DWORD dwSpinCount +); +``` + +## Parameters + + `dwSpinCount` + [in] The new spin count for the current `IHostCrst` instance. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetSpinCount` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + On multi-processor systems, if the critical section represented by the current `IHostCrst` instance is unavailable, a calling thread spins `dwSpinCount` times before calling [IHostSemaphore::Wait](ihostsemaphore-wait-method.md) on a semaphore associated with the critical section. If the critical section becomes free during the spin operation, the calling thread avoids the wait operation. + + The usage of `dwSpinCount` is identical to the usage of the parameter of the same name in the Win32 `InitializeCriticalSectionAndSpinCount` function. + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md b/docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md index 4d5a8ac256326..ad1a8de192155 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md +++ b/docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md @@ -2,67 +2,66 @@ description: "Learn more about: IHostCrst::TryEnter Method" title: "IHostCrst::TryEnter Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostCrst.TryEnter" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostCrst::TryEnter" -helpviewer_keywords: +helpviewer_keywords: - "IHostCrst::TryEnter method [.NET Framework hosting]" - "TryEnter method [.NET Framework hosting]" -ms.assetid: a922fa98-beab-4f09-a342-cc94fc65687f -topic_type: +topic_type: - "apiref" --- # IHostCrst::TryEnter Method -Attempts to enter the critical section represented by the current [IHostCrst](ihostcrst-interface.md) instance. - -## Syntax - -```cpp -HRESULT TryEnter ( - [in] DWORD option, - [out] BOOL *pbSucceeded -); -``` - -## Parameters - - `option` - [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values, indicating what action the host should take if the operation blocks. - - `pbSucceeded` - [out] `true` if the critical section can be entered; otherwise, `false`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`TryEnter` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `TryEnter` returns immediately and indicates whether the calling thread entered the critical section. This method mirrors the Wind32 `TryEnterCriticalSection` function. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Attempts to enter the critical section represented by the current [IHostCrst](ihostcrst-interface.md) instance. + +## Syntax + +```cpp +HRESULT TryEnter ( + [in] DWORD option, + [out] BOOL *pbSucceeded +); +``` + +## Parameters + + `option` + [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values, indicating what action the host should take if the operation blocks. + + `pbSucceeded` + [out] `true` if the critical section can be entered; otherwise, `false`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`TryEnter` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `TryEnter` returns immediately and indicates whether the calling thread entered the critical section. This method mirrors the Wind32 `TryEnterCriticalSection` function. + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md b/docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md index 785db21f068df..0a7627dd281eb 100644 --- a/docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md @@ -2,42 +2,41 @@ description: "Learn more about: IHostGCManager Interface" title: "IHostGCManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostGCManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostGCManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostGCManager interface [.NET Framework hosting]" -ms.assetid: 820330a4-244c-4f67-ab5e-f24b0b3c2080 -topic_type: +topic_type: - "apiref" --- # IHostGCManager Interface -Provides methods that notify the host of events in the garbage collection mechanism implemented by the common language runtime (CLR). - -## Members - -|Member|Description| -|------------|-----------------| -|[SuspensionEnding Method](ihostgcmanager-suspensionending-method.md)|Notifies the host that the CLR is resuming execution of tasks on threads that had been suspended for a garbage collection.| -|[SuspensionStarting Method](ihostgcmanager-suspensionstarting-method.md)|Notifies the host that the CLR is suspending execution of tasks, to perform a garbage collection.| -|[ThreadIsBlockingForSuspension Method](ihostgcmanager-threadisblockingforsuspension-method.md)|Notifies the host that the thread from which the method call was made is about to block for a garbage collection.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods that notify the host of events in the garbage collection mechanism implemented by the common language runtime (CLR). + +## Members + +|Member|Description| +|------------|-----------------| +|[SuspensionEnding Method](ihostgcmanager-suspensionending-method.md)|Notifies the host that the CLR is resuming execution of tasks on threads that had been suspended for a garbage collection.| +|[SuspensionStarting Method](ihostgcmanager-suspensionstarting-method.md)|Notifies the host that the CLR is suspending execution of tasks, to perform a garbage collection.| +|[ThreadIsBlockingForSuspension Method](ihostgcmanager-threadisblockingforsuspension-method.md)|Notifies the host that the thread from which the method call was made is about to block for a garbage collection.| + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md b/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md index 7fae9657e62b3..ed4107a46e951 100644 --- a/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md +++ b/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md @@ -2,66 +2,65 @@ description: "Learn more about: IHostGCManager::SuspensionEnding Method" title: "IHostGCManager::SuspensionEnding Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostGCManager.SuspensionEnding" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostGCManager::SuspensionEnding" -helpviewer_keywords: +helpviewer_keywords: - "SuspensionEnding method, IHostGCManager interface [.NET Framework hosting]" - "IHostGCManager::SuspensionEnding method [.NET Framework hosting]" -ms.assetid: 8849a1db-17f0-44b7-880a-bd36d431eb91 -topic_type: +topic_type: - "apiref" --- # IHostGCManager::SuspensionEnding Method -Notifies the host that the common language runtime (CLR) is resuming execution of tasks on threads that had been suspended for a garbage collection. - -## Syntax - -```cpp -HRESULT SuspensionEnding ( - [in] DWORD generation -); -``` - -## Parameters - - `generation` - [in] The garbage collection generation that is just finishing, from which the thread is resuming. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SuspensionEnding` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR calls `SuspensionEnding` after it performs a garbage collection, to inform the host that the thread is resuming execution. - +Notifies the host that the common language runtime (CLR) is resuming execution of tasks on threads that had been suspended for a garbage collection. + +## Syntax + +```cpp +HRESULT SuspensionEnding ( + [in] DWORD generation +); +``` + +## Parameters + + `generation` + [in] The garbage collection generation that is just finishing, from which the thread is resuming. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SuspensionEnding` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR calls `SuspensionEnding` after it performs a garbage collection, to inform the host that the thread is resuming execution. + > [!IMPORTANT] -> Do not reschedule the thread the method call was made from. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> Do not reschedule the thread the method call was made from. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md b/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md index 4e6e865907c15..8cfa77bcf376a 100644 --- a/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md +++ b/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md @@ -2,59 +2,58 @@ description: "Learn more about: IHostGCManager::SuspensionStarting Method" title: "IHostGCManager::SuspensionStarting Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostGCManager.SuspensionStarting" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostGCManager::SuspensionStarting" -helpviewer_keywords: +helpviewer_keywords: - "SuspensionStarting method, IHostGCManager interface [.NET Framework hosting]" - "IHostGCManager::SuspensionStarting method [.NET Framework hosting]" -ms.assetid: c381f524-94cf-4fa2-9298-50f847a03431 -topic_type: +topic_type: - "apiref" --- # IHostGCManager::SuspensionStarting Method -Notifies the host that the common language runtime (CLR) is suspending execution of tasks, to perform a garbage collection. - -## Syntax - -```cpp -HRESULT SuspensionStarting (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SuspensionStarting` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks +Notifies the host that the common language runtime (CLR) is suspending execution of tasks, to perform a garbage collection. + +## Syntax + +```cpp +HRESULT SuspensionStarting (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SuspensionStarting` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR calls `SuspensionStarting` to inform the host that garbage collection is occurring. - The CLR calls `SuspensionStarting` to inform the host that garbage collection is occurring. - > [!IMPORTANT] -> Do not reschedule this task. The host must reschedule a task when [ThreadIsBlockingForSuspension](ihostgcmanager-threadisblockingforsuspension-method.md) is called. - -## Requirements +> Do not reschedule this task. The host must reschedule a task when [ThreadIsBlockingForSuspension](ihostgcmanager-threadisblockingforsuspension-method.md) is called. + +## 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 2.0 - **Platforms:** See [System Requirements](../../../framework/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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md b/docs/core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md index f82010ee1fef4..4aac5bf367bc7 100644 --- a/docs/core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md +++ b/docs/core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md @@ -2,59 +2,58 @@ description: "Learn more about: IHostGCManager::ThreadIsBlockingForSuspension Method" title: "IHostGCManager::ThreadIsBlockingForSuspension Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostGCManager.ThreadIsBlockingForSuspension" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostGCManager::ThreadIsBlockingForSuspension" -helpviewer_keywords: +helpviewer_keywords: - "IHostGCManager::ThreadIsBlockingForSuspension method [.NET Framework hosting]" - "ThreadIsBlockingForSuspension method [.NET Framework hosting]" -ms.assetid: 2657d45d-26d2-4d0a-8473-32b652e3321d -topic_type: +topic_type: - "apiref" --- # IHostGCManager::ThreadIsBlockingForSuspension Method -Notifies the host that the thread from which the method call was made is about to block for a garbage collection. - -## Syntax - -```cpp -HRESULT ThreadIsBlockingForSuspension (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`ThreadIsBlockingForSuspension` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks +Notifies the host that the thread from which the method call was made is about to block for a garbage collection. + +## Syntax + +```cpp +HRESULT ThreadIsBlockingForSuspension (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`ThreadIsBlockingForSuspension` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR typically calls the `ThreadIsBlockForSuspension` method in preparation for a garbage collection, to give the host an opportunity to reschedule the thread for unmanaged tasks. - The CLR typically calls the `ThreadIsBlockForSuspension` method in preparation for a garbage collection, to give the host an opportunity to reschedule the thread for unmanaged tasks. - > [!IMPORTANT] -> The host can reschedule tasks only after a call to `ThreadIsBlockingForSuspension`. After the runtime calls [SuspensionStarting](ihostgcmanager-suspensionstarting-method.md), the host must not reschedule a task. - -## Requirements +> The host can reschedule tasks only after a call to `ThreadIsBlockingForSuspension`. After the runtime calls [SuspensionStarting](ihostgcmanager-suspensionstarting-method.md), the host must not reschedule a task. + +## 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 2.0 - **Platforms:** See [System Requirements](../../../framework/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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md index 8c18682ef5028..c5e7338e6a193 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md @@ -2,70 +2,69 @@ description: "Learn more about: IHostIoCompletionManager::Bind Method" title: "IHostIoCompletionManager::Bind Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager.Bind" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager::Bind" -helpviewer_keywords: +helpviewer_keywords: - "IHostIoCompletionManager::Bind method [.NET Framework hosting]" - "Bind method [.NET Framework hosting]" -ms.assetid: acd74cb5-7e22-4a07-83c3-82288e1abd9f -topic_type: +topic_type: - "apiref" --- # IHostIoCompletionManager::Bind Method -Binds the specified handle to an I/O completion port that has been created by an earlier call to [CreateIoCompletionPort](ihostiocompletionmanager-createiocompletionport-method.md). - -## Syntax - -```cpp -HRESULT Bind ( - [in] HANDLE hPort, - [in] HANDLE hHandle -); -``` - -## Parameters - - `hPort` - [in] The I/O completion port to which to bind `hHandle`. If the value of `hPort` is null, `hHandle` is bound to the default I/O completion port. - - `hHandle` - [in] The operating system handle to bind to `hPort`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Bind` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - An I/O completion port is created by using a call to `CreateIoCompletionPort`. The CLR calls `Bind` to bind a handle to that port. - +Binds the specified handle to an I/O completion port that has been created by an earlier call to [CreateIoCompletionPort](ihostiocompletionmanager-createiocompletionport-method.md). + +## Syntax + +```cpp +HRESULT Bind ( + [in] HANDLE hPort, + [in] HANDLE hHandle +); +``` + +## Parameters + + `hPort` + [in] The I/O completion port to which to bind `hHandle`. If the value of `hPort` is null, `hHandle` is bound to the default I/O completion port. + + `hHandle` + [in] The operating system handle to bind to `hPort`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Bind` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + An I/O completion port is created by using a call to `CreateIoCompletionPort`. The CLR calls `Bind` to bind a handle to that port. + > [!NOTE] -> When an I/O request completes, the host must call the [ICLRIoCompletionManager::OnComplete](iclriocompletionmanager-oncomplete-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> When an I/O request completes, the host must call the [ICLRIoCompletionManager::OnComplete](iclriocompletionmanager-oncomplete-method.md) method. + +## 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 2.0 + ## See also - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md index c99a2c7ce9594..cb46d64c9795e 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IHostIoCompletionManager::CloseIoCompletionPort Method" title: "IHostIoCompletionManager::CloseIoCompletionPort Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager.CloseIoCompletionPort" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager::CloseIoCompletionPort" -helpviewer_keywords: +helpviewer_keywords: - "IHostIoCompletionManager::CloseIoCompletionPort method [.NET Framework hosting]" - "CloseIoCompletionPort method [.NET Framework hosting]" -ms.assetid: e86ad7be-3758-498a-a972-5522d69dfbb3 -topic_type: +topic_type: - "apiref" --- # IHostIoCompletionManager::CloseIoCompletionPort Method -Requests that the host close a port that was opened through an earlier call to [CreateIoCompletionPort](ihostiocompletionmanager-createiocompletionport-method.md). - -## Syntax - -```cpp -HRESULT CloseIoCompletionPort ( - [in] HANDLE hPort -); -``` - -## Parameters - - `hPort` - [in] The handle of the port to close. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CloseIoCompletionPort` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_INVALIDARG|An invalid port handle was passed.| - -## Remarks - - `hPort` must be a handle to a port that was created by an earlier call to `CreateIoCompletionPort`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Requests that the host close a port that was opened through an earlier call to [CreateIoCompletionPort](ihostiocompletionmanager-createiocompletionport-method.md). + +## Syntax + +```cpp +HRESULT CloseIoCompletionPort ( + [in] HANDLE hPort +); +``` + +## Parameters + + `hPort` + [in] The handle of the port to close. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CloseIoCompletionPort` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_INVALIDARG|An invalid port handle was passed.| + +## Remarks + + `hPort` must be a handle to a port that was created by an earlier call to `CreateIoCompletionPort`. + +## 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 2.0 + ## See also - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md index 0fa2f6dc3bbd0..02558515e6933 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IHostIoCompletionManager::CreateIoCompletionPort Method" title: "IHostIoCompletionManager::CreateIoCompletionPort Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager.CreateIoCompletionPort" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager::CreateIoCompletionPort" -helpviewer_keywords: +helpviewer_keywords: - "IHostIoCompletionManager::CreateIoCompletionPort method [.NET Framework hosting]" - "CreateIoCompletionPort method [.NET Framework hosting]" -ms.assetid: 907a2b43-68db-44a7-acac-89e792e7bb3c -topic_type: +topic_type: - "apiref" --- # IHostIoCompletionManager::CreateIoCompletionPort Method -Requests that the host create a new I/O completion port. - -## Syntax - -```cpp -HRESULT CreateIoCompletionPort ( - [out] HANDLE *phPort -); -``` - -## Parameters - - `phPort` - [out] A pointer to a handle to the newly created I/O completion port, or 0 (zero), if the port could not be created. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateIoCompletionPort` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to allocate the requested resource.| - -## Remarks - - The CLR calls the `CreateIoCompletionPort` method to request that the host create a new I/O completion port. It binds I/O operations to this port through a call to the [IHostIoCompletionManager::Bind](ihostiocompletionmanager-bind-method.md) method. The host reports status back to the CLR by calling [ICLRIoCompletionManager::OnComplete](iclriocompletionmanager-oncomplete-method.md). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Requests that the host create a new I/O completion port. + +## Syntax + +```cpp +HRESULT CreateIoCompletionPort ( + [out] HANDLE *phPort +); +``` + +## Parameters + + `phPort` + [out] A pointer to a handle to the newly created I/O completion port, or 0 (zero), if the port could not be created. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateIoCompletionPort` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to allocate the requested resource.| + +## Remarks + + The CLR calls the `CreateIoCompletionPort` method to request that the host create a new I/O completion port. It binds I/O operations to this port through a call to the [IHostIoCompletionManager::Bind](ihostiocompletionmanager-bind-method.md) method. The host reports status back to the CLR by calling [ICLRIoCompletionManager::OnComplete](iclriocompletionmanager-oncomplete-method.md). + +## 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 2.0 + ## See also - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md index 0802562ad168c..5d4e7176848d9 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IHostIoCompletionManager::GetAvailableThreads Method" title: "IHostIoCompletionManager::GetAvailableThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager.GetAvailableThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager::GetAvailableThreads" -helpviewer_keywords: +helpviewer_keywords: - "GetAvailableThreads method, IHostIoCompletionManager interface [.NET Framework hosting]" - "IHostIoCompletionManager::GetAvailableThreads method [.NET Framework hosting]" -ms.assetid: bab363d1-b859-47a4-9884-5661c611cce7 -topic_type: +topic_type: - "apiref" --- # IHostIoCompletionManager::GetAvailableThreads Method -Gets the number of I/O completion threads, of the total number of threads managed by the host, that are not currently servicing requests. - -## Syntax - -```cpp -HRESULT GetAvailableThreads ( - [out] DWORD *pdwAvailableIoCompletionThreads -); -``` - -## Parameters - - `pdwAvailableIoCompletionThreads` - [out] A pointer to the number of I/O completion threads managed by the host that are currently available to service requests. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetAvailableThreads` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not provide an implementation of `GetAvailableThreads`.| - -## Remarks - - A host might want exclusive control over the size of the I/O completion thread pool, for reasons such as implementation, performance, or scalability. Therefore, the host is not required to implement `GetAvailableThreads`. In this case, the host should return E_NOTIMPL from this method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the number of I/O completion threads, of the total number of threads managed by the host, that are not currently servicing requests. + +## Syntax + +```cpp +HRESULT GetAvailableThreads ( + [out] DWORD *pdwAvailableIoCompletionThreads +); +``` + +## Parameters + + `pdwAvailableIoCompletionThreads` + [out] A pointer to the number of I/O completion threads managed by the host that are currently available to service requests. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetAvailableThreads` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not provide an implementation of `GetAvailableThreads`.| + +## Remarks + + A host might want exclusive control over the size of the I/O completion thread pool, for reasons such as implementation, performance, or scalability. Therefore, the host is not required to implement `GetAvailableThreads`. In this case, the host should return E_NOTIMPL from this method. + +## 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 2.0 + ## See also - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md index 47d038b794855..d11d44c1e7823 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md @@ -2,73 +2,72 @@ description: "Learn more about: IHostIoCompletionManager::GetHostOverlappedSize Method" title: "IHostIoCompletionManager::GetHostOverlappedSize Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager.GetHostOverlappedSize" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager::GetHostOverlappedSize" -helpviewer_keywords: +helpviewer_keywords: - "IHostIoCompletionManager::GetHostOverlappedSize method [.NET Framework hosting]" - "GetHostOverlappedSize method [.NET Framework hosting]" -ms.assetid: 2902578b-d5e2-4f8d-a103-0c7b6dceda9e -topic_type: +topic_type: - "apiref" --- # IHostIoCompletionManager::GetHostOverlappedSize Method -Gets the size of any custom data the host intends to append to I/O requests. - -## Syntax - -```cpp -HRESULT GetHostOverlappedSize ( - [out] DWORD *pcbSize -); -``` - -## Parameters - - `pcbSize` - [out] A pointer to the number of bytes that the common language runtime (CLR) should allocate in addition to the size of the Win32 `OVERLAPPED` object. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetHostOverlappedSize` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - All asynchronous I/O calls to Windows Platform APIs take a Win32 `OVERLAPPED` object, which provides information such as the file pointer position. To maintain state, applications that make asynchronous I/O calls typically add custom data to the structure. `GetHostOverlappedSize` and [IHostIoCompletionManager::InitializeHostOverlapped](ihostiocompletionmanager-initializehostoverlapped-method.md) provide an opportunity for the host to include such custom data. - - The CLR calls the `GetHostOverlappedSize` method to determine the size of the custom data that the host intends to append to the `OVERLAPPED` object. - +Gets the size of any custom data the host intends to append to I/O requests. + +## Syntax + +```cpp +HRESULT GetHostOverlappedSize ( + [out] DWORD *pcbSize +); +``` + +## Parameters + + `pcbSize` + [out] A pointer to the number of bytes that the common language runtime (CLR) should allocate in addition to the size of the Win32 `OVERLAPPED` object. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetHostOverlappedSize` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + All asynchronous I/O calls to Windows Platform APIs take a Win32 `OVERLAPPED` object, which provides information such as the file pointer position. To maintain state, applications that make asynchronous I/O calls typically add custom data to the structure. `GetHostOverlappedSize` and [IHostIoCompletionManager::InitializeHostOverlapped](ihostiocompletionmanager-initializehostoverlapped-method.md) provide an opportunity for the host to include such custom data. + + The CLR calls the `GetHostOverlappedSize` method to determine the size of the custom data that the host intends to append to the `OVERLAPPED` object. + > [!NOTE] -> `GetHostOverlappedSize` is called only once. The host's custom data must be the same size for every I/O request. - +> `GetHostOverlappedSize` is called only once. The host's custom data must be the same size for every I/O request. + > [!IMPORTANT] -> The size of the `OVERLAPPED` object itself is not included in the value of `pcbSize`. - - For more information about the `OVERLAPPED` structure, see the Windows Platform documentation. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> The size of the `OVERLAPPED` object itself is not included in the value of `pcbSize`. + + For more information about the `OVERLAPPED` structure, see the Windows Platform documentation. + +## 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 2.0 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md index eb21ac96c97c6..d04a09f02cab2 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IHostIoCompletionManager::GetMaxThreads Method" title: "IHostIoCompletionManager::GetMaxThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager.GetMaxThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager::GetMaxThreads" -helpviewer_keywords: +helpviewer_keywords: - "IHostIoCompletionManager::GetMaxThreads method [.NET Framework hosting]" - "GetMaxThreads method, IHostIoCompletionManager interface [.NET Framework hosting]" -ms.assetid: e7a6cadc-2433-4472-a701-58891abcde45 -topic_type: +topic_type: - "apiref" --- # IHostIoCompletionManager::GetMaxThreads Method -Gets the maximum number of threads that the host can allot to service I/O requests. - -## Syntax - -```cpp -HRESULT GetMaxThreads ( - [out] DWORD *pdwMaxIoCompletionThreads -); -``` - -## Parameters - - `pdwMaxIoCompletionThreads` - [out] A pointer to the maximum number of threads in the thread pool that the host can allot to service I/O requests. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetMaxThreads` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not provide an implementation of `GetMaxThreads`.| - -## Remarks - - A host might want exclusive control over the number of threads that can be allotted to process I/O requests, for reasons such as implementation, performance, or scalability. For this reason, the host is not required to implement `GetMaxThreads`. In this case, the host should return E_NOTIMPL from this method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the maximum number of threads that the host can allot to service I/O requests. + +## Syntax + +```cpp +HRESULT GetMaxThreads ( + [out] DWORD *pdwMaxIoCompletionThreads +); +``` + +## Parameters + + `pdwMaxIoCompletionThreads` + [out] A pointer to the maximum number of threads in the thread pool that the host can allot to service I/O requests. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetMaxThreads` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not provide an implementation of `GetMaxThreads`.| + +## Remarks + + A host might want exclusive control over the number of threads that can be allotted to process I/O requests, for reasons such as implementation, performance, or scalability. For this reason, the host is not required to implement `GetMaxThreads`. In this case, the host should return E_NOTIMPL from this method. + +## 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 2.0 + ## See also - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md index 3417ac46ad984..23e471bffc8ae 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IHostIoCompletionManager::GetMinThreads Method" title: "IHostIoCompletionManager::GetMinThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager.GetMinThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager::GetMinThreads" -helpviewer_keywords: +helpviewer_keywords: - "GetMinThreads method, IHostIoCompletionManager interface [.NET Framework hosting]" - "IHostIoCompletionManager::GetMinThreads method [.NET Framework hosting]" -ms.assetid: d7a7f733-677d-481c-b3d5-444fcc502b8e -topic_type: +topic_type: - "apiref" --- # IHostIoCompletionManager::GetMinThreads Method -Gets the minimum number of threads that the host provides for processing I/O requests. - -## Syntax - -```cpp -HRESULT GetMinThreads ( - [out] DWORD *pdwMinIOCompletionThreads -); -``` - -## Parameters - - `pdwMinIOCompletionThreads` - [out] A pointer to the minimum number of threads that the host provides to process I/O requests. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetMinThreads` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not provide an implementation of `GetMinThreads`.| - -## Remarks - - A host might want exclusive control over the number of threads allotted to service I/O requests, for reasons such as implementation, performance, or scalability. For this reason, the host is not required to implement `GetMinThreads`. In this case, the host should return E_NOTIMPL from this method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the minimum number of threads that the host provides for processing I/O requests. + +## Syntax + +```cpp +HRESULT GetMinThreads ( + [out] DWORD *pdwMinIOCompletionThreads +); +``` + +## Parameters + + `pdwMinIOCompletionThreads` + [out] A pointer to the minimum number of threads that the host provides to process I/O requests. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetMinThreads` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not provide an implementation of `GetMinThreads`.| + +## Remarks + + A host might want exclusive control over the number of threads allotted to service I/O requests, for reasons such as implementation, performance, or scalability. For this reason, the host is not required to implement `GetMinThreads`. In this case, the host should return E_NOTIMPL from this method. + +## 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 2.0 + ## See also - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md index d049d60cb2c7c..8ccc34344d808 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md @@ -2,69 +2,68 @@ description: "Learn more about: IHostIoCompletionManager::InitializeHostOverlapped Method" title: "IHostIoCompletionManager::InitializeHostOverlapped Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager.InitializeHostOverlapped" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager::InitializeHostOverlapped" -helpviewer_keywords: +helpviewer_keywords: - "IHostIoCompletionManager::InitializeHostOverlapped method [.NET Framework hosting]" - "InitializeHostOverlapped method [.NET Framework hosting]" -ms.assetid: c35199bf-bc47-4901-b467-4e8a37644bbb -topic_type: +topic_type: - "apiref" --- # IHostIoCompletionManager::InitializeHostOverlapped Method -Provides the host with an opportunity to initialize any custom data to append to a Win32 `OVERLAPPED` structure that is used for asynchronous I/O requests. - -## Syntax - -```cpp -HRESULT InitializeHostOverlapped ( - [in] void* pvOverlapped -); -``` - -## Parameters - - `pvOverlapped` - [in] A pointer to the Win32 `OVERLAPPED` structure to be included with the I/O request. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`InitializeHostOverlapped` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to allocate the requested resource.| - -## Remarks - - The Windows Platform functions use the `OVERLAPPED` structure to store state for asynchronous I/O requests. The CLR calls the `InitializeHostOverlapped` method to give the host the opportunity to append custom data to an `OVERLAPPED` instance. - +Provides the host with an opportunity to initialize any custom data to append to a Win32 `OVERLAPPED` structure that is used for asynchronous I/O requests. + +## Syntax + +```cpp +HRESULT InitializeHostOverlapped ( + [in] void* pvOverlapped +); +``` + +## Parameters + + `pvOverlapped` + [in] A pointer to the Win32 `OVERLAPPED` structure to be included with the I/O request. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`InitializeHostOverlapped` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to allocate the requested resource.| + +## Remarks + + The Windows Platform functions use the `OVERLAPPED` structure to store state for asynchronous I/O requests. The CLR calls the `InitializeHostOverlapped` method to give the host the opportunity to append custom data to an `OVERLAPPED` instance. + > [!IMPORTANT] -> To get to the beginning of their custom data block, hosts must set the offset to the size of the `OVERLAPPED` structure (`sizeof(OVERLAPPED)`). - - A return value of E_OUTOFMEMORY indicates that the host has failed to initialize its custom data. In this case, the CLR reports an error and fails the call. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> To get to the beginning of their custom data block, hosts must set the offset to the size of the `OVERLAPPED` structure (`sizeof(OVERLAPPED)`). + + A return value of E_OUTOFMEMORY indicates that the host has failed to initialize its custom data. In this case, the CLR reports an error and fails the call. + +## 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 2.0 + ## See also - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md index 480d47a17596f..321be0ace0b57 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md @@ -2,54 +2,53 @@ description: "Learn more about: IHostIoCompletionManager Interface" title: "IHostIoCompletionManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostIoCompletionManager interface [.NET Framework hosting]" -ms.assetid: c28d1983-83f7-46e2-990f-dbb9dc07c818 -topic_type: +topic_type: - "apiref" --- # IHostIoCompletionManager Interface -Provides methods that allow the common language runtime (CLR) to interact with I/O completion ports provided by the host. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Bind Method](ihostiocompletionmanager-bind-method.md)|Binds a handle to an I/O completion port.| -|[CloseIoCompletionPort Method](ihostiocompletionmanager-closeiocompletionport-method.md)|Closes a port that was created through an earlier call to `CreateIoCompletionPort`.| -|[CreateIoCompletionPort Method](ihostiocompletionmanager-createiocompletionport-method.md)|Requests that the host create a new I/O completion port.| -|[GetAvailableThreads Method](ihostiocompletionmanager-getavailablethreads-method.md)|Gets the number of I/O completion threads that are not currently processing requests.| -|[GetHostOverlappedSize Method](ihostiocompletionmanager-gethostoverlappedsize-method.md)|Gets the size of any custom data the host intends to append to I/O requests.| -|[GetMaxThreads Method](ihostiocompletionmanager-getmaxthreads-method.md)|Gets the maximum number of threads that the host can allot to service I/O requests.| -|[GetMinThreads Method](ihostiocompletionmanager-getminthreads-method.md)|Gets the minimum number of threads that the host provides to service I/O requests.| -|[InitializeHostOverlapped Method](ihostiocompletionmanager-initializehostoverlapped-method.md)|Provides the host with an opportunity to initialize any custom data about an I/O request.| -|[SetCLRIoCompletionManager Method](ihostiocompletionmanager-setclriocompletionmanager-method.md)|Provides the host with an interface pointer to an [ICLRIoCompletionManager](iclriocompletionmanager-interface.md) instance implemented by the CLR.| -|[SetMaxThreads Method](ihostiocompletionmanager-setmaxthreads-method.md)|Sets the maximum number of threads that the host allots to service I/O requests.| -|[SetMinThreads Method](ihostiocompletionmanager-setminthreads-method.md)|Sets the minimum number of threads that the host should allot to I/O completion.| - -## Remarks - - `IHostIoCompletionManager` corresponds to the `ICLRIoCompletionManager` interface implemented by the CLR. The CLR calls the methods of `IHostIoCompletionManager` to bind handles to the ports that the host provides, and the host calls the methods of `ICLRIoCompletionManager` to report the completion of I/O requests. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods that allow the common language runtime (CLR) to interact with I/O completion ports provided by the host. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Bind Method](ihostiocompletionmanager-bind-method.md)|Binds a handle to an I/O completion port.| +|[CloseIoCompletionPort Method](ihostiocompletionmanager-closeiocompletionport-method.md)|Closes a port that was created through an earlier call to `CreateIoCompletionPort`.| +|[CreateIoCompletionPort Method](ihostiocompletionmanager-createiocompletionport-method.md)|Requests that the host create a new I/O completion port.| +|[GetAvailableThreads Method](ihostiocompletionmanager-getavailablethreads-method.md)|Gets the number of I/O completion threads that are not currently processing requests.| +|[GetHostOverlappedSize Method](ihostiocompletionmanager-gethostoverlappedsize-method.md)|Gets the size of any custom data the host intends to append to I/O requests.| +|[GetMaxThreads Method](ihostiocompletionmanager-getmaxthreads-method.md)|Gets the maximum number of threads that the host can allot to service I/O requests.| +|[GetMinThreads Method](ihostiocompletionmanager-getminthreads-method.md)|Gets the minimum number of threads that the host provides to service I/O requests.| +|[InitializeHostOverlapped Method](ihostiocompletionmanager-initializehostoverlapped-method.md)|Provides the host with an opportunity to initialize any custom data about an I/O request.| +|[SetCLRIoCompletionManager Method](ihostiocompletionmanager-setclriocompletionmanager-method.md)|Provides the host with an interface pointer to an [ICLRIoCompletionManager](iclriocompletionmanager-interface.md) instance implemented by the CLR.| +|[SetMaxThreads Method](ihostiocompletionmanager-setmaxthreads-method.md)|Sets the maximum number of threads that the host allots to service I/O requests.| +|[SetMinThreads Method](ihostiocompletionmanager-setminthreads-method.md)|Sets the minimum number of threads that the host should allot to I/O completion.| + +## Remarks + + `IHostIoCompletionManager` corresponds to the `ICLRIoCompletionManager` interface implemented by the CLR. The CLR calls the methods of `IHostIoCompletionManager` to bind handles to the ports that the host provides, and the host calls the methods of `ICLRIoCompletionManager` to report the completion of I/O requests. + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md index b944bfcd5fdeb..1109b79e92659 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md @@ -2,63 +2,62 @@ description: "Learn more about: IHostIoCompletionManager::SetCLRIoCompletionManager Method" title: "IHostIoCompletionManager::SetCLRIoCompletionManager Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager.SetCLRIoCompletionManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager::SetCLRIoCompletionManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostIoCompletionManager::SetCLRIoCompletionManager method [.NET Framework hosting]" - "SetCLRIoCompletionManager method [.NET Framework hosting]" -ms.assetid: 4254bb01-3a14-4f34-a3be-60ff1f5072b5 -topic_type: +topic_type: - "apiref" --- # IHostIoCompletionManager::SetCLRIoCompletionManager Method -Provides the host with an interface pointer to the [ICLRIoCompletionManager](iclriocompletionmanager-interface.md) instance implemented by the common language runtime (CLR). - -## Syntax - -```cpp -HRESULT SetCLRIoCompletionManager ( - [in] ICLRIoCompletionManager *pManager -); -``` - -## Parameters - - `pManager` - [in] An interface pointer to an `ICLRIoCompletionManager` instance provided by the CLR. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetCLRIoCompletionManager` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - After the CLR has called `SetCLRIoCompletionManager`, the host must call [ICLRIoCompletionManager::OnComplete](iclriocompletionmanager-oncomplete-method.md) to notify the CLR when an I/O request has been completed. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides the host with an interface pointer to the [ICLRIoCompletionManager](iclriocompletionmanager-interface.md) instance implemented by the common language runtime (CLR). + +## Syntax + +```cpp +HRESULT SetCLRIoCompletionManager ( + [in] ICLRIoCompletionManager *pManager +); +``` + +## Parameters + + `pManager` + [in] An interface pointer to an `ICLRIoCompletionManager` instance provided by the CLR. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetCLRIoCompletionManager` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + After the CLR has called `SetCLRIoCompletionManager`, the host must call [ICLRIoCompletionManager::OnComplete](iclriocompletionmanager-oncomplete-method.md) to notify the CLR when an I/O request has been completed. + +## 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 2.0 + ## See also - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md index b927a6ec18c5e..d67e5ade83ed9 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IHostIoCompletionManager::SetMaxThreads Method" title: "IHostIoCompletionManager::SetMaxThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager.SetMaxThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager::SetMaxThreads" -helpviewer_keywords: +helpviewer_keywords: - "IHostIoCompletionManager::SetMaxThreads method [.NET Framework hosting]" - "SetMaxThreads method, IHostIoCompletionManager interface [.NET Framework hosting]" -ms.assetid: ebad4f40-d9f1-4dc6-9b27-a89c9eb3926f -topic_type: +topic_type: - "apiref" --- # IHostIoCompletionManager::SetMaxThreads Method -Sets the maximum number of threads that the host allots to service I/O requests. - -## Syntax - -```cpp -HRESULT SetMaxThreads ( - [in] DWORD dwMaxIoCompletionThreads -); -``` - -## Parameters - - `dwMaxIoCompletionThreads` - [in] The maximum number of threads to allot for I/O requests. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetMaxThreads` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not provide an implementation of `SetMaxThreads`.| - -## Remarks - - `SetMaxThreads` provides the CLR with an opportunity to set the maximum number of threads that are available to service requests on I/O ports. A host might need exclusive control over the size of the thread pool, for reasons such as implementation, performance, or scalability. For this reason, the host is not required to implement `SetMaxThreads`. In this case, a host should return E_NOTIMPL from this method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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 maximum number of threads that the host allots to service I/O requests. + +## Syntax + +```cpp +HRESULT SetMaxThreads ( + [in] DWORD dwMaxIoCompletionThreads +); +``` + +## Parameters + + `dwMaxIoCompletionThreads` + [in] The maximum number of threads to allot for I/O requests. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetMaxThreads` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not provide an implementation of `SetMaxThreads`.| + +## Remarks + + `SetMaxThreads` provides the CLR with an opportunity to set the maximum number of threads that are available to service requests on I/O ports. A host might need exclusive control over the size of the thread pool, for reasons such as implementation, performance, or scalability. For this reason, the host is not required to implement `SetMaxThreads`. In this case, a host should return E_NOTIMPL from this method. + +## 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 2.0 + ## See also - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md index 60cba0252b1ed..bf9fcc40366e4 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IHostIoCompletionManager::SetMinThreads Method" title: "IHostIoCompletionManager::SetMinThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager.SetMinThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager::SetMinThreads" -helpviewer_keywords: +helpviewer_keywords: - "SetMinThreads method, IHostIoCompletionManager interface [.NET Framework hosting]" - "IHostIoCompletionManager::SetMinThreads method [.NET Framework hosting]" -ms.assetid: dea34b81-8d2b-4cc3-8696-0ad4291d8a92 -topic_type: +topic_type: - "apiref" --- # IHostIoCompletionManager::SetMinThreads Method -Sets the minimum number of threads that the host should allot to I/O completion. - -## Syntax - -```cpp -HRESULT SetMinThreads ( - [in] DWORD dwMinIoCompletionThreads -); -``` - -## Parameters - - `dwMinIoCompletionThreads` - [in] The minimum number of I/O completion threads that the host should create. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetMinThreads` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not provide an implementation of `SetMinThreads`.| - -## Remarks - - A host might want exclusive control over the number of threads that can be allotted to process I/O requests, for reasons such as implementation, performance, or scalability. For this reason, the host is not required to implement `SetMinThreads`. In this case, the host should return E_NOTIMPL from this method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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 minimum number of threads that the host should allot to I/O completion. + +## Syntax + +```cpp +HRESULT SetMinThreads ( + [in] DWORD dwMinIoCompletionThreads +); +``` + +## Parameters + + `dwMinIoCompletionThreads` + [in] The minimum number of I/O completion threads that the host should create. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetMinThreads` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not provide an implementation of `SetMinThreads`.| + +## Remarks + + A host might want exclusive control over the number of threads that can be allotted to process I/O requests, for reasons such as implementation, performance, or scalability. For this reason, the host is not required to implement `SetMinThreads`. In this case, the host should return E_NOTIMPL from this method. + +## 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 2.0 + ## See also - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md b/docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md index 8150518a080e7..ea289b2e8f0d0 100644 --- a/docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md @@ -2,72 +2,71 @@ description: "Learn more about: IHostMAlloc::Alloc Method" title: "IHostMAlloc::Alloc Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMAlloc.Alloc" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMAlloc::Alloc" -helpviewer_keywords: +helpviewer_keywords: - "Alloc method, IHostMAlloc interface [.NET Framework hosting]" - "IHostMAlloc::Alloc method [.NET Framework hosting]" -ms.assetid: a3007f5e-d75d-4b37-842b-704e9edced5e -topic_type: +topic_type: - "apiref" --- # IHostMAlloc::Alloc Method -Requests that the host allocate the specified amount of memory from the heap. - -## Syntax - -```cpp -HRESULT Alloc ( +Requests that the host allocate the specified amount of memory from the heap. + +## Syntax + +```cpp +HRESULT Alloc ( [in] SIZE_T cbSize, [in] EMemoryCriticalLevel dwCriticalLevel, - [out] void** ppMem -); -``` - -## Parameters - - `cbSize` - [in] The size, in bytes, of the current memory allocation request. - - `dwCriticalLevel` - [in] One of the [EMemoryCriticalLevel](ememorycriticallevel-enumeration.md) values, indicating the impact of an allocation failure. - - `ppMem` - [out] A pointer to the allocated memory, or null if the request could not be completed. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Alloc` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to complete the allocation request.| - -## Remarks - - The CLR gets an interface pointer to an `IHostMalloc` instance by calling the [IHostMemoryManager::CreateMalloc](ihostmemorymanager-createmalloc-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - + [out] void** ppMem +); +``` + +## Parameters + + `cbSize` + [in] The size, in bytes, of the current memory allocation request. + + `dwCriticalLevel` + [in] One of the [EMemoryCriticalLevel](ememorycriticallevel-enumeration.md) values, indicating the impact of an allocation failure. + + `ppMem` + [out] A pointer to the allocated memory, or null if the request could not be completed. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Alloc` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to complete the allocation request.| + +## Remarks + + The CLR gets an interface pointer to an `IHostMalloc` instance by calling the [IHostMemoryManager::CreateMalloc](ihostmemorymanager-createmalloc-method.md) method. + +## 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 2.0 + ## See also - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md b/docs/core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md index 12cc32da18538..81817a388a8ed 100644 --- a/docs/core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md @@ -2,80 +2,79 @@ description: "Learn more about: IHostMAlloc::DebugAlloc Method" title: "IHostMAlloc::DebugAlloc Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMAlloc.DebugAlloc" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMAlloc::DebugAlloc" -helpviewer_keywords: +helpviewer_keywords: - "DebugAlloc method [.NET Framework hosting]" - "IHostMAlloc::DebugAlloc method [.NET Framework hosting]" -ms.assetid: 0bfbc527-bea2-43ce-b041-69186f4440dd -topic_type: +topic_type: - "apiref" --- # IHostMAlloc::DebugAlloc Method -Requests that the host allocate the specified amount of memory from the heap, and additionally track where the memory was allocated. - -## Syntax - -```cpp -HRESULT DebugAlloc ( +Requests that the host allocate the specified amount of memory from the heap, and additionally track where the memory was allocated. + +## Syntax + +```cpp +HRESULT DebugAlloc ( [in] SIZE_T cbSize, [in] EMemoryCriticalLevel dwCriticalLevel, [in] char* pszFileName, [in] int iLineNo, - [out] void** ppMem -); -``` - -## Parameters - - `cbSize` - [in] The size, in bytes, of the current memory allocation request. - - `dwCriticalLevel` - [in] One of the [EMemoryCriticalLevel](ememorycriticallevel-enumeration.md) values, indicating the impact of an allocation failure. - - `pszFileName` - [in] The code file of the executable being debugged. - - `iLineNo` - [in] The line number in `pszFileName` where the allocation was requested. - - `ppMem` - [out] A pointer to the allocated memory, or null if the request could not be completed. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`DebugAlloc` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to complete the allocation request.| - -## Remarks - - The CLR gets an interface pointer to an [IHostMalloc](ihostmalloc-interface.md) instance by calling the [IHostMemoryManager::CreateMalloc](ihostmemorymanager-createmalloc-method.md) method. `DebugAlloc` allows the runtime to get code file information for use during debugging. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - + [out] void** ppMem +); +``` + +## Parameters + + `cbSize` + [in] The size, in bytes, of the current memory allocation request. + + `dwCriticalLevel` + [in] One of the [EMemoryCriticalLevel](ememorycriticallevel-enumeration.md) values, indicating the impact of an allocation failure. + + `pszFileName` + [in] The code file of the executable being debugged. + + `iLineNo` + [in] The line number in `pszFileName` where the allocation was requested. + + `ppMem` + [out] A pointer to the allocated memory, or null if the request could not be completed. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`DebugAlloc` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to complete the allocation request.| + +## Remarks + + The CLR gets an interface pointer to an [IHostMalloc](ihostmalloc-interface.md) instance by calling the [IHostMemoryManager::CreateMalloc](ihostmemorymanager-createmalloc-method.md) method. `DebugAlloc` allows the runtime to get code file information for use during debugging. + +## 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 2.0 + ## See also - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md b/docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md index 4ee5f138adcb9..75f1c583d40c9 100644 --- a/docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IHostMAlloc::Free Method" title: "IHostMAlloc::Free Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMAlloc.Free" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMAlloc::Free" -helpviewer_keywords: +helpviewer_keywords: - "IHostMAlloc::Free method [.NET Framework hosting]" - "Free method, IHostMAlloc interface [.NET Framework hosting]" -ms.assetid: c89abf5b-1120-4437-8b57-4a99fb3ae7f9 -topic_type: +topic_type: - "apiref" --- # IHostMAlloc::Free Method -Frees memory that was allocated by using the [Alloc](ihostmalloc-alloc-method.md) function. - -## Syntax - -```cpp -HRESULT Free ( - [in] void* pMem -); -``` - -## Parameters - - `pMem` - [in] A pointer to the memory to be freed. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Free` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|HOST_E_INVALIDOPERATION|An attempt was made to free memory that was not allocated through the host.| - -## Remarks - - If the `pMem` parameter refers to a region of memory that was not allocated by using a call to `Alloc`, the host should return HOST_E_INVALIDOPERATION. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Frees memory that was allocated by using the [Alloc](ihostmalloc-alloc-method.md) function. + +## Syntax + +```cpp +HRESULT Free ( + [in] void* pMem +); +``` + +## Parameters + + `pMem` + [in] A pointer to the memory to be freed. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Free` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|HOST_E_INVALIDOPERATION|An attempt was made to free memory that was not allocated through the host.| + +## Remarks + + If the `pMem` parameter refers to a region of memory that was not allocated by using a call to `Alloc`, the host should return HOST_E_INVALIDOPERATION. + +## 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 2.0 + ## See also - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmalloc-interface.md b/docs/core/unmanaged-api/hosting/ihostmalloc-interface.md index 5f2884c3c7964..1a7e6d27cd7a1 100644 --- a/docs/core/unmanaged-api/hosting/ihostmalloc-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostmalloc-interface.md @@ -2,46 +2,45 @@ description: "Learn more about: IHostMalloc Interface" title: "IHostMalloc Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMAlloc" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMAlloc" -helpviewer_keywords: +helpviewer_keywords: - "IHostMAlloc interface [.NET Framework hosting]" -ms.assetid: e3c6643b-6fc7-4a99-959d-4b7b4e63fdee -topic_type: +topic_type: - "apiref" --- # IHostMalloc Interface -Provides methods that allow the common language runtime (CLR) to request fine-grained allocations from the heap through the host. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Alloc Method](ihostmalloc-alloc-method.md)|Requests that the host allocate the requested amount of memory from the heap.| -|[DebugAlloc Method](ihostmalloc-debugalloc-method.md)|Requests that the host allocate the requested amount of memory from the heap, and additionally track where the memory was allocated.| -|[Free Method](ihostmalloc-free-method.md)|Frees memory that was allocated by using the `Alloc` method.| - -## Remarks - - The CLR gets an interface pointer to an `IHostMalloc` instance by calling the [IHostMemoryManager::CreateMalloc](ihostmemorymanager-createmalloc-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods that allow the common language runtime (CLR) to request fine-grained allocations from the heap through the host. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Alloc Method](ihostmalloc-alloc-method.md)|Requests that the host allocate the requested amount of memory from the heap.| +|[DebugAlloc Method](ihostmalloc-debugalloc-method.md)|Requests that the host allocate the requested amount of memory from the heap, and additionally track where the memory was allocated.| +|[Free Method](ihostmalloc-free-method.md)|Frees memory that was allocated by using the `Alloc` method.| + +## Remarks + + The CLR gets an interface pointer to an `IHostMalloc` instance by calling the [IHostMemoryManager::CreateMalloc](ihostmemorymanager-createmalloc-method.md) method. + +## 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 2.0 + ## See also - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md b/docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md index 39a316a63fadc..dc7362619a1e3 100644 --- a/docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md @@ -2,42 +2,41 @@ description: "Learn more about: IHostManualEvent Interface" title: "IHostManualEvent Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostManualEvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostManualEvent" -helpviewer_keywords: +helpviewer_keywords: - "IHostManualEvent interface [.NET Framework hosting]" -ms.assetid: 300c2661-b7d1-4c39-b080-9ebdef0fd523 -topic_type: +topic_type: - "apiref" --- # IHostManualEvent Interface -Provides the host's implementation of a representation of a manual reset event. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Reset Method](ihostmanualevent-reset-method.md)|Resets the current `IHostManualEvent` instance to a non-signaled state.| -|[Set Method](ihostmanualevent-set-method.md)|Sets the current `IHostManualEvent` instance to a signaled state.| -|[Wait Method](ihostmanualevent-wait-method.md)|Causes the current `IHostManualEvent` instance to wait until it is owned, or a specified amount of time elapses.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides the host's implementation of a representation of a manual reset event. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Reset Method](ihostmanualevent-reset-method.md)|Resets the current `IHostManualEvent` instance to a non-signaled state.| +|[Set Method](ihostmanualevent-set-method.md)|Sets the current `IHostManualEvent` instance to a signaled state.| +|[Wait Method](ihostmanualevent-wait-method.md)|Causes the current `IHostManualEvent` instance to wait until it is owned, or a specified amount of time elapses.| + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmanualevent-reset-method.md b/docs/core/unmanaged-api/hosting/ihostmanualevent-reset-method.md index 789aab112a6cc..6c0de81494e6b 100644 --- a/docs/core/unmanaged-api/hosting/ihostmanualevent-reset-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmanualevent-reset-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IHostManualEvent::Reset Method" title: "IHostManualEvent::Reset Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostManualEvent.Reset" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostManualEvent::Reset" -helpviewer_keywords: +helpviewer_keywords: - "Reset method, IHostManualEvent interface [.NET Framework hosting]" - "IHostManualEvent::Reset method [.NET Framework hosting]" -ms.assetid: 0d101168-b5e3-49ce-90c7-85cf2db83c4c -topic_type: +topic_type: - "apiref" --- # IHostManualEvent::Reset Method -Resets the current [IHostManualEvent](ihostmanualevent-interface.md) instance to a non-signaled state. - -## Syntax - -```cpp -HRESULT Reset (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Reset` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Resets the current [IHostManualEvent](ihostmanualevent-interface.md) instance to a non-signaled state. + +## Syntax + +```cpp +HRESULT Reset (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Reset` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md b/docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md index 67c0e163c3a35..8eb1680a965eb 100644 --- a/docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IHostManualEvent::Set Method" title: "IHostManualEvent::Set Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostManualEvent.Set" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostManualEvent::Set" -helpviewer_keywords: +helpviewer_keywords: - "Set method, IHostManualEvent interface [.NET Framework hosting]" - "IHostManualEvent::Set method [.NET Framework hosting]" -ms.assetid: e930c174-f71d-4faa-bb59-f0fb3df4d77b -topic_type: +topic_type: - "apiref" --- # IHostManualEvent::Set Method -Sets the current [IHostManualEvent](ihostmanualevent-interface.md) instance to a signaled state. - -## Syntax - -```cpp -HRESULT Set (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Set` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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 current [IHostManualEvent](ihostmanualevent-interface.md) instance to a signaled state. + +## Syntax + +```cpp +HRESULT Set (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Set` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md b/docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md index 1f743fb2ae155..dfebb3aac34c3 100644 --- a/docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IHostManualEvent::Wait Method" title: "IHostManualEvent::Wait Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostManualEvent.Wait" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostManualEvent::Wait" -helpviewer_keywords: +helpviewer_keywords: - "IHostManualEvent::Wait method [.NET Framework hosting]" - "Wait method, IHostManualEvent interface [.NET Framework hosting]" -ms.assetid: 1fbb7d8b-8a23-4c2b-8376-1a70cd2d6030 -topic_type: +topic_type: - "apiref" --- # IHostManualEvent::Wait Method -Causes the current [IHostManualEvent](ihostmanualevent-interface.md) instance to wait until it is owned, or a specified amount of time elapses. - -## Syntax - -```cpp -HRESULT Wait ( - [in] DWORD dwMilliseconds, - [in] DWORD option -); -``` - -## Parameters +Causes the current [IHostManualEvent](ihostmanualevent-interface.md) instance to wait until it is owned, or a specified amount of time elapses. - `dwMilliseconds` - [in] The number of milliseconds to wait before returning, if the current `IHostManualEvent` instance is not owned. - - `option` - [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values, indicating the action the host should take if this operation blocks. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Wait` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|HOST_E_DEADLOCK|The host detected a deadlock during the wait interval, and chose the current `IHostManualEvent` instance as the deadlock victim.| - -## Requirements +## Syntax + +```cpp +HRESULT Wait ( + [in] DWORD dwMilliseconds, + [in] DWORD option +); +``` + +## Parameters + + `dwMilliseconds` + [in] The number of milliseconds to wait before returning, if the current `IHostManualEvent` instance is not owned. + + `option` + [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values, indicating the action the host should take if this operation blocks. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Wait` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|HOST_E_DEADLOCK|The host detected a deadlock during the wait interval, and chose the current `IHostManualEvent` instance as the deadlock victim.| + +## 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 2.0 - **Platforms:** See [System Requirements](../../../framework/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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md index 604d89abb577c..ca14173b64c9f 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IHostMemoryManager::AcquiredVirtualAddressSpace Method" title: "IHostMemoryManager::AcquiredVirtualAddressSpace Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMemoryManager.AcquiredVirtualAddressSpace" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMemoryManager::AcquiredVirtualAddressSpace" -helpviewer_keywords: +helpviewer_keywords: - "IHostMemoryManager::AcquiredVirtualAddressSpace method [.NET Framework hosting]" - "AcquiredVirtualAddressSpace method [.NET Framework hosting]" -ms.assetid: ef2f83c2-127e-4c38-8385-306c03cd2167 -topic_type: +topic_type: - "apiref" --- # IHostMemoryManager::AcquiredVirtualAddressSpace Method -Notifies the host that the common language runtime (CLR) has acquired the specified memory from the operating system. - -## Syntax - -```cpp -HRESULT AcquiredVirtualAddressSpace( - [in] LPVOID startAddress, - [in] SIZE_T size -); -``` - -## Parameters - - `startAddress` - [in] The starting address of the memory. - - `size` - [in] The size, in bytes, of the memory. - -## Remarks - - The `AcquiredVirtualAddressSpace` method is a callback method and must be implemented by the writer of the hosting application. It is called by the CLR. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Notifies the host that the common language runtime (CLR) has acquired the specified memory from the operating system. + +## Syntax + +```cpp +HRESULT AcquiredVirtualAddressSpace( + [in] LPVOID startAddress, + [in] SIZE_T size +); +``` + +## Parameters + + `startAddress` + [in] The starting address of the memory. + + `size` + [in] The size, in bytes, of the memory. + +## Remarks + + The `AcquiredVirtualAddressSpace` method is a callback method and must be implemented by the writer of the hosting application. It is called by the CLR. + +## 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 2.0 + ## See also - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md index 6f62333fb3878..15fc943e5b344 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md @@ -2,68 +2,67 @@ description: "Learn more about: IHostMemoryManager::CreateMAlloc Method" title: "IHostMemoryManager::CreateMAlloc Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMemoryManager.CreateMAlloc" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMemoryManager::CreateMAlloc" -helpviewer_keywords: +helpviewer_keywords: - "CreateAlloc method [.NET Framework hosting]" - "IHostMemoryManager::CreateMAlloc method [.NET Framework hosting]" -ms.assetid: 9ee6e052-bef7-4350-9e4f-edfffd99ad6f -topic_type: +topic_type: - "apiref" --- # IHostMemoryManager::CreateMAlloc Method -Gets an interface pointer to an [IHostMAlloc](ihostmalloc-interface.md) instance that is used to make allocation requests from a heap created by the host. - -## Syntax - -```cpp -HRESULT CreateMalloc ( - [in] DWORD dwMallocType, - [out] IHostMalloc **ppMalloc -); -``` - -## Parameters - - `dwMallocType` - [in] A combination of [MALLOC_TYPE](malloc-type-enumeration.md) flags that specifies the characteristics of the memory that is being allocated. - - `ppMAlloc` - [out] A pointer to the address of an `IHostMAlloc` instance provided by the host. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateMAlloc` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough physical memory was available to complete the allocation request.| - -## Remarks - - `CreateMAlloc` returns an object that allows the CLR to make allocation requests through the host instead of using the standard Win32 functions. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets an interface pointer to an [IHostMAlloc](ihostmalloc-interface.md) instance that is used to make allocation requests from a heap created by the host. + +## Syntax + +```cpp +HRESULT CreateMalloc ( + [in] DWORD dwMallocType, + [out] IHostMalloc **ppMalloc +); +``` + +## Parameters + + `dwMallocType` + [in] A combination of [MALLOC_TYPE](malloc-type-enumeration.md) flags that specifies the characteristics of the memory that is being allocated. + + `ppMAlloc` + [out] A pointer to the address of an `IHostMAlloc` instance provided by the host. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateMAlloc` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough physical memory was available to complete the allocation request.| + +## Remarks + + `CreateMAlloc` returns an object that allows the CLR to make allocation requests through the host instead of using the standard Win32 functions. + +## 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 2.0 + ## See also - [IHostMalloc Interface](ihostmalloc-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md index 93a7213cf31e3..ef78f9e409f5a 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md @@ -2,69 +2,68 @@ description: "Learn more about: IHostMemoryManager::GetMemoryLoad Method" title: "IHostMemoryManager::GetMemoryLoad Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMemoryManager.GetMemoryLoad" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMemoryManager::GetMemoryLoad" -helpviewer_keywords: +helpviewer_keywords: - "IHostMemoryManager::GetMemoryLoad method [.NET Framework hosting]" - "GetMemoryLoad method [.NET Framework hosting]" -ms.assetid: e8138f6e-a0a4-48d4-8dae-9466b4dc6180 -topic_type: +topic_type: - "apiref" --- # IHostMemoryManager::GetMemoryLoad Method -Gets the amount of physical memory that is currently in use, and therefore unavailable, as reported by the host. - -## Syntax - -```cpp -HRESULT GetMemoryLoad ( +Gets the amount of physical memory that is currently in use, and therefore unavailable, as reported by the host. + +## Syntax + +```cpp +HRESULT GetMemoryLoad ( [out] DWORD* pMemoryLoad, - [out] SIZE_T *pAvailableBytes -); -``` - -## Parameters - - `pMemoryLoad` - [out] A pointer to the approximate percentage of total physical memory that is currently in use. - - `pAvailableBytes` - [out] A pointer to the number of bytes available to the common language runtime (CLR). - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetMemoryLoad` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `GetMemoryLoad` wraps the Win32 `GlobalMemoryStatus` function. The value of `pMemoryLoad` is the equivalent of the `dwMemoryLoad` field in the `MEMORYSTATUS` structure returned from `GlobalMemoryStatus`. - - The runtime uses the return value as a heuristic for the garbage collector. For example, if the host reports that the majority of memory is in use, the garbage collector may elect to collect from multiple generations to increase the amount of memory that can potentially become available. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - + [out] SIZE_T *pAvailableBytes +); +``` + +## Parameters + + `pMemoryLoad` + [out] A pointer to the approximate percentage of total physical memory that is currently in use. + + `pAvailableBytes` + [out] A pointer to the number of bytes available to the common language runtime (CLR). + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetMemoryLoad` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `GetMemoryLoad` wraps the Win32 `GlobalMemoryStatus` function. The value of `pMemoryLoad` is the equivalent of the `dwMemoryLoad` field in the `MEMORYSTATUS` structure returned from `GlobalMemoryStatus`. + + The runtime uses the return value as a heuristic for the garbage collector. For example, if the host reports that the majority of memory is in use, the garbage collector may elect to collect from multiple generations to increase the amount of memory that can potentially become available. + +## 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 2.0 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md index 037be976a06d5..109944547f585 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md @@ -2,53 +2,52 @@ description: "Learn more about: IHostMemoryManager Interface" title: "IHostMemoryManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMemoryManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMemoryManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostMemoryManager interface [.NET Framework hosting]" -ms.assetid: a945d439-3b34-4aa4-b575-8413dd7806ce -topic_type: +topic_type: - "apiref" --- # IHostMemoryManager Interface -Provides methods that allow the common language runtime (CLR) to make virtual memory requests through the host, instead of using the standard Win32 virtual memory functions. - -## Methods - -|Method|Description| -|------------|-----------------| -|[AcquiredVirtualAddressSpace Method](ihostmemorymanager-acquiredvirtualaddressspace-method.md)|Notifies the host that the common language runtime (CLR) has acquired the specified memory from the operating system.| -|[CreateMAlloc Method](ihostmemorymanager-createmalloc-method.md)|Gets an interface pointer to an [IHostMAlloc](ihostmalloc-interface.md) instance that is used to request memory allocations from a heap created by the host.| -|[GetMemoryLoad Method](ihostmemorymanager-getmemoryload-method.md)|Gets the amount of physical memory that is currently being used, as reported by the host.| -|[NeedsVirtualAddressSpace Method](ihostmemorymanager-needsvirtualaddressspace-method.md)|Notifies the host that the CLR is going to attempt to use the specified memory.| -|[RegisterMemoryNotificationCallback Method](ihostmemorymanager-registermemorynotificationcallback-method.md)|Registers a pointer to a callback function that the host invokes to notify the CLR of the current memory load on the computer.| -|[ReleasedVirtualAddressSpace Method](ihostmemorymanager-releasedvirtualaddressspace-method.md)|Notifies the host that the CLR has finished using the specified memory.| -|[VirtualAlloc Method](ihostmemorymanager-virtualalloc-method.md)|Serves as a logical wrapper for the corresponding Win32 function, which reserves or commits a region of pages in the virtual address space of the calling process.| -|[VirtualFree Method](ihostmemorymanager-virtualfree-method.md)|Serves as a logical wrapper for the corresponding Win32 function, which releases, decommits, or releases and decommits a region of pages within the virtual address space of the calling process.| -|[VirtualProtect Method](ihostmemorymanager-virtualprotect-method.md)|Serves as a logical wrapper for the corresponding Win32 function, which changes the protection on a region of committed pages in the virtual address space of the calling process.| -|[VirtualQuery Method](ihostmemorymanager-virtualquery-method.md)|Serves as a logical wrapper for the corresponding Win32 function, which retrieves information about a range of pages in the virtual address space of the calling process.| - -## Remarks - - `IHostMemoryManager` also provides methods for the CLR to obtain a pointer through which to make memory requests on the heap and to get the level of memory pressure in the process, as reported by the host. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods that allow the common language runtime (CLR) to make virtual memory requests through the host, instead of using the standard Win32 virtual memory functions. + +## Methods + +|Method|Description| +|------------|-----------------| +|[AcquiredVirtualAddressSpace Method](ihostmemorymanager-acquiredvirtualaddressspace-method.md)|Notifies the host that the common language runtime (CLR) has acquired the specified memory from the operating system.| +|[CreateMAlloc Method](ihostmemorymanager-createmalloc-method.md)|Gets an interface pointer to an [IHostMAlloc](ihostmalloc-interface.md) instance that is used to request memory allocations from a heap created by the host.| +|[GetMemoryLoad Method](ihostmemorymanager-getmemoryload-method.md)|Gets the amount of physical memory that is currently being used, as reported by the host.| +|[NeedsVirtualAddressSpace Method](ihostmemorymanager-needsvirtualaddressspace-method.md)|Notifies the host that the CLR is going to attempt to use the specified memory.| +|[RegisterMemoryNotificationCallback Method](ihostmemorymanager-registermemorynotificationcallback-method.md)|Registers a pointer to a callback function that the host invokes to notify the CLR of the current memory load on the computer.| +|[ReleasedVirtualAddressSpace Method](ihostmemorymanager-releasedvirtualaddressspace-method.md)|Notifies the host that the CLR has finished using the specified memory.| +|[VirtualAlloc Method](ihostmemorymanager-virtualalloc-method.md)|Serves as a logical wrapper for the corresponding Win32 function, which reserves or commits a region of pages in the virtual address space of the calling process.| +|[VirtualFree Method](ihostmemorymanager-virtualfree-method.md)|Serves as a logical wrapper for the corresponding Win32 function, which releases, decommits, or releases and decommits a region of pages within the virtual address space of the calling process.| +|[VirtualProtect Method](ihostmemorymanager-virtualprotect-method.md)|Serves as a logical wrapper for the corresponding Win32 function, which changes the protection on a region of committed pages in the virtual address space of the calling process.| +|[VirtualQuery Method](ihostmemorymanager-virtualquery-method.md)|Serves as a logical wrapper for the corresponding Win32 function, which retrieves information about a range of pages in the virtual address space of the calling process.| + +## Remarks + + `IHostMemoryManager` also provides methods for the CLR to obtain a pointer through which to make memory requests on the heap and to get the level of memory pressure in the process, as reported by the host. + +## 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 2.0 + ## See also - [IHostMalloc Interface](ihostmalloc-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md index 53f980cc5e959..1a23a3d293c3f 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md @@ -2,58 +2,57 @@ description: "Learn more about: IHostMemoryManager::NeedsVirtualAddressSpace Method" title: "IHostMemoryManager::NeedsVirtualAddressSpace Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMemoryManager.NeedsVirtualAddressSpace" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMemoryManager::NeedsVirtualAddressSpace" -helpviewer_keywords: +helpviewer_keywords: - "IHostMemoryManager::NeedsVirtualAddressSpace method [.NET Framework hosting]" - "NeedsVirtualAddressSpace method [.NET Framework hosting]" -ms.assetid: 71f0eab5-0170-46f8-9f88-1df5abdeb34a -topic_type: +topic_type: - "apiref" --- # IHostMemoryManager::NeedsVirtualAddressSpace Method -Notifies the host that the common language runtime (CLR) is going to attempt to use the specified memory. - -## Syntax - -```cpp -HRESULT NeedsVirtualAddressSpace ( - [in] LPVOID startAddress, - [in] SIZE_T size -); -``` - -## Parameters - - `startAddress` - [in] The starting address of the memory. - - `size` - [in] The size, in bytes, of the memory. - -## Remarks - - The `NeedsVirtualAddressSpace` method is a callback method and must be implemented by the writer of the hosting application. It is called by the CLR. - - If the host does not want the CLR to use the specified memory, it may return an E_OUTOFMEMORY HRESULT. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Notifies the host that the common language runtime (CLR) is going to attempt to use the specified memory. + +## Syntax + +```cpp +HRESULT NeedsVirtualAddressSpace ( + [in] LPVOID startAddress, + [in] SIZE_T size +); +``` + +## Parameters + + `startAddress` + [in] The starting address of the memory. + + `size` + [in] The size, in bytes, of the memory. + +## Remarks + + The `NeedsVirtualAddressSpace` method is a callback method and must be implemented by the writer of the hosting application. It is called by the CLR. + + If the host does not want the CLR to use the specified memory, it may return an E_OUTOFMEMORY HRESULT. + +## 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 2.0 + ## See also - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md index c4b95b225fc96..be3453691eccd 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md @@ -2,66 +2,65 @@ description: "Learn more about: IHostMemoryManager::RegisterMemoryNotificationCallback Method" title: "IHostMemoryManager::RegisterMemoryNotificationCallback Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMemoryManager.RegisterMemoryNotificationCallback" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMemoryManager::RegisterMemoryNotificationCallback" -helpviewer_keywords: +helpviewer_keywords: - "IHostMemoryManager::RegisterMemoryNotificationCallback method [.NET Framework hosting]" - "RegisterMemoryNotificationCallback method [.NET Framework hosting]" -ms.assetid: 65d301f6-4dbb-4b5f-8eff-82540e2b6465 -topic_type: +topic_type: - "apiref" --- # IHostMemoryManager::RegisterMemoryNotificationCallback Method -Registers a pointer to a callback function that the host invokes to notify the common language runtime (CLR) of the current memory load on the computer. - -## Syntax - -```cpp -HRESULT RegisterMemoryNotificationCallback ( - [in] ICLRMemoryNotificationCallback* pCallback -); -``` - -## Parameters - - `pCallback` - [in] An interface pointer to an [ICLRMemoryNotificationCallback](iclrmemorynotificationcallback-interface.md) instance that is implemented by the CLR. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`RegisterMemoryNotificationCallback` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - Because the `ICLRMemoryNotificationCallback` interface defines only one method ([ICLRMemoryNotificationCallback::OnMemoryNotification](iclrmemorynotificationcallback-onmemorynotification-method.md)), and because `pCallback` is a pointer to an `ICLRMemoryNotificationCallback` instance provided by the CLR, the registration is effectively for the callback function itself. The host invokes `OnMemoryNotification` to report memory pressure conditions, rather than using the standard Win32 `CreateMemoryResourceNotification` function. For more information, see the Windows Platform documentation. - +Registers a pointer to a callback function that the host invokes to notify the common language runtime (CLR) of the current memory load on the computer. + +## Syntax + +```cpp +HRESULT RegisterMemoryNotificationCallback ( + [in] ICLRMemoryNotificationCallback* pCallback +); +``` + +## Parameters + + `pCallback` + [in] An interface pointer to an [ICLRMemoryNotificationCallback](iclrmemorynotificationcallback-interface.md) instance that is implemented by the CLR. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`RegisterMemoryNotificationCallback` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + Because the `ICLRMemoryNotificationCallback` interface defines only one method ([ICLRMemoryNotificationCallback::OnMemoryNotification](iclrmemorynotificationcallback-onmemorynotification-method.md)), and because `pCallback` is a pointer to an `ICLRMemoryNotificationCallback` instance provided by the CLR, the registration is effectively for the callback function itself. The host invokes `OnMemoryNotification` to report memory pressure conditions, rather than using the standard Win32 `CreateMemoryResourceNotification` function. For more information, see the Windows Platform documentation. + > [!NOTE] -> Calls to `OnMemoryNotification` never block. They always return immediately. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> Calls to `OnMemoryNotification` never block. They always return immediately. + +## 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 2.0 + ## See also - [ICLRMemoryNotificationCallback Interface](iclrmemorynotificationcallback-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md index 807e5f217ee4a..237f20472599f 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IHostMemoryManager::ReleasedVirtualAddressSpace Method" title: "IHostMemoryManager::ReleasedVirtualAddressSpace Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMemoryManager.ReleasedVirtualAddressSpace" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMemoryManager::ReleasedVirtualAddressSpace" -helpviewer_keywords: +helpviewer_keywords: - "ReleasedVirtualAddressSpace method [.NET Framework hosting]" - "IHostMemoryManager::ReleasedVirtualAddressSpace method [.NET Framework hosting]" -ms.assetid: d1876601-6ab9-48e1-8ebd-184af1d0cd76 -topic_type: +topic_type: - "apiref" --- # IHostMemoryManager::ReleasedVirtualAddressSpace Method -Notifies the host that the common language runtime (CLR) has finished using the specified memory. - -## Syntax - -```cpp -HRESULT ReleasedVirtualAddressSpace( - [in] LPVOID startAddress -); -``` - -## Parameters - - `startAddress` - [in] Pointer to the starting address of the memory to be released. - -## Remarks - - The `ReleasedVirtualAddressSpace` method is a callback method and must be implemented by the writer of the hosting application. It is called by the CLR. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Notifies the host that the common language runtime (CLR) has finished using the specified memory. + +## Syntax + +```cpp +HRESULT ReleasedVirtualAddressSpace( + [in] LPVOID startAddress +); +``` + +## Parameters + + `startAddress` + [in] Pointer to the starting address of the memory to be released. + +## Remarks + + The `ReleasedVirtualAddressSpace` method is a callback method and must be implemented by the writer of the hosting application. It is called by the CLR. + +## 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 2.0 + ## See also - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md index 6a00f702e7412..d825222042244 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md @@ -2,86 +2,85 @@ description: "Learn more about: IHostMemoryManager::VirtualAlloc Method" title: "IHostMemoryManager::VirtualAlloc Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMemoryManager.VirtualAlloc" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMemoryManager::VirtualAlloc" -helpviewer_keywords: +helpviewer_keywords: - "VirtualAlloc method [.NET Framework hosting]" - "IHostMemoryManager::VirtualAlloc method [.NET Framework hosting]" -ms.assetid: 4dff3646-a050-4bd9-ac31-fe307e8637ec -topic_type: +topic_type: - "apiref" --- # IHostMemoryManager::VirtualAlloc Method -Serves as a logical wrapper for the corresponding Win32 function. The Win32 implementation of `VirtualAlloc` reserves or commits a region of pages in the virtual address space of the calling process. - -## Syntax - -```cpp -HRESULT VirtualAlloc ( - [in] void* pAddress, - [in] SIZE_T dwSize, - [in] DWORD flAllocationType, - [in] DWORD flProtect, - [in] EMemoryCriticalLevel dwCriticalLevel, - [out] void** ppMem -); -``` - -## Parameters - - `pAddress` - [in] A pointer to the starting address of the region to allocate. - - `dwSize` - [in] The size, in bytes, of the region. - - `flAllocationType` - [in] The type of memory allocation. - - `flProtect` - [in] Memory protection for the region of pages to be allocated. - - `dwCriticalLevel` - [in] An [EMemoryCriticalLevel](ememorycriticallevel-enumeration.md) value that indicates the impact of an allocation failure. - - `ppMem` - [out] Pointer to the starting address of the allocated memory, or null if the request could not be satisfied. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`VirtualAlloc` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to complete the allocation request| - -## Remarks - - You reserve a region in the address space of your process by calling `VirtualAlloc`. The `pAddress` parameter contains the beginning address of the memory block you want. This parameter is typically set to null. The operating system keeps a record of free address ranges available to your process. A `pAddress` value of null instructs the system to reserve the region wherever it sees fit. Alternatively, you can provide a specific starting address for the memory block. In both cases, the output parameter `ppMem` is returned as a pointer to the allocated memory. The function itself returns an HRESULT value. - - The Win32 `VirtualAlloc` function does not have a `ppMem` parameter, and returns the pointer to the allocated memory instead. For more information, see the Windows Platform documentation. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Serves as a logical wrapper for the corresponding Win32 function. The Win32 implementation of `VirtualAlloc` reserves or commits a region of pages in the virtual address space of the calling process. + +## Syntax + +```cpp +HRESULT VirtualAlloc ( + [in] void* pAddress, + [in] SIZE_T dwSize, + [in] DWORD flAllocationType, + [in] DWORD flProtect, + [in] EMemoryCriticalLevel dwCriticalLevel, + [out] void** ppMem +); +``` + +## Parameters + + `pAddress` + [in] A pointer to the starting address of the region to allocate. + + `dwSize` + [in] The size, in bytes, of the region. + + `flAllocationType` + [in] The type of memory allocation. + + `flProtect` + [in] Memory protection for the region of pages to be allocated. + + `dwCriticalLevel` + [in] An [EMemoryCriticalLevel](ememorycriticallevel-enumeration.md) value that indicates the impact of an allocation failure. + + `ppMem` + [out] Pointer to the starting address of the allocated memory, or null if the request could not be satisfied. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`VirtualAlloc` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to complete the allocation request| + +## Remarks + + You reserve a region in the address space of your process by calling `VirtualAlloc`. The `pAddress` parameter contains the beginning address of the memory block you want. This parameter is typically set to null. The operating system keeps a record of free address ranges available to your process. A `pAddress` value of null instructs the system to reserve the region wherever it sees fit. Alternatively, you can provide a specific starting address for the memory block. In both cases, the output parameter `ppMem` is returned as a pointer to the allocated memory. The function itself returns an HRESULT value. + + The Win32 `VirtualAlloc` function does not have a `ppMem` parameter, and returns the pointer to the allocated memory instead. For more information, see the Windows Platform documentation. + +## 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 2.0 + ## See also - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md index aea2df6b076b4..3e6051599aba5 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md @@ -2,74 +2,73 @@ description: "Learn more about: IHostMemoryManager::VirtualFree Method" title: "IHostMemoryManager::VirtualFree Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMemoryManager.VirtualFree" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMemoryManager::VirtualFree" -helpviewer_keywords: +helpviewer_keywords: - "IHostMemoryManager::VirtualFree method [.NET Framework hosting]" - "VirtualFree method [.NET Framework hosting]" -ms.assetid: 1a436e89-eb28-4d15-bcf1-a072f86dbd99 -topic_type: +topic_type: - "apiref" --- # IHostMemoryManager::VirtualFree Method -Serves as a logical wrapper for the corresponding Win32 function. The Win32 implementation of `VirtualFree` releases, decommits, or releases and decommits a region of pages within the virtual address space of the calling process. - -## Syntax - -```cpp -HRESULT VirtualFree ( - [in] LPVOID lpAddress, - [in] SIZE_T dwSize, - [in] DWORD dwFreeType -); -``` - -## Parameters - - `lpAddress` - [in] A pointer to the base address of the virtual memory pages to be freed. - - `dwSize` - [in] The size, in bytes, of the region to be freed. - - `dwFreeType` - [in] The type of freeing operation. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`VirtualFree` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|HOST_E_INVALIDOPERATION|An attempt was made to free memory that was not allocated through the host.| - -## Remarks - - `VirtualFree` frees virtual memory pages associated with the `lpAddress` parameter through an earlier call to the [IHostMemoryManager::VirtualAlloc](ihostmemorymanager-virtualalloc-method.md) function. Attempts to free memory that was not allocated through the host should return HOST_E_INVALIDOPERATION. - - The semantics are identical to those of the Win32 implementation of `VirtualFree`. For more information, see the Windows Platform documentation. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Serves as a logical wrapper for the corresponding Win32 function. The Win32 implementation of `VirtualFree` releases, decommits, or releases and decommits a region of pages within the virtual address space of the calling process. + +## Syntax + +```cpp +HRESULT VirtualFree ( + [in] LPVOID lpAddress, + [in] SIZE_T dwSize, + [in] DWORD dwFreeType +); +``` + +## Parameters + + `lpAddress` + [in] A pointer to the base address of the virtual memory pages to be freed. + + `dwSize` + [in] The size, in bytes, of the region to be freed. + + `dwFreeType` + [in] The type of freeing operation. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`VirtualFree` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|HOST_E_INVALIDOPERATION|An attempt was made to free memory that was not allocated through the host.| + +## Remarks + + `VirtualFree` frees virtual memory pages associated with the `lpAddress` parameter through an earlier call to the [IHostMemoryManager::VirtualAlloc](ihostmemorymanager-virtualalloc-method.md) function. Attempts to free memory that was not allocated through the host should return HOST_E_INVALIDOPERATION. + + The semantics are identical to those of the Win32 implementation of `VirtualFree`. For more information, see the Windows Platform documentation. + +## 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 2.0 + ## See also - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md index 5324405f18c5b..293a4a785b879 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md @@ -2,75 +2,74 @@ description: "Learn more about: IHostMemoryManager::VirtualProtect Method" title: "IHostMemoryManager::VirtualProtect Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMemoryManager.VirtualProtect" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMemoryManager::VirtualProtect" -helpviewer_keywords: +helpviewer_keywords: - "IHostMemoryManager::VirtualProtect method [.NET Framework hosting]" - "VirtualProtect method [.NET Framework hosting]" -ms.assetid: 13be0299-df0d-4951-aabf-0676a30b385f -topic_type: +topic_type: - "apiref" --- # IHostMemoryManager::VirtualProtect Method -Serves as a logical wrapper for the corresponding Win32 function. The Win32 implementation of `VirtualProtect` changes the protection on a region of committed pages in the virtual address space of the calling process. - -## Syntax - -```cpp -HRESULT VirtualProtect ( - [in] void* lpAddress, - [in] SIZE_T dwSize, - [in] DWORD flNewProtect, - [out] DWORD* pflOldProtect -); -``` - -## Parameters - - `lpAddress` - [in] A pointer to the base address of the virtual memory whose protection attributes are to be changed. - - `dwSize` - [in] The size, in bytes, of the region of memory pages to be changed. - - `flNewProtect` - [in] The type of memory protection to apply. - - `pflOldProtect` - [out] A pointer to the previous memory protection value. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`VirtualProtect` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - This implementation of `VirtualProtect` returns an HRESULT value, while the Win32 implementation returns a non-zero value to indicate success, and a zero value to indicate failure. For more information, see the Windows Platform documentation. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Serves as a logical wrapper for the corresponding Win32 function. The Win32 implementation of `VirtualProtect` changes the protection on a region of committed pages in the virtual address space of the calling process. + +## Syntax + +```cpp +HRESULT VirtualProtect ( + [in] void* lpAddress, + [in] SIZE_T dwSize, + [in] DWORD flNewProtect, + [out] DWORD* pflOldProtect +); +``` + +## Parameters + + `lpAddress` + [in] A pointer to the base address of the virtual memory whose protection attributes are to be changed. + + `dwSize` + [in] The size, in bytes, of the region of memory pages to be changed. + + `flNewProtect` + [in] The type of memory protection to apply. + + `pflOldProtect` + [out] A pointer to the previous memory protection value. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`VirtualProtect` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + This implementation of `VirtualProtect` returns an HRESULT value, while the Win32 implementation returns a non-zero value to indicate success, and a zero value to indicate failure. For more information, see the Windows Platform documentation. + +## 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 2.0 + ## See also - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md index fe719e878a11a..cefb0e1e5a959 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md +++ b/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md @@ -2,78 +2,77 @@ description: "Learn more about: IHostMemoryManager::VirtualQuery Method" title: "IHostMemoryManager::VirtualQuery Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMemoryManager.VirtualQuery" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMemoryManager::VirtualQuery" -helpviewer_keywords: +helpviewer_keywords: - "IHostMemoryManager::VirtualQuery method [.NET Framework hosting]" - "VirtualQuery method [.NET Framework hosting]" -ms.assetid: 757af1e6-b9e8-49e7-b5db-342be3aa205f -topic_type: +topic_type: - "apiref" --- # IHostMemoryManager::VirtualQuery Method -Serves as a logical wrapper for the corresponding Win32 function. The Win32 implementation of `VirtualQuery` retrieves information about a range of pages in the virtual address space of the calling process. - -## Syntax - -```cpp -HRESULT VirtualQuery ( - [in] void* lpAddress, - [out] void* lpBuffer, - [in] SIZE_T dwLength, - [out] SIZE_T* pResult -); -``` - -## Parameters - - `lpAddress` - [in] A pointer to the address in virtual memory to be queried. - - `lpBuffer` - [out] A pointer to a structure that contains information about the specified memory region. - - `dwLength` - [in] The size, in bytes, of the buffer that `lpBuffer` points to. - - `pResult` - [out] A pointer to the number of bytes returned by the information buffer. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`VirtualQuery` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `VirtualQuery` provides information about a range of pages in the virtual address space of the calling process. This implementation sets the value of the `pResult` parameter to the number of bytes returned in the information buffer, and returns an HRESULT value. In the Win32 `VirtualQuery` function, the return value is the buffer size. For more information, see the Windows Platform documentation. - +Serves as a logical wrapper for the corresponding Win32 function. The Win32 implementation of `VirtualQuery` retrieves information about a range of pages in the virtual address space of the calling process. + +## Syntax + +```cpp +HRESULT VirtualQuery ( + [in] void* lpAddress, + [out] void* lpBuffer, + [in] SIZE_T dwLength, + [out] SIZE_T* pResult +); +``` + +## Parameters + + `lpAddress` + [in] A pointer to the address in virtual memory to be queried. + + `lpBuffer` + [out] A pointer to a structure that contains information about the specified memory region. + + `dwLength` + [in] The size, in bytes, of the buffer that `lpBuffer` points to. + + `pResult` + [out] A pointer to the number of bytes returned by the information buffer. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`VirtualQuery` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `VirtualQuery` provides information about a range of pages in the virtual address space of the calling process. This implementation sets the value of the `pResult` parameter to the number of bytes returned in the information buffer, and returns an HRESULT value. In the Win32 `VirtualQuery` function, the return value is the buffer size. For more information, see the Windows Platform documentation. + > [!IMPORTANT] -> The operating system's implementation of `VirtualQuery` does not incur deadlock and can run to completion with random threads suspended in user code. Use great caution when implementing a hosted version of this method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> The operating system's implementation of `VirtualQuery` does not incur deadlock and can run to completion with random threads suspended in user code. Use great caution when implementing a hosted version of this method. + +## 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 2.0 + ## See also - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md b/docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md index c038a6900b50b..76d501b086658 100644 --- a/docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md @@ -2,42 +2,41 @@ description: "Learn more about: IHostPolicyManager Interface" title: "IHostPolicyManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostPolicyManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostPolicyManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostPolicyManager interface [.NET Framework hosting]" -ms.assetid: 8c4aa124-5e00-46d9-b1e8-57ba6574bb0d -topic_type: +topic_type: - "apiref" --- # IHostPolicyManager Interface -Provides methods that notify the host of the actions the common language runtime (CLR) performs in case of aborts, timeouts, or failures. - -## Methods - -|Method|Description| -|------------|-----------------| -|[OnDefaultAction Method](ihostpolicymanager-ondefaultaction-method.md)|Notifies the host that the CLR is about to take the default action specified by a call to [ICLRPolicyManager::SetDefaultAction](iclrpolicymanager-setdefaultaction-method.md) in response to a thread abort or unload.| -|[OnFailure Method](ihostpolicymanager-onfailure-method.md)|Notifies the host that the CLR is about to take the action specified by a call to [ICLRPolicyManager::SetActionOnFailure](iclrpolicymanager-setactiononfailure-method.md) in response to a resource allocation or reclamation failure.| -|[OnTimeout Method](ihostpolicymanager-ontimeout-method.md)|Notifies the host that the CLR is about to take the action specified by a call to [ICLRPolicyManager::SetActionOnTimeout](iclrpolicymanager-setactionontimeout-method.md) in response to a timeout.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods that notify the host of the actions the common language runtime (CLR) performs in case of aborts, timeouts, or failures. + +## Methods + +|Method|Description| +|------------|-----------------| +|[OnDefaultAction Method](ihostpolicymanager-ondefaultaction-method.md)|Notifies the host that the CLR is about to take the default action specified by a call to [ICLRPolicyManager::SetDefaultAction](iclrpolicymanager-setdefaultaction-method.md) in response to a thread abort or unload.| +|[OnFailure Method](ihostpolicymanager-onfailure-method.md)|Notifies the host that the CLR is about to take the action specified by a call to [ICLRPolicyManager::SetActionOnFailure](iclrpolicymanager-setactiononfailure-method.md) in response to a resource allocation or reclamation failure.| +|[OnTimeout Method](ihostpolicymanager-ontimeout-method.md)|Notifies the host that the CLR is about to take the action specified by a call to [ICLRPolicyManager::SetActionOnTimeout](iclrpolicymanager-setactionontimeout-method.md) in response to a timeout.| + +## 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 2.0 + ## See also - [EClrFailure Enumeration](eclrfailure-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md b/docs/core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md index d9f4db0455df5..57b57c91761d9 100644 --- a/docs/core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md +++ b/docs/core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md @@ -2,63 +2,62 @@ description: "Learn more about: IHostPolicyManager::OnDefaultAction Method" title: "IHostPolicyManager::OnDefaultAction Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostPolicyManager.OnDefaultAction" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostPolicyManager::OnDefaultAction" -helpviewer_keywords: +helpviewer_keywords: - "OnDefaultAction method [.NET Framework hosting]" - "IHostPolicyManager::OnDefaultAction method [.NET Framework hosting]" -ms.assetid: 071e73bd-4795-470f-9373-cfaef553b7f2 -topic_type: +topic_type: - "apiref" --- # IHostPolicyManager::OnDefaultAction Method -Notifies the host that the common language runtime (CLR) is about to take the default action that was set by a call to the [ICLRPolicyManager::SetDefaultAction](iclrpolicymanager-setdefaultaction-method.md) method in response to a thread abort or unload. - -## Syntax - -```cpp -HRESULT OnDefaultAction ( +Notifies the host that the common language runtime (CLR) is about to take the default action that was set by a call to the [ICLRPolicyManager::SetDefaultAction](iclrpolicymanager-setdefaultaction-method.md) method in response to a thread abort or unload. + +## Syntax + +```cpp +HRESULT OnDefaultAction ( [in] EClrOperation operation, - [in] EPolicyAction action -); -``` - -## Parameters + [in] EPolicyAction action +); +``` + +## Parameters + + `operation` + [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the kind of event to which the CLR is responding. + + `action` + [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the action that the CLR is taking in response to the event. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`OnDefaultAction` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll - `operation` - [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the kind of event to which the CLR is responding. - - `action` - [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the action that the CLR is taking in response to the event. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`OnDefaultAction` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Requirements + **.NET versions:** Available since .NET Framework 2.0 - **Platforms:** See [System Requirements](../../../framework/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 - [EClrOperation Enumeration](eclroperation-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md b/docs/core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md index 1f2790373c96b..eee9d62d62d7f 100644 --- a/docs/core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md +++ b/docs/core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md @@ -2,63 +2,62 @@ description: "Learn more about: IHostPolicyManager::OnFailure Method" title: "IHostPolicyManager::OnFailure Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostPolicyManager.OnFailure" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostPolicyManager::OnFailure" -helpviewer_keywords: +helpviewer_keywords: - "OnFailure method [.NET Framework hosting]" - "IHostPolicyManager::OnFailure method [.NET Framework hosting]" -ms.assetid: 77d3f31e-9a53-4349-9c02-610a71736d42 -topic_type: +topic_type: - "apiref" --- # IHostPolicyManager::OnFailure Method -Notifies the host that the common language runtime (CLR) is about to take the action specified by a call to the [ICLRPolicyManager::SetActionOnFailure](iclrpolicymanager-setactiononfailure-method.md) method in response to a resource allocation or reclamation failure. - -## Syntax - -```cpp -HRESULT OnFailure( - [in] EClrFailure failure, - [in] EPolicyAction action -); -``` - -## Parameters +Notifies the host that the common language runtime (CLR) is about to take the action specified by a call to the [ICLRPolicyManager::SetActionOnFailure](iclrpolicymanager-setactiononfailure-method.md) method in response to a resource allocation or reclamation failure. - `failure` - [in] One of the [EClrFailure](eclrfailure-enumeration.md) values, indicating the kind of failure to which the CLR is responding. - - `action` - [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the action the CLR is taking in response to `failure`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`OnFailure` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Requirements +## Syntax + +```cpp +HRESULT OnFailure( + [in] EClrFailure failure, + [in] EPolicyAction action +); +``` + +## Parameters + + `failure` + [in] One of the [EClrFailure](eclrfailure-enumeration.md) values, indicating the kind of failure to which the CLR is responding. + + `action` + [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the action the CLR is taking in response to `failure`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`OnFailure` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 2.0 - **Platforms:** See [System Requirements](../../../framework/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 - [EClrFailure Enumeration](eclrfailure-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md b/docs/core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md index c86aae7bd30b7..b826e0bd2454c 100644 --- a/docs/core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md +++ b/docs/core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md @@ -2,63 +2,62 @@ description: "Learn more about: IHostPolicyManager::OnTimeout Method" title: "IHostPolicyManager::OnTimeout Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostPolicyManager.OnTimeout" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostPolicyManager::OnTimeout" -helpviewer_keywords: +helpviewer_keywords: - "IHostPolicyManager::OnTimeout method [.NET Framework hosting]" - "OnTimeout method [.NET Framework hosting]" -ms.assetid: 0a313b51-5e4d-4714-a86b-af75cf3902e6 -topic_type: +topic_type: - "apiref" --- # IHostPolicyManager::OnTimeout Method -Notifies the host that the common language runtime (CLR) is about to take the action specified by a call to the [ICLRPolicyManager::SetActionOnTimeout](iclrpolicymanager-setactionontimeout-method.md) method in response to a timeout. - -## Syntax - -```cpp -HRESULT OnTimeout ( +Notifies the host that the common language runtime (CLR) is about to take the action specified by a call to the [ICLRPolicyManager::SetActionOnTimeout](iclrpolicymanager-setactionontimeout-method.md) method in response to a timeout. + +## Syntax + +```cpp +HRESULT OnTimeout ( [in] EClrOperation operation, - [in] EPolicyAction action -); -``` - -## Parameters + [in] EPolicyAction action +); +``` + +## Parameters + + `operation` + [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the kind of operation that timed out. + + `action` + [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the action the CLR is taking in response to the timeout. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`OnTimeout` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll - `operation` - [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the kind of operation that timed out. - - `action` - [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the action the CLR is taking in response to the timeout. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`OnTimeout` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Requirements + **.NET versions:** Available since .NET Framework 2.0 - **Platforms:** See [System Requirements](../../../framework/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 - [EClrOperation Enumeration](eclroperation-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md index bfc57fc7ced2f..39461cab9d2d0 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md @@ -2,63 +2,62 @@ description: "Learn more about: IHostSecurityContext::Capture Method" title: "IHostSecurityContext::Capture Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSecurityContext.Capture" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSecurityContext::Capture" -helpviewer_keywords: +helpviewer_keywords: - "Capture method [.NET Framework hosting]" - "IHostSecurityContext::Capture method [.NET Framework hosting]" -ms.assetid: ae0836d0-1170-4494-bac5-d0e809df51a2 -topic_type: +topic_type: - "apiref" --- # IHostSecurityContext::Capture Method -Gets a clone of the [IHostSecurityContext](ihostsecuritycontext-interface.md) instance returned from a call to [IHostSecurityManager::GetSecurityContext](ihostsecuritymanager-getsecuritycontext-method.md). - -## Syntax - +Gets a clone of the [IHostSecurityContext](ihostsecuritycontext-interface.md) instance returned from a call to [IHostSecurityManager::GetSecurityContext](ihostsecuritymanager-getsecuritycontext-method.md). + +## Syntax + ```cpp -HRESULT Capture ( - [out] IHostSecurityContext** ppClonedContext -); -``` - -## Parameters - - `ppClonedContext` - [out] A pointer to the address of a clone of the `IHostSecurityContext` object to be captured. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Capture` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The interface pointer returned from `Capture` is a clone of the captured context. When this information is moved across an asynchronous code point, its lifetime is separated from that of the pointer against which the call was made. The original pointer can therefore be released. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +HRESULT Capture ( + [out] IHostSecurityContext** ppClonedContext +); +``` + +## Parameters + + `ppClonedContext` + [out] A pointer to the address of a clone of the `IHostSecurityContext` object to be captured. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Capture` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The interface pointer returned from `Capture` is a clone of the captured context. When this information is moved across an asynchronous code point, its lifetime is separated from that of the pointer against which the call was made. The original pointer can therefore be released. + +## 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 2.0 + ## See also - [IHostSecurityContext Interface](ihostsecuritycontext-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritycontext-interface.md b/docs/core/unmanaged-api/hosting/ihostsecuritycontext-interface.md index 08e0f00b1e4e4..4bd462e0d39de 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritycontext-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritycontext-interface.md @@ -2,44 +2,43 @@ description: "Learn more about: IHostSecurityContext Interface" title: "IHostSecurityContext Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSecurityContext" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSecurityContext" -helpviewer_keywords: +helpviewer_keywords: - "IHostSecurityContext interface [.NET Framework hosting]" -ms.assetid: 88e2eac0-8ccb-404f-abbc-287d55159842 -topic_type: +topic_type: - "apiref" --- # IHostSecurityContext Interface -Allows the common language runtime (CLR) to maintain security context information implemented by the host. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Capture Method](ihostsecuritycontext-capture-method.md)|Gets a clone of the `IHostSecurityContext` instance returned from a call to [IHostSecurityManager::GetSecurityContext](ihostsecuritymanager-getsecuritycontext-method.md).| - -## Remarks - - A host can control all code access to thread tokens by both the CLR and user code. It can also ensure that complete security context information is passed across asynchronous operations or code points with restricted code access. `IHostSecurityContext` encapsulates this security context information, which is opaque to the runtime. The runtime captures this information using `Capture`, and moves it across thread pool worker item dispatch, finalizer execution, and module and class constructors. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Allows the common language runtime (CLR) to maintain security context information implemented by the host. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Capture Method](ihostsecuritycontext-capture-method.md)|Gets a clone of the `IHostSecurityContext` instance returned from a call to [IHostSecurityManager::GetSecurityContext](ihostsecuritymanager-getsecuritycontext-method.md).| + +## Remarks + + A host can control all code access to thread tokens by both the CLR and user code. It can also ensure that complete security context information is passed across asynchronous operations or code points with restricted code access. `IHostSecurityContext` encapsulates this security context information, which is opaque to the runtime. The runtime captures this information using `Capture`, and moves it across thread pool worker item dispatch, finalizer execution, and module and class constructors. + +## 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 2.0 + ## See also - [ICLRHostProtectionManager Interface](iclrhostprotectionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md index 2950f4852b354..c19e41627a66a 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md @@ -2,67 +2,66 @@ description: "Learn more about: IHostSecurityManager::GetSecurityContext Method" title: "IHostSecurityManager::GetSecurityContext Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSecurityManager.GetSecurityContext" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSecurityManager::GetSecurityContext" -helpviewer_keywords: +helpviewer_keywords: - "GetSecurityContext method [.NET Framework hosting]" - "IHostSecurityManager::GetSecurityContext method [.NET Framework hosting]" -ms.assetid: 958970d6-f6a2-4b84-b32a-f555cbaf8f61 -topic_type: +topic_type: - "apiref" --- # IHostSecurityManager::GetSecurityContext Method -Gets the requested [IHostSecurityContext](ihostsecuritycontext-interface.md) from the host. - -## Syntax - +Gets the requested [IHostSecurityContext](ihostsecuritycontext-interface.md) from the host. + +## Syntax + ```cpp -HRESULT GetSecurityContext ( +HRESULT GetSecurityContext ( [in] EContextType eContextType, - [out] IHostSecurityContext** ppSecurityContext -); -``` - -## Parameters - - `eContextType` - [in] One of the [EContextType](econtexttype-enumeration.md) values, indicating what type of security context to return. - - `ppSecurityContext` - [out] The address of an interface pointer to the `IHostSecurityContext` of `eContextType`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetSecurityContext` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - A host can control all code access to thread tokens by both the CLR and user code. It can also ensure that complete security context information is passed across asynchronous operations or code points with restricted code access. `IHostSecurityContext` encapsulates this security context information, which is opaque to the CLR. The CLR captures this information and moves it across thread pool worker item dispatch, finalizer execution, and module and class construction. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - + [out] IHostSecurityContext** ppSecurityContext +); +``` + +## Parameters + + `eContextType` + [in] One of the [EContextType](econtexttype-enumeration.md) values, indicating what type of security context to return. + + `ppSecurityContext` + [out] The address of an interface pointer to the `IHostSecurityContext` of `eContextType`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetSecurityContext` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + A host can control all code access to thread tokens by both the CLR and user code. It can also ensure that complete security context information is passed across asynchronous operations or code points with restricted code access. `IHostSecurityContext` encapsulates this security context information, which is opaque to the CLR. The CLR captures this information and moves it across thread pool worker item dispatch, finalizer execution, and module and class construction. + +## 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 2.0 + ## See also - [EContextType Enumeration](econtexttype-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md index 3de2021a56adf..08c6f55739be5 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md @@ -2,65 +2,64 @@ description: "Learn more about: IHostSecurityManager::ImpersonateLoggedOnUser Method" title: "IHostSecurityManager::ImpersonateLoggedOnUser Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSecurityManager.ImpersonateLoggedOnUser" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSecurityManager::ImpersonateLoggedOnUser" -helpviewer_keywords: +helpviewer_keywords: - "ImpersonateLoggedOnUser method [.NET Framework hosting]" - "IHostSecurityManager::ImpersonateLoggedOnUser method [.NET Framework hosting]" -ms.assetid: acc49ba0-f1d9-45ad-871f-9d053a89dcbe -topic_type: +topic_type: - "apiref" --- # IHostSecurityManager::ImpersonateLoggedOnUser Method -Requests that code be executed using the credentials of the current user identity. - -## Syntax - -```cpp -HRESULT ImpersonateLoggedOnUser ( - [in] HANDLE hToken -); -``` - -## Parameters - - `hToken` - [in] A token representing the credentials of the user to be impersonated. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`ImpersonateLoggedOnUser` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - Call `LogonUser` or a related Win32 function to get a handle to the credentials of the current user identity. - - The `HANDLE` type is not COM-compliant, that is, its size is specific to an operating system, and it requires custom marshalling. Thus, this token is for use only within the process, between the CLR and the host. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Requests that code be executed using the credentials of the current user identity. + +## Syntax + +```cpp +HRESULT ImpersonateLoggedOnUser ( + [in] HANDLE hToken +); +``` + +## Parameters + + `hToken` + [in] A token representing the credentials of the user to be impersonated. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`ImpersonateLoggedOnUser` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + Call `LogonUser` or a related Win32 function to get a handle to the credentials of the current user identity. + + The `HANDLE` type is not COM-compliant, that is, its size is specific to an operating system, and it requires custom marshalling. Thus, this token is for use only within the process, between the CLR and the host. + +## 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 2.0 + ## See also - [IHostSecurityContext Interface](ihostsecuritycontext-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-interface.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-interface.md index ae7c590184bf6..ecfaaf5402d58 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-interface.md @@ -2,59 +2,58 @@ description: "Learn more about: IHostSecurityManager Interface" title: "IHostSecurityManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSecurityManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSecurityManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostSecurityManager interface [.NET Framework hosting]" -ms.assetid: c3be2cbd-2d93-438b-9888-9a0251b63c03 -topic_type: +topic_type: - "apiref" --- # IHostSecurityManager Interface -Provides methods that allow access to and control over the security context of the currently executing thread. - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetSecurityContext Method](ihostsecuritymanager-getsecuritycontext-method.md)|Gets the requested [IHostSecurityContext](ihostsecuritycontext-interface.md) from the host.| -|[ImpersonateLoggedOnUser Method](ihostsecuritymanager-impersonateloggedonuser-method.md)|Requests that code be executed using the credentials of the current user identity.| -|[OpenThreadToken Method](ihostsecuritymanager-openthreadtoken-method.md)|Opens the discretionary access token associated with the current thread.| -|[RevertToSelf Method](ihostsecuritymanager-reverttoself-method.md)|Terminates impersonation of the current user identity and returns the original thread token.| -|[SetSecurityContext Method](ihostsecuritymanager-setsecuritycontext-method.md)|Sets the security context for the currently executing thread.| -|[SetThreadToken Method](ihostsecuritymanager-setthreadtoken-method.md)|Sets a handle for the currently executing thread.| - -## Remarks - - A host can control all code access to thread tokens by both the common language runtime (CLR) and user code. It can also ensure that complete security context information is passed across asynchronous operations or code points with restricted code access. `IHostSecurityContext` encapsulates this security context information, which is opaque to the CLR. - - The CLR handles managed thread context internally. It queries the process-specific `IHostSecurityManager` in the following situations: - -- On the finalizer thread, during finalizer execution. - -- During class and module constructor execution. - -- At asynchronous points on the worker thread, in calls to the [IHostThreadPoolManager::QueueUserWorkItem](ihostthreadpoolmanager-queueuserworkitem-method.md) method. - -- In servicing of I/O completion ports. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods that allow access to and control over the security context of the currently executing thread. + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetSecurityContext Method](ihostsecuritymanager-getsecuritycontext-method.md)|Gets the requested [IHostSecurityContext](ihostsecuritycontext-interface.md) from the host.| +|[ImpersonateLoggedOnUser Method](ihostsecuritymanager-impersonateloggedonuser-method.md)|Requests that code be executed using the credentials of the current user identity.| +|[OpenThreadToken Method](ihostsecuritymanager-openthreadtoken-method.md)|Opens the discretionary access token associated with the current thread.| +|[RevertToSelf Method](ihostsecuritymanager-reverttoself-method.md)|Terminates impersonation of the current user identity and returns the original thread token.| +|[SetSecurityContext Method](ihostsecuritymanager-setsecuritycontext-method.md)|Sets the security context for the currently executing thread.| +|[SetThreadToken Method](ihostsecuritymanager-setthreadtoken-method.md)|Sets a handle for the currently executing thread.| + +## Remarks + + A host can control all code access to thread tokens by both the common language runtime (CLR) and user code. It can also ensure that complete security context information is passed across asynchronous operations or code points with restricted code access. `IHostSecurityContext` encapsulates this security context information, which is opaque to the CLR. + + The CLR handles managed thread context internally. It queries the process-specific `IHostSecurityManager` in the following situations: + +- On the finalizer thread, during finalizer execution. + +- During class and module constructor execution. + +- At asynchronous points on the worker thread, in calls to the [IHostThreadPoolManager::QueueUserWorkItem](ihostthreadpoolmanager-queueuserworkitem-method.md) method. + +- In servicing of I/O completion ports. + +## 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 2.0 + ## See also - [IHostSecurityContext Interface](ihostsecuritycontext-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md index ac07a83770305..1018a607f4aee 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md @@ -2,73 +2,72 @@ description: "Learn more about: IHostSecurityManager::OpenThreadToken Method" title: "IHostSecurityManager::OpenThreadToken Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSecurityManager.OpenThreadToken" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSecurityManager::OpenThreadToken" -helpviewer_keywords: +helpviewer_keywords: - "IHostSecurityManager::OpenThreadToken method [.NET Framework hosting]" - "OpenThreadToken method [.NET Framework hosting]" -ms.assetid: d5999052-8bf0-4a9e-8621-da6284406b18 -topic_type: +topic_type: - "apiref" --- # IHostSecurityManager::OpenThreadToken Method -Opens the discretionary access token associated with the currently executing thread. - -## Syntax - -```cpp -HRESULT OpenThreadToken ( +Opens the discretionary access token associated with the currently executing thread. + +## Syntax + +```cpp +HRESULT OpenThreadToken ( [in] DWORD dwDesiredAccess, [in] BOOL bOpenAsSelf, - [out] HANDLE *phThreadToken -); -``` - -## Parameters - - `dwDesiredAccess` - [in] A mask of access values that specify the requested types of access to the thread token. These values are defined in the Win32 `OpenThreadToken` function. The requested access types are reconciled against the token's discretionary access control list (DACL) to determine which types of access to grant or deny. - - `bOpenAsSelf` - [in] `true` to specify that the access check should be made using the security context of the process for the calling thread; `false` to specify that the access check should be performed using the security context for the calling thread itself. If the thread is impersonating a client, the security context can be that of a client process. - - `phThreadToken` - [out] A pointer to the newly opened access token. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`OpenThreadToken` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `IHostSecurityManager::OpenThreadToken` behaves similarly to the corresponding Win32 function of the same name, except that the Win32 function allows the caller to pass in a handle to an arbitrary thread, while `IHostSecurityManager::OpenThreadToken` opens only the token associated with the calling thread. - - The `HANDLE` type is not COM-compliant, that is, its size is specific to the operating system, and it requires custom marshalling. Thus, this token is for use only within the process, between the CLR and the host. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - + [out] HANDLE *phThreadToken +); +``` + +## Parameters + + `dwDesiredAccess` + [in] A mask of access values that specify the requested types of access to the thread token. These values are defined in the Win32 `OpenThreadToken` function. The requested access types are reconciled against the token's discretionary access control list (DACL) to determine which types of access to grant or deny. + + `bOpenAsSelf` + [in] `true` to specify that the access check should be made using the security context of the process for the calling thread; `false` to specify that the access check should be performed using the security context for the calling thread itself. If the thread is impersonating a client, the security context can be that of a client process. + + `phThreadToken` + [out] A pointer to the newly opened access token. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`OpenThreadToken` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `IHostSecurityManager::OpenThreadToken` behaves similarly to the corresponding Win32 function of the same name, except that the Win32 function allows the caller to pass in a handle to an arbitrary thread, while `IHostSecurityManager::OpenThreadToken` opens only the token associated with the calling thread. + + The `HANDLE` type is not COM-compliant, that is, its size is specific to the operating system, and it requires custom marshalling. Thus, this token is for use only within the process, between the CLR and the host. + +## 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 2.0 + ## See also - [IHostSecurityContext Interface](ihostsecuritycontext-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md index 64f4d071e8d9d..a53e67760f94d 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IHostSecurityManager::RevertToSelf Method" title: "IHostSecurityManager::RevertToSelf Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSecurityManager.RevertToSelf" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSecurityManager::RevertToSelf" -helpviewer_keywords: +helpviewer_keywords: - "RevertToSelf method [.NET Framework hosting]" - "IHostSecurityManager::RevertToSelf method [.NET Framework hosting]" -ms.assetid: 189f28f8-f9a1-4192-aedc-91084e4f8b99 -topic_type: +topic_type: - "apiref" --- # IHostSecurityManager::RevertToSelf Method -Terminates impersonation of the current user identity and returns the original thread token. - -## Syntax - -```cpp -HRESULT RevertToSelf (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`RevertToSelf` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `RevertToSelf` is called to return to the original thread token, after an earlier call to the [ImpersonateLoggedOnUser](ihostsecuritymanager-impersonateloggedonuser-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Terminates impersonation of the current user identity and returns the original thread token. + +## Syntax + +```cpp +HRESULT RevertToSelf (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`RevertToSelf` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `RevertToSelf` is called to return to the original thread token, after an earlier call to the [ImpersonateLoggedOnUser](ihostsecuritymanager-impersonateloggedonuser-method.md) method. + +## 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 2.0 + ## See also - [IHostSecurityContext Interface](ihostsecuritycontext-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md index 972a8af4487ea..1f879ad5128fa 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md @@ -2,69 +2,68 @@ description: "Learn more about: IHostSecurityManager::SetSecurityContext Method" title: "IHostSecurityManager::SetSecurityContext Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSecurityManager.SetSecurityContext" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSecurityManager::SetSecurityContext" -helpviewer_keywords: +helpviewer_keywords: - "SetSecurityContext method [.NET Framework hosting]" - "IHostSecurityManager::SetSecurityContext method [.NET Framework hosting]" -ms.assetid: e4372384-ee69-48d7-97e0-8fab7866597a -topic_type: +topic_type: - "apiref" --- # IHostSecurityManager::SetSecurityContext Method -Sets the security context of the currently executing thread. - -## Syntax - -```cpp -HRESULT SetSecurityContext ( - [in] EContextType eContextType, - [out] IHostSecurityContext** ppSecurityContext -); -``` - -## Parameters - - `eContextType` - [in] One of the [EContextType](econtexttype-enumeration.md) values, indicating what type of context the common language runtime (CLR) is placing on the host. - - `ppSecurityContext` - [out] A pointer to the address of a new [IHostSecurityContext](ihostsecuritycontext-interface.md) object. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetSecurityContext` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR calls `SetSecurityContext` in several scenarios. Before it executes class and module constructors and finalizers, the CLR calls `SetSecurityContext` to protect the host from execution failures. It then resets the security context to its original state after execution of the constructor or finalizer, by using another call to `SetSecurityContext`. A similar pattern occurs with I/O completion. If the host implements [IHostIoCompletionManager](ihostiocompletionmanager-interface.md), the CLR calls `SetSecurityContext` after the host calls [ICLRIoCompletionManager::OnComplete](iclriocompletionmanager-oncomplete-method.md). - - At asynchronous points in worker threads, the CLR calls `SetSecurityContext` within or within [IHostThreadPoolManager::QueueUserWorkItem](ihostthreadpoolmanager-queueuserworkitem-method.md), depending on whether the host or the CLR is implementing the thread pool. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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 security context of the currently executing thread. + +## Syntax + +```cpp +HRESULT SetSecurityContext ( + [in] EContextType eContextType, + [out] IHostSecurityContext** ppSecurityContext +); +``` + +## Parameters + + `eContextType` + [in] One of the [EContextType](econtexttype-enumeration.md) values, indicating what type of context the common language runtime (CLR) is placing on the host. + + `ppSecurityContext` + [out] A pointer to the address of a new [IHostSecurityContext](ihostsecuritycontext-interface.md) object. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetSecurityContext` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR calls `SetSecurityContext` in several scenarios. Before it executes class and module constructors and finalizers, the CLR calls `SetSecurityContext` to protect the host from execution failures. It then resets the security context to its original state after execution of the constructor or finalizer, by using another call to `SetSecurityContext`. A similar pattern occurs with I/O completion. If the host implements [IHostIoCompletionManager](ihostiocompletionmanager-interface.md), the CLR calls `SetSecurityContext` after the host calls [ICLRIoCompletionManager::OnComplete](iclriocompletionmanager-oncomplete-method.md). + + At asynchronous points in worker threads, the CLR calls `SetSecurityContext` within or within [IHostThreadPoolManager::QueueUserWorkItem](ihostthreadpoolmanager-queueuserworkitem-method.md), depending on whether the host or the CLR is implementing the thread pool. + +## 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 2.0 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md index 306cd682e52e7..c231b31464d99 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md @@ -2,65 +2,64 @@ description: "Learn more about: IHostSecurityManager::SetThreadToken Method" title: "IHostSecurityManager::SetThreadToken Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSecurityManager.SetThreadToken" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSecurityManager::SetThreadToken" -helpviewer_keywords: +helpviewer_keywords: - "SetThreadToken method [.NET Framework hosting]" - "IHostSecurityManager::SetThreadToken method [.NET Framework hosting]" -ms.assetid: e951c345-8a86-4587-911b-a1a57bc6428a -topic_type: +topic_type: - "apiref" --- # IHostSecurityManager::SetThreadToken Method -Sets a handle for the currently executing thread. - -## Syntax - -```cpp -HRESULT SetThreadToken ( - [in] HANDLE hToken -); -``` - -## Parameters - - `hToken` - [in] A handle to the token to set for the currently executing thread. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetThreadToken` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `IHostSecurityManager::SetThreadToken` behaves similarly to the corresponding Win32 function of the same name, except that the Win32 function allows the caller to pass in a handle to an arbitrary thread, while `IHostSecurityManager::SetThreadToken` can associate a token only with the currently executing thread. - - The `HANDLE` type is not COM-compliant; that is, its size is specific to an operating system and it requires custom marshalling. Thus, this token is for use only within the process, between the CLR and the host. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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 a handle for the currently executing thread. + +## Syntax + +```cpp +HRESULT SetThreadToken ( + [in] HANDLE hToken +); +``` + +## Parameters + + `hToken` + [in] A handle to the token to set for the currently executing thread. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetThreadToken` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `IHostSecurityManager::SetThreadToken` behaves similarly to the corresponding Win32 function of the same name, except that the Win32 function allows the caller to pass in a handle to an arbitrary thread, while `IHostSecurityManager::SetThreadToken` can associate a token only with the currently executing thread. + + The `HANDLE` type is not COM-compliant; that is, its size is specific to an operating system and it requires custom marshalling. Thus, this token is for use only within the process, between the CLR and the host. + +## 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 2.0 + ## See also - [IHostSecurityManager Interface](ihostsecuritymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md b/docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md index aa6d0819f906f..165fa52221987 100644 --- a/docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md @@ -2,41 +2,40 @@ description: "Learn more about: IHostSemaphore Interface" title: "IHostSemaphore Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSemaphore" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSemaphore" -helpviewer_keywords: +helpviewer_keywords: - "IHostSemaphore interface [.NET Framework hosting]" -ms.assetid: c0765321-656c-441e-bab5-58176292be1e -topic_type: +topic_type: - "apiref" --- # IHostSemaphore Interface -Represents the host's implementation of a semaphore for threading. - -## Methods - -|Method|Description| -|------------|-----------------| -|[ReleaseSemaphore Method](ihostsemaphore-releasesemaphore-method.md)|Increases the count of the current `IHostSemaphore` instance by the specified amount.| -|[Wait Method](ihostsemaphore-wait-method.md)|Causes the current `IHostSemaphore` instance to wait until it is owned or the specified amount of time elapses.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Represents the host's implementation of a semaphore for threading. + +## Methods + +|Method|Description| +|------------|-----------------| +|[ReleaseSemaphore Method](ihostsemaphore-releasesemaphore-method.md)|Increases the count of the current `IHostSemaphore` instance by the specified amount.| +|[Wait Method](ihostsemaphore-wait-method.md)|Causes the current `IHostSemaphore` instance to wait until it is owned or the specified amount of time elapses.| + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md b/docs/core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md index fce2a1cc7d768..fcb329c50a4b1 100644 --- a/docs/core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md @@ -2,67 +2,66 @@ description: "Learn more about: IHostSemaphore::ReleaseSemaphore Method" title: "IHostSemaphore::ReleaseSemaphore Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSemaphore.ReleaseSemaphore" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSemaphore::ReleaseSemaphore" -helpviewer_keywords: +helpviewer_keywords: - "ReleaseSemaphore method [.NET Framework hosting]" - "IHostSemaphore::ReleaseSemaphore method [.NET Framework hosting]" -ms.assetid: a343d197-979a-4ac6-ab8c-cb8a05f3120e -topic_type: +topic_type: - "apiref" --- # IHostSemaphore::ReleaseSemaphore Method -Increases the count of the current [IHostSemaphore](ihostsemaphore-interface.md) instance by the specified amount. - -## Syntax - -```cpp -HRESULT ReleaseSemaphore ( - [in] LONG lReleaseCount, - [out] LONG *lpPreviousCount -); -``` - -## Parameters - - `lReleaseCount` - [in] The amount by which to increase the count of the current `IHostSemaphore` instance. This amount must be greater than zero. - - `lpPreviousCount` - [out] A pointer to the previous count, or null if the caller does not require the previous count. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`ReleaseSemaphore` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR typically calls `ReleaseSemaphore` to notify the host that it has finished using a resource, passing a value of 1 for the `lReleaseCount` parameter. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Increases the count of the current [IHostSemaphore](ihostsemaphore-interface.md) instance by the specified amount. + +## Syntax + +```cpp +HRESULT ReleaseSemaphore ( + [in] LONG lReleaseCount, + [out] LONG *lpPreviousCount +); +``` + +## Parameters + + `lReleaseCount` + [in] The amount by which to increase the count of the current `IHostSemaphore` instance. This amount must be greater than zero. + + `lpPreviousCount` + [out] A pointer to the previous count, or null if the caller does not require the previous count. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`ReleaseSemaphore` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR typically calls `ReleaseSemaphore` to notify the host that it has finished using a resource, passing a value of 1 for the `lReleaseCount` parameter. + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md b/docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md index 6ad669c91ff7c..851199bdd8031 100644 --- a/docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IHostSemaphore::Wait Method" title: "IHostSemaphore::Wait Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSemaphore.Wait" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSemaphore::Wait" -helpviewer_keywords: +helpviewer_keywords: - "IHostSemaphore::Wait method [.NET Framework hosting]" - "Wait method, IHostSemaphore interface [.NET Framework hosting]" -ms.assetid: 0da962a3-ce55-44dd-ab7a-14ad7105af4a -topic_type: +topic_type: - "apiref" --- # IHostSemaphore::Wait Method -Causes the current [IHostSemaphore](ihostsemaphore-interface.md) instance to wait until it is owned or the specified amount of time elapses. - -## Syntax - -```cpp -HRESULT Wait ( - [in] DWORD dwMilliseconds, - [in] DWORD option -); -``` - -## Parameters +Causes the current [IHostSemaphore](ihostsemaphore-interface.md) instance to wait until it is owned or the specified amount of time elapses. - `dwMilliseconds` - [in] The number of milliseconds to wait before returning, if the current `IHostSemaphore` instance is not owned. - - `option` - [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values, specifying what action the host should take if this operation blocks. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Wait` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|HOST_E_DEADLOCK|The host detected a deadlock during the wait interval, and chose the current `IHostSemaphore` instance as a deadlock victim.| - -## Requirements +## Syntax + +```cpp +HRESULT Wait ( + [in] DWORD dwMilliseconds, + [in] DWORD option +); +``` + +## Parameters + + `dwMilliseconds` + [in] The number of milliseconds to wait before returning, if the current `IHostSemaphore` instance is not owned. + + `option` + [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values, specifying what action the host should take if this operation blocks. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Wait` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|HOST_E_DEADLOCK|The host detected a deadlock during the wait interval, and chose the current `IHostSemaphore` instance as a deadlock victim.| + +## 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 2.0 - **Platforms:** See [System Requirements](../../../framework/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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md index 2a5c8599916e1..e8ed66094c355 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IHostSyncManager::CreateAutoEvent Method" title: "IHostSyncManager::CreateAutoEvent Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSyncManager.CreateAutoEvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSyncManager::CreateAutoEvent" -helpviewer_keywords: +helpviewer_keywords: - "IHostSyncManager::CreateAutoEvent method [.NET Framework hosting]" - "CreateAutoEvent method [.NET Framework hosting]" -ms.assetid: 3153643e-cf5c-4b44-8e0e-c2b22cb08208 -topic_type: +topic_type: - "apiref" --- # IHostSyncManager::CreateAutoEvent Method -Creates an auto-reset event object. - -## Syntax - -```cpp -HRESULT CreateAutoEvent ( - [out] IHostAutoEvent **ppEvent -); -``` - -## Parameters - - `ppEvent` - [out] A pointer to the address of an [IHostAutoEvent](ihostautoevent-interface.md) instance implemented by the host, or null if the event object could not be created. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateAutoEvent` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| - -## Remarks - - `CreateAutoEvent` creates an auto-event object whose state is automatically changed to non-signaled after the waiting thread has been released. This method mirrors the Win32 `CreateEvent` function with a value of `false` specified for the `bManualReset` parameter - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Creates an auto-reset event object. + +## Syntax + +```cpp +HRESULT CreateAutoEvent ( + [out] IHostAutoEvent **ppEvent +); +``` + +## Parameters + + `ppEvent` + [out] A pointer to the address of an [IHostAutoEvent](ihostautoevent-interface.md) instance implemented by the host, or null if the event object could not be created. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateAutoEvent` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| + +## Remarks + + `CreateAutoEvent` creates an auto-event object whose state is automatically changed to non-signaled after the waiting thread has been released. This method mirrors the Win32 `CreateEvent` function with a value of `false` specified for the `bManualReset` parameter + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md index 032c1f232f1f2..9663b5d040a03 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IHostSyncManager::CreateCrst Method" title: "IHostSyncManager::CreateCrst Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSyncManager.CreateCrst" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSyncManager::CreateCrst" -helpviewer_keywords: +helpviewer_keywords: - "CreateCrst method [.NET Framework hosting]" - "IHostSyncManager::CreateCrst method [.NET Framework hosting]" -ms.assetid: ac278cc8-2540-4a6c-b5c6-b90c3970b4f4 -topic_type: +topic_type: - "apiref" --- # IHostSyncManager::CreateCrst Method -Creates a critical section object for synchronization. - -## Syntax - -```cpp -HRESULT CreateCrst ( - [out] IHostCrst** ppCrst -); -``` - -## Parameters - - `ppCrst` - [out] A pointer to the address of an [IHostCrst](ihostcrst-interface.md) instance implemented by the host, or null if the critical section could not be created. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateCrst` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to create the requested critical section.| - -## Remarks - - Critical section objects provide synchronization similar to that provided by a mutex object, except that critical sections can be used only by the threads of a single process. `CreateCrst` mirrors the Win32 `InitializeCriticalSection` function. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Creates a critical section object for synchronization. + +## Syntax + +```cpp +HRESULT CreateCrst ( + [out] IHostCrst** ppCrst +); +``` + +## Parameters + + `ppCrst` + [out] A pointer to the address of an [IHostCrst](ihostcrst-interface.md) instance implemented by the host, or null if the critical section could not be created. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateCrst` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to create the requested critical section.| + +## Remarks + + Critical section objects provide synchronization similar to that provided by a mutex object, except that critical sections can be used only by the threads of a single process. `CreateCrst` mirrors the Win32 `InitializeCriticalSection` function. + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md index 6d3b2cbf2adef..1204ab19de703 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md @@ -2,68 +2,67 @@ description: "Learn more about: IHostSyncManager::CreateCrstWithSpinCount Method" title: "IHostSyncManager::CreateCrstWithSpinCount Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSyncManager.CreateCrstWithSpinCount" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSyncManager::CreateCrstWithSpinCount" -helpviewer_keywords: +helpviewer_keywords: - "CreateCrstWithSpinCount method [.NET Framework hosting]" - "IHostSyncManager::CreateCrstWithSpinCount method [.NET Framework hosting]" -ms.assetid: 7280fa8c-3639-4abf-91cb-bc343da742d1 -topic_type: +topic_type: - "apiref" --- # IHostSyncManager::CreateCrstWithSpinCount Method -Creates a critical section object with spin count for synchronization. - -## Syntax - -```cpp -HRESULT CreateCrstWithSpinCount ( - [in] DWORD dwSpinCount, - [out] IHostCrst** ppCrst -); -``` - -## Parameters - - `dwSpinCount` - [in] Specifies the spin count for the critical section object. - - `ppCrst` - [out] A pointer to the address of an [IHostCrst](ihostcrst-interface.md) instance, or null if the critical section could not be created. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateCrstWithSpinCount` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to create the requested critical section.| - -## Remarks - - A spin count is used only on a multi-processor system. The spin count specifies the number of times a calling thread must spin before it performs a wait operation on a semaphore that is associated with an unavailable critical section. If the critical section becomes free during the spin operation, the calling thread avoids the wait operation. `CreateCrstWithSpinCount` mirrors the Win32 `InitializeCriticalSectionAndSpinCount` function. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Creates a critical section object with spin count for synchronization. + +## Syntax + +```cpp +HRESULT CreateCrstWithSpinCount ( + [in] DWORD dwSpinCount, + [out] IHostCrst** ppCrst +); +``` + +## Parameters + + `dwSpinCount` + [in] Specifies the spin count for the critical section object. + + `ppCrst` + [out] A pointer to the address of an [IHostCrst](ihostcrst-interface.md) instance, or null if the critical section could not be created. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateCrstWithSpinCount` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to create the requested critical section.| + +## Remarks + + A spin count is used only on a multi-processor system. The spin count specifies the number of times a calling thread must spin before it performs a wait operation on a semaphore that is associated with an unavailable critical section. If the critical section becomes free during the spin operation, the calling thread avoids the wait operation. `CreateCrstWithSpinCount` mirrors the Win32 `InitializeCriticalSectionAndSpinCount` function. + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md index dad90d29b9fa6..d6ed4fac761aa 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md @@ -2,68 +2,67 @@ description: "Learn more about: IHostSyncManager::CreateManualEvent Method" title: "IHostSyncManager::CreateManualEvent Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSyncManager.CreateManualEvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSyncManager::CreateManualEvent" -helpviewer_keywords: +helpviewer_keywords: - "CreateManualEvent method [.NET Framework hosting]" - "IHostSyncManager::CreateManualEvent method [.NET Framework hosting]" -ms.assetid: 68661fbd-09cf-46dc-890b-e694f8a3880a -topic_type: +topic_type: - "apiref" --- # IHostSyncManager::CreateManualEvent Method -Creates a manual-reset event object. - -## Syntax - -```cpp -HRESULT CreateManualEvent ( - [in] BOOL bInitialState, - [out] IHostManualEvent **ppEvent -); -``` - -## Parameters - - `bInitialState` - [in] `true`, if the object is signaled; otherwise, `false`. - - `ppEvent` - [out] A pointer to the address of an [IHostManualEvent](ihostmanualevent-interface.md) instance, or null if the event could not be created. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateManualEvent` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| - -## Remarks - - `CreateManualEvent` creates an `IHostManualEvent`, a manual-reset event object that requires a call to the [IHostManualEvent::Reset](ihostmanualevent-reset-method.md) method to set it to a non-signaled state. `CreateManualEvent` mirrors the Win32 `CreateEvent` function with a value of `true` specified for the `bManualReset` parameter. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Creates a manual-reset event object. + +## Syntax + +```cpp +HRESULT CreateManualEvent ( + [in] BOOL bInitialState, + [out] IHostManualEvent **ppEvent +); +``` + +## Parameters + + `bInitialState` + [in] `true`, if the object is signaled; otherwise, `false`. + + `ppEvent` + [out] A pointer to the address of an [IHostManualEvent](ihostmanualevent-interface.md) instance, or null if the event could not be created. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateManualEvent` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| + +## Remarks + + `CreateManualEvent` creates an `IHostManualEvent`, a manual-reset event object that requires a call to the [IHostManualEvent::Reset](ihostmanualevent-reset-method.md) method to set it to a non-signaled state. `CreateManualEvent` mirrors the Win32 `CreateEvent` function with a value of `true` specified for the `bManualReset` parameter. + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md index 54dbc120eb7f1..5c38b55673449 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md @@ -2,70 +2,69 @@ description: "Learn more about: IHostSyncManager::CreateMonitorEvent Method" title: "IHostSyncManager::CreateMonitorEvent Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSyncManager.CreateMonitorEvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSyncManager::CreateMonitorEvent" -helpviewer_keywords: +helpviewer_keywords: - "CreateMonitorEvent method [.NET Framework hosting]" - "IHostSyncManager::CreateMonitorEvent method [.NET Framework hosting]" -ms.assetid: 524c7fd3-9b5c-46e7-99ba-555fd2fe33f0 -topic_type: +topic_type: - "apiref" --- # IHostSyncManager::CreateMonitorEvent Method -Creates a monitored auto-reset event object. - -## Syntax - -```cpp -HRESULT CreateMonitorEvent ( - [in] SIZE_T cookie, - [out] IHostAutoEvent **ppEvent -); -``` - -## Parameters - - `cookie` - [in] A cookie to associate with the event object. - - `ppEvent` - [out] A pointer to the address of an [IHostAutoEvent](ihostautoevent-interface.md) instance, or null if the event object could not be created. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateMonitorEvent` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| - -## Remarks - - `CreateMonitorEvent` returns an `IHostAutoEvent` that the CLR uses in its implementation of the managed type. This method mirrors the Win32 `CreateEvent` function, with a value of `false` specified for the `bManualReset` parameter. - - The host can use the cookie to determine which task is waiting on the monitor by calling the [ICLRSyncManager::GetMonitorOwner](iclrsyncmanager-getmonitorowner-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Creates a monitored auto-reset event object. + +## Syntax + +```cpp +HRESULT CreateMonitorEvent ( + [in] SIZE_T cookie, + [out] IHostAutoEvent **ppEvent +); +``` + +## Parameters + + `cookie` + [in] A cookie to associate with the event object. + + `ppEvent` + [out] A pointer to the address of an [IHostAutoEvent](ihostautoevent-interface.md) instance, or null if the event object could not be created. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateMonitorEvent` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| + +## Remarks + + `CreateMonitorEvent` returns an `IHostAutoEvent` that the CLR uses in its implementation of the managed type. This method mirrors the Win32 `CreateEvent` function, with a value of `false` specified for the `bManualReset` parameter. + + The host can use the cookie to determine which task is waiting on the monitor by calling the [ICLRSyncManager::GetMonitorOwner](iclrsyncmanager-getmonitorowner-method.md) method. + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md index 8a7e07e7678c7..71a0a4171828c 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md @@ -2,72 +2,71 @@ description: "Learn more about: IHostSyncManager::CreateRWLockReaderEvent Method" title: "IHostSyncManager::CreateRWLockReaderEvent Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSyncManager.CreateRWLockReaderEvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSyncManager::CreateRWLockReaderEvent" -helpviewer_keywords: +helpviewer_keywords: - "CreateRWLockReaderEvent method [.NET Framework hosting]" - "IHostSyncManager::CreateRWLockReaderEvent method [.NET Framework hosting]" -ms.assetid: 68c4ea19-c47c-45c6-b420-d3a2ba1c2d50 -topic_type: +topic_type: - "apiref" --- # IHostSyncManager::CreateRWLockReaderEvent Method -Creates a manual-reset event object for the implementation of a reader lock. - -## Syntax - -```cpp -HRESULT CreateRWLockReaderEvent ( - [in] BOOL bInitialState, - [in] SIZE_T cookie, - [out] IHostManualEvent **ppEvent -); -``` - -## Parameters - - `bInitialState` - [in] `true`, if `ppEvent` should be signaled; otherwise, `false`. - - `cookie` - [in] A cookie to associate with the reader lock. - - `ppEvent` - [out] A pointer to the address of an [IHostManualEvent](ihostmanualevent-interface.md) instance, or null if the event object could not be created. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateRWLockReaderEvent` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| - -## Remarks - - The CLR calls `CreateRWLockReaderEvent` to get a reference to an `IHostManualEvent` instance to use in its implementation of a reader lock. The host can use the cookie to determine which tasks are waiting on the reader lock by querying the [ICLRSyncManager](iclrsyncmanager-interface.md) interface. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Creates a manual-reset event object for the implementation of a reader lock. + +## Syntax + +```cpp +HRESULT CreateRWLockReaderEvent ( + [in] BOOL bInitialState, + [in] SIZE_T cookie, + [out] IHostManualEvent **ppEvent +); +``` + +## Parameters + + `bInitialState` + [in] `true`, if `ppEvent` should be signaled; otherwise, `false`. + + `cookie` + [in] A cookie to associate with the reader lock. + + `ppEvent` + [out] A pointer to the address of an [IHostManualEvent](ihostmanualevent-interface.md) instance, or null if the event object could not be created. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateRWLockReaderEvent` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| + +## Remarks + + The CLR calls `CreateRWLockReaderEvent` to get a reference to an `IHostManualEvent` instance to use in its implementation of a reader lock. The host can use the cookie to determine which tasks are waiting on the reader lock by querying the [ICLRSyncManager](iclrsyncmanager-interface.md) interface. + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md index 1e1ce26e0bacb..15441ec0db6cb 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md @@ -2,68 +2,67 @@ description: "Learn more about: IHostSyncManager::CreateRWLockWriterEvent Method" title: "IHostSyncManager::CreateRWLockWriterEvent Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSyncManager.CreateRWLockWriterEvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSyncManager::CreateRWLockWriterEvent" -helpviewer_keywords: +helpviewer_keywords: - "CreateRWLockWriterEvent method [.NET Framework hosting]" - "IHostSyncManager::CreateRWLockWriterEvent method [.NET Framework hosting]" -ms.assetid: 70e488c2-cf53-4dc0-ba52-74372d215c41 -topic_type: +topic_type: - "apiref" --- # IHostSyncManager::CreateRWLockWriterEvent Method -Creates an auto-reset event object for the implementation of a writer lock. - -## Syntax - -```cpp -HRESULT CreateRWLockWriterEvent ( - [in] SIZE_T cookie, - [out] IHostAutoEvent **ppEvent -); -``` - -## Parameters - - `cookie` - [in] A cookie to associate with the auto-reset event. - - `ppEvent` - [out] A pointer to the address of an [IHostAutoEvent](ihostautoevent-interface.md) instance, or null if the event object could not be created. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateRWLockWriterEvent` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| - -## Remarks - - The CLR calls the `CreateRWLockWriterEvent` method to get a reference to an `IHostAutoEvent` instance to use in its implementation of a writer lock. The host can use the specified cookie to determine which tasks are waiting on the lock by calling the iteration methods of the [ICLRSyncManager](iclrsyncmanager-interface.md) interface. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Creates an auto-reset event object for the implementation of a writer lock. + +## Syntax + +```cpp +HRESULT CreateRWLockWriterEvent ( + [in] SIZE_T cookie, + [out] IHostAutoEvent **ppEvent +); +``` + +## Parameters + + `cookie` + [in] A cookie to associate with the auto-reset event. + + `ppEvent` + [out] A pointer to the address of an [IHostAutoEvent](ihostautoevent-interface.md) instance, or null if the event object could not be created. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateRWLockWriterEvent` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| + +## Remarks + + The CLR calls the `CreateRWLockWriterEvent` method to get a reference to an `IHostAutoEvent` instance to use in its implementation of a writer lock. The host can use the specified cookie to determine which tasks are waiting on the lock by calling the iteration methods of the [ICLRSyncManager](iclrsyncmanager-interface.md) interface. + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md index 5c4e9912e59b2..0d3fe1e1f8e76 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md @@ -2,72 +2,71 @@ description: "Learn more about: IHostSyncManager::CreateSemaphore Method" title: "IHostSyncManager::CreateSemaphore Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSyncManager.CreateSemaphore" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSyncManager::CreateSemaphore" -helpviewer_keywords: +helpviewer_keywords: - "CreateSemaphore method [.NET Framework hosting]" - "IHostSyncManager::CreateSemaphore method [.NET Framework hosting]" -ms.assetid: 37679e94-5ff9-4173-8fa5-457febeb89bf -topic_type: +topic_type: - "apiref" --- # IHostSyncManager::CreateSemaphore Method -Creates an [IHostSemaphore](ihostsemaphore-interface.md) object for the common language runtime (CLR) to use as a semaphore for wait events. - -## Syntax - -```cpp -HRESULT CreateSemaphore ( - [in] DWORD dwInitial, - [in] DWORD dwMax, - [out] IHostSemaphore **ppSemaphore -); -``` - -## Parameters - - `dwInitial` - [in] The initial count for `ppSemaphore`. - - `dwMax` - [in] The maximum count for `ppSemaphore`. - - `ppSemaphore` - [out] A pointer to the address of an `IHostSemaphore` instance, or null if the semaphore could not be created. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateSemaphore` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| - -## Remarks - - `CreateSemaphore` mirrors the Win32 function that has the same name. The `dwInitial` and `dwMax` parameters use the same semantics for the semaphore count as the Win32 `lInitialCount` and `lMaximumCount` parameters, respectively. `dwInitial` must be between zero and `dwMax`, inclusive. `dwMax` must be greater than zero. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Creates an [IHostSemaphore](ihostsemaphore-interface.md) object for the common language runtime (CLR) to use as a semaphore for wait events. + +## Syntax + +```cpp +HRESULT CreateSemaphore ( + [in] DWORD dwInitial, + [in] DWORD dwMax, + [out] IHostSemaphore **ppSemaphore +); +``` + +## Parameters + + `dwInitial` + [in] The initial count for `ppSemaphore`. + + `dwMax` + [in] The maximum count for `ppSemaphore`. + + `ppSemaphore` + [out] A pointer to the address of an `IHostSemaphore` instance, or null if the semaphore could not be created. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateSemaphore` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| + +## Remarks + + `CreateSemaphore` mirrors the Win32 function that has the same name. The `dwInitial` and `dwMax` parameters use the same semantics for the semaphore count as the Win32 `lInitialCount` and `lMaximumCount` parameters, respectively. `dwInitial` must be between zero and `dwMax`, inclusive. `dwMax` must be greater than zero. + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md index c45eb23d00b7b..7e4f1393e22c6 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md @@ -2,52 +2,51 @@ description: "Learn more about: IHostSyncManager Interface" title: "IHostSyncManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSyncManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSyncManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostSyncManager interface [.NET Framework hosting]" -ms.assetid: 2e081a37-6a28-4c93-b7ab-1c96a464637c -topic_type: +topic_type: - "apiref" --- # IHostSyncManager Interface -Provides methods that allow the common language runtime (CLR) to create synchronization primitives by calling the host instead of using the Win32 synchronization functions. - -## Methods - -|Method|Description| -|------------|-----------------| -|[CreateAutoEvent Method](ihostsyncmanager-createautoevent-method.md)|Creates an auto-reset event object.| -|[CreateCrst Method](ihostsyncmanager-createcrst-method.md)|Creates a critical section object for synchronization.| -|[CreateCrstWithSpinCount Method](ihostsyncmanager-createcrstwithspincount-method.md)|Creates a critical section object with spin count for synchronization.| -|[CreateManualEvent Method](ihostsyncmanager-createmanualevent-method.md)|Creates a manual-reset event object.| -|[CreateMonitorEvent Method](ihostsyncmanager-createmonitorevent-method.md)|Creates a monitored auto-reset event object.| -|[CreateRWLockReaderEvent Method](ihostsyncmanager-createrwlockreaderevent-method.md)|Creates a manual-reset event object for the implementation of a reader lock.| -|[CreateRWLockWriterEvent Method](ihostsyncmanager-createrwlockwriterevent-method.md)|Creates an auto-reset event object for the implementation of a writer lock.| -|[CreateSemaphore Method](ihostsyncmanager-createsemaphore-method.md)|Creates an [IHostSemaphore](ihostsemaphore-interface.md) object for the CLR to use as a semaphore for wait events.| -|[SetCLRSyncManager Method](ihostsyncmanager-setclrsyncmanager-method.md)|Sets the [ICLRSyncManager](iclrsyncmanager-interface.md) instance to associate with the current `IHostSyncManager` instance.| - -## Remarks - - The CLR discovers the host's implementation of `IHostSyncManager` by calling the [IHostControl::GetHostManager](ihostcontrol-gethostmanager-method.md) method with an `IID` of IID_IHostSyncManager. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods that allow the common language runtime (CLR) to create synchronization primitives by calling the host instead of using the Win32 synchronization functions. + +## Methods + +|Method|Description| +|------------|-----------------| +|[CreateAutoEvent Method](ihostsyncmanager-createautoevent-method.md)|Creates an auto-reset event object.| +|[CreateCrst Method](ihostsyncmanager-createcrst-method.md)|Creates a critical section object for synchronization.| +|[CreateCrstWithSpinCount Method](ihostsyncmanager-createcrstwithspincount-method.md)|Creates a critical section object with spin count for synchronization.| +|[CreateManualEvent Method](ihostsyncmanager-createmanualevent-method.md)|Creates a manual-reset event object.| +|[CreateMonitorEvent Method](ihostsyncmanager-createmonitorevent-method.md)|Creates a monitored auto-reset event object.| +|[CreateRWLockReaderEvent Method](ihostsyncmanager-createrwlockreaderevent-method.md)|Creates a manual-reset event object for the implementation of a reader lock.| +|[CreateRWLockWriterEvent Method](ihostsyncmanager-createrwlockwriterevent-method.md)|Creates an auto-reset event object for the implementation of a writer lock.| +|[CreateSemaphore Method](ihostsyncmanager-createsemaphore-method.md)|Creates an [IHostSemaphore](ihostsemaphore-interface.md) object for the CLR to use as a semaphore for wait events.| +|[SetCLRSyncManager Method](ihostsyncmanager-setclrsyncmanager-method.md)|Sets the [ICLRSyncManager](iclrsyncmanager-interface.md) instance to associate with the current `IHostSyncManager` instance.| + +## Remarks + + The CLR discovers the host's implementation of `IHostSyncManager` by calling the [IHostControl::GetHostManager](ihostcontrol-gethostmanager-method.md) method with an `IID` of IID_IHostSyncManager. + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md b/docs/core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md index 4ecc6d59bad1f..a1a922c2c86ce 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md +++ b/docs/core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md @@ -2,63 +2,62 @@ description: "Learn more about: IHostSyncManager::SetCLRSyncManager Method" title: "IHostSyncManager::SetCLRSyncManager Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSyncManager.SetCLRSyncManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSyncManager::SetCLRSyncManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostSyncManager::SetCLRSyncManager method [.NET Framework hosting]" - "SetCLRSyncManager method [.NET Framework hosting]" -ms.assetid: 2b8bbe76-a45d-4989-bacb-11df42f8798c -topic_type: +topic_type: - "apiref" --- # IHostSyncManager::SetCLRSyncManager Method -Sets the [ICLRSyncManager](iclrsyncmanager-interface.md) instance to associate with the current [IHostSyncManager](ihostsyncmanager-interface.md) instance. - -## Syntax - -```cpp -HRESULT SetCLRSyncManager ( - [in] ICLRSyncManager *pManager -); -``` - -## Parameters - - `pManager` - [in] A pointer to an `ICLRSyncManager` instance supplied by the common language runtime (CLR). - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetCLRSyncManager` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - To facilitate communication between the host and the CLR, hosting interfaces generally come in pairs. One member of the pair is implemented by the host, and the other member is implemented by the CLR. As a host-side implementation, the `IHostSyncManager` interface corresponds to the `ICLRSyncManager` interface implemented by the CLR. The CLR calls `SetCLRSyncManager` to supply an `ICLRSyncManager` instance for the host to associate with the current `IHostSyncManager` instance. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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 [ICLRSyncManager](iclrsyncmanager-interface.md) instance to associate with the current [IHostSyncManager](ihostsyncmanager-interface.md) instance. + +## Syntax + +```cpp +HRESULT SetCLRSyncManager ( + [in] ICLRSyncManager *pManager +); +``` + +## Parameters + + `pManager` + [in] A pointer to an `ICLRSyncManager` instance supplied by the common language runtime (CLR). + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetCLRSyncManager` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + To facilitate communication between the host and the CLR, hosting interfaces generally come in pairs. One member of the pair is implemented by the host, and the other member is implemented by the CLR. As a host-side implementation, the `IHostSyncManager` interface corresponds to the `ICLRSyncManager` interface implemented by the CLR. The CLR calls `SetCLRSyncManager` to supply an `ICLRSyncManager` instance for the host to associate with the current `IHostSyncManager` instance. + +## 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 2.0 + ## See also - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttask-alert-method.md b/docs/core/unmanaged-api/hosting/ihosttask-alert-method.md index 82d3e7c34c0b7..d56d928476316 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-alert-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-alert-method.md @@ -2,59 +2,58 @@ description: "Learn more about: IHostTask::Alert Method" title: "IHostTask::Alert Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTask.Alert" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTask::Alert" -helpviewer_keywords: +helpviewer_keywords: - "IHostTask::Alert method [.NET Framework hosting]" - "Alert method, IHostTask interface [.NET Framework hosting]" -ms.assetid: 5245d4b5-b6c3-48df-9cb9-8caf059f43fb -topic_type: +topic_type: - "apiref" --- # IHostTask::Alert Method -Requests that the host wake the task represented by the current [IHostTask](ihosttask-interface.md) instance, so the task can be aborted. - -## Syntax - -```cpp -HRESULT Alert (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR calls the `Alert` method when is called from user code, or when the associated with the current shuts down. The host must return immediately, because the call is made asynchronously. If the host cannot alert the task immediately, it must wake up the next time it enters a state in which it can be alerted. - +Requests that the host wake the task represented by the current [IHostTask](ihosttask-interface.md) instance, so the task can be aborted. + +## Syntax + +```cpp +HRESULT Alert (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR calls the `Alert` method when is called from user code, or when the associated with the current shuts down. The host must return immediately, because the call is made asynchronously. If the host cannot alert the task immediately, it must wake up the next time it enters a state in which it can be alerted. + > [!NOTE] -> `Alert` affects only those tasks to which the runtime has passed a [WAIT_OPTION](wait-option-enumeration.md) value of WAIT_ALERTABLE to methods such as [Join](ihosttask-join-method.md). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> `Alert` affects only those tasks to which the runtime has passed a [WAIT_OPTION](wait-option-enumeration.md) value of WAIT_ALERTABLE to methods such as [Join](ihosttask-join-method.md). + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md b/docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md index 2f3a72081d6de..3a7479d1fda36 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md @@ -2,63 +2,62 @@ description: "Learn more about: IHostTask::GetPriority Method" title: "IHostTask::GetPriority Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTask.GetPriority" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTask::GetPriority" -helpviewer_keywords: +helpviewer_keywords: - "GetPriority method [.NET Framework hosting]" - "IHostTask::GetPriority method [.NET Framework hosting]" -ms.assetid: 4b463cd6-77c1-4f9a-8518-346ad8fc4b70 -topic_type: +topic_type: - "apiref" --- # IHostTask::GetPriority Method -Gets the thread priority level of the task represented by the current [IHostTask](ihosttask-interface.md) instance. - -## Syntax - -```cpp -HRESULT GetPriority ( - [out] int *pPriority -); -``` - -## Parameters - - `pPriority` - [out] A pointer to an integer that indicates the thread priority level of the task represented by the current `IHostTask` instance. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetPriority` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - Thread priority level values are defined by the Win32 `SetThreadPriority` function. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the thread priority level of the task represented by the current [IHostTask](ihosttask-interface.md) instance. + +## Syntax + +```cpp +HRESULT GetPriority ( + [out] int *pPriority +); +``` + +## Parameters + + `pPriority` + [out] A pointer to an integer that indicates the thread priority level of the task represented by the current `IHostTask` instance. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetPriority` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + Thread priority level values are defined by the Win32 `SetThreadPriority` function. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttask-interface.md b/docs/core/unmanaged-api/hosting/ihosttask-interface.md index 93a7308a61149..05bdc62ad4096 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-interface.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-interface.md @@ -2,49 +2,48 @@ description: "Learn more about: IHostTask Interface" title: "IHostTask Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTask" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTask" -helpviewer_keywords: +helpviewer_keywords: - "IHostTask interface [.NET Framework hosting]" -ms.assetid: a71dbbd5-64b8-47eb-9f03-8e8c85fbe2bc -topic_type: +topic_type: - "apiref" --- # IHostTask Interface -Provides methods that allow the common language runtime (CLR) to communicate with the host to manage tasks. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Alert Method](ihosttask-alert-method.md)|Requests that the host wake the task represented by the current `IHostTask` instance, so the task can be aborted.| -|[GetPriority Method](ihosttask-getpriority-method.md)|Gets the thread priority level of the task represented by the current `IHostTask` instance.| -|[Join Method](ihosttask-join-method.md)|Blocks the calling task until the task represented by the current `IHostTask` instance completes, the specified time interval elapses, or [IHostTask::Alert](ihosttask-alert-method.md) is called.| -|[SetCLRTask Method](ihosttask-setclrtask-method.md)|Associates an [ICLRTask Interface](iclrtask-interface.md) instance with the current `IHostTask` instance.| -|[SetPriority Method](ihosttask-setpriority-method.md)|Requests that the host adjust the thread priority level for the task represented by the current `IHostTask` instance.| -|[Start Method](ihosttask-start-method.md)|Requests that the host move the task represented by the current `IHostTask` instance from a suspended state to a live state, in which code can be executed.| - -## Remarks - - The CLR calls methods defined by `IHostTask` to start a task, set its thread priority level, and so on. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods that allow the common language runtime (CLR) to communicate with the host to manage tasks. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Alert Method](ihosttask-alert-method.md)|Requests that the host wake the task represented by the current `IHostTask` instance, so the task can be aborted.| +|[GetPriority Method](ihosttask-getpriority-method.md)|Gets the thread priority level of the task represented by the current `IHostTask` instance.| +|[Join Method](ihosttask-join-method.md)|Blocks the calling task until the task represented by the current `IHostTask` instance completes, the specified time interval elapses, or [IHostTask::Alert](ihosttask-alert-method.md) is called.| +|[SetCLRTask Method](ihosttask-setclrtask-method.md)|Associates an [ICLRTask Interface](iclrtask-interface.md) instance with the current `IHostTask` instance.| +|[SetPriority Method](ihosttask-setpriority-method.md)|Requests that the host adjust the thread priority level for the task represented by the current `IHostTask` instance.| +|[Start Method](ihosttask-start-method.md)|Requests that the host move the task represented by the current `IHostTask` instance from a suspended state to a live state, in which code can be executed.| + +## Remarks + + The CLR calls methods defined by `IHostTask` to start a task, set its thread priority level, and so on. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttask-join-method.md b/docs/core/unmanaged-api/hosting/ihosttask-join-method.md index 374e63ef755fb..acdb60924ad46 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-join-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-join-method.md @@ -2,63 +2,62 @@ description: "Learn more about: IHostTask::Join Method" title: "IHostTask::Join Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTask.Join" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTask::Join" -helpviewer_keywords: +helpviewer_keywords: - "IHostTask::Join method [.NET Framework hosting]" - "Join method, IHostTask interface [.NET Framework hosting]" -ms.assetid: 2cffcc52-19e0-4ced-a440-fc7375078ac9 -topic_type: +topic_type: - "apiref" --- # IHostTask::Join Method -Blocks the calling task until the task represented by the current [IHostTask](ihosttask-interface.md) instance completes, the specified time interval elapses, or [IHostTask::Alert](ihosttask-alert-method.md) is called. - -## Syntax - -```cpp -HRESULT Join ( - [in] DWORD milliseconds, - [in] DWORD option -); -``` - -## Parameters +Blocks the calling task until the task represented by the current [IHostTask](ihosttask-interface.md) instance completes, the specified time interval elapses, or [IHostTask::Alert](ihosttask-alert-method.md) is called. - `milliseconds` - [in] The time interval, in milliseconds, to wait for the task to terminate. If this interval elapses before the task terminates, the calling task unblocks. - - `option` - [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values. A value of WAIT_ALERTABLE instructs the host to wake the task if `Alert` is called before `milliseconds` elapses. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Join` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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, or the current `IHostTask` instance is not associated with a task.| -|E_FAIL|An unknown catastrophic failure occurred. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Requirements +## Syntax + +```cpp +HRESULT Join ( + [in] DWORD milliseconds, + [in] DWORD option +); +``` + +## Parameters + + `milliseconds` + [in] The time interval, in milliseconds, to wait for the task to terminate. If this interval elapses before the task terminates, the calling task unblocks. + + `option` + [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values. A value of WAIT_ALERTABLE instructs the host to wake the task if `Alert` is called before `milliseconds` elapses. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Join` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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, or the current `IHostTask` instance is not associated with a task.| +|E_FAIL|An unknown catastrophic failure occurred. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 2.0 - **Platforms:** See [System Requirements](../../../framework/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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md b/docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md index 1c0b9b5120d91..6b12ccf38b035 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md @@ -2,63 +2,62 @@ description: "Learn more about: IHostTask::SetCLRTask Method" title: "IHostTask::SetCLRTask Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTask.SetCLRTask" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTask::SetCLRTask" -helpviewer_keywords: +helpviewer_keywords: - "SetCLRTask method [.NET Framework hosting]" - "IHostTask::SetCLRTask method [.NET Framework hosting]" -ms.assetid: e9d39c80-41a1-49e7-bb5e-ea3433bfb5d7 -topic_type: +topic_type: - "apiref" --- # IHostTask::SetCLRTask Method -Associates an `ICLRTask` instance with the current [IHostTask](ihosttask-interface.md) instance. - -## Syntax - -```cpp -HRESULT SetCLRTask ( - [in] ICLRTask *pCLRTask -); -``` - -## Parameters - - `pCLRTask` - [in] An interface pointer to the `ICLRTask` instance to be associated with the current `IHostTask` instance. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetCLRTask` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR calls `SetCLRTask` to associate an `ICLRTask` instance with the current `IHostTask` instance, which was created by a call to [IHostTaskManager::CreateTask](ihosttaskmanager-createtask-method.md). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Associates an `ICLRTask` instance with the current [IHostTask](ihosttask-interface.md) instance. + +## Syntax + +```cpp +HRESULT SetCLRTask ( + [in] ICLRTask *pCLRTask +); +``` + +## Parameters + + `pCLRTask` + [in] An interface pointer to the `ICLRTask` instance to be associated with the current `IHostTask` instance. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetCLRTask` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR calls `SetCLRTask` to associate an `ICLRTask` instance with the current `IHostTask` instance, which was created by a call to [IHostTaskManager::CreateTask](ihosttaskmanager-createtask-method.md). + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md b/docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md index 98fa504ab5fe1..41d4a56bef399 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md @@ -2,84 +2,83 @@ description: "Learn more about: IHostTask::SetPriority Method" title: "IHostTask::SetPriority Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTask.SetPriority" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTask::SetPriority" -helpviewer_keywords: +helpviewer_keywords: - "IHostTask::SetPriority method [.NET Framework hosting]" - "SetPriority method [.NET Framework hosting]" -ms.assetid: cd8c379b-c7a0-434f-8e23-899bd26be75d -topic_type: +topic_type: - "apiref" --- # IHostTask::SetPriority Method -Requests that the host adjust the thread priority level for the task represented by the current [IHostTask](ihosttask-interface.md) instance. - -## Syntax - -```cpp -HRESULT SetPriority ( - [in] int newPriority -); -``` - -## Parameters - - `newPriority` - [in] An integer that represents the requested thread priority value for the task represented by the current `IHostTask` instance. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetPriority` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - Threads are granted processing time using a round-robin system that is partly based on a thread's priority level. `SetPriority` allows the CLR to set that thread priority level for the current task. The following `newPriority` values are supported. - -- THREAD_PRIORITY_ABOVE_NORMAL - -- THREAD_PRIORITY_BELOW_NORMAL - -- THREAD_PRIORITY_HIGHEST - -- THREAD_PRIORITY_IDLE - -- THREAD_PRIORITY_LOWEST - -- THREAD_PRIORITY_NORMAL - -- THREAD_PRIORITY_TIME_CRITICAL - - The CLR calls `SetPriority` when the value of the is modified by user code. A host can define its own algorithms for thread priority assignment, and is free to ignore this request. - +Requests that the host adjust the thread priority level for the task represented by the current [IHostTask](ihosttask-interface.md) instance. + +## Syntax + +```cpp +HRESULT SetPriority ( + [in] int newPriority +); +``` + +## Parameters + + `newPriority` + [in] An integer that represents the requested thread priority value for the task represented by the current `IHostTask` instance. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetPriority` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + Threads are granted processing time using a round-robin system that is partly based on a thread's priority level. `SetPriority` allows the CLR to set that thread priority level for the current task. The following `newPriority` values are supported. + +- THREAD_PRIORITY_ABOVE_NORMAL + +- THREAD_PRIORITY_BELOW_NORMAL + +- THREAD_PRIORITY_HIGHEST + +- THREAD_PRIORITY_IDLE + +- THREAD_PRIORITY_LOWEST + +- THREAD_PRIORITY_NORMAL + +- THREAD_PRIORITY_TIME_CRITICAL + + The CLR calls `SetPriority` when the value of the is modified by user code. A host can define its own algorithms for thread priority assignment, and is free to ignore this request. + > [!NOTE] -> `SetPriority` does not report whether the thread priority level was changed. Call [IHostTask::GetPriority](ihosttask-getpriority-method.md) to determine the value of the task's thread priority level. - - Thread priority level values are defined by the Win32 `SetThreadPriority` function. For more information about thread priority, see the Windows Platform documentation. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> `SetPriority` does not report whether the thread priority level was changed. Call [IHostTask::GetPriority](ihosttask-getpriority-method.md) to determine the value of the task's thread priority level. + + Thread priority level values are defined by the Win32 `SetThreadPriority` function. For more information about thread priority, see the Windows Platform documentation. + +## 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 2.0 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/ihosttask-start-method.md b/docs/core/unmanaged-api/hosting/ihosttask-start-method.md index bf70ae371a8b3..58e14371ba4ee 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-start-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttask-start-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IHostTask::Start Method" title: "IHostTask::Start Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTask.Start" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTask::Start" -helpviewer_keywords: +helpviewer_keywords: - "IHostTask::Start method [.NET Framework hosting]" - "Start method, IHostTask interface [.NET Framework hosting]" -ms.assetid: b18742b0-d8c4-401c-ae89-e6eccdaa81d0 -topic_type: +topic_type: - "apiref" --- # IHostTask::Start Method -Requests that the host move the task represented by the current [IHostTask](ihosttask-interface.md) instance from a suspended to a live state, in which code can be executed. - -## Syntax - -```cpp -HRESULT Start (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|Start returned successfully.| -|E_FAIL|An unknown catastrophic failure occurred. When a method returns E_FAIL, the common language runtime (CLR) is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `Start` always returns an HRESULT value of S_OK, except in cases where a catastrophic failure has occurred. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Requests that the host move the task represented by the current [IHostTask](ihosttask-interface.md) instance from a suspended to a live state, in which code can be executed. + +## Syntax + +```cpp +HRESULT Start (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|Start returned successfully.| +|E_FAIL|An unknown catastrophic failure occurred. When a method returns E_FAIL, the common language runtime (CLR) is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `Start` always returns an HRESULT value of S_OK, except in cases where a catastrophic failure has occurred. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md index ed60995564b1c..0a636880a2da9 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md @@ -2,57 +2,56 @@ description: "Learn more about: IHostTaskManager::BeginDelayAbort Method" title: "IHostTaskManager::BeginDelayAbort Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.BeginDelayAbort" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::BeginDelayAbort" -helpviewer_keywords: +helpviewer_keywords: - "BeginDelayAbort method [.NET Framework hosting]" - "IHostTaskManager::BeginDelayAbort method [.NET Framework hosting]" -ms.assetid: 75f42a8b-ed68-4718-a030-a179cfba7d72 -topic_type: +topic_type: - "apiref" --- # IHostTaskManager::BeginDelayAbort Method -Notifies the host that managed code is entering a period in which the current task must not be aborted. - -## Syntax - -```cpp -HRESULT BeginDelayAbort (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`BeginDelayAbort` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_UNEXPECTED|`BeginDelayAbort` has already been called, but the corresponding call to [EndDelayAbort](ihosttaskmanager-enddelayabort-method.md) has not yet been received.| - -## Remarks - - The host must not abort the current task until `EndDelayAbort` is called. If another call to `BeginDelayAbort` is made without an intervening call to `EndDelayAbort`, the host should return E_UNEXPECTED from `BeginDelayAbort`, and should take no action. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Notifies the host that managed code is entering a period in which the current task must not be aborted. + +## Syntax + +```cpp +HRESULT BeginDelayAbort (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`BeginDelayAbort` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_UNEXPECTED|`BeginDelayAbort` has already been called, but the corresponding call to [EndDelayAbort](ihosttaskmanager-enddelayabort-method.md) has not yet been received.| + +## Remarks + + The host must not abort the current task until `EndDelayAbort` is called. If another call to `BeginDelayAbort` is made without an intervening call to `EndDelayAbort`, the host should return E_UNEXPECTED from `BeginDelayAbort`, and should take no action. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md index d5b947cbe2c7f..369e821d0a771 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IHostTaskManager::BeginThreadAffinity Method" title: "IHostTaskManager::BeginThreadAffinity Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.BeginThreadAffinity" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::BeginThreadAffinity" -helpviewer_keywords: +helpviewer_keywords: - "IHostTaskManager::BeginThreadAffinity method [.NET Framework hosting]" - "BeginThreadAffinity method [.NET Framework hosting]" -ms.assetid: fea3ab88-ce41-4c5a-847b-bb78cd748da6 -topic_type: +topic_type: - "apiref" --- # IHostTaskManager::BeginThreadAffinity Method -Notifies the host that managed code is entering a period in which the current task must not be moved to another operating system thread. - -## Syntax - -```cpp -HRESULT BeginThreadAffinity (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`BeginThreadAffinity` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR typically calls `IHostTaskManager::BeginThreadAffinity` in the context of a call to . The current task must not be rescheduled until a corresponding call is made to [IHostTaskManager::EndThreadAffinity](ihosttaskmanager-endthreadaffinity-method.md). Tasks can be switched out, but when they are switched back in, they must be assigned to the same operating system thread from which they were switched out. Nested calls to `BeginThreadAffinity` have no effect, because the call refers to the current task. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Notifies the host that managed code is entering a period in which the current task must not be moved to another operating system thread. + +## Syntax + +```cpp +HRESULT BeginThreadAffinity (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`BeginThreadAffinity` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR typically calls `IHostTaskManager::BeginThreadAffinity` in the context of a call to . The current task must not be rescheduled until a corresponding call is made to [IHostTaskManager::EndThreadAffinity](ihosttaskmanager-endthreadaffinity-method.md). Tasks can be switched out, but when they are switched back in, they must be assigned to the same operating system thread from which they were switched out. Nested calls to `BeginThreadAffinity` have no effect, because the call refers to the current task. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md index cc12189060d81..a31581e23b960 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md @@ -2,69 +2,68 @@ description: "Learn more about: IHostTaskManager::CallNeedsHostHook Method" title: "IHostTaskManager::CallNeedsHostHook Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.CallNeedsHostHook" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::CallNeedsHostHook" -helpviewer_keywords: +helpviewer_keywords: - "CallNeedsHostHook method [.NET Framework hosting]" - "IHostTaskManager::CallNeedsHostHook method [.NET Framework hosting]" -ms.assetid: b60f1f59-9825-4b57-961f-d2979518e6a7 -topic_type: +topic_type: - "apiref" --- # IHostTaskManager::CallNeedsHostHook Method -Enables the host to specify whether the common language runtime (CLR) can inline the specified call to an unmanaged function. - -## Syntax - -```cpp -HRESULT CallNeedsHostHook ( +Enables the host to specify whether the common language runtime (CLR) can inline the specified call to an unmanaged function. + +## Syntax + +```cpp +HRESULT CallNeedsHostHook ( [in] SIZE_T target, - [out] BOOL *pbCallNeedsHostHook -); -``` - -## Parameters - - `target` - [in] The address within the mapped portable executable (PE) file of the unmanaged function that is to be called. - - `pbCallNeedsHostHook` - [out] A pointer to a Boolean value that indicates whether the host requires the call to be hooked. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CallNeedsHostHook` 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 has occurred. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - To help optimize code execution, the CLR performs an analysis of each platform invoke call during compilation to determine whether the call can be inlined. `CallNeedsHostHook` enables the host to override that decision by requiring that a call to an unmanaged function be hooked. If the host requires a hook, the runtime does not inline the call. - - The host typically would require a hook where it must adjust a floating-point state, or upon receiving notification that a call is entering a state where the host cannot track the runtime's requests for memory or any locks taken. When the host requires that the call be hooked, the runtime notifies the host of transitions to and from managed code by using calls to [EnterRuntime](ihosttaskmanager-enterruntime-method.md), [LeaveRuntime](ihosttaskmanager-leaveruntime-method.md), [ReverseEnterRuntime](ihosttaskmanager-reverseenterruntime-method.md), and [ReverseLeaveRuntime](ihosttaskmanager-reverseleaveruntime-method.md). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - + [out] BOOL *pbCallNeedsHostHook +); +``` + +## Parameters + + `target` + [in] The address within the mapped portable executable (PE) file of the unmanaged function that is to be called. + + `pbCallNeedsHostHook` + [out] A pointer to a Boolean value that indicates whether the host requires the call to be hooked. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CallNeedsHostHook` 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 has occurred. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + To help optimize code execution, the CLR performs an analysis of each platform invoke call during compilation to determine whether the call can be inlined. `CallNeedsHostHook` enables the host to override that decision by requiring that a call to an unmanaged function be hooked. If the host requires a hook, the runtime does not inline the call. + + The host typically would require a hook where it must adjust a floating-point state, or upon receiving notification that a call is entering a state where the host cannot track the runtime's requests for memory or any locks taken. When the host requires that the call be hooked, the runtime notifies the host of transitions to and from managed code by using calls to [EnterRuntime](ihosttaskmanager-enterruntime-method.md), [LeaveRuntime](ihosttaskmanager-leaveruntime-method.md), [ReverseEnterRuntime](ihosttaskmanager-reverseenterruntime-method.md), and [ReverseLeaveRuntime](ihosttaskmanager-reverseleaveruntime-method.md). + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md index dad9cf5450f62..e7b855ad35450 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md @@ -2,76 +2,75 @@ description: "Learn more about: IHostTaskManager::CreateTask Method" title: "IHostTaskManager::CreateTask Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.CreateTask" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::CreateTask" -helpviewer_keywords: +helpviewer_keywords: - "CreateTask method, IHostTaskManager interface [.NET Framework hosting]" - "IHostTaskManager::CreateTask method [.NET Framework hosting]" -ms.assetid: a6f8ad36-61e1-42b0-9db2-add575646d18 -topic_type: +topic_type: - "apiref" --- # IHostTaskManager::CreateTask Method -Requests that the host create a new task. - -## Syntax - -```cpp -HRESULT CreateTask ( +Requests that the host create a new task. + +## Syntax + +```cpp +HRESULT CreateTask ( [in] DWORD stacksize, - [in] LPTHREAD_START_ROUTINE pStartAddress, - [in] PVOID pParameter, - [out] IHostTask **ppTask -); -``` - -## Parameters - - `stacksize` - [in] The requested size, in bytes, of the requested stack, or 0 (zero) for the default size. - - `pStartAddress` - [in] A pointer to the function the task is to execute. - - `pParameter` - [in] A pointer to the user data to be passed to the function, or null if the function takes no parameters. - - `ppTask` - [out] A pointer to the address of an [IHostTask](ihosttask-interface.md) instance created by the host, or null if the task cannot be created. The task remains in a suspended state until it is explicitly started by a call to [IHostTask::Start](ihosttask-start-method.md). - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateTask` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to create the requested task.| - -## Remarks - - The CLR calls `CreateTask` to request that the host create a new task. The host returns an interface pointer to an `IHostTask` instance. The returned task must remain suspended until it is explicitly started by a call to `IHostTask::Start`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - + [in] LPTHREAD_START_ROUTINE pStartAddress, + [in] PVOID pParameter, + [out] IHostTask **ppTask +); +``` + +## Parameters + + `stacksize` + [in] The requested size, in bytes, of the requested stack, or 0 (zero) for the default size. + + `pStartAddress` + [in] A pointer to the function the task is to execute. + + `pParameter` + [in] A pointer to the user data to be passed to the function, or null if the function takes no parameters. + + `ppTask` + [out] A pointer to the address of an [IHostTask](ihosttask-interface.md) instance created by the host, or null if the task cannot be created. The task remains in a suspended state until it is explicitly started by a call to [IHostTask::Start](ihosttask-start-method.md). + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateTask` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to create the requested task.| + +## Remarks + + The CLR calls `CreateTask` to request that the host create a new task. The host returns an interface pointer to an `IHostTask` instance. The returned task must remain suspended until it is explicitly started by a call to `IHostTask::Start`. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md index 19636f3c1c560..700e0fc403226 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md @@ -2,57 +2,56 @@ description: "Learn more about: IHostTaskManager::EndDelayAbort Method" title: "IHostTaskManager::EndDelayAbort Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.EndDelayAbort" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::EndDelayAbort" -helpviewer_keywords: +helpviewer_keywords: - "EndDelayAbort method [.NET Framework hosting]" - "IHostTaskManager::EndDelayAbort method [.NET Framework hosting]" -ms.assetid: 6e02facb-2504-4356-9af5-0cee1f8436a7 -topic_type: +topic_type: - "apiref" --- # IHostTaskManager::EndDelayAbort Method -Notifies the host that managed code is exiting the period in which the current task must not be aborted, following an earlier call to [IHostTaskManager::BeginDelayAbort](ihosttaskmanager-begindelayabort-method.md). - -## Syntax - -```cpp -HRESULT EndDelayAbort (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`EndDelayAbort` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_UNEXPECTED|`EndDelayAbort` was called without a corresponding call to `BeginDelayAbort`.| - -## Remarks - - The CLR makes a corresponding call to `BeginDelayAbort` on the current task before calling `EndDelayAbort`. In the absence of such a corresponding call, the host's implementation of [IHostTaskManager](ihosttaskmanager-interface.md) should return E_UNEXPECTED from `EndDelayAbort`, and should take no action. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Notifies the host that managed code is exiting the period in which the current task must not be aborted, following an earlier call to [IHostTaskManager::BeginDelayAbort](ihosttaskmanager-begindelayabort-method.md). + +## Syntax + +```cpp +HRESULT EndDelayAbort (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`EndDelayAbort` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_UNEXPECTED|`EndDelayAbort` was called without a corresponding call to `BeginDelayAbort`.| + +## Remarks + + The CLR makes a corresponding call to `BeginDelayAbort` on the current task before calling `EndDelayAbort`. In the absence of such a corresponding call, the host's implementation of [IHostTaskManager](ihosttaskmanager-interface.md) should return E_UNEXPECTED from `EndDelayAbort`, and should take no action. + +## 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 2.0 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md index 86e740b6b92f1..a92faff6a3bff 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md @@ -2,57 +2,56 @@ description: "Learn more about: IHostTaskManager::EndThreadAffinity Method" title: "IHostTaskManager::EndThreadAffinity Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.EndThreadAffinity" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::EndThreadAffinity" -helpviewer_keywords: +helpviewer_keywords: - "EndThreadAffinity method [.NET Framework hosting]" - "IHostTaskManager::EndThreadAffinity method [.NET Framework hosting]" -ms.assetid: 7738a904-0cd7-4fde-a3eb-2323a5533157 -topic_type: +topic_type: - "apiref" --- # IHostTaskManager::EndThreadAffinity Method -Notifies the host that managed code is exiting the period in which the current task must not be moved to another operating system thread, following an earlier call to [IHostTaskManager::BeginThreadAffinity](ihosttaskmanager-beginthreadaffinity-method.md). - -## Syntax - -```cpp -HRESULT EndThreadAffinity (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`EndThreadAffinity` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_UNEXPECTED|`EndThreadAffinity` was called without an earlier corresponding call to `BeginThreadAffinity`.| - -## Remarks - - The CLR makes a corresponding call to `BeginThreadAffinity` on the current task before calling `EndThreadAffinity`. In the absence of such a corresponding call, the host's implementation of [IHostTaskManager](ihosttaskmanager-interface.md) should return E_UNEXPECTED, and take no action. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Notifies the host that managed code is exiting the period in which the current task must not be moved to another operating system thread, following an earlier call to [IHostTaskManager::BeginThreadAffinity](ihosttaskmanager-beginthreadaffinity-method.md). + +## Syntax + +```cpp +HRESULT EndThreadAffinity (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`EndThreadAffinity` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_UNEXPECTED|`EndThreadAffinity` was called without an earlier corresponding call to `BeginThreadAffinity`.| + +## Remarks + + The CLR makes a corresponding call to `BeginThreadAffinity` on the current task before calling `EndThreadAffinity`. In the absence of such a corresponding call, the host's implementation of [IHostTaskManager](ihosttaskmanager-interface.md) should return E_UNEXPECTED, and take no action. + +## 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 2.0 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md index 1aaa22971ec69..f738161d652fa 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md @@ -2,60 +2,59 @@ description: "Learn more about: IHostTaskManager::EnterRuntime Method" title: "IHostTaskManager::EnterRuntime Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.EnterRuntime" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::EnterRuntime" -helpviewer_keywords: +helpviewer_keywords: - "IHostTaskManager::EnterRuntime method [.NET Framework hosting]" - "EnterRuntime method [.NET Framework hosting]" -ms.assetid: 1aa7a4b1-636a-4f5e-b834-b406d72f7120 -topic_type: +topic_type: - "apiref" --- # IHostTaskManager::EnterRuntime Method -Notifies the host that a call to an unmanaged method, such as a platform invoke method, is returning execution control to the common language runtime (CLR). - -## Syntax - -```cpp -HRESULT EnterRuntime (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`EnterRuntime` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to complete the requested allocation.| - -## Remarks +Notifies the host that a call to an unmanaged method, such as a platform invoke method, is returning execution control to the common language runtime (CLR). + +## Syntax + +```cpp +HRESULT EnterRuntime (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`EnterRuntime` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to complete the requested allocation.| + +## Remarks + + `EnterRuntime` is called to notify the host that an unmanaged function, for which an earlier call to the [LeaveRuntime](ihosttaskmanager-leaveruntime-method.md) method was made, has finished executing, and is returning execution control to the runtime. - `EnterRuntime` is called to notify the host that an unmanaged function, for which an earlier call to the [LeaveRuntime](ihosttaskmanager-leaveruntime-method.md) method was made, has finished executing, and is returning execution control to the runtime. - > [!NOTE] -> [ReverseEnterRuntime](ihosttaskmanager-reverseenterruntime-method.md) is called to notify the host that an unmanaged function, for which an earlier call to `LeaveRuntime` was made, is making a call into managed code. - -## Requirements +> [ReverseEnterRuntime](ihosttaskmanager-reverseenterruntime-method.md) is called to notify the host that an unmanaged function, for which an earlier call to `LeaveRuntime` was made, is making a call into managed code. + +## 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 2.0 - **Platforms:** See [System Requirements](../../../framework/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 - [Advanced COM Interoperability](/previous-versions/dotnet/netframework-4.0/bd9cdfyx(v=vs.100)) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md index e4a0018181352..152645e53c6a7 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IHostTaskManager::GetCurrentTask Method" title: "IHostTaskManager::GetCurrentTask Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.GetCurrentTask" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::GetCurrentTask" -helpviewer_keywords: +helpviewer_keywords: - "GetCurrentTask method, IHostTaskManager interface [.NET Framework hosting]" - "IHostTaskManager::GetCurrentTask method [.NET Framework hosting]" -ms.assetid: f17bca49-90bd-4dee-a5e1-b9a57ea46f85 -topic_type: +topic_type: - "apiref" --- # IHostTaskManager::GetCurrentTask Method -Gets an interface pointer to the task that is currently executing on the operating system thread from which this call is made. - -## Syntax - -```cpp -HRESULT GetCurrentTask ( - [out] IHostTask **pTask -); -``` - -## Parameters - - `pTask` - [out] A pointer to the address of an [IHostTask](ihosttask-interface.md) instance that represents the currently executing task, or null, if no task is currently executing. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetCurrentTask` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|HOST_E_INVALIDOPERATION|`GetCurrentTask` was called on an operating system thread outside the control of the host.| - -## Remarks - - The host can also set the `pTask` parameter to null to prevent a task that it did not initiate from entering the CLR. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets an interface pointer to the task that is currently executing on the operating system thread from which this call is made. + +## Syntax + +```cpp +HRESULT GetCurrentTask ( + [out] IHostTask **pTask +); +``` + +## Parameters + + `pTask` + [out] A pointer to the address of an [IHostTask](ihosttask-interface.md) instance that represents the currently executing task, or null, if no task is currently executing. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetCurrentTask` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|HOST_E_INVALIDOPERATION|`GetCurrentTask` was called on an operating system thread outside the control of the host.| + +## Remarks + + The host can also set the `pTask` parameter to null to prevent a task that it did not initiate from entering the CLR. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md index 987e65df512a4..153d75aea54db 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md @@ -2,48 +2,47 @@ description: "Learn more about: IHostTaskManager::GetStackGuarantee Method" title: "IHostTaskManager::GetStackGuarantee Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.GetStackGuarantee" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::GetStackGuarantee" -helpviewer_keywords: +helpviewer_keywords: - "GetStackGuarantee method [.NET Framework hosting]" - "IHostTaskManager::GetStackGuarantee method [.NET Framework hosting]" -ms.assetid: 8176d732-c25c-4520-811d-e3310f339947 -topic_type: +topic_type: - "apiref" --- # IHostTaskManager::GetStackGuarantee Method -Gets the amount of stack space that is guaranteed to be available after a stack operation completes, but before the closing of a process. - -## Syntax - -```cpp -HRESULT GetStackGuarantee( - [out] ULONG *pGuarantee -); -``` - -## Parameters - - `pGuarantee` - [out] A pointer to the number of bytes that are available. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the amount of stack space that is guaranteed to be available after a stack operation completes, but before the closing of a process. + +## Syntax + +```cpp +HRESULT GetStackGuarantee( + [out] ULONG *pGuarantee +); +``` + +## Parameters + + `pGuarantee` + [out] A pointer to the number of bytes that are available. + +## 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 2.0 + ## See also - [IHostTaskManager Interface](ihosttaskmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md index b732cb0a69430..4956d31841e7b 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md @@ -2,61 +2,60 @@ description: "Learn more about: IHostTaskManager Interface" title: "IHostTaskManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostTaskManager interface [.NET Framework hosting]" -ms.assetid: 4a0b05b9-3ef1-4607-b7c8-bd4dd43647a0 -topic_type: +topic_type: - "apiref" --- # IHostTaskManager Interface -Provides methods that allow the common language runtime (CLR) to work with tasks through the host instead of using the standard operating system threading or fiber functions. - -## Methods - -|Method|Description| -|------------|-----------------| -|[BeginDelayAbort Method](ihosttaskmanager-begindelayabort-method.md)|Notifies the host that managed code is entering a period in which the current task must not be aborted.| -|[BeginThreadAffinity Method](ihosttaskmanager-beginthreadaffinity-method.md)|Notifies the host that managed code is entering a period in which the current task must not be moved to another operating system thread.| -|[CallNeedsHostHook Method](ihosttaskmanager-callneedshosthook-method.md)|Enables the host to specify whether the common language runtime can inline the specified call to an unmanaged function.| -|[CreateTask Method](ihosttaskmanager-createtask-method.md)|Requests that the host create a new task.| -|[EndDelayAbort Method](ihosttaskmanager-enddelayabort-method.md)|Notifies the host that managed code is exiting the period in which the current task must not be aborted, following an earlier call to `BeginDelayAbort`.| -|[EndThreadAffinity Method](ihosttaskmanager-endthreadaffinity-method.md)|Notifies the host that managed code is exiting the period in which the current task must not be moved to another operating system thread, following an earlier call to `BeginThreadAffinity`.| -|[EnterRuntime Method](ihosttaskmanager-enterruntime-method.md)|Notifies the host that a call to an unmanaged method, such as a platform invoke method, is returning execution control to the CLR.| -|[GetCurrentTask Method](ihosttaskmanager-getcurrenttask-method.md)|Gets an interface pointer to the task that is currently executing on the operating system thread from which this call is made.| -|[GetStackGuarantee Method](ihosttaskmanager-getstackguarantee-method.md)|Gets the amount of stack space that is guaranteed to be available after a stack operation completes, but before the closing of a process.| -|[LeaveRuntime Method](ihosttaskmanager-leaveruntime-method.md)|Notifies the host that managed code is about to make a call to an unmanaged function.| -|[ReverseEnterRuntime Method](ihosttaskmanager-reverseenterruntime-method.md)|Notifies the host that a call is being made into the common language runtime (CLR) from unmanaged code.| -|[ReverseLeaveRuntime Method](ihosttaskmanager-reverseleaveruntime-method.md)|Notifies the host that control is leaving the CLR and entering an unmanaged function that was, in turn, called from managed code.| -|[SetCLRTaskManager Method](ihosttaskmanager-setclrtaskmanager-method.md)|Provides the host with an interface pointer to an [ICLRTaskManager](iclrtaskmanager-interface.md) instance implemented by the CLR.| -|[SetLocale Method](ihosttaskmanager-setlocale-method.md)|Notifies the host that the CLR has changed the locale on the current task.| -|[SetStackGuarantee Method](ihosttaskmanager-setstackguarantee-method.md)|Reserved for internal use only.| -|[SetUILocale Method](ihosttaskmanager-setuilocale-method.md)|Notifies the host that the user interface locale has been changed on the current task.| -|[Sleep Method](ihosttaskmanager-sleep-method.md)|Notifies the host that the current task is going to sleep.| -|[SwitchToTask Method](ihosttaskmanager-switchtotask-method.md)|Notifies the host that it should switch out the current task.| - -## Remarks +Provides methods that allow the common language runtime (CLR) to work with tasks through the host instead of using the standard operating system threading or fiber functions. - `IHostTaskManager` allows the CLR to create and manage tasks, to provide hooks for the host to take action when control transfers from managed to unmanaged code and vice versa, and to specify certain actions the host can and cannot take during code execution. - -## Requirements +## Methods + +|Method|Description| +|------------|-----------------| +|[BeginDelayAbort Method](ihosttaskmanager-begindelayabort-method.md)|Notifies the host that managed code is entering a period in which the current task must not be aborted.| +|[BeginThreadAffinity Method](ihosttaskmanager-beginthreadaffinity-method.md)|Notifies the host that managed code is entering a period in which the current task must not be moved to another operating system thread.| +|[CallNeedsHostHook Method](ihosttaskmanager-callneedshosthook-method.md)|Enables the host to specify whether the common language runtime can inline the specified call to an unmanaged function.| +|[CreateTask Method](ihosttaskmanager-createtask-method.md)|Requests that the host create a new task.| +|[EndDelayAbort Method](ihosttaskmanager-enddelayabort-method.md)|Notifies the host that managed code is exiting the period in which the current task must not be aborted, following an earlier call to `BeginDelayAbort`.| +|[EndThreadAffinity Method](ihosttaskmanager-endthreadaffinity-method.md)|Notifies the host that managed code is exiting the period in which the current task must not be moved to another operating system thread, following an earlier call to `BeginThreadAffinity`.| +|[EnterRuntime Method](ihosttaskmanager-enterruntime-method.md)|Notifies the host that a call to an unmanaged method, such as a platform invoke method, is returning execution control to the CLR.| +|[GetCurrentTask Method](ihosttaskmanager-getcurrenttask-method.md)|Gets an interface pointer to the task that is currently executing on the operating system thread from which this call is made.| +|[GetStackGuarantee Method](ihosttaskmanager-getstackguarantee-method.md)|Gets the amount of stack space that is guaranteed to be available after a stack operation completes, but before the closing of a process.| +|[LeaveRuntime Method](ihosttaskmanager-leaveruntime-method.md)|Notifies the host that managed code is about to make a call to an unmanaged function.| +|[ReverseEnterRuntime Method](ihosttaskmanager-reverseenterruntime-method.md)|Notifies the host that a call is being made into the common language runtime (CLR) from unmanaged code.| +|[ReverseLeaveRuntime Method](ihosttaskmanager-reverseleaveruntime-method.md)|Notifies the host that control is leaving the CLR and entering an unmanaged function that was, in turn, called from managed code.| +|[SetCLRTaskManager Method](ihosttaskmanager-setclrtaskmanager-method.md)|Provides the host with an interface pointer to an [ICLRTaskManager](iclrtaskmanager-interface.md) instance implemented by the CLR.| +|[SetLocale Method](ihosttaskmanager-setlocale-method.md)|Notifies the host that the CLR has changed the locale on the current task.| +|[SetStackGuarantee Method](ihosttaskmanager-setstackguarantee-method.md)|Reserved for internal use only.| +|[SetUILocale Method](ihosttaskmanager-setuilocale-method.md)|Notifies the host that the user interface locale has been changed on the current task.| +|[Sleep Method](ihosttaskmanager-sleep-method.md)|Notifies the host that the current task is going to sleep.| +|[SwitchToTask Method](ihosttaskmanager-switchtotask-method.md)|Notifies the host that it should switch out the current task.| + +## Remarks + + `IHostTaskManager` allows the CLR to create and manage tasks, to provide hooks for the host to take action when control transfers from managed to unmanaged code and vice versa, and to specify certain actions the host can and cannot take during code execution. + +## 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 2.0 - **Platforms:** See [System Requirements](../../../framework/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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md index b1ffb45448007..126ccd6a0033f 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md @@ -2,76 +2,75 @@ description: "Learn more about: IHostTaskManager::LeaveRuntime Method" title: "IHostTaskManager::LeaveRuntime Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.LeaveRuntime" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::LeaveRuntime" -helpviewer_keywords: +helpviewer_keywords: - "IHostTaskManager::LeaveRuntime method [.NET Framework hosting]" - "LeaveRuntime method [.NET Framework hosting]" -ms.assetid: 43689cc4-e48e-46e5-a22d-bafd768b8759 -topic_type: +topic_type: - "apiref" --- # IHostTaskManager::LeaveRuntime Method -Notifies the host that the currently executing task is about to leave the common language runtime (CLR) and enter unmanaged code. - +Notifies the host that the currently executing task is about to leave the common language runtime (CLR) and enter unmanaged code. + > [!IMPORTANT] -> A corresponding call to [IHostTaskManager::EnterRuntime](ihosttaskmanager-enterruntime-method.md) notifies the host that the currently executing task is reentering managed code. - -## Syntax - -```cpp -HRESULT LeaveRuntime ( - [in] SIZE_T target -); -``` - -## Parameters - - `target` - [in] The address within the mapped portable executable file of the unmanaged function to be called. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`LeaveRuntime` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory is available to complete the requested allocation.| - -## Remarks - - Call sequences to and from unmanaged code can be nested. For example, the list below describes a hypothetical situation in which the sequence of calls to `LeaveRuntime`, [IHostTaskManager::ReverseEnterRuntime](ihosttaskmanager-reverseenterruntime-method.md), [IHostTaskManager::ReverseLeaveRuntime](ihosttaskmanager-reverseleaveruntime-method.md), and `IHostTaskManager::EnterRuntime` allows the host to identify the nested layers. - -|Action|Corresponding Method Call| -|------------|-------------------------------| -|A managed Visual Basic executable calls an unmanaged function written in C by using platform invoke.|`IHostTaskManager::LeaveRuntime`| -|The unmanaged C function calls a method in a managed DLL written in C#.|`IHostTaskManager::ReverseEnterRuntime`| -|The managed C# function calls another unmanaged function written in C, also using platform invoke.|`IHostTaskManager::LeaveRuntime`| -|The second unmanaged function returns execution to the C# function.|`IHostTaskManager::EnterRuntime`| -|The C# function returns execution to the first unmanaged function.|`IHostTaskManager::ReverseLeaveRuntime`| -|The first unmanaged function returns execution to the Visual Basic program.|`IHostTaskManager::EnterRuntime`| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> A corresponding call to [IHostTaskManager::EnterRuntime](ihosttaskmanager-enterruntime-method.md) notifies the host that the currently executing task is reentering managed code. + +## Syntax + +```cpp +HRESULT LeaveRuntime ( + [in] SIZE_T target +); +``` + +## Parameters + + `target` + [in] The address within the mapped portable executable file of the unmanaged function to be called. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`LeaveRuntime` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory is available to complete the requested allocation.| + +## Remarks + + Call sequences to and from unmanaged code can be nested. For example, the list below describes a hypothetical situation in which the sequence of calls to `LeaveRuntime`, [IHostTaskManager::ReverseEnterRuntime](ihosttaskmanager-reverseenterruntime-method.md), [IHostTaskManager::ReverseLeaveRuntime](ihosttaskmanager-reverseleaveruntime-method.md), and `IHostTaskManager::EnterRuntime` allows the host to identify the nested layers. + +|Action|Corresponding Method Call| +|------------|-------------------------------| +|A managed Visual Basic executable calls an unmanaged function written in C by using platform invoke.|`IHostTaskManager::LeaveRuntime`| +|The unmanaged C function calls a method in a managed DLL written in C#.|`IHostTaskManager::ReverseEnterRuntime`| +|The managed C# function calls another unmanaged function written in C, also using platform invoke.|`IHostTaskManager::LeaveRuntime`| +|The second unmanaged function returns execution to the C# function.|`IHostTaskManager::EnterRuntime`| +|The C# function returns execution to the first unmanaged function.|`IHostTaskManager::ReverseLeaveRuntime`| +|The first unmanaged function returns execution to the Visual Basic program.|`IHostTaskManager::EnterRuntime`| + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md index 9448412700906..6cb8b3651f1ae 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md @@ -2,60 +2,59 @@ description: "Learn more about: IHostTaskManager::ReverseEnterRuntime Method" title: "IHostTaskManager::ReverseEnterRuntime Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.ReverseEnterRuntime" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::ReverseEnterRuntime" -helpviewer_keywords: +helpviewer_keywords: - "IHostTaskManager::ReverseEnterRuntime method [.NET Framework hosting]" - "ReverseEnterRuntime method [.NET Framework hosting]" -ms.assetid: b1e26bff-d3ea-436e-9867-29720df999f4 -topic_type: +topic_type: - "apiref" --- # IHostTaskManager::ReverseEnterRuntime Method -Notifies the host that a call is being made into the common language runtime (CLR) from unmanaged code. - -## Syntax - -```cpp -HRESULT ReverseEnterRuntime (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`ReverseEnterRuntime` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory is available to complete the requested resource allocation.| - -## Remarks +Notifies the host that a call is being made into the common language runtime (CLR) from unmanaged code. + +## Syntax + +```cpp +HRESULT ReverseEnterRuntime (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`ReverseEnterRuntime` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory is available to complete the requested resource allocation.| + +## Remarks + + If the call into the CLR is made from a sequence that originated in managed code, each call to `ReverseEnterRuntime` corresponds to a call to [ReverseLeaveRuntime](ihosttaskmanager-reverseleaveruntime-method.md). - If the call into the CLR is made from a sequence that originated in managed code, each call to `ReverseEnterRuntime` corresponds to a call to [ReverseLeaveRuntime](ihosttaskmanager-reverseleaveruntime-method.md). - > [!NOTE] -> Calls can originate from unmanaged code without being nested. In this case, there is no call to [EnterRuntime](ihosttaskmanager-enterruntime-method.md), [LeaveRuntime](ihosttaskmanager-leaveruntime-method.md), or `ReverseLeaveRuntime`, and the number of calls to `ReverseEnterRuntime` does not equal the number of calls to `ReverseLeaveRuntime`. - -## Requirements +> Calls can originate from unmanaged code without being nested. In this case, there is no call to [EnterRuntime](ihosttaskmanager-enterruntime-method.md), [LeaveRuntime](ihosttaskmanager-leaveruntime-method.md), or `ReverseLeaveRuntime`, and the number of calls to `ReverseEnterRuntime` does not equal the number of calls to `ReverseLeaveRuntime`. + +## 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 2.0 - **Platforms:** See [System Requirements](../../../framework/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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md index bcb352deb0d4e..7e660b6e38662 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md @@ -2,57 +2,56 @@ description: "Learn more about: IHostTaskManager::ReverseLeaveRuntime Method" title: "IHostTaskManager::ReverseLeaveRuntime Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.ReverseLeaveRuntime" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::ReverseLeaveRuntime" -helpviewer_keywords: +helpviewer_keywords: - "IHostTaskManager::ReverseLeaveRuntime method [.NET Framework hosting]" - "ReverseLeaveRuntime method [.NET Framework hosting]" -ms.assetid: 4837d398-16a1-4e32-902c-022cd1aad3ca -topic_type: +topic_type: - "apiref" --- # IHostTaskManager::ReverseLeaveRuntime Method -Notifies the host that control is leaving the common language runtime (CLR) and entering an unmanaged function that was, in turn, called from managed code. - -## Syntax - -```cpp -HRESULT ReverseLeaveRuntime (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`ReverseLeaveRuntime` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory is available to complete the requested resource allocation.| - -## Remarks +Notifies the host that control is leaving the common language runtime (CLR) and entering an unmanaged function that was, in turn, called from managed code. - The CLR calls `ReverseLeaveRuntime` to inform the host that the currently executing task is returning control to an unmanaged function that was, in turn, called from managed code through platform invoke. Each call to `ReverseLeaveRuntime` matches a corresponding call to [ReverseEnterRuntime](ihosttaskmanager-reverseenterruntime-method.md). - -## Requirements +## Syntax + +```cpp +HRESULT ReverseLeaveRuntime (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`ReverseLeaveRuntime` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory is available to complete the requested resource allocation.| + +## Remarks + + The CLR calls `ReverseLeaveRuntime` to inform the host that the currently executing task is returning control to an unmanaged function that was, in turn, called from managed code through platform invoke. Each call to `ReverseLeaveRuntime` matches a corresponding call to [ReverseEnterRuntime](ihosttaskmanager-reverseenterruntime-method.md). + +## 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 2.0 - **Platforms:** See [System Requirements](../../../framework/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 - [CallNeedsHostHook Method](ihosttaskmanager-callneedshosthook-method.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md index 5451bdcde1384..f08fe65bc6097 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md @@ -2,63 +2,62 @@ description: "Learn more about: IHostTaskManager::SetCLRTaskManager Method" title: "IHostTaskManager::SetCLRTaskManager Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.SetCLRTaskManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::SetCLRTaskManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostTaskManager::SetCLRTaskManager method [.NET Framework hosting]" - "SetCLRTaskManager method [.NET Framework hosting]" -ms.assetid: ec90ee83-bd4b-408b-9274-62a923ab86a1 -topic_type: +topic_type: - "apiref" --- # IHostTaskManager::SetCLRTaskManager Method -Provides the host with an interface pointer to an [ICLRTaskManager](iclrtaskmanager-interface.md) instance implemented by the common language runtime (CLR). - -## Syntax - -```cpp -HRESULT SetCLRTaskManager ( - [in] ICLRTaskManager *pManager -); -``` - -## Parameters - - `pManager` - [in] A pointer to an `ICLRTaskManager` instance implemented by the common language runtime. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetCLRTaskManager` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The runtime calls `SetCLRTaskManager` to provide the host with an interface pointer to an `ICLRTaskManager` instance. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides the host with an interface pointer to an [ICLRTaskManager](iclrtaskmanager-interface.md) instance implemented by the common language runtime (CLR). + +## Syntax + +```cpp +HRESULT SetCLRTaskManager ( + [in] ICLRTaskManager *pManager +); +``` + +## Parameters + + `pManager` + [in] A pointer to an `ICLRTaskManager` instance implemented by the common language runtime. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetCLRTaskManager` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The runtime calls `SetCLRTaskManager` to provide the host with an interface pointer to an `ICLRTaskManager` instance. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md index 6576b514332c2..48077c77f0b5b 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IHostTaskManager::SetLocale Method" title: "IHostTaskManager::SetLocale Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.SetLocale" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::SetLocale" -helpviewer_keywords: +helpviewer_keywords: - "SetLocale method, IHostTaskManager interface [.NET Framework hosting]" - "IHostTaskManager::SetLocale method [.NET Framework hosting]" -ms.assetid: 747ee407-ee8c-484d-9583-25089236d2d1 -topic_type: +topic_type: - "apiref" --- # IHostTaskManager::SetLocale Method -Notifies the host that the common language runtime (CLR) has changed the locale, or culture, on the currently executing task. - -## Syntax - -```cpp -HRESULT SetLocale ( - [in] LCID lcid -); -``` - -## Parameters - - `lcid` - [in] The locale identifier value that maps to the newly assigned geographical culture and language. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetLocale` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not allow managed user code to modify the locale.| - -## Remarks - - The runtime calls `SetLocale` when the value of the property is changed by managed code. This method provides an opportunity for the host to execute any mechanisms it might have for synchronization of locales. If a host does not allow the locale to be changed from managed code, or does not implement a mechanism to synchronize locales, it should return E_NOTIMPL from this method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Notifies the host that the common language runtime (CLR) has changed the locale, or culture, on the currently executing task. + +## Syntax + +```cpp +HRESULT SetLocale ( + [in] LCID lcid +); +``` + +## Parameters + + `lcid` + [in] The locale identifier value that maps to the newly assigned geographical culture and language. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetLocale` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not allow managed user code to modify the locale.| + +## Remarks + + The runtime calls `SetLocale` when the value of the property is changed by managed code. This method provides an opportunity for the host to execute any mechanisms it might have for synchronization of locales. If a host does not allow the locale to be changed from managed code, or does not implement a mechanism to synchronize locales, it should return E_NOTIMPL from this method. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md index 26d5a2bcf0cab..4001fe964fc1a 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md @@ -2,43 +2,42 @@ description: "Learn more about: IHostTaskManager::SetStackGuarantee Method" title: "IHostTaskManager::SetStackGuarantee Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.SetStackGuarantee" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::SetStackGuarantee" -helpviewer_keywords: +helpviewer_keywords: - "IHostTaskManager::SetStackGuarantee method [.NET Framework hosting]" - "SetStackGuarantee method [.NET Framework hosting]" -ms.assetid: 6dcc4a4b-3a78-4369-bcc7-c0be6dde57d4 -topic_type: +topic_type: - "apiref" --- # IHostTaskManager::SetStackGuarantee Method -Reserved for internal use only. - -## Syntax - -```cpp -HRESULT SetStackGuarantee( - [in] ULONG guarantee -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Reserved for internal use only. + +## Syntax + +```cpp +HRESULT SetStackGuarantee( + [in] ULONG guarantee +); +``` + +## 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 2.0 + ## See also - [GetStackGuarantee Method](ihosttaskmanager-getstackguarantee-method.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md index e3adc557af3e0..87a09db24d311 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IHostTaskManager::SetUILocale Method" title: "IHostTaskManager::SetUILocale Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.SetUILocale" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::SetUILocale" -helpviewer_keywords: +helpviewer_keywords: - "SetUILocale method, IHostTaskManager interface [.NET Framework hosting]" - "IHostTaskManager::SetUILocale method [.NET Framework hosting]" -ms.assetid: d0c87a9c-ea81-4237-a16b-c22b36ec9dc8 -topic_type: +topic_type: - "apiref" --- # IHostTaskManager::SetUILocale Method -Notifies the host that the common language runtime (CLR) has changed the user interface (UI) locale, or culture, on the currently executing task. - -## Syntax - -```cpp -HRESULT SetUILocale ( - [in] LCID lcid -); -``` - -## Parameters - - `lcid` - [in] The locale identifier value that maps to the newly assigned geographical culture and language. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetUILocale` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not allow managed user code to change the UI culture.| - -## Remarks - - The runtime calls `SetUILocale` when the value of the property is changed by managed code. This method provides an opportunity for the host to execute any mechanisms it might have for synchronization of locales. If a host does not allow the UI locale to be changed from managed code, or does not implement a mechanism to synchronize locales, it should return E_NOTIMPL from this method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Notifies the host that the common language runtime (CLR) has changed the user interface (UI) locale, or culture, on the currently executing task. + +## Syntax + +```cpp +HRESULT SetUILocale ( + [in] LCID lcid +); +``` + +## Parameters + + `lcid` + [in] The locale identifier value that maps to the newly assigned geographical culture and language. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetUILocale` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not allow managed user code to change the UI culture.| + +## Remarks + + The runtime calls `SetUILocale` when the value of the property is changed by managed code. This method provides an opportunity for the host to execute any mechanisms it might have for synchronization of locales. If a host does not allow the UI locale to be changed from managed code, or does not implement a mechanism to synchronize locales, it should return E_NOTIMPL from this method. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md index ae34955b61573..b1a64326f4df5 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md @@ -2,67 +2,66 @@ description: "Learn more about: IHostTaskManager::Sleep Method" title: "IHostTaskManager::Sleep Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.Sleep" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::Sleep" -helpviewer_keywords: +helpviewer_keywords: - "IHostTaskManager::Sleep method [.NET Framework hosting]" - "Sleep method, IHostTaskManager interface [.NET Framework hosting]" -ms.assetid: f67d25f3-9199-4c5f-b1e8-1c819243cfd5 -topic_type: +topic_type: - "apiref" --- # IHostTaskManager::Sleep Method -Notifies the host that the current task is going to sleep. - -## Syntax - -```cpp -HRESULT Sleep ( - [in] DWORD dwMilliseconds, - [in] DWORD option -); -``` - -## Parameters - - `dwMilliseconds` - [in] The time interval, in milliseconds, that the thread will sleep. - - `option` - [in] One of the [WAIT_OPTION](wait-option-enumeration.md) enumeration values, indicating what action the host should take if this action blocks. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Sleep` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR typically calls `IHostTaskManager::Sleep` when is called from user code. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Notifies the host that the current task is going to sleep. + +## Syntax + +```cpp +HRESULT Sleep ( + [in] DWORD dwMilliseconds, + [in] DWORD option +); +``` + +## Parameters + + `dwMilliseconds` + [in] The time interval, in milliseconds, that the thread will sleep. + + `option` + [in] One of the [WAIT_OPTION](wait-option-enumeration.md) enumeration values, indicating what action the host should take if this action blocks. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Sleep` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR typically calls `IHostTaskManager::Sleep` when is called from user code. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md b/docs/core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md index b1fa8eb8fe056..1890963403b71 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md +++ b/docs/core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md @@ -2,66 +2,65 @@ description: "Learn more about: IHostTaskManager::SwitchToTask Method" title: "IHostTaskManager::SwitchToTask Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.SwitchToTask" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::SwitchToTask" -helpviewer_keywords: +helpviewer_keywords: - "IHostTaskManager::SwitchToTask method [.NET Framework hosting]" - "SwitchToTask method [.NET Framework hosting]" -ms.assetid: 35d0c27e-4b14-49ce-810d-7ab2120177e8 -topic_type: +topic_type: - "apiref" --- # IHostTaskManager::SwitchToTask Method -Notifies the host that it should switch out the current task. - -## Syntax - -```cpp -HRESULT SwitchToTask ( - [in] DWORD option -); -``` - -## Parameters - - `option` - [in] One of the [WAIT_OPTION](wait-option-enumeration.md) enumeration values, indicating the action the host should take if the requested operation blocks. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SwitchToTask` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The host can switch in another task as desired or needed. - +Notifies the host that it should switch out the current task. + +## Syntax + +```cpp +HRESULT SwitchToTask ( + [in] DWORD option +); +``` + +## Parameters + + `option` + [in] One of the [WAIT_OPTION](wait-option-enumeration.md) enumeration values, indicating the action the host should take if the requested operation blocks. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SwitchToTask` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The host can switch in another task as desired or needed. + > [!NOTE] -> `SwitchToTask` does not specify which task the host should switch to; it specifies only the task that it should switch from. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +> `SwitchToTask` does not specify which task the host should switch to; it specifies only the task that it should switch from. + +## 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 2.0 + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md index 53322b8b4fb34..b3b9c1b02c3d4 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IHostThreadPoolManager::GetAvailableThreads Method" title: "IHostThreadPoolManager::GetAvailableThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostThreadPoolManager.GetAvailableThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostThreadPoolManager::GetAvailableThreads" -helpviewer_keywords: +helpviewer_keywords: - "GetAvailableThreads method, IHostThreadPoolManager interface [.NET Framework hosting]" - "IHostThreadPoolManager::GetAvailableThreads method [.NET Framework hosting]" -ms.assetid: 61d26dfd-7f24-4e7d-a63e-b30a463f08e1 -topic_type: +topic_type: - "apiref" --- # IHostThreadPoolManager::GetAvailableThreads Method -Gets the number of threads in the thread pool that are not currently processing work items. - -## Syntax - -```cpp -HRESULT GetAvailableThreads ( - [out] DWORD *pdwAvailableWorkerThreads -); -``` - -## Parameters - - `pdwAvailableWorkerThreads` - [out] Pointer to the number of threads in the thread pool that are not currently processing work items. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetAvailableThreads` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not provide an implementation of `GetAvailableThreads`.| - -## Remarks - - If the host does not provide an implementation of `GetAvailableThreads`, it should return an HRESULT value of E_NOTIMPL. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the number of threads in the thread pool that are not currently processing work items. + +## Syntax + +```cpp +HRESULT GetAvailableThreads ( + [out] DWORD *pdwAvailableWorkerThreads +); +``` + +## Parameters + + `pdwAvailableWorkerThreads` + [out] Pointer to the number of threads in the thread pool that are not currently processing work items. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetAvailableThreads` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not provide an implementation of `GetAvailableThreads`.| + +## Remarks + + If the host does not provide an implementation of `GetAvailableThreads`, it should return an HRESULT value of E_NOTIMPL. + +## 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 2.0 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md index 56d148b442265..47ce67d66ac27 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md @@ -2,66 +2,65 @@ description: "Learn more about: IHostThreadPoolManager::GetMaxThreads Method" title: "IHostThreadPoolManager::GetMaxThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostThreadPoolManager.GetMaxThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostThreadPoolManager::GetMaxThreads" -helpviewer_keywords: +helpviewer_keywords: - "IHostThreadPoolManager::GetMaxThreads method [.NET Framework hosting]" - "GetMaxThreads method, IHostThreadPoolManager interface [.NET Framework hosting]" -ms.assetid: db268876-6178-4a81-aca3-318ee7f96001 -topic_type: +topic_type: - "apiref" --- # IHostThreadPoolManager::GetMaxThreads Method -Gets the maximum number of threads that the host maintains concurrently in the thread pool. - -## Syntax - -```cpp -HRESULT GetMaxThreads ( - [out] DWORD *pdwMaxWorkerThreads -); -``` - -## Parameters - - `pdwMaxWorkerThreads` - [out] A pointer to the maximum number of threads that the host maintains in the thread pool. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetMaxThreads` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not provide an implementation of `GetMaxThreads`.| - -## Remarks - - The CLR calls `GetMaxThreads` to determine the total number of threads in the thread pool. The [GetAvailableThreads](ihostthreadpoolmanager-getavailablethreads-method.md) method gets the number of threads that are not currently processing work items. All requests above the returned value of the `pdwMaxWorkerThreads` parameter remain queued until threads become available. - - If the host does not provide an implementation of `GetMaxThreads`, it should return an HRESULT value of E_NOTIMPL. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the maximum number of threads that the host maintains concurrently in the thread pool. + +## Syntax + +```cpp +HRESULT GetMaxThreads ( + [out] DWORD *pdwMaxWorkerThreads +); +``` + +## Parameters + + `pdwMaxWorkerThreads` + [out] A pointer to the maximum number of threads that the host maintains in the thread pool. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetMaxThreads` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not provide an implementation of `GetMaxThreads`.| + +## Remarks + + The CLR calls `GetMaxThreads` to determine the total number of threads in the thread pool. The [GetAvailableThreads](ihostthreadpoolmanager-getavailablethreads-method.md) method gets the number of threads that are not currently processing work items. All requests above the returned value of the `pdwMaxWorkerThreads` parameter remain queued until threads become available. + + If the host does not provide an implementation of `GetMaxThreads`, it should return an HRESULT value of E_NOTIMPL. + +## 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 2.0 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md index 0f9b514c557ce..f6180deb7dd1f 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IHostThreadPoolManager::GetMinThreads Method" title: "IHostThreadPoolManager::GetMinThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostThreadPoolManager.GetMinThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostThreadPoolManager::GetMinThreads" -helpviewer_keywords: +helpviewer_keywords: - "IHostThreadPoolManager::GetMinThreads method [.NET Framework hosting]" - "GetMinThreads method, IHostThreadPoolManager interface [.NET Framework hosting]" -ms.assetid: dc07232b-b2e4-4dab-87e2-3c955974ab48 -topic_type: +topic_type: - "apiref" --- # IHostThreadPoolManager::GetMinThreads Method -Gets the minimum number of idle threads that the host maintains in the thread pool in anticipation of requests. - -## Syntax - -```cpp -HRESULT GetMinThreads ( - [out] DWORD *MinThreads -); -``` - -## Parameters - - `MinThreads` - [out] A pointer to the minimum number of idle worker threads that the host currently maintains. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetMinThreads` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not provide an implementation of `GetMinThreads`.| - -## Remarks - - The host is not required to provide an implementation of `GetMinThreads`. In this case, it should return an HRESULT value of E_NOTIMPL. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the minimum number of idle threads that the host maintains in the thread pool in anticipation of requests. + +## Syntax + +```cpp +HRESULT GetMinThreads ( + [out] DWORD *MinThreads +); +``` + +## Parameters + + `MinThreads` + [out] A pointer to the minimum number of idle worker threads that the host currently maintains. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetMinThreads` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not provide an implementation of `GetMinThreads`.| + +## Remarks + + The host is not required to provide an implementation of `GetMinThreads`. In this case, it should return an HRESULT value of E_NOTIMPL. + +## 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 2.0 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md index 6b772b5ea6660..5e7d26ba23c43 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md @@ -2,49 +2,48 @@ description: "Learn more about: IHostThreadPoolManager Interface" title: "IHostThreadPoolManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostThreadPoolManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostThreadPoolManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostThreadPoolManager interface [.NET Framework hosting]" -ms.assetid: c3a2cd90-7c4e-4374-bb87-b41befb8344f -topic_type: +topic_type: - "apiref" --- # IHostThreadPoolManager Interface -Provides methods that enable the common language runtime (CLR) to configure the thread pool and to queue work items to the thread pool. - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetAvailableThreads Method](ihostthreadpoolmanager-getavailablethreads-method.md)|Gets the number of threads in the thread pool that are not currently processing work items.| -|[GetMaxThreads Method](ihostthreadpoolmanager-getmaxthreads-method.md)|Gets the maximum number of threads that the host maintains concurrently in the thread pool.| -|[GetMinThreads Method](ihostthreadpoolmanager-getminthreads-method.md)|Gets the minimum number of idle threads that the host maintains in anticipation of requests.| -|[QueueUserWorkItem Method](ihostthreadpoolmanager-queueuserworkitem-method.md)|Queues a function for execution, and provides an object containing data to be used by the function.| -|[SetMaxThreads Method](ihostthreadpoolmanager-setmaxthreads-method.md)|Sets the maximum number of threads that the host can maintain in the thread pool.| -|[SetMinThreads Method](ihostthreadpoolmanager-setminthreads-method.md)|Sets the minimum number of idle threads that the host must maintain in anticipation of requests.| - -## Remarks - - The host is not required to configure the thread pool by using the values specified in calls to the `SetMaxThreads` and `SetMinThreads` methods. In this case, the host should return an HRESULT value of E_NOTIMPL from these methods. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods that enable the common language runtime (CLR) to configure the thread pool and to queue work items to the thread pool. + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetAvailableThreads Method](ihostthreadpoolmanager-getavailablethreads-method.md)|Gets the number of threads in the thread pool that are not currently processing work items.| +|[GetMaxThreads Method](ihostthreadpoolmanager-getmaxthreads-method.md)|Gets the maximum number of threads that the host maintains concurrently in the thread pool.| +|[GetMinThreads Method](ihostthreadpoolmanager-getminthreads-method.md)|Gets the minimum number of idle threads that the host maintains in anticipation of requests.| +|[QueueUserWorkItem Method](ihostthreadpoolmanager-queueuserworkitem-method.md)|Queues a function for execution, and provides an object containing data to be used by the function.| +|[SetMaxThreads Method](ihostthreadpoolmanager-setmaxthreads-method.md)|Sets the maximum number of threads that the host can maintain in the thread pool.| +|[SetMinThreads Method](ihostthreadpoolmanager-setminthreads-method.md)|Sets the minimum number of idle threads that the host must maintain in anticipation of requests.| + +## Remarks + + The host is not required to configure the thread pool by using the values specified in calls to the `SetMaxThreads` and `SetMinThreads` methods. In this case, the host should return an HRESULT value of E_NOTIMPL from these methods. + +## 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 2.0 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md index 994ad0f978dc6..0be760483a1b0 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md @@ -2,71 +2,70 @@ description: "Learn more about: IHostThreadPoolManager::QueueUserWorkItem Method" title: "IHostThreadPoolManager::QueueUserWorkItem Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostThreadPoolManager.QueueUserWorkItem" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostThreadPoolManager::QueueUserWorkItem" -helpviewer_keywords: +helpviewer_keywords: - "IHostThreadPoolManager::QueueUserWorkItem method [.NET Framework hosting]" - "QueueUserWorkItem method [.NET Framework hosting]" -ms.assetid: 41602053-8670-4827-9d61-cbfcba509b9c -topic_type: +topic_type: - "apiref" --- # IHostThreadPoolManager::QueueUserWorkItem Method -Queues a function for execution, and specifies an object containing data to be used by that function. The function executes when a thread becomes available. - -## Syntax - -```cpp -HRESULT QueueUserWorkItem ( - [in] LPTHREAD_START_ROUTINE Function, - [in] PVOID Context, - [in] ULONG Flags -); -``` - -## Parameters - - `Function` - [in] A function pointer that represents the function to execute. - - `Context` - [in] An object that contains data to be used by `Function`. - - `Flags` - [in] One of the flags values, as defined for the Win32 `QueueUserWorkItem` method, that control execution. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`QueueUserWorkItem` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `QueueUserWorkItem` queues a work item to a worker thread in the thread pool. Its signature and parameter types are identical to those of the corresponding Win32 function, which has the same name. For more information, see the Windows Platform documentation. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Queues a function for execution, and specifies an object containing data to be used by that function. The function executes when a thread becomes available. + +## Syntax + +```cpp +HRESULT QueueUserWorkItem ( + [in] LPTHREAD_START_ROUTINE Function, + [in] PVOID Context, + [in] ULONG Flags +); +``` + +## Parameters + + `Function` + [in] A function pointer that represents the function to execute. + + `Context` + [in] An object that contains data to be used by `Function`. + + `Flags` + [in] One of the flags values, as defined for the Win32 `QueueUserWorkItem` method, that control execution. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`QueueUserWorkItem` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `QueueUserWorkItem` queues a work item to a worker thread in the thread pool. Its signature and parameter types are identical to those of the corresponding Win32 function, which has the same name. For more information, see the Windows Platform documentation. + +## 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 2.0 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md index 03a5d3c1de9c1..cf1fd0545e979 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IHostThreadPoolManager::SetMaxThreads Method" title: "IHostThreadPoolManager::SetMaxThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostThreadPoolManager.SetMaxThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostThreadPoolManager::SetMaxThreads" -helpviewer_keywords: +helpviewer_keywords: - "IHostThreadPoolManager::SetMaxThreads method [.NET Framework hosting]" - "SetMaxThreads method, IHostThreadPoolManager interface [.NET Framework hosting]" -ms.assetid: 77cfd347-95c2-4425-b807-4ecc2a8d4578 -topic_type: +topic_type: - "apiref" --- # IHostThreadPoolManager::SetMaxThreads Method -Sets the maximum number of threads that the host can maintain in the thread pool. - -## Syntax - -```cpp -HRESULT SetMaxThreads ( - [in] DWORD MaxThreads -); -``` - -## Parameters - - `MaxThreads` - The maximum number of worker threads in the thread pool. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetMaxThreads` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not provide an implementation of `SetMaxThreads`.| - -## Remarks - - A host is not required to allow the CLR to configure the size of the thread pool. Some hosts might want exclusive control over the thread pool, for reasons such as implementation, performance, or scalability. In this case, a host should return an HRESULT value of E_NOTIMPL. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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 maximum number of threads that the host can maintain in the thread pool. + +## Syntax + +```cpp +HRESULT SetMaxThreads ( + [in] DWORD MaxThreads +); +``` + +## Parameters + + `MaxThreads` + The maximum number of worker threads in the thread pool. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetMaxThreads` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not provide an implementation of `SetMaxThreads`.| + +## Remarks + + A host is not required to allow the CLR to configure the size of the thread pool. Some hosts might want exclusive control over the thread pool, for reasons such as implementation, performance, or scalability. In this case, a host should return an HRESULT value of E_NOTIMPL. + +## 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 2.0 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md index 5c34c17fd3330..c0054c718404c 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md +++ b/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IHostThreadPoolManager::SetMinThreads Method" title: "IHostThreadPoolManager::SetMinThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostThreadPoolManager.SetMinThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostThreadPoolManager::SetMinThreads" -helpviewer_keywords: +helpviewer_keywords: - "SetMinThreads method, IHostThreadPoolManager interface [.NET Framework hosting]" - "IHostThreadPoolManager::SetMinThreads method [.NET Framework hosting]" -ms.assetid: 10409db9-9fd2-4e4d-b8cd-cf6fec0afaa2 -topic_type: +topic_type: - "apiref" --- # IHostThreadPoolManager::SetMinThreads Method -Sets the minimum number of idle threads that the host must maintain in anticipation of requests. - -## Syntax - -```cpp -HRESULT SetMinThreads ( - [in] DWORD MinThreads -); -``` - -## Parameters - - `MinThreads` - [in] The new minimum number of threads that the host must maintain. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetMinThreads` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not provide an implementation of `SetMinThreads`.| - -## Remarks - - A host is not required to provide an implementation of `SetMinThreads`. In this case, it should return an HRESULT value of E_NOTIMPL. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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 minimum number of idle threads that the host must maintain in anticipation of requests. + +## Syntax + +```cpp +HRESULT SetMinThreads ( + [in] DWORD MinThreads +); +``` + +## Parameters + + `MinThreads` + [in] The new minimum number of threads that the host must maintain. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetMinThreads` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not provide an implementation of `SetMinThreads`.| + +## Remarks + + A host is not required to provide an implementation of `SetMinThreads`. In this case, it should return an HRESULT value of E_NOTIMPL. + +## 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 2.0 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md b/docs/core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md index d9ae77e89741b..9ede7d9e844e5 100644 --- a/docs/core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md +++ b/docs/core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md @@ -2,60 +2,59 @@ description: "Learn more about: IManagedObject::GetObjectIdentity Method" title: "IManagedObject::GetObjectIdentity Method" ms.date: "03/30/2017" -api_name: +api_name: - "IManagedObject.GetObjectIdentity" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "GetObjectIdentity" -helpviewer_keywords: +helpviewer_keywords: - "GetObjectIdentity method [.NET Framework hosting]" - "IManagedObject::GetObjectIdentity method [.NET Framework hosting]" -ms.assetid: b862ff3e-e480-4cdf-84e2-e1013334a467 -topic_type: +topic_type: - "apiref" --- # IManagedObject::GetObjectIdentity Method -Gets the identity of this managed object. - -## Syntax - -```cpp -HRESULT GetObjectIdentity ( - [out] BSTR* pBSTRGUID, - [out] int* AppDomainID, - [out] CCW_PTR pCCW -); -``` - -## Parameters - - `pBSTRGUID` - [out] A pointer to the GUID of the process in which the object resides. - - `AppDomainID` - [out] A pointer to the ID of the object's application domain. - - `pCCW` - [out] A pointer to object's index in the COM classic v-table. - -## Remarks - - The identity of a managed object includes process GUID, application domain ID, and the object's index in the COM classic v-table. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the identity of this managed object. + +## Syntax + +```cpp +HRESULT GetObjectIdentity ( + [out] BSTR* pBSTRGUID, + [out] int* AppDomainID, + [out] CCW_PTR pCCW +); +``` + +## Parameters + + `pBSTRGUID` + [out] A pointer to the GUID of the process in which the object resides. + + `AppDomainID` + [out] A pointer to the ID of the object's application domain. + + `pCCW` + [out] A pointer to object's index in the COM classic v-table. + +## Remarks + + The identity of a managed object includes process GUID, application domain ID, and the object's index in the COM classic v-table. + +## 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 2.0 + ## See also - [IManagedObject Interface](imanagedobject-interface.md) diff --git a/docs/core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md b/docs/core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md index 109a2fcbc0440..a9b8fe7248fee 100644 --- a/docs/core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md +++ b/docs/core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IManagedObject::GetSerializedBuffer Method" title: "IManagedObject::GetSerializedBuffer Method" ms.date: "03/30/2017" -api_name: +api_name: - "IManagedObject.GetSerializedBuffer" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "GetSerializedBuffer" -helpviewer_keywords: +helpviewer_keywords: - "IManagedObject::GetSerializedBuffer method [.NET Framework hosting]" - "GetSerializedBuffer method [.NET Framework hosting]" -ms.assetid: c17105bb-b49f-434e-8f9b-77f8c85b9220 -topic_type: +topic_type: - "apiref" --- # IManagedObject::GetSerializedBuffer Method -Gets the string representation of this managed object. - -## Syntax - -```cpp -HRESULT GetSerializedBuffer ( - [out] BSTR *pBSTR -); -``` - -## Parameters - - `pBSTR` - [out] A pointer to a string that is the serialized object. - -## Remarks - - The `GetSerializedBuffer` method serializes the object so it can be marshalled to the client. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Gets the string representation of this managed object. + +## Syntax + +```cpp +HRESULT GetSerializedBuffer ( + [out] BSTR *pBSTR +); +``` + +## Parameters + + `pBSTR` + [out] A pointer to a string that is the serialized object. + +## Remarks + + The `GetSerializedBuffer` method serializes the object so it can be marshalled to the client. + +## 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 2.0 + ## See also - [IManagedObject Interface](imanagedobject-interface.md) diff --git a/docs/core/unmanaged-api/hosting/imanagedobject-interface.md b/docs/core/unmanaged-api/hosting/imanagedobject-interface.md index 3c087294f926c..02cc2f97ef3ad 100644 --- a/docs/core/unmanaged-api/hosting/imanagedobject-interface.md +++ b/docs/core/unmanaged-api/hosting/imanagedobject-interface.md @@ -2,41 +2,40 @@ description: "Learn more about: IManagedObject Interface" title: "IManagedObject Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IManagedObject" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IManagedObject" -helpviewer_keywords: +helpviewer_keywords: - "IManagedObject interface [.NET Framework hosting]" -ms.assetid: 1fbbf572-6d28-41a5-82fb-579ac90bfcf5 -topic_type: +topic_type: - "apiref" --- # IManagedObject Interface -Provides methods for controlling a managed object. - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetObjectIdentity Method](imanagedobject-getobjectidentity-method.md)|Gets the identity of this managed object.| -|[GetSerializedBuffer Method](imanagedobject-getserializedbuffer-method.md)|Gets the string representation of this managed object.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods for controlling a managed object. + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetObjectIdentity Method](imanagedobject-getobjectidentity-method.md)|Gets the identity of this managed object.| +|[GetSerializedBuffer Method](imanagedobject-getserializedbuffer-method.md)|Gets the string representation of this managed object.| + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/index.md b/docs/core/unmanaged-api/hosting/index.md index 30751e16f2244..3690543948e0b 100644 --- a/docs/core/unmanaged-api/hosting/index.md +++ b/docs/core/unmanaged-api/hosting/index.md @@ -2,36 +2,33 @@ description: "Learn more about unmanaged APIs for .NET hosting" title: ".NET hosting (unmanaged API reference)" ms.date: "09/19/2023" -helpviewer_keywords: +helpviewer_keywords: - "unmanaged API reference [.NET], hosting" - "native API reference [.NET], hosting" - "hosting [.NET], using the unmanaged API" -ms.assetid: 14295c28-1da8-408b-a656-9584abcd9896 --- # .NET hosting (unmanaged API reference) The hosting API enables unmanaged hosts to integrate the common language runtime (CLR) into their applications. -These articles describe APIs that can be used with both .NET Framework and .NET. For .NET Framework-specific unmanaged APIs, see [.NET Framework hosting](../../../framework/unmanaged-api/hosting/index.md). - -## In This Section - - [Hosting Coclasses](hosting-coclasses.md) - Describes the unmanaged coclasses that the hosting API uses. - - [Hosting Enumerations](hosting-enumerations.md) - Describes the unmanaged enumerations that the hosting API uses. - - [Hosting Global Static Functions](hosting-global-static-functions.md) - Describes the unmanaged global static functions that the hosting API uses. - - [Hosting Interfaces](hosting-interfaces.md) - Describes the unmanaged interfaces that enable a runtime host to integrate the CLR into an unmanaged application. - - [Hosting Structures](hosting-structures.md) - Describes the unmanaged structures that the hosting API uses. - -## Related Sections - - [Runtime Hosts](/previous-versions/dotnet/netframework-4.0/a51xd4ze(v=vs.100)) - Describes the runtime hosts included with the .NET Framework. +## In This Section + + [Hosting Coclasses](hosting-coclasses.md)\ + Describes the unmanaged coclasses that the hosting API uses. + + [Hosting Enumerations](hosting-enumerations.md)\ + Describes the unmanaged enumerations that the hosting API uses. + + [Hosting Global Static Functions](hosting-global-static-functions.md)\ + Describes the unmanaged global static functions that the hosting API uses. + + [Hosting Interfaces](hosting-interfaces.md)\ + Describes the unmanaged interfaces that enable a runtime host to integrate the CLR into an unmanaged application. + + [Hosting Structures](hosting-structures.md)\ + Describes the unmanaged structures that the hosting API uses. + +## Related Sections + + [Runtime Hosts](/previous-versions/dotnet/netframework-4.0/a51xd4ze(v=vs.100))\ + Describes the runtime hosts included with .NET Framework. diff --git a/docs/core/unmanaged-api/hosting/iobjecthandle-interface.md b/docs/core/unmanaged-api/hosting/iobjecthandle-interface.md index 0568dfc1cb7ea..be8f44d8c335b 100644 --- a/docs/core/unmanaged-api/hosting/iobjecthandle-interface.md +++ b/docs/core/unmanaged-api/hosting/iobjecthandle-interface.md @@ -2,40 +2,39 @@ description: "Learn more about: IObjectHandle Interface" title: "IObjectHandle Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IObjectHandle" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IObjectHandle" -helpviewer_keywords: +helpviewer_keywords: - "IObjectHandle interface [.NET Framework hosting]" -ms.assetid: 436683ef-9849-4b24-89a9-28c06d148dce -topic_type: +topic_type: - "apiref" --- # IObjectHandle Interface -Provides a method for unwrapping marshal-by-value objects from indirection. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Unwrap Method](iobjecthandle-unwrap-method.md)|Unwraps a marshal-by-value object from indirection.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides a method for unwrapping marshal-by-value objects from indirection. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Unwrap Method](iobjecthandle-unwrap-method.md)|Unwraps a marshal-by-value object from indirection.| + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md b/docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md index be6d6529f91dd..2c8dff7c5a209 100644 --- a/docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md +++ b/docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md @@ -2,44 +2,43 @@ description: "Learn more about: IObjectHandle::Unwrap Method" title: "IObjectHandle::Unwrap Method" ms.date: "03/30/2017" -api_name: +api_name: - "IObjectHandle.Unwrap" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "Unwrap" -helpviewer_keywords: +helpviewer_keywords: - "Unwrap method [.NET Framework hosting]" - "IObjectHandle::Unwrap method [.NET Framework hosting]" -ms.assetid: 794c6f8e-ed58-416b-b756-e864f2c958f7 -topic_type: +topic_type: - "apiref" --- # IObjectHandle::Unwrap Method -Unwraps a marshal-by-value object from indirection. - -## Syntax - -```cpp -HRESULT Unwrap ( - [out, retval] VARIANT *ppv -); -``` - -## Parameters - - `ppv` - [out] A pointer to the object to be unwrapped. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] +Unwraps a marshal-by-value object from indirection. + +## Syntax + +```cpp +HRESULT Unwrap ( + [out, retval] VARIANT *ppv +); +``` + +## Parameters + + `ppv` + [out] A pointer to the object to be unwrapped. + +## 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 2.0 diff --git a/docs/core/unmanaged-api/hosting/itypename-getassemblyname-method.md b/docs/core/unmanaged-api/hosting/itypename-getassemblyname-method.md index 0dc092d3be320..9034d569d0333 100644 --- a/docs/core/unmanaged-api/hosting/itypename-getassemblyname-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-getassemblyname-method.md @@ -2,43 +2,42 @@ description: "Learn more about: ITypeName::GetAssemblyName Method" title: "ITypeName::GetAssemblyName Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeName.GetAssemblyName" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "GetAssemblyName" -helpviewer_keywords: +helpviewer_keywords: - "ITypeName::GetAssemblyName method [.NET Framework hosting]" - "GetAssemblyName method [.NET Framework hosting]" -ms.assetid: 97801d99-f5f1-4a30-882f-959827093fac -topic_type: +topic_type: - "apiref" --- # ITypeName::GetAssemblyName Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT GetAssemblyName ( - [out, retval] BSTR* rgbszAssemblyNames -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT GetAssemblyName ( + [out, retval] BSTR* rgbszAssemblyNames +); +``` + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypename-getmodifierlength-method.md b/docs/core/unmanaged-api/hosting/itypename-getmodifierlength-method.md index 8c4215f0716dd..50e0fa2e71fee 100644 --- a/docs/core/unmanaged-api/hosting/itypename-getmodifierlength-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-getmodifierlength-method.md @@ -2,43 +2,42 @@ description: "Learn more about: ITypeName::GetModifierLength Method" title: "ITypeName::GetModifierLength Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeName.GetModifierLength" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "GetModifierLength" -helpviewer_keywords: +helpviewer_keywords: - "ITypeName::GetModifierLength method [.NET Framework hosting]" - "GetModifierLength method [.NET Framework hosting]" -ms.assetid: ac45f261-03f9-4728-b5d7-dd7cbb05f9e6 -topic_type: +topic_type: - "apiref" --- # ITypeName::GetModifierLength Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT GetModifierLength ( - [out, retval] DWORD* pCount -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT GetModifierLength ( + [out, retval] DWORD* pCount +); +``` + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypename-getmodifiers-method.md b/docs/core/unmanaged-api/hosting/itypename-getmodifiers-method.md index 912d1e0b31212..5c73f1cbfa25f 100644 --- a/docs/core/unmanaged-api/hosting/itypename-getmodifiers-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-getmodifiers-method.md @@ -2,45 +2,44 @@ description: "Learn more about: ITypeName::GetModifiers Method" title: "ITypeName::GetModifiers Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeName.GetModifiers" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "GetModifiers" -helpviewer_keywords: +helpviewer_keywords: - "ITypeName::GetModifiers method [.NET Framework hosting]" - "GetModifiers method [.NET Framework hosting]" -ms.assetid: 75508c55-3e09-4135-80da-cc811003fa82 -topic_type: +topic_type: - "apiref" --- # ITypeName::GetModifiers Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT GetModifiers ( - [in] DWORD count, - [out] DWORD* rgModifiers, - [out, retval] DWORD* pCount -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT GetModifiers ( + [in] DWORD count, + [out] DWORD* rgModifiers, + [out, retval] DWORD* pCount +); +``` + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypename-getnamecount-method.md b/docs/core/unmanaged-api/hosting/itypename-getnamecount-method.md index a74155f16cdca..692116cda8747 100644 --- a/docs/core/unmanaged-api/hosting/itypename-getnamecount-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-getnamecount-method.md @@ -2,43 +2,42 @@ description: "Learn more about: ITypeName::GetNameCount Method" title: "ITypeName::GetNameCount Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeName.GetNameCount" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "GetNameCount" -helpviewer_keywords: +helpviewer_keywords: - "GetNameCount method [.NET Framework hosting]" - "ITypeName::GetNameCount method [.NET Framework hosting]" -ms.assetid: 0beb909a-5095-40e5-909d-9ecc280300b8 -topic_type: +topic_type: - "apiref" --- # ITypeName::GetNameCount Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT GetNameCount ( - [out, retval] DWORD* pCount -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT GetNameCount ( + [out, retval] DWORD* pCount +); +``` + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypename-getnames-method.md b/docs/core/unmanaged-api/hosting/itypename-getnames-method.md index b9b2a392c4252..f5f0148bca5ea 100644 --- a/docs/core/unmanaged-api/hosting/itypename-getnames-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-getnames-method.md @@ -2,45 +2,44 @@ description: "Learn more about: ITypeName::GetNames Method" title: "ITypeName::GetNames Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeName.GetNames" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "GetNames" -helpviewer_keywords: +helpviewer_keywords: - "ITypeName::GetNames method [.NET Framework hosting]" - "GetNames method [.NET Framework hosting]" -ms.assetid: e2a3637b-d1e9-4d93-9e9b-0555fbff793d -topic_type: +topic_type: - "apiref" --- # ITypeName::GetNames Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT GetNames ( - [in] DWORD count, - [out] BSTR* rgbszNames, - [out, retval] DWORD* pCount -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT GetNames ( + [in] DWORD count, + [out] BSTR* rgbszNames, + [out, retval] DWORD* pCount +); +``` + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md b/docs/core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md index be9cbb40f5600..dcb5ba8d69b85 100644 --- a/docs/core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md @@ -2,43 +2,42 @@ description: "Learn more about: ITypeName::GetTypeArgumentCount Method" title: "ITypeName::GetTypeArgumentCount Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeName.GetTypeArgumentCount" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "GetTypeArgumentCount" -helpviewer_keywords: +helpviewer_keywords: - "GetTypeArgumentCount method [.NET Framework hosting]" - "ITypeName::GetTypeArgumentCount method [.NET Framework hosting]" -ms.assetid: ecb5480c-761a-4b02-83e0-b79abc67fd08 -topic_type: +topic_type: - "apiref" --- # ITypeName::GetTypeArgumentCount Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT GetTypeArgumentCount ( - [out, retval] DWORD* pCount -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT GetTypeArgumentCount ( + [out, retval] DWORD* pCount +); +``` + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypename-gettypearguments-method.md b/docs/core/unmanaged-api/hosting/itypename-gettypearguments-method.md index 115a2fd3a63e8..c910538ec3d68 100644 --- a/docs/core/unmanaged-api/hosting/itypename-gettypearguments-method.md +++ b/docs/core/unmanaged-api/hosting/itypename-gettypearguments-method.md @@ -2,45 +2,44 @@ description: "Learn more about: ITypeName::GetTypeArguments Method" title: "ITypeName::GetTypeArguments Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeName.GetTypeArguments" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "GetTypeArguments" -helpviewer_keywords: +helpviewer_keywords: - "ITypeName::GetTypeArguments method [.NET Framework hosting]" - "GetTypeArguments method [.NET Framework hosting]" -ms.assetid: 638d77df-ff9c-40d9-88ee-930f5f87ada1 -topic_type: +topic_type: - "apiref" --- # ITypeName::GetTypeArguments Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT GetTypeArguments ( - [in] DWORD count, - [out] ITypeName** rgpArguments, - [out, retval] DWORD* pCount -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT GetTypeArguments ( + [in] DWORD count, + [out] ITypeName** rgpArguments, + [out, retval] DWORD* pCount +); +``` + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypename-interface.md b/docs/core/unmanaged-api/hosting/itypename-interface.md index e694d7909cfff..cff1b38934e06 100644 --- a/docs/core/unmanaged-api/hosting/itypename-interface.md +++ b/docs/core/unmanaged-api/hosting/itypename-interface.md @@ -2,36 +2,35 @@ description: "Learn more about: ITypeName Interface" title: "ITypeName Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeName" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ITypeName" -helpviewer_keywords: +helpviewer_keywords: - "ITypeName interface [.NET Framework hosting]" -ms.assetid: 3be458bb-a519-4e22-b373-0b28f2c9cc3c -topic_type: +topic_type: - "apiref" --- # ITypeName Interface -Provides methods for obtaining type name information. - - This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods for obtaining type name information. + + This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md index fb8440d599122..3faa428c42906 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md @@ -2,43 +2,42 @@ description: "Learn more about: ITypeNameBuilder::AddArray Method" title: "ITypeNameBuilder::AddArray Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeNameBuilder.AddArray" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "AddArray" -helpviewer_keywords: +helpviewer_keywords: - "ITypeNameBuilder::AddArray method [.NET Framework hosting]" - "AddArray method [.NET Framework hosting]" -ms.assetid: 0a21ae28-54bc-4f6e-aaa6-960a22c5f530 -topic_type: +topic_type: - "apiref" --- # ITypeNameBuilder::AddArray Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT AddArray ( - [in] DWORD rank -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT AddArray ( + [in] DWORD rank +); +``` + +## 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 - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md index 29929290e1ece..516a4a97526ca 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md @@ -2,43 +2,42 @@ description: "Learn more about: ITypeNameBuilder::AddAssemblySpec Method" title: "ITypeNameBuilder::AddAssemblySpec Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeNameBuilder.AddAssemblySpec" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "AddAssemblySpec" -helpviewer_keywords: +helpviewer_keywords: - "ITypeNameBuilder::AddAssemblySpec method [.NET Framework hosting]" - "AddAssemblySpec method [.NET Framework hosting]" -ms.assetid: 4723e553-10c6-4828-aff8-bc62385163b8 -topic_type: +topic_type: - "apiref" --- # ITypeNameBuilder::AddAssemblySpec Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT AddAssemblySpec ( - [in] LPCWSTR szAssemblySpec -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT AddAssemblySpec ( + [in] LPCWSTR szAssemblySpec +); +``` + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md index 44d1ed57cc6cb..a49fc10234e01 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md @@ -13,7 +13,6 @@ f1_keywords: helpviewer_keywords: - "ITypeNameBuilder::AddByRef method [.NET Framework hosting]" - "AddByRef method [.NET Framework hosting]" -ms.assetid: 3f1b6bc4-6efb-4b90-8be0-b1ba8d856ca0 topic_type: - "apiref" --- @@ -36,7 +35,7 @@ HRESULT AddByRef ( ); **Library:** Included 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/hosting/itypenamebuilder-addname-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addname-method.md index 1bbc18b5c67f8..3731e5c998c5c 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addname-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addname-method.md @@ -2,43 +2,42 @@ description: "Learn more about: ITypeNameBuilder::AddName Method" title: "ITypeNameBuilder::AddName Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeNameBuilder.AddName" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "AddName" -helpviewer_keywords: +helpviewer_keywords: - "ITypeNameBuilder::AddName method [.NET Framework hosting]" - "AddName method [.NET Framework hosting]" -ms.assetid: be2f6e55-f46d-49aa-b477-80fd7e4515f7 -topic_type: +topic_type: - "apiref" --- # ITypeNameBuilder::AddName Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT AddName ( - [in] LPCWSTR szName -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT AddName ( + [in] LPCWSTR szName +); +``` + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md index d2a296b818be4..8124322708e9b 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md @@ -2,41 +2,40 @@ description: "Learn more about: ITypeNameBuilder::AddPointer Method" title: "ITypeNameBuilder::AddPointer Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeNameBuilder.AddPointer" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "AddPointer" -helpviewer_keywords: +helpviewer_keywords: - "ITypeNameBuilder::AddPointer method [.NET Framework hosting]" - "AddPointer method [.NET Framework hosting]" -ms.assetid: b6f1dbd4-1a9f-44dd-b54b-c530ab44eb48 -topic_type: +topic_type: - "apiref" --- # ITypeNameBuilder::AddPointer Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT AddPointer ( ); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT AddPointer ( ); +``` + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md index e6d9a75c5348b..218d41a0cfcf3 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md @@ -2,41 +2,40 @@ description: "Learn more about: ITypeNameBuilder::AddSzArray Method" title: "ITypeNameBuilder::AddSzArray Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeNameBuilder.AddSzArray" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "AddSzArray" -helpviewer_keywords: +helpviewer_keywords: - "AddSzArray method [.NET Framework hosting]" - "ITypeNameBuilder::AddSzArray method [.NET Framework hosting]" -ms.assetid: a6a46296-af14-4c53-9744-f7a1e3f3028a -topic_type: +topic_type: - "apiref" --- # ITypeNameBuilder::AddSzArray Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT AddSzArray ( ); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT AddSzArray ( ); +``` + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-clear-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-clear-method.md index 5b30b8b8d239e..d4b3e6951da93 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-clear-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-clear-method.md @@ -2,41 +2,40 @@ description: "Learn more about: ITypeNameBuilder::Clear Method" title: "ITypeNameBuilder::Clear Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeNameBuilder.Clear" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "Clear" -helpviewer_keywords: +helpviewer_keywords: - "Clear method [.NET Framework hosting]" - "ITypeNameBuilder::Clear method [.NET Framework hosting]" -ms.assetid: 18d54280-46af-479f-8d84-5ab64f8b23b9 -topic_type: +topic_type: - "apiref" --- # ITypeNameBuilder::Clear Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT Clear ( ); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT Clear ( ); +``` + +## 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 - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md index 39a03ede52789..084e259b756bc 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md @@ -2,41 +2,40 @@ description: "Learn more about: ITypeNameBuilder::CloseGenericArgument Method" title: "ITypeNameBuilder::CloseGenericArgument Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeNameBuilder.CloseGenericArgument" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CloseGenericArgument" -helpviewer_keywords: +helpviewer_keywords: - "ITypeNameBuilder::CloseGenericArgument method [.NET Framework hosting]" - "CloseGenericArgument method [.NET Framework hosting]" -ms.assetid: c9a8178d-be1f-4ad4-abdb-d38470659b82 -topic_type: +topic_type: - "apiref" --- # ITypeNameBuilder::CloseGenericArgument Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CloseGenericArgument ( ); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CloseGenericArgument ( ); +``` + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md index 7db67267ff123..e77e25179a2ec 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md @@ -2,41 +2,40 @@ description: "Learn more about: ITypeNameBuilder::CloseGenericArguments Method" title: "ITypeNameBuilder::CloseGenericArguments Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeNameBuilder.CloseGenericArguments" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CloseGenericArguments" -helpviewer_keywords: +helpviewer_keywords: - "CloseGenericArguments method [.NET Framework hosting]" - "ITypeNameBuilder::CloseGenericArguments method [.NET Framework hosting]" -ms.assetid: 583d13f9-786b-49e3-bc42-a4ba3aa8d9c6 -topic_type: +topic_type: - "apiref" --- # ITypeNameBuilder::CloseGenericArguments Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CloseGenericArguments ( ); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CloseGenericArguments ( ); +``` + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md index a7cefca6697d3..3d58a974b793f 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md @@ -2,36 +2,35 @@ description: "Learn more about: ITypeNameBuilder Interface" title: "ITypeNameBuilder Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeNameBuilder" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ITypeNameBuilder" -helpviewer_keywords: +helpviewer_keywords: - "ITypeNameBuilder interface [.NET Framework hosting]" -ms.assetid: 1f88e62e-2762-44d1-83b1-095f8734c0bc -topic_type: +topic_type: - "apiref" --- # ITypeNameBuilder Interface -Provides methods for building a type name. - - This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods for building a type name. + + This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md index e21eaf477ec7b..5d41cf8236f01 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md @@ -2,41 +2,40 @@ description: "Learn more about: ITypeNameBuilder::OpenGenericArgument Method" title: "ITypeNameBuilder::OpenGenericArgument Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeNameBuilder.OpenGenericArgument" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "OpenGenericArgument" -helpviewer_keywords: +helpviewer_keywords: - "ITypeNameBuilder::OpenGenericArgument method [.NET Framework hosting]" - "OpenGenericArgument method [.NET Framework hosting]" -ms.assetid: 476feeac-e8e9-46cf-9f8d-be103181d0ab -topic_type: +topic_type: - "apiref" --- # ITypeNameBuilder::OpenGenericArgument Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT OpenGenericArgument ( ); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT OpenGenericArgument ( ); +``` + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md index 84ae6ec3187fa..60c9d866482bd 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md @@ -2,41 +2,40 @@ description: "Learn more about: ITypeNameBuilder::OpenGenericArguments Method" title: "ITypeNameBuilder::OpenGenericArguments Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeNameBuilder.OpenGenericArguments" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "OpenGenericArguments" -helpviewer_keywords: +helpviewer_keywords: - "OpenGenericArguments method [.NET Framework hosting]" - "ITypeNameBuilder::OpenGenericArguments method [.NET Framework hosting]" -ms.assetid: 4da94508-30da-41f4-8bf9-ce88bdf96fd2 -topic_type: +topic_type: - "apiref" --- # ITypeNameBuilder::OpenGenericArguments Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT OpenGenericArguments ( ); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT OpenGenericArguments ( ); +``` + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md index 27448fb55c365..81750a47f375f 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md @@ -2,43 +2,42 @@ description: "Learn more about: ITypeNameBuilder::ToString Method" title: "ITypeNameBuilder::ToString Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeNameBuilder.ToString" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ToString" -helpviewer_keywords: +helpviewer_keywords: - "ToString method [.NET Framework hosting]" - "ITypeNameBuilder::ToString method [.NET Framework hosting]" -ms.assetid: 6372aca7-869a-4af6-ba2b-0eb1047ef5c0 -topic_type: +topic_type: - "apiref" --- # ITypeNameBuilder::ToString Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT ToString ( - [out, retval] BSTR* pszStringRepresentation -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT ToString ( + [out, retval] BSTR* pszStringRepresentation +); +``` + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md b/docs/core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md index e844d20f5c844..8755555cec745 100644 --- a/docs/core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md @@ -2,43 +2,42 @@ description: "Learn more about: ITypeNameFactory::GetTypeNameBuilder Method" title: "ITypeNameFactory::GetTypeNameBuilder Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeNameFactory.GetTypeNameBuilder" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "GetTypeNameBuilder" -helpviewer_keywords: +helpviewer_keywords: - "ITypeNameFactory::GetTypeNameBuilder method [.NET Framework hosting]" - "GetTypeNameBuilder method [.NET Framework hosting]" -ms.assetid: c682f744-996e-43c7-a9ea-c57cbc755398 -topic_type: +topic_type: - "apiref" --- # ITypeNameFactory::GetTypeNameBuilder Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT GetTypeNameBuilder ( - [out, retval] ITypeNameBuilder** ppTypeBuilder -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT GetTypeNameBuilder ( + [out, retval] ITypeNameBuilder** ppTypeBuilder +); +``` + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamefactory-interface.md b/docs/core/unmanaged-api/hosting/itypenamefactory-interface.md index 47480bab54d99..4e93fdfe7888f 100644 --- a/docs/core/unmanaged-api/hosting/itypenamefactory-interface.md +++ b/docs/core/unmanaged-api/hosting/itypenamefactory-interface.md @@ -2,36 +2,35 @@ description: "Learn more about: ITypeNameFactory Interface" title: "ITypeNameFactory Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeNameFactory" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ITypeNameFactory" -helpviewer_keywords: +helpviewer_keywords: - "ITypeNameFactory interface [.NET Framework hosting]" -ms.assetid: fa4247c4-f4f1-4855-9241-e04d737f5f73 -topic_type: +topic_type: - "apiref" --- # ITypeNameFactory Interface -Provides methods for deconstructing a type name. - - This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Provides methods for deconstructing a type name. + + This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md b/docs/core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md index c0c7e4f083a36..1a4e09c329e59 100644 --- a/docs/core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md +++ b/docs/core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md @@ -2,45 +2,44 @@ description: "Learn more about: ITypeNameFactory::ParseTypeName Method" title: "ITypeNameFactory::ParseTypeName Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeNameFactory.ParseTypeName" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ParseTypeName" -helpviewer_keywords: +helpviewer_keywords: - "ITypeNameFactory::ParseTypeName method [.NET Framework hosting]" - "ParseTypeName method [.NET Framework hosting]" -ms.assetid: 13c9f063-371c-4911-a5e7-e1e0b88ae382 -topic_type: +topic_type: - "apiref" --- # ITypeNameFactory::ParseTypeName Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT ParseTypeName ( - [in] LPCWSTR szName, - [out] DWORD* pError, - [out, retval] ITypeName** ppTypeName -); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT ParseTypeName ( + [in] LPCWSTR szName, + [out] DWORD* pError, + [out, retval] ITypeName** ppTypeName +); +``` + +## 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 2.0 + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md b/docs/core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md index bcf15de1ed930..77109eae3874d 100644 --- a/docs/core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md +++ b/docs/core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md @@ -2,60 +2,59 @@ description: "Learn more about: IValidator::FormatEventInfo Method" title: "IValidator::FormatEventInfo Method" ms.date: "03/30/2017" -api_name: +api_name: - "IValidator.FormatEventInfo" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "FormatEventInfo" -helpviewer_keywords: +helpviewer_keywords: - "IValidator::FormatEventInfo method [.NET Framework hosting]" - "FormatEventInfo method, IValidator interface [.NET Framework hosting]" -ms.assetid: 4c0c7477-05ba-461b-b21b-cbfba95f1db1 -topic_type: +topic_type: - "apiref" --- # IValidator::FormatEventInfo Method -Gets the error message corresponding to the specified validation error. - -## Syntax - -```cpp -HRESULT FormatEventInfo( - [in] HRESULT hVECode, - [in] VEContext Context, - [in, out] LPWSTR msg, - [in] unsigned long ulMaxLength, - [in] SAFEARRAY(VARIANT) psa -); -``` - -## Parameters - - `hVECode` - [in] The HRESULT value that was passed to the validation error handler. - - `Context` - [in] A `VEContext` instance that contains context information about the validation error. - - `msg` - [in, out] A string that contains the returned error message. - - `ulMaxLength` - [in] The maximum length of the error message. - - `psa` - [in] A safe array that contains additional parameters describing the error. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** IValidator.idl, IValidator.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] +Gets the error message corresponding to the specified validation error. + +## Syntax + +```cpp +HRESULT FormatEventInfo( + [in] HRESULT hVECode, + [in] VEContext Context, + [in, out] LPWSTR msg, + [in] unsigned long ulMaxLength, + [in] SAFEARRAY(VARIANT) psa +); +``` + +## Parameters + + `hVECode` + [in] The HRESULT value that was passed to the validation error handler. + + `Context` + [in] A `VEContext` instance that contains context information about the validation error. + + `msg` + [in, out] A string that contains the returned error message. + + `ulMaxLength` + [in] The maximum length of the error message. + + `psa` + [in] A safe array that contains additional parameters describing the error. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** IValidator.idl, IValidator.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 diff --git a/docs/core/unmanaged-api/hosting/ivalidator-interface.md b/docs/core/unmanaged-api/hosting/ivalidator-interface.md index 7d2bcdf87bd46..fdbd6aafa1905 100644 --- a/docs/core/unmanaged-api/hosting/ivalidator-interface.md +++ b/docs/core/unmanaged-api/hosting/ivalidator-interface.md @@ -12,7 +12,6 @@ f1_keywords: - "IValidator" helpviewer_keywords: - "IValidator interface [.NET Framework hosting]" -ms.assetid: b297e3b0-20f9-478f-b707-5e2eecb2b5b2 topic_type: - "apiref" --- @@ -35,7 +34,7 @@ Provides methods for validating portable executable (PE) images and reporting va **Library:** Included 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/hosting/ivalidator-validate-method.md b/docs/core/unmanaged-api/hosting/ivalidator-validate-method.md index 13cedb52a936e..0cf17d4f7b32f 100644 --- a/docs/core/unmanaged-api/hosting/ivalidator-validate-method.md +++ b/docs/core/unmanaged-api/hosting/ivalidator-validate-method.md @@ -13,7 +13,6 @@ f1_keywords: helpviewer_keywords: - "IValidator::Validate method [.NET Framework hosting]" - "Validate method, IValidator interface [.NET Framework hosting]" -ms.assetid: 7d68666a-fb73-4455-bebd-908d49a16abc topic_type: - "apiref" --- @@ -70,4 +69,4 @@ HRESULT Validate ( **Library:** Included 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 diff --git a/docs/core/unmanaged-api/hosting/loadlibraryshim-function.md b/docs/core/unmanaged-api/hosting/loadlibraryshim-function.md index a223a9bd0ca8b..fbc39e9984a54 100644 --- a/docs/core/unmanaged-api/hosting/loadlibraryshim-function.md +++ b/docs/core/unmanaged-api/hosting/loadlibraryshim-function.md @@ -2,76 +2,75 @@ description: "Learn more about: LoadLibraryShim Function" title: "LoadLibraryShim Function" ms.date: "03/30/2017" -api_name: +api_name: - "LoadLibraryShim" -api_location: +api_location: - "mscoree.dll" - "mscoreei.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "LoadLibraryShim" -helpviewer_keywords: +helpviewer_keywords: - "LoadLibraryShim function [.NET Framework hosting]" -ms.assetid: 30931874-4d0e-4df1-b3d1-e425b50655d1 -topic_type: +topic_type: - "apiref" --- # LoadLibraryShim Function -Loads a specified version of a DLL that is included in the .NET Framework redistributable package. - - This function has been deprecated in the .NET Framework 4. Use the [ICLRRuntimeInfo::LoadLibrary](iclrruntimeinfo-loadlibrary-method.md) method instead. - -## Syntax - -```cpp -HRESULT LoadLibraryShim ( - [in] LPCWSTR szDllName, - [in] LPCWSTR szVersion, - LPVOID pvReserved, - [out] HMODULE *phModDll -); -``` - -## Parameters - - `szDllName` - [in] A zero-terminated string that represents the name of the DLL to be loaded from the .NET Framework library. - - `szVersion` - [in] A zero-terminated string that represents the version of the DLL to be loaded. If `szVersion` is null, the version selected for loading is the latest version of the specified DLL that is less than version 4. That is, all versions equal to or greater than version 4 are ignored if `szVersion` is null, and if no version less than version 4 is installed, the DLL fails to load. This is to ensure that installation of the .NET Framework 4 does not affect pre-existing applications or components. See the entry [In-Proc SxS and Migration Quick Start](https://devblogs.microsoft.com/dotnet/in-proc-sxs-and-migration-quick-start/) in the CLR team blog. - - `pvReserved` - Reserved for future use. - - `phModDll` - [out] A pointer to the handle of the module. - -## Return Value - - This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values. - -|Return code|Description| -|-----------------|-----------------| -|S_OK|The method completed successfully.| -|CLR_E_SHIM_RUNTIMELOAD|Loading `szDllName` requires loading the common language runtime (CLR), and the necessary version of the CLR cannot be loaded.| - -## Remarks - - This function is used to load DLLs that are included in the .NET Framework redistributable package. It does not load user-generated DLLs. - +Loads a specified version of a DLL that is included in the .NET Framework redistributable package. + + This function has been deprecated in the .NET Framework 4. Use the [ICLRRuntimeInfo::LoadLibrary](iclrruntimeinfo-loadlibrary-method.md) method instead. + +## Syntax + +```cpp +HRESULT LoadLibraryShim ( + [in] LPCWSTR szDllName, + [in] LPCWSTR szVersion, + LPVOID pvReserved, + [out] HMODULE *phModDll +); +``` + +## Parameters + + `szDllName` + [in] A zero-terminated string that represents the name of the DLL to be loaded from the .NET Framework library. + + `szVersion` + [in] A zero-terminated string that represents the version of the DLL to be loaded. If `szVersion` is null, the version selected for loading is the latest version of the specified DLL that is less than version 4. That is, all versions equal to or greater than version 4 are ignored if `szVersion` is null, and if no version less than version 4 is installed, the DLL fails to load. This is to ensure that installation of the .NET Framework 4 does not affect pre-existing applications or components. See the entry [In-Proc SxS and Migration Quick Start](https://devblogs.microsoft.com/dotnet/in-proc-sxs-and-migration-quick-start/) in the CLR team blog. + + `pvReserved` + Reserved for future use. + + `phModDll` + [out] A pointer to the handle of the module. + +## Return Value + + This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values. + +|Return code|Description| +|-----------------|-----------------| +|S_OK|The method completed successfully.| +|CLR_E_SHIM_RUNTIMELOAD|Loading `szDllName` requires loading the common language runtime (CLR), and the necessary version of the CLR cannot be loaded.| + +## Remarks + + This function is used to load DLLs that are included in the .NET Framework redistributable package. It does not load user-generated DLLs. + > [!NOTE] -> Beginning with .NET Framework version 2.0, loading Fusion.dll causes the CLR to be loaded. This is because the functions in Fusion.dll are now wrappers whose implementations are provided by the runtime. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +> Beginning with .NET Framework version 2.0, loading Fusion.dll causes the CLR to be loaded. This is because the functions in Fusion.dll are now wrappers whose implementations are provided by the runtime. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/loadstringrc-function.md b/docs/core/unmanaged-api/hosting/loadstringrc-function.md index 6168c4802785c..90ed9e0fffe41 100644 --- a/docs/core/unmanaged-api/hosting/loadstringrc-function.md +++ b/docs/core/unmanaged-api/hosting/loadstringrc-function.md @@ -2,74 +2,73 @@ description: "Learn more about: LoadStringRC Function" title: "LoadStringRC Function" ms.date: "03/30/2017" -api_name: +api_name: - "LoadStringRC" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "LoadStringRC" -helpviewer_keywords: +helpviewer_keywords: - "LoadStringRC function [.NET Framework hosting]" -ms.assetid: 752e49b4-987c-4c28-a118-1a0c1ed510c5 -topic_type: +topic_type: - "apiref" --- # LoadStringRC Function -Translates an HRESULT value into an error message by using the default culture of the current thread. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT LoadStringRC ( +Translates an HRESULT value into an error message by using the default culture of the current thread. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT LoadStringRC ( [in] UINT iResourceID, [out] LPWSTR szBuffer, [in] int iMax, - [in] int bQuiet -); -``` - -## Parameters - - `iResourceID` - [in] An HRESULT. - - `szBuffer` - [out] A buffer that contains the error message upon successful completion. - - `iMax` - [in] The size of the error message buffer. - - `bQuiet` - [in] Ignored. - -## Return Value - - This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values. - -|Return code|Description| -|-----------------|-----------------| -|S_OK|The method completed successfully.| -|E_INVALIDARG|`szBuffer` is null or `iMax` is zero (0).| - -## Remarks - - If the method does not complete successfully, `szBuffer` contains an empty string. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll and Mscorwks.dll. Use MSCorEE.dll instead of Mscorwks.dll to ensure that you target the correct version of the .NET Framework. - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - + [in] int bQuiet +); +``` + +## Parameters + + `iResourceID` + [in] An HRESULT. + + `szBuffer` + [out] A buffer that contains the error message upon successful completion. + + `iMax` + [in] The size of the error message buffer. + + `bQuiet` + [in] Ignored. + +## Return Value + + This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values. + +|Return code|Description| +|-----------------|-----------------| +|S_OK|The method completed successfully.| +|E_INVALIDARG|`szBuffer` is null or `iMax` is zero (0).| + +## Remarks + + If the method does not complete successfully, `szBuffer` contains an empty string. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll and Mscorwks.dll. Use MSCorEE.dll instead of Mscorwks.dll to ensure that you target the correct version of the .NET Framework. + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [LoadStringRCEx Function](loadstringrcex-function.md) diff --git a/docs/core/unmanaged-api/hosting/loadstringrcex-function.md b/docs/core/unmanaged-api/hosting/loadstringrcex-function.md index dbe6c266995e2..f02484fdc58d1 100644 --- a/docs/core/unmanaged-api/hosting/loadstringrcex-function.md +++ b/docs/core/unmanaged-api/hosting/loadstringrcex-function.md @@ -2,82 +2,81 @@ description: "Learn more about: LoadStringRCEx Function" title: "LoadStringRCEx Function" ms.date: "03/30/2017" -api_name: +api_name: - "LoadStringRCEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "LoadStringRCEx" -helpviewer_keywords: +helpviewer_keywords: - "LoadStringRCEx function [.NET Framework hosting]" -ms.assetid: bc789636-ca14-4f07-8f77-9305874d7495 -topic_type: +topic_type: - "apiref" --- # LoadStringRCEx Function -Translates an HRESULT value to an appropriate error message for the specified culture. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT LoadStringRCEx ( +Translates an HRESULT value to an appropriate error message for the specified culture. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT LoadStringRCEx ( [in] LCID lcid, [in] UINT iResouceID, [out] LPWSTR szBuffer, [in] int iMax, [in] int bQuiet, - [out] int *pcwchUsed -); -``` - -## Parameters - - `lcid` - [in] A culture identifier. Pass -1 for `lcid` to use the default culture. - - `iResourceID` - [in] An HRESULT. - - `szBuffer` - [out] A buffer that contains the error message upon successful completion. - - `iMax` - [in] The size of the error message buffer. - - `bQuiet` - [in] Ignored. - - `pcwchUsed` - [out] A pointer to the length of the error message. - -## Return Value - - This method returns standard COM error codes, as defined in WinError.h, in addition to the following values. - -|Return code|Description| -|-----------------|-----------------| -|S_OK|The method completed successfully.| -|E_INVALIDARG|`szBuffer` is null, or `iMax` is zero (0).| - -## Remarks - - If the method does not complete successfully, `szBuffer` contains an empty string. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - + [out] int *pcwchUsed +); +``` + +## Parameters + + `lcid` + [in] A culture identifier. Pass -1 for `lcid` to use the default culture. + + `iResourceID` + [in] An HRESULT. + + `szBuffer` + [out] A buffer that contains the error message upon successful completion. + + `iMax` + [in] The size of the error message buffer. + + `bQuiet` + [in] Ignored. + + `pcwchUsed` + [out] A pointer to the length of the error message. + +## Return Value + + This method returns standard COM error codes, as defined in WinError.h, in addition to the following values. + +|Return code|Description| +|-----------------|-----------------| +|S_OK|The method completed successfully.| +|E_INVALIDARG|`szBuffer` is null, or `iMax` is zero (0).| + +## Remarks + + If the method does not complete successfully, `szBuffer` contains an empty string. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/lockclrversion-function.md b/docs/core/unmanaged-api/hosting/lockclrversion-function.md index 55506e4fc4545..72a74f11766e4 100644 --- a/docs/core/unmanaged-api/hosting/lockclrversion-function.md +++ b/docs/core/unmanaged-api/hosting/lockclrversion-function.md @@ -2,95 +2,94 @@ description: "Learn more about: LockClrVersion Function" title: "LockClrVersion Function" ms.date: "03/30/2017" -api_name: +api_name: - "LockClrVersion" -api_location: +api_location: - "mscoree.dll" - "mscoreei.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "LockClrVersion" -helpviewer_keywords: +helpviewer_keywords: - "LockClrVersion function [.NET Framework hosting]" -ms.assetid: 1318ee37-c43b-40eb-bbe8-88fc46453d74 -topic_type: +topic_type: - "apiref" --- # LockClrVersion Function -Allows the host to determine which version of the common language runtime (CLR) will be used within the process before explicitly initializing the CLR. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT LockClrVersion ( - [in] FLockClrVersionCallback hostCallback, - [in] FLockClrVersionCallback *pBeginHostSetup, - [in] FLockClrVersionCallback *pEndHostSetup -); -``` - -## Parameters - - `hostCallback` - [in] The function to be called by the CLR upon initialization. - - `pBeginHostSetup` - [in] The function to be called by the host to inform the CLR that initialization is starting. - - `pEndHostSetup` - [in] The function to be called by the host to inform the CLR that initialization is complete. - -## Return Value - - This method returns standard COM error codes, as defined in WinError.h, in addition to the following values. - -|Return code|Description| -|-----------------|-----------------| -|S_OK|The method completed successfully.| -|E_INVALIDARG|One or more of the arguments is null.| - -## Remarks - - The host calls `LockClrVersion` before initializing the CLR. `LockClrVersion` takes three parameters, all of which are callbacks of type [FLockClrVersionCallback](flockclrversioncallback-function-pointer.md). This type is defined as follows. - -```cpp -typedef HRESULT ( __stdcall *FLockClrVersionCallback ) (); -``` - - The following steps occur upon initialization of the runtime: - -1. The host calls [CorBindToRuntimeEx](corbindtoruntimeex-function.md) or one of the other runtime initialization functions. Alternatively, the host could initialize the runtime using COM object activation. - -2. The runtime calls the function specified by the `hostCallback` parameter. - -3. The function specified by `hostCallback` then makes the following sequence of calls: - - - The function specified by the `pBeginHostSetup` parameter. - - - `CorBindToRuntimeEx` (or another runtime initialization function). - - - [ICLRRuntimeHost::SetHostControl](iclrruntimehost-sethostcontrol-method.md). - - - [ICLRRuntimeHost::Start](iclrruntimehost-start-method.md). - - - The function specified by the `pEndHostSetup` parameter. - - All the calls from `pBeginHostSetup` to `pEndHostSetup` must occur on a single thread or fiber, with the same logical stack. This thread can be different from the thread upon which `hostCallback` is called. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Allows the host to determine which version of the common language runtime (CLR) will be used within the process before explicitly initializing the CLR. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT LockClrVersion ( + [in] FLockClrVersionCallback hostCallback, + [in] FLockClrVersionCallback *pBeginHostSetup, + [in] FLockClrVersionCallback *pEndHostSetup +); +``` + +## Parameters + + `hostCallback` + [in] The function to be called by the CLR upon initialization. + + `pBeginHostSetup` + [in] The function to be called by the host to inform the CLR that initialization is starting. + + `pEndHostSetup` + [in] The function to be called by the host to inform the CLR that initialization is complete. + +## Return Value + + This method returns standard COM error codes, as defined in WinError.h, in addition to the following values. + +|Return code|Description| +|-----------------|-----------------| +|S_OK|The method completed successfully.| +|E_INVALIDARG|One or more of the arguments is null.| + +## Remarks + + The host calls `LockClrVersion` before initializing the CLR. `LockClrVersion` takes three parameters, all of which are callbacks of type [FLockClrVersionCallback](flockclrversioncallback-function-pointer.md). This type is defined as follows. + +```cpp +typedef HRESULT ( __stdcall *FLockClrVersionCallback ) (); +``` + + The following steps occur upon initialization of the runtime: + +1. The host calls [CorBindToRuntimeEx](corbindtoruntimeex-function.md) or one of the other runtime initialization functions. Alternatively, the host could initialize the runtime using COM object activation. + +2. The runtime calls the function specified by the `hostCallback` parameter. + +3. The function specified by `hostCallback` then makes the following sequence of calls: + + - The function specified by the `pBeginHostSetup` parameter. + + - `CorBindToRuntimeEx` (or another runtime initialization function). + + - [ICLRRuntimeHost::SetHostControl](iclrruntimehost-sethostcontrol-method.md). + + - [ICLRRuntimeHost::Start](iclrruntimehost-start-method.md). + + - The function specified by the `pEndHostSetup` parameter. + + All the calls from `pBeginHostSetup` to `pEndHostSetup` must occur on a single thread or fiber, with the same logical stack. This thread can be different from the thread upon which `hostCallback` is called. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md b/docs/core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md index 658dd6ac1f2a0..5e9b4ef28c3d1 100644 --- a/docs/core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md +++ b/docs/core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md @@ -2,63 +2,62 @@ description: "Learn more about: LPOVERLAPPED_COMPLETION_ROUTINE Function Pointer" title: "LPOVERLAPPED_COMPLETION_ROUTINE Function Pointer" ms.date: "03/30/2017" -api_name: +api_name: - "LPOVERLAPPED_COMPLETION_ROUTINE" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "LPOVERLAPPED_COMPLETION_ROUTINE" -helpviewer_keywords: +helpviewer_keywords: - "LPOVERLAPPED_COMPLETION_ROUTINE function pointer [.NET Framework hosting]" -ms.assetid: 5fb645d9-b818-401c-8c2c-c30d86de58ba -topic_type: +topic_type: - "apiref" --- # LPOVERLAPPED_COMPLETION_ROUTINE Function Pointer -Points to a function that notifies the host when an overlapped (that is, asynchronous) I/O to a device has completed. - - This function pointer has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -typedef VOID (*LPOVERLAPPED_COMPLETION_ROUTINE) ( - [in] DWORD dwErrorCode, - [in] DWORD dwNumberOfBytesTransfered, - [in] LPVOID lpOverlapped -); -``` - -## Parameters - - `dwErrorCode` - [in] A value that is an error code if the device has been closed; otherwise, this value is zero. - - Closing a device causes all pending I/O to the device to be completed immediately. - - `dwNumberOfBytesTransfered` - [in] The number of bytes transferred by the I/O operation. - - `lpOverlapped` - [in] A pointer to a structure that contains information to be used to complete the I/O request. - -## Remarks - - The function to which `LPOVERLAPPED_COMPLETION_ROUTINE` points is a callback function and must be implemented by the writer of the hosting application. The callback function allows the host to process the completed I/O request. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorWks.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Points to a function that notifies the host when an overlapped (that is, asynchronous) I/O to a device has completed. + + This function pointer has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +typedef VOID (*LPOVERLAPPED_COMPLETION_ROUTINE) ( + [in] DWORD dwErrorCode, + [in] DWORD dwNumberOfBytesTransfered, + [in] LPVOID lpOverlapped +); +``` + +## Parameters + + `dwErrorCode` + [in] A value that is an error code if the device has been closed; otherwise, this value is zero. + + Closing a device causes all pending I/O to the device to be completed immediately. + + `dwNumberOfBytesTransfered` + [in] The number of bytes transferred by the I/O operation. + + `lpOverlapped` + [in] A pointer to a structure that contains information to be used to complete the I/O request. + +## Remarks + + The function to which `LPOVERLAPPED_COMPLETION_ROUTINE` points is a callback function and must be implemented by the writer of the hosting application. The callback function allows the host to process the completed I/O request. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorWks.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md b/docs/core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md index 2660244843c87..7aa83e77388f8 100644 --- a/docs/core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md +++ b/docs/core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md @@ -2,53 +2,52 @@ description: "Learn more about: LPTHREAD_START_ROUTINE Function Pointer" title: "LPTHREAD_START_ROUTINE Function Pointer" ms.date: "03/30/2017" -api_name: +api_name: - "LPTHREAD_START_ROUTINE" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "LPTHREAD_START_ROUTINE" -helpviewer_keywords: +helpviewer_keywords: - "LPTHREAD_START_ROUTINE function pointer [.NET Framework hosting]" -ms.assetid: 7b9b93b0-fe92-42ba-8693-701168a29dde -topic_type: +topic_type: - "apiref" --- # LPTHREAD_START_ROUTINE Function Pointer -Points to a function that notifies the host that a thread has started to execute. - - This function pointer has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -typedef DWORD (__stdcall *LPTHREAD_START_ROUTINE) ( - [in] LPVOID lpThreadParameter -); -``` - -## Parameters - - `lpThreadParameter` - [in] A pointer to the code that has started executing. - -## Remarks - - The function to which `LPTHREAD_START_ROUTINE` points is a callback function and must be implemented by the writer of the hosting application. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorWks.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Points to a function that notifies the host that a thread has started to execute. + + This function pointer has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +typedef DWORD (__stdcall *LPTHREAD_START_ROUTINE) ( + [in] LPVOID lpThreadParameter +); +``` + +## Parameters + + `lpThreadParameter` + [in] A pointer to the code that has started executing. + +## Remarks + + The function to which `LPTHREAD_START_ROUTINE` points is a callback function and must be implemented by the writer of the hosting application. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorWks.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/malloc-type-enumeration.md b/docs/core/unmanaged-api/hosting/malloc-type-enumeration.md index 7be9ef6d77d87..2330878c0b89f 100644 --- a/docs/core/unmanaged-api/hosting/malloc-type-enumeration.md +++ b/docs/core/unmanaged-api/hosting/malloc-type-enumeration.md @@ -2,50 +2,49 @@ description: "Learn more about: MALLOC_TYPE Enumeration" title: "MALLOC_TYPE Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "MALLOC_TYPE" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "MALLOC_TYPE" -helpviewer_keywords: +helpviewer_keywords: - "MALLOC_TYPE Enumeration" -ms.assetid: c02476f9-23a2-4af7-9282-aa9c42c7429b -topic_type: +topic_type: - "apiref" --- # MALLOC_TYPE Enumeration -Contains values that specify the characteristics of the memory that is being allocated. - -## Syntax - -```cpp -typedef enum { - MALLOC_THREADSAFE = 0x1, - MALLOC_EXECUTABLE = 0x2, -} MALLOC_TYPE; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`MALLOC_EXECUTABLE`|The allocated memory can contain an executable file.| -|`MALLOC_THREADSAFE`|The allocated memory is thread-safe. That is, the memory can be accessed by multiple threads without any synchronization.

If this flag is not set, calls on the object must be serialized.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Contains values that specify the characteristics of the memory that is being allocated. + +## Syntax + +```cpp +typedef enum { + MALLOC_THREADSAFE = 0x1, + MALLOC_EXECUTABLE = 0x2, +} MALLOC_TYPE; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`MALLOC_EXECUTABLE`|The allocated memory can contain an executable file.| +|`MALLOC_THREADSAFE`|The allocated memory is thread-safe. That is, the memory can be accessed by multiple threads without any synchronization.

If this flag is not set, calls on the object must be serialized.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/mdainfo-structure.md b/docs/core/unmanaged-api/hosting/mdainfo-structure.md index 80debb4ec21c3..fa03531fc707f 100644 --- a/docs/core/unmanaged-api/hosting/mdainfo-structure.md +++ b/docs/core/unmanaged-api/hosting/mdainfo-structure.md @@ -2,63 +2,62 @@ description: "Learn more about: MDAInfo Structure" title: "MDAInfo Structure" ms.date: "03/30/2017" -api_name: +api_name: - "MDAInfo" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "MDAInfo" -helpviewer_keywords: +helpviewer_keywords: - "MDAInfo structure [.NET Framework hosting]" -ms.assetid: fb8c14f7-d461-43d1-8b47-adb6723b9b93 -topic_type: +topic_type: - "apiref" --- # MDAInfo Structure -Provides details about the `Event_MDAFired` event, which triggers the creation of a managed debugging assistant (MDA). - -## Syntax - -```cpp -typedef struct _MDAInfo { - LPCWSTR lpMDACaption; - LPCWSTR lpMDAMessage -} MDAInfo; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`lpMDACaption`|The title of the current MDA. The title describes the kind of failure that triggered the `Event_MDAFired` event.| -|`lpMDAMessage`|The output message provided by the current MDA.| - -## Remarks - - Managed debugging assistants (MDAs) are debugging aids that work in conjunction with the common language runtime (CLR) to perform tasks such as identifying invalid conditions in the runtime execution engine or dumping additional information about the state of the engine. MDAs generate XML messages about events that are otherwise difficult to trap. They are especially useful for debugging transitions between managed and unmanaged code. - - The runtime takes the following steps when an event that triggers the creation of an MDA is fired: - -- If the host has not registered an [IActionOnCLREvent](iactiononclrevent-interface.md) instance by calling [ICLROnEventManager::RegisterActionOnEvent](iclroneventmanager-registeractiononevent-method.md) to be notified of an `Event_MDAFired` event, the runtime proceeds with its default, non-hosted behavior. - -- If the host has registered a handler for this event, the runtime checks to see whether a debugger is attached to the process. If it is, the runtime breaks into the debugger. When the debugger continues, it calls into the host. If no debugger is attached, the runtime calls `IActionOnCLREvent::OnEvent` and passes a pointer to an `MDAInfo` instance as the `data` parameter. - - The host can choose to activate MDAs and to be notified when an MDA is activated. This gives the host an opportunity to override default behavior and to abort the managed thread that raised the event, to prevent it from corrupting the process state. For more information about using MDAs, see [Diagnosing Errors with Managed Debugging Assistants](../../debug-trace-profile/diagnosing-errors-with-managed-debugging-assistants.md). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.idl - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Provides details about the `Event_MDAFired` event, which triggers the creation of a managed debugging assistant (MDA). + +## Syntax + +```cpp +typedef struct _MDAInfo { + LPCWSTR lpMDACaption; + LPCWSTR lpMDAMessage +} MDAInfo; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`lpMDACaption`|The title of the current MDA. The title describes the kind of failure that triggered the `Event_MDAFired` event.| +|`lpMDAMessage`|The output message provided by the current MDA.| + +## Remarks + + Managed debugging assistants (MDAs) are debugging aids that work in conjunction with the common language runtime (CLR) to perform tasks such as identifying invalid conditions in the runtime execution engine or dumping additional information about the state of the engine. MDAs generate XML messages about events that are otherwise difficult to trap. They are especially useful for debugging transitions between managed and unmanaged code. + + The runtime takes the following steps when an event that triggers the creation of an MDA is fired: + +- If the host has not registered an [IActionOnCLREvent](iactiononclrevent-interface.md) instance by calling [ICLROnEventManager::RegisterActionOnEvent](iclroneventmanager-registeractiononevent-method.md) to be notified of an `Event_MDAFired` event, the runtime proceeds with its default, non-hosted behavior. + +- If the host has registered a handler for this event, the runtime checks to see whether a debugger is attached to the process. If it is, the runtime breaks into the debugger. When the debugger continues, it calls into the host. If no debugger is attached, the runtime calls `IActionOnCLREvent::OnEvent` and passes a pointer to an `MDAInfo` instance as the `data` parameter. + + The host can choose to activate MDAs and to be notified when an MDA is activated. This gives the host an opportunity to override default behavior and to abort the managed thread that raised the event, to prevent it from corrupting the process state. For more information about using MDAs, see [Diagnosing Errors with Managed Debugging Assistants](../../../framework/debug-trace-profile/diagnosing-errors-with-managed-debugging-assistants.md). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.idl + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Hosting Structures](hosting-structures.md) -- [Diagnosing Errors with Managed Debugging Assistants](../../debug-trace-profile/diagnosing-errors-with-managed-debugging-assistants.md) +- [Diagnosing Errors with Managed Debugging Assistants](../../../framework/debug-trace-profile/diagnosing-errors-with-managed-debugging-assistants.md) diff --git a/docs/core/unmanaged-api/hosting/metahost-config-flags-enumeration.md b/docs/core/unmanaged-api/hosting/metahost-config-flags-enumeration.md index ee6d95395de87..1bc0dcc4a7fbe 100644 --- a/docs/core/unmanaged-api/hosting/metahost-config-flags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/metahost-config-flags-enumeration.md @@ -2,58 +2,57 @@ description: "Learn more about: METAHOST_CONFIG_FLAGS Enumeration" title: "METAHOST_CONFIG_FLAGS Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "METAHOST_CONFIG_FLAGS" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "METAHOST_CONFIG_FLAGS" -helpviewer_keywords: +helpviewer_keywords: - "METAHOST_CONFIG_FLAGS enumeration [.NET Framework hosting]" -ms.assetid: 6f1e389f-ed99-4d6a-a0ba-72d7d869a01d -topic_type: +topic_type: - "apiref" --- # METAHOST_CONFIG_FLAGS Enumeration -Describes the possible flags returned in the `pdwConfigFlags` parameter of the [ICLRMetaHostPolicy::GetRequestedRuntime](iclrmetahostpolicy-getrequestedruntime-method.md) method, indicating the presence and setting of the `useLegacyV2RuntimeActivationPolicy` attribute in the [\ element](../../configure-apps/file-schema/startup/startup-element.md) of the configuration file. - -## Syntax - -```cpp -typedef enum { - METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_UNSET = 0x00, - METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_TRUE = 0x01, - METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_FALSE = 0x02, - METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_MASK = 0x03 -} METAHOST_CONFIG_FLAGS; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_UNSET`|The `useLegacyV2RuntimeActivationPolicy` attribute was not present in the [\ Element](../../configure-apps/file-schema/startup/startup-element.md).| -|`METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_TRUE`|The `useLegacyV2RuntimeActivationPolicy` attribute was present and set to `true`.| -|`METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_FALSE`|The `useLegacyV2RuntimeActivationPolicy` attribute was present and set to `false`.| -|`METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_MASK`|Apply this mask to the value returned in `pdwConfigFlags` to get the values relevant to `useLegacyV2RuntimeActivationPolicy`.| - -## Remarks - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/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)] - +Describes the possible flags returned in the `pdwConfigFlags` parameter of the [ICLRMetaHostPolicy::GetRequestedRuntime](iclrmetahostpolicy-getrequestedruntime-method.md) method, indicating the presence and setting of the `useLegacyV2RuntimeActivationPolicy` attribute in the [\ element](../../../framework/configure-apps/file-schema/startup/startup-element.md) of the configuration file. + +## Syntax + +```cpp +typedef enum { + METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_UNSET = 0x00, + METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_TRUE = 0x01, + METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_FALSE = 0x02, + METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_MASK = 0x03 +} METAHOST_CONFIG_FLAGS; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_UNSET`|The `useLegacyV2RuntimeActivationPolicy` attribute was not present in the [\ Element](../../../framework/configure-apps/file-schema/startup/startup-element.md).| +|`METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_TRUE`|The `useLegacyV2RuntimeActivationPolicy` attribute was present and set to `true`.| +|`METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_FALSE`|The `useLegacyV2RuntimeActivationPolicy` attribute was present and set to `false`.| +|`METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_MASK`|Apply this mask to the value returned in `pdwConfigFlags` to get the values relevant to `useLegacyV2RuntimeActivationPolicy`.| + +## Remarks + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Metahost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [Hosting Enumerations](hosting-enumerations.md) - [GetRequestedRuntime Method](iclrmetahostpolicy-getrequestedruntime-method.md) -- [\ Element](../../configure-apps/file-schema/startup/startup-element.md) +- [\ Element](../../../framework/configure-apps/file-schema/startup/startup-element.md) diff --git a/docs/core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md b/docs/core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md index debebef50f8db..d02bdc97eeecd 100644 --- a/docs/core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md @@ -2,63 +2,62 @@ description: "Learn more about: METAHOST_POLICY_FLAGS Enumeration" title: "METAHOST_POLICY_FLAGS Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "METAHOST_POLICY_FLAGS" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "METAHOST_POLICY_FLAGS" -helpviewer_keywords: +helpviewer_keywords: - "METAHOST_POLICY_FLAGS enumeration [.NET Framework hosting]" -ms.assetid: 3bb4b526-0118-42e2-ba59-c95648528ce9 -topic_type: +topic_type: - "apiref" --- # METAHOST_POLICY_FLAGS Enumeration -Provides binding policies that are common to most runtime hosts. This enumeration is used by the [ICLRMetaHostPolicy::GetRequestedRuntime](iclrmetahostpolicy-getrequestedruntime-method.md) method. - -## Syntax - -```cpp -typedef enum { - METAHOST_POLICY_HIGHCOMPAT = 0x00, - METAHOST_POLICY_APPLY_UPGRADE_POLICY = 0x08, - METAHOST_POLICY_EMULATE_EXE_LAUNCH = 0x10, - METAHOST_POLICY_SHOW_ERROR_DIALOG = 0x20, - METAHOST_POLICY_USE_PROCESS_IMAGE_PATH = 0x40, - METAHOST_POLICY_ENSURE_SKU_SUPPORTED = 0x80, - METAHOST_POLICY_IGNORE_ERROR_MODE = 0x1000 - -} METAHOST_POLICY_FLAGS; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`METAHOST_POLICY_HIGHCOMPAT`|Defines the high-compatibility policy, which does not consider any common language runtime (CLR) that is loaded into the current process. Instead, it considers only the installed CLRs and the preferences of the component, as derived from the assembly file itself, the declared built-against version, or the configuration file.| -|`METAHOST_POLICY_APPLY_UPGRADE_POLICY`|Applies upgrade policy to the version bind result when an exact match is not found, based on the contents of HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\\.NETFramework\Policy\Upgrades. This has the same effect as [RUNTIME_INFO_UPGRADE_VERSION](runtime-info-flags-enumeration.md).| -|`METAHOST_POLICY_EMULATE_EXE_LAUNCH`|Binding results are returned as if the image provided to the call were launched in a new process. Currently, `GetRequestedRuntime` ignores the set of loadable runtimes and binds against the set of installed runtimes. This flag allows a host to determine which runtime an EXE will bind to when it is launched.| -|`METAHOST_POLICY_SHOW_ERROR_DIALOG`|An error dialog box is displayed if `GetRequestedRuntime` is unable to find a runtime that is compatible with the input parameters. Beginning with .NET Framework 4.5, this error dialog box can take the form of a Windows feature dialog box that asks whether the user would like to enable the appropriate feature.| -|`METAHOST_POLICY_USE_PROCESS_IMAGE_PATH`|`GetRequestedRuntime` uses the process image (and any corresponding configuration file) as additional input to the binding process. By default, `GetRequestedRuntime` does not fall back to the process image path (typically, the EXE that was used to launch the process) when determining the runtime to bind to.| -|`METAHOST_POLICY_ENSURE_SKU_SUPPORTED`|`GetRequestedRuntime` must check whether the appropriate SKU is installed when no information is available in the configuration file. This allows applications that do not have configuration files to fail gracefully on smaller SKUs than the default installation of the .NET Framework. By default, `GetRequestedRuntime` does not check whether the appropriate SKU is installed unless the SKU attribute is specified in the configuration file `` element.| -|`METAHOST_POLICY_IGNORE_ERROR_MODE`|`GetRequestedRuntime` should ignore SEM_FAILCRITICALERRORS (which is set by calling the [SetErrorMode](/windows/win32/api/errhandlingapi/nf-errhandlingapi-seterrormode) function), and show the error dialog box. By default, SEM_FAILCRITICALERRORS suppresses the error dialog box. It may have been inherited from another process, and the silent error may be undesirable in your scenario.| - -## Remarks - -## Requirements +Provides binding policies that are common to most runtime hosts. This enumeration is used by the [ICLRMetaHostPolicy::GetRequestedRuntime](iclrmetahostpolicy-getrequestedruntime-method.md) method. + +## Syntax + +```cpp +typedef enum { + METAHOST_POLICY_HIGHCOMPAT = 0x00, + METAHOST_POLICY_APPLY_UPGRADE_POLICY = 0x08, + METAHOST_POLICY_EMULATE_EXE_LAUNCH = 0x10, + METAHOST_POLICY_SHOW_ERROR_DIALOG = 0x20, + METAHOST_POLICY_USE_PROCESS_IMAGE_PATH = 0x40, + METAHOST_POLICY_ENSURE_SKU_SUPPORTED = 0x80, + METAHOST_POLICY_IGNORE_ERROR_MODE = 0x1000 + +} METAHOST_POLICY_FLAGS; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`METAHOST_POLICY_HIGHCOMPAT`|Defines the high-compatibility policy, which does not consider any common language runtime (CLR) that is loaded into the current process. Instead, it considers only the installed CLRs and the preferences of the component, as derived from the assembly file itself, the declared built-against version, or the configuration file.| +|`METAHOST_POLICY_APPLY_UPGRADE_POLICY`|Applies upgrade policy to the version bind result when an exact match is not found, based on the contents of HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\\.NETFramework\Policy\Upgrades. This has the same effect as [RUNTIME_INFO_UPGRADE_VERSION](runtime-info-flags-enumeration.md).| +|`METAHOST_POLICY_EMULATE_EXE_LAUNCH`|Binding results are returned as if the image provided to the call were launched in a new process. Currently, `GetRequestedRuntime` ignores the set of loadable runtimes and binds against the set of installed runtimes. This flag allows a host to determine which runtime an EXE will bind to when it is launched.| +|`METAHOST_POLICY_SHOW_ERROR_DIALOG`|An error dialog box is displayed if `GetRequestedRuntime` is unable to find a runtime that is compatible with the input parameters. Beginning with .NET Framework 4.5, this error dialog box can take the form of a Windows feature dialog box that asks whether the user would like to enable the appropriate feature.| +|`METAHOST_POLICY_USE_PROCESS_IMAGE_PATH`|`GetRequestedRuntime` uses the process image (and any corresponding configuration file) as additional input to the binding process. By default, `GetRequestedRuntime` does not fall back to the process image path (typically, the EXE that was used to launch the process) when determining the runtime to bind to.| +|`METAHOST_POLICY_ENSURE_SKU_SUPPORTED`|`GetRequestedRuntime` must check whether the appropriate SKU is installed when no information is available in the configuration file. This allows applications that do not have configuration files to fail gracefully on smaller SKUs than the default installation of the .NET Framework. By default, `GetRequestedRuntime` does not check whether the appropriate SKU is installed unless the SKU attribute is specified in the configuration file `` element.| +|`METAHOST_POLICY_IGNORE_ERROR_MODE`|`GetRequestedRuntime` should ignore SEM_FAILCRITICALERRORS (which is set by calling the [SetErrorMode](/windows/win32/api/errhandlingapi/nf-errhandlingapi-seterrormode) function), and show the error dialog box. By default, SEM_FAILCRITICALERRORS suppresses the error dialog box. It may have been inherited from another process, and the silent error may be undesirable in your scenario.| + +## Remarks + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** Metahost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - **Platforms:** See [System Requirements](../../../framework/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 Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/modulebindinfo-structure.md b/docs/core/unmanaged-api/hosting/modulebindinfo-structure.md index 0c6af7c05236e..f0262aff3f19f 100644 --- a/docs/core/unmanaged-api/hosting/modulebindinfo-structure.md +++ b/docs/core/unmanaged-api/hosting/modulebindinfo-structure.md @@ -2,56 +2,55 @@ description: "Learn more about: ModuleBindInfo Structure" title: "ModuleBindInfo Structure" ms.date: "03/30/2017" -api_name: +api_name: - "ModuleBindInfo" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ModuleBindInfo" -helpviewer_keywords: +helpviewer_keywords: - "ModuleBindInfo structure [.NET Framework hosting]" -ms.assetid: 632d4adc-dbc9-4ce8-9397-abc3285c1c69 -topic_type: +topic_type: - "apiref" --- # ModuleBindInfo Structure -Provides detailed information about the referenced module and the assembly that contains it. - -## Syntax - -```cpp -typedef struct _ModuleBindInfo { - DWORD dwAppDomainId; - LPCWSTR lpAssemblyIdentity; - LPCWSTR lpModuleName -} ModuleBindInfo; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`dwAppDomainId`|A unique identifier for the `IStream` that is returned by a call to the [IHostAssemblyStore::ProvideModule](ihostassemblystore-providemodule-method.md) method from which the referenced module is to be loaded.| -|`lpAssemblyIdentity`|A unique identifier for the assembly that contains the referenced module.| -|`lpModuleName`|The name of the referenced module.| - -## Remarks - - `ModuleBindInfo` is passed as a parameter to `IHostAssemblyStore::ProvideModule`. The host supplies the unique identifier `dwAppDomainId` to the common language runtime (CLR). After a call to the [IHostAssemblyStore::ProvideAssembly](ihostassemblystore-provideassembly-method.md) method returns, the runtime uses the identifier to determine whether the contents of the `IStream` have been mapped. If so, the runtime loads the existing copy rather than remapping the stream. The runtime also uses this identifier as a lookup key for streams that are returned from calls to the `IHostAssemblyStore::ProvideAssembly` method. Therefore, the identifier must be unique for module requests as well as for assembly requests. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.idl - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Provides detailed information about the referenced module and the assembly that contains it. + +## Syntax + +```cpp +typedef struct _ModuleBindInfo { + DWORD dwAppDomainId; + LPCWSTR lpAssemblyIdentity; + LPCWSTR lpModuleName +} ModuleBindInfo; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`dwAppDomainId`|A unique identifier for the `IStream` that is returned by a call to the [IHostAssemblyStore::ProvideModule](ihostassemblystore-providemodule-method.md) method from which the referenced module is to be loaded.| +|`lpAssemblyIdentity`|A unique identifier for the assembly that contains the referenced module.| +|`lpModuleName`|The name of the referenced module.| + +## Remarks + + `ModuleBindInfo` is passed as a parameter to `IHostAssemblyStore::ProvideModule`. The host supplies the unique identifier `dwAppDomainId` to the common language runtime (CLR). After a call to the [IHostAssemblyStore::ProvideAssembly](ihostassemblystore-provideassembly-method.md) method returns, the runtime uses the identifier to determine whether the contents of the `IStream` have been mapped. If so, the runtime loads the existing copy rather than remapping the stream. The runtime also uses this identifier as a lookup key for streams that are returned from calls to the `IHostAssemblyStore::ProvideAssembly` method. Therefore, the identifier must be unique for module requests as well as for assembly requests. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.idl + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Hosting Structures](hosting-structures.md) diff --git a/docs/core/unmanaged-api/hosting/net-framework-4-hosting-global-static-functions.md b/docs/core/unmanaged-api/hosting/net-framework-4-hosting-global-static-functions.md index e5376a63e5d71..7a4f2b9c4fb66 100644 --- a/docs/core/unmanaged-api/hosting/net-framework-4-hosting-global-static-functions.md +++ b/docs/core/unmanaged-api/hosting/net-framework-4-hosting-global-static-functions.md @@ -2,21 +2,20 @@ description: "Learn more about: .NET Framework 4 Hosting Global Static Functions" title: ".NET Framework 4 Hosting Global Static Functions" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - "hosting global static functions [.NET Framework], version 4" - "global static functions [.NET Framework hosting], version 4" - ".NET Framework 4, hosting global static functions" -ms.assetid: 07a1a6e1-db73-4555-81df-bc4054c51492 --- # .NET Framework 4 Hosting Global Static Functions -The .NET Framework 4 introduces one new exported method in MSCorEE.dll: [CLRCreateInstance](clrcreateinstance-function.md). - -## In This Section +The .NET Framework 4 introduces one new exported method in MSCorEE.dll: [CLRCreateInstance](clrcreateinstance-function.md). + +## In This Section + + [CLRCreateInstance Function](clrcreateinstance-function.md) + Provides one of three interfaces: [ICLRMetaHost](iclrmetahost-interface.md), [ICLRMetaHostPolicy](iclrmetahostpolicy-interface.md), or [ICLRDebugging](../../../framework/unmanaged-api/debugging/iclrdebugging-interface.md). - [CLRCreateInstance Function](clrcreateinstance-function.md) - Provides one of three interfaces: [ICLRMetaHost](iclrmetahost-interface.md), [ICLRMetaHostPolicy](iclrmetahostpolicy-interface.md), or [ICLRDebugging](../../../framework/unmanaged-api/debugging/iclrdebugging-interface.md). - ## See also - [Hosting Global Static Functions](hosting-global-static-functions.md) diff --git a/docs/core/unmanaged-api/hosting/rundll32shimw-function.md b/docs/core/unmanaged-api/hosting/rundll32shimw-function.md index 91fc3839333e0..557a7d81f42ca 100644 --- a/docs/core/unmanaged-api/hosting/rundll32shimw-function.md +++ b/docs/core/unmanaged-api/hosting/rundll32shimw-function.md @@ -2,61 +2,60 @@ description: "Learn more about: RunDll32ShimW Function" title: "RunDll32ShimW Function" ms.date: "03/30/2017" -api_name: +api_name: - "RunDll32ShimW" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "RunDll32ShimW" -helpviewer_keywords: +helpviewer_keywords: - "RunDll32ShimW function [.NET Framework hosting]" -ms.assetid: 9ea07b57-96e2-44df-8711-8fe6c119087f -topic_type: +topic_type: - "apiref" --- # RunDll32ShimW Function -Executes the specified command. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT RunDll32ShimW ( - [in] HWND hwnd, - [in] HINSTANCE hinst, - [in] LPCWSTR lpszCmdLine, - [in] int nCmdShow -); -``` - -## Parameters - - `hwnd` - [in] A handle to a window in which the command output will be displayed. - - `hinst` - [in] A handle to the library that contains the command. - - `lpszCmdLine` - [in] A string that specifies the command to be executed. - - `nCmdShow` - [in] An integer that specifies the display mode for the output window. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Executes the specified command. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT RunDll32ShimW ( + [in] HWND hwnd, + [in] HINSTANCE hinst, + [in] LPCWSTR lpszCmdLine, + [in] int nCmdShow +); +``` + +## Parameters + + `hwnd` + [in] A handle to a window in which the command output will be displayed. + + `hinst` + [in] A handle to the library that contains the command. + + `lpszCmdLine` + [in] A string that specifies the command to be executed. + + `nCmdShow` + [in] An integer that specifies the display mode for the output window. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/runtime-info-flags-enumeration.md b/docs/core/unmanaged-api/hosting/runtime-info-flags-enumeration.md index f3c75080fb55d..5be6534cf22fd 100644 --- a/docs/core/unmanaged-api/hosting/runtime-info-flags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/runtime-info-flags-enumeration.md @@ -2,74 +2,73 @@ description: "Learn more about: RUNTIME_INFO_FLAGS Enumeration" title: "RUNTIME_INFO_FLAGS Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "RUNTIME_INFO_FLAGS" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "RUNTIME_INFO_FLAGS" -helpviewer_keywords: +helpviewer_keywords: - "RUNTIME_INFO_FLAGS enumeration [.NET Framework hosting]" -ms.assetid: adba37be-f775-4cdb-8919-5746ce694f33 -topic_type: +topic_type: - "apiref" --- # RUNTIME_INFO_FLAGS Enumeration -Contains values that indicate what information about the common language runtime (CLR) should be returned. - -## Syntax - -```cpp -typedef enum { - - RUNTIME_INFO_UPGRADE_VERSION = 0x01, - RUNTIME_INFO_REQUEST_IA64 = 0x02, - RUNTIME_INFO_REQUEST_AMD64 = 0x04, - RUNTIME_INFO_REQUEST_X86 = 0x08, - RUNTIME_INFO_DONT_RETURN_DIRECTORY = 0x10, - RUNTIME_INFO_DONT_RETURN_VERSION = 0x20, - RUNTIME_INFO_DONT_SHOW_ERROR_DIALOG = 0x40, - RUNTIME_INFO_IGNORE_ERROR_MODE = 0x1000 - -} RUNTIME_INFO_FLAGS; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`RUNTIME_INFO_DONT_RETURN_DIRECTORY`|Indicates that directory information should not be included.| -|`RUNTIME_INFO_DONT_RETURN_VERSION`|Indicates that version information should not be included.| -|`RUNTIME_INFO_DONT_SHOW_ERROR_DIALOG`|Indicates that an error dialog box should not be shown upon failure.| -|`RUNTIME_INFO_IGNORE_ERROR_MODE`|Indicates that the effects of calling the [SetErrorMode](/windows/win32/api/errhandlingapi/nf-errhandlingapi-seterrormode) function with the SEM_FAILCRITICALERRORS flag should be overridden. That is, an installation dialog box should be shown upon failure, instead of being suppressed.| -|`RUNTIME_INFO_REQUEST_AMD64`|Indicates a request for information about an AMD-64-compatible version of the runtime.| -|`RUNTIME_INFO_REQUEST_IA64`|Indicates a request for information about an IA-64-compatible version of the runtime.| -|`RUNTIME_INFO_REQUEST_X86`|Indicates a request for information about an x86-compatible version of the runtime.| -|`RUNTIME_INFO_UPGRADE_VERSION`|Indicates that version upgrade information should be included.| - -## Remarks - - The following platform architecture flags can be specified only one at a time and cannot be combined: - -- RUNTIME_INFO_REQUEST_IA64 - -- RUNTIME_INFO_REQUEST_AMD64 - -- RUNTIME_INFO_REQUEST_X86 - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Contains values that indicate what information about the common language runtime (CLR) should be returned. + +## Syntax + +```cpp +typedef enum { + + RUNTIME_INFO_UPGRADE_VERSION = 0x01, + RUNTIME_INFO_REQUEST_IA64 = 0x02, + RUNTIME_INFO_REQUEST_AMD64 = 0x04, + RUNTIME_INFO_REQUEST_X86 = 0x08, + RUNTIME_INFO_DONT_RETURN_DIRECTORY = 0x10, + RUNTIME_INFO_DONT_RETURN_VERSION = 0x20, + RUNTIME_INFO_DONT_SHOW_ERROR_DIALOG = 0x40, + RUNTIME_INFO_IGNORE_ERROR_MODE = 0x1000 + +} RUNTIME_INFO_FLAGS; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`RUNTIME_INFO_DONT_RETURN_DIRECTORY`|Indicates that directory information should not be included.| +|`RUNTIME_INFO_DONT_RETURN_VERSION`|Indicates that version information should not be included.| +|`RUNTIME_INFO_DONT_SHOW_ERROR_DIALOG`|Indicates that an error dialog box should not be shown upon failure.| +|`RUNTIME_INFO_IGNORE_ERROR_MODE`|Indicates that the effects of calling the [SetErrorMode](/windows/win32/api/errhandlingapi/nf-errhandlingapi-seterrormode) function with the SEM_FAILCRITICALERRORS flag should be overridden. That is, an installation dialog box should be shown upon failure, instead of being suppressed.| +|`RUNTIME_INFO_REQUEST_AMD64`|Indicates a request for information about an AMD-64-compatible version of the runtime.| +|`RUNTIME_INFO_REQUEST_IA64`|Indicates a request for information about an IA-64-compatible version of the runtime.| +|`RUNTIME_INFO_REQUEST_X86`|Indicates a request for information about an x86-compatible version of the runtime.| +|`RUNTIME_INFO_UPGRADE_VERSION`|Indicates that version upgrade information should be included.| + +## Remarks + + The following platform architecture flags can be specified only one at a time and cannot be combined: + +- RUNTIME_INFO_REQUEST_IA64 + +- RUNTIME_INFO_REQUEST_AMD64 + +- RUNTIME_INFO_REQUEST_X86 + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md b/docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md index 139a991cb8fb1..06100f28379b7 100644 --- a/docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md +++ b/docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md @@ -2,54 +2,53 @@ description: "Learn more about: StackOverflowInfo Structure" title: "StackOverflowInfo Structure" ms.date: "03/30/2017" -api_name: +api_name: - "StackOverflowInfo" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "StackOverflowInfo" -helpviewer_keywords: +helpviewer_keywords: - "StackOverflowInfo structure [.NET Framework hosting]" -ms.assetid: 519389f2-0217-436c-99d4-93a76ebce5b5 -topic_type: +topic_type: - "apiref" --- # StackOverflowInfo Structure -Stores the type of overflow that occurred and information on the exception that was thrown due to the overflow. - -## Syntax - -```cpp -typedef struct _StackOverflowInfo { - StackOverflowType soType; - EXCEPTION_POINTERS *pExceptionInfo; -} StackOverflowInfo; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`soType`|A value of the [StackOverflowType](stackoverflowtype-enumeration.md) enumeration that specifies the type of overflow.| -|`pExceptionInfo`|A pointer to a Win32 `EXCEPTION_POINTERS` object, which contains an exception record with a machine-independent description of an exception and a context record with a machine-dependent description of the processor context at the time of the exception.| - -## Remarks - - A `StackOverflowInfo` object is passed to the [IActionOnCLREvent::OnEvent](iactiononclrevent-onevent-method.md) method for `Event_StackOverflow` events. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.idl - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Stores the type of overflow that occurred and information on the exception that was thrown due to the overflow. + +## Syntax + +```cpp +typedef struct _StackOverflowInfo { + StackOverflowType soType; + EXCEPTION_POINTERS *pExceptionInfo; +} StackOverflowInfo; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`soType`|A value of the [StackOverflowType](stackoverflowtype-enumeration.md) enumeration that specifies the type of overflow.| +|`pExceptionInfo`|A pointer to a Win32 `EXCEPTION_POINTERS` object, which contains an exception record with a machine-independent description of an exception and a context record with a machine-dependent description of the processor context at the time of the exception.| + +## Remarks + + A `StackOverflowInfo` object is passed to the [IActionOnCLREvent::OnEvent](iactiononclrevent-onevent-method.md) method for `Event_StackOverflow` events. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.idl + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Hosting Structures](hosting-structures.md) diff --git a/docs/core/unmanaged-api/hosting/stackoverflowtype-enumeration.md b/docs/core/unmanaged-api/hosting/stackoverflowtype-enumeration.md index 8afe571b46e15..1ce0eb09efce3 100644 --- a/docs/core/unmanaged-api/hosting/stackoverflowtype-enumeration.md +++ b/docs/core/unmanaged-api/hosting/stackoverflowtype-enumeration.md @@ -2,56 +2,55 @@ description: "Learn more about: StackOverflowType Enumeration" title: "StackOverflowType Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "StackOverflowType" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "StackOverflowType" -helpviewer_keywords: +helpviewer_keywords: - "StackOverflowType enumeration [.NET Framework hosting]" -ms.assetid: dab648ad-972b-479c-b129-b4c1dcbd932e -topic_type: +topic_type: - "apiref" --- # StackOverflowType Enumeration -Contains values that indicate the underlying cause of a stack overflow event. - -## Syntax - -```cpp -typedef enum { - SO_Managed, - SO_ClrEngine, - SO_Other -} StackOverflowType; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`SO_ClrEngine`|The stack overflow was caused by the execution engine.| -|`SO_Managed`|The stack overflow was caused by managed code.| -|`SO_Other`|The stack overflow was caused by unmanaged code.| - -## Remarks - - This information is passed to the host through a call to the [IActionOnCLREvent::OnEvent](iactiononclrevent-onevent-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Contains values that indicate the underlying cause of a stack overflow event. + +## Syntax + +```cpp +typedef enum { + SO_Managed, + SO_ClrEngine, + SO_Other +} StackOverflowType; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`SO_ClrEngine`|The stack overflow was caused by the execution engine.| +|`SO_Managed`|The stack overflow was caused by managed code.| +|`SO_Other`|The stack overflow was caused by unmanaged code.| + +## Remarks + + This information is passed to the host through a call to the [IActionOnCLREvent::OnEvent](iactiononclrevent-onevent-method.md) method. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/startup-flags-enumeration.md b/docs/core/unmanaged-api/hosting/startup-flags-enumeration.md index 3be8f64353d1e..aeb9e9feea13f 100644 --- a/docs/core/unmanaged-api/hosting/startup-flags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/startup-flags-enumeration.md @@ -2,82 +2,81 @@ description: "Learn more about: STARTUP_FLAGS Enumeration" title: "STARTUP_FLAGS Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "STARTUP_FLAGS" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "STARTUP_FLAGS" -helpviewer_keywords: +helpviewer_keywords: - "STARTUP_FLAGS enumeration [.NET Framework hosting]" -ms.assetid: 4f043594-0c45-4bc6-988e-a6793f0d8d06 -topic_type: +topic_type: - "apiref" --- # STARTUP_FLAGS Enumeration -Contains values that indicate the startup behavior of the common language runtime (CLR). By default, garbage collection is non-concurrent, and only the base class library is loaded into the domain-neutral area. - -## Syntax - -```cpp -typedef enum { - STARTUP_CONCURRENT_GC = 0x1, - STARTUP_LOADER_OPTIMIZATION_MASK = 0x3<<1, - STARTUP_LOADER_OPTIMIZATION_SINGLE_DOMAIN = 0x1<<1, - STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN = 0x2<<1, - STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN_HOST = 0x3<<1, - - STARTUP_LOADER_SAFEMODE = 0x10, - STARTUP_LOADER_SETPREFERENCE = 0x100, - - STARTUP_SERVER_GC = 0x1000, - STARTUP_HOARD_GC_VM = 0x2000, - - STARTUP_SINGLE_VERSION_HOSTING_INTERFACE = 0x4000, - STARTUP_LEGACY_IMPERSONATION = 0x10000, - STARTUP_DISABLE_COMMITTHREADSTACK = 0x20000, - STARTUP_ALWAYSFLOW_IMPERSONATION = 0x40000, - STARTUP_TRIM_GC_COMMIT = 0x80000, - - STARTUP_ETW = 0x100000, - STARTUP_ARM = 0x400000 -} STARTUP_FLAGS; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`STARTUP_CONCURRENT_GC`|Specifies that concurrent garbage collection should be used. If the caller asks for the server build and concurrent garbage collection on a single-processor machine, the workstation build and non-concurrent garbage collection are run instead. **Note:** Concurrent garbage collection is not supported in applications that are running the WOW64 x86 emulator on 64-bit systems that implement the Intel Itanium architecture (formerly called IA-64). For more information about using WOW64 on 64-bit Windows systems, see [Running 32-bit Applications](/windows/desktop/WinProg64/running-32-bit-applications).| -|`STARTUP_LOADER_OPTIMIZATION_MASK`|Specifies that loader optimization shall occur.| -|`STARTUP_LOADER_OPTIMIZATION_SINGLE_DOMAIN`|Specifies that no assemblies are loaded as domain-neutral.| -|`STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN`|Specifies that all assemblies are loaded as domain-neutral.| -|`STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN_HOST`|Specifies that all strong-named assemblies are loaded as domain-neutral.| -|`STARTUP_LOADER_SAFEMODE`|Specifies that CLR version policy will not be applied to the version passed in. The exact version specified of the CLR will be loaded. The shim does not evaluate policy to determine the latest compatible version.| -|`STARTUP_LOADER_SETPREFERENCE`|Specifies that the preferred runtime will be set, but not actually started.| -|`STARTUP_SERVER_GC`|Specifies that the server garbage collection will be used.| -|`STARTUP_HOARD_GC_VM`|Specifies that garbage collection will keep the virtual address used.| -|`STARTUP_SINGLE_VERSION_HOSTING_INTERFACE`|Specifies that mixing a hosting interface will not be allowed.| -|`STARTUP_LEGACY_IMPERSONATION`|Specifies that impersonation should not flow across asynchronous points by default.| -|`STARTUP_DISABLE_COMMITTHREADSTACK`|Specifies that the full thread stack should not be committed when the thread starts running.| -|`STARTUP_ALWAYSFLOW_IMPERSONATION`|Specifies that managed impersonations and impersonations achieved through platform invoke will flow across asynchronous points. By default, only managed impersonations will flow across asynchronous points.| -|`STARTUP_TRIM_GC_COMMIT`|Specifies that garbage collection will use less committed space when system memory is low. See `gcTrimCommitOnLowMemory` in [Optimization for Shared Web Hosting](../../../standard/garbage-collection/optimization-for-shared-web-hosting.md).| -|`STARTUP_ETW`|Specifies that event tracing for Windows (ETW) is enabled for common language runtime events. Beginning with Windows Vista, event tracing is always enabled, so this flag has no effect. See [Controlling .NET Framework Logging](../../performance/controlling-logging.md).| -|`STARTUP_ARM`|Specifies that application domain resource monitoring is enabled. See the property and [\ Element](../../configure-apps/file-schema/runtime/appdomainresourcemonitoring-element.md).| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Contains values that indicate the startup behavior of the common language runtime (CLR). By default, garbage collection is non-concurrent, and only the base class library is loaded into the domain-neutral area. + +## Syntax + +```cpp +typedef enum { + STARTUP_CONCURRENT_GC = 0x1, + STARTUP_LOADER_OPTIMIZATION_MASK = 0x3<<1, + STARTUP_LOADER_OPTIMIZATION_SINGLE_DOMAIN = 0x1<<1, + STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN = 0x2<<1, + STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN_HOST = 0x3<<1, + + STARTUP_LOADER_SAFEMODE = 0x10, + STARTUP_LOADER_SETPREFERENCE = 0x100, + + STARTUP_SERVER_GC = 0x1000, + STARTUP_HOARD_GC_VM = 0x2000, + + STARTUP_SINGLE_VERSION_HOSTING_INTERFACE = 0x4000, + STARTUP_LEGACY_IMPERSONATION = 0x10000, + STARTUP_DISABLE_COMMITTHREADSTACK = 0x20000, + STARTUP_ALWAYSFLOW_IMPERSONATION = 0x40000, + STARTUP_TRIM_GC_COMMIT = 0x80000, + + STARTUP_ETW = 0x100000, + STARTUP_ARM = 0x400000 +} STARTUP_FLAGS; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`STARTUP_CONCURRENT_GC`|Specifies that concurrent garbage collection should be used. If the caller asks for the server build and concurrent garbage collection on a single-processor machine, the workstation build and non-concurrent garbage collection are run instead. **Note:** Concurrent garbage collection is not supported in applications that are running the WOW64 x86 emulator on 64-bit systems that implement the Intel Itanium architecture (formerly called IA-64). For more information about using WOW64 on 64-bit Windows systems, see [Running 32-bit Applications](/windows/desktop/WinProg64/running-32-bit-applications).| +|`STARTUP_LOADER_OPTIMIZATION_MASK`|Specifies that loader optimization shall occur.| +|`STARTUP_LOADER_OPTIMIZATION_SINGLE_DOMAIN`|Specifies that no assemblies are loaded as domain-neutral.| +|`STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN`|Specifies that all assemblies are loaded as domain-neutral.| +|`STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN_HOST`|Specifies that all strong-named assemblies are loaded as domain-neutral.| +|`STARTUP_LOADER_SAFEMODE`|Specifies that CLR version policy will not be applied to the version passed in. The exact version specified of the CLR will be loaded. The shim does not evaluate policy to determine the latest compatible version.| +|`STARTUP_LOADER_SETPREFERENCE`|Specifies that the preferred runtime will be set, but not actually started.| +|`STARTUP_SERVER_GC`|Specifies that the server garbage collection will be used.| +|`STARTUP_HOARD_GC_VM`|Specifies that garbage collection will keep the virtual address used.| +|`STARTUP_SINGLE_VERSION_HOSTING_INTERFACE`|Specifies that mixing a hosting interface will not be allowed.| +|`STARTUP_LEGACY_IMPERSONATION`|Specifies that impersonation should not flow across asynchronous points by default.| +|`STARTUP_DISABLE_COMMITTHREADSTACK`|Specifies that the full thread stack should not be committed when the thread starts running.| +|`STARTUP_ALWAYSFLOW_IMPERSONATION`|Specifies that managed impersonations and impersonations achieved through platform invoke will flow across asynchronous points. By default, only managed impersonations will flow across asynchronous points.| +|`STARTUP_TRIM_GC_COMMIT`|Specifies that garbage collection will use less committed space when system memory is low. See `gcTrimCommitOnLowMemory` in [Optimization for Shared Web Hosting](../../../standard/garbage-collection/optimization-for-shared-web-hosting.md).| +|`STARTUP_ETW`|Specifies that event tracing for Windows (ETW) is enabled for common language runtime events. Beginning with Windows Vista, event tracing is always enabled, so this flag has no effect. See [Controlling .NET Framework Logging](../../../framework/performance/controlling-logging.md).| +|`STARTUP_ARM`|Specifies that application domain resource monitoring is enabled. See the property and [\ Element](../../../framework/configure-apps/file-schema/runtime/appdomainresourcemonitoring-element.md).| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md b/docs/core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md index b75c50ffb3805..d5d4bdd2b94e1 100644 --- a/docs/core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md +++ b/docs/core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md @@ -2,97 +2,96 @@ description: "Learn more about: StrongNameGetPublicKeyEx Method" title: "StrongNameGetPublicKeyEx Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName2.StrongNameGetPublicKeyEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "StrongNameGetPublicKeyEx" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameGetPublicKeyEx method, ICLRStrongName2 interface [.NET Framework hosting]" - "ICLRStrongName2::StrongNameGetPublicKeyEx method [.NET Framework hosting]" -ms.assetid: 63d8260c-fb32-4f8f-a357-768afd570f68 -topic_type: +topic_type: - "apiref" --- # StrongNameGetPublicKeyEx Method -Gets the public key from a public/private key pair, and specifies a hash algorithm and a signature algorithm. - -## Syntax - -```cpp +Gets the public key from a public/private key pair, and specifies a hash algorithm and a signature algorithm. + +## Syntax + +```cpp HRESULT StrongNameGetPublicKey ( - [in] LPCWSTR pwzKeyContainer, - [in] BYTE *pbKeyBlob, - [in] ULONG cbKeyBlob, - [out] BYTE **ppbPublicKeyBlob, - [out] ULONG *pcbPublicKeyBlob - [in] ULONG uHashAlgId, - [in] ULONG uReserved, -); -``` - -## Parameters - - `pwzKeyContainer` - [in] The name of the key container that contains the public/private key pair. If `pbKeyBlob` is null, `szKeyContainer` must specify a valid container within the cryptographic service provider (CSP). In this case, the `StrongNameGetPublicKeyEx` method extracts the public key from the key pair stored in the container. - - If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). - - The keys must be 1024-bit Rivest-Shamir-Adleman (RSA) signing keys. No other types of keys are supported at this time. - - `pbKeyBlob` - [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `szKeyContainer` is assumed to contain the key pair. - - `cbKeyBlob` - [in] The size, in bytes, of `pbKeyBlob`. - - `ppbPublicKeyBlob` - [out] The returned public key BLOB. The `ppbPublicKeyBlob` parameter is allocated by the common language runtime and returned to the caller. The caller must free the memory by using the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method. - - `pcbPublicKeyBlob` - [out] The size of the returned public key BLOB. - - `uHashAlgId` - [in] The assembly hash algorithm. See the Remarks section for a list of accepted values. - - `uReserved` - [in] Reserved for future use; defaults to null. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - The public key is contained in a [PublicKeyBlob](../strong-naming/publickeyblob-structure.md) structure. - - The following table shows the set of accepted values for the `uHashAlgId` parameter. - -|Name|Value| -|----------|-----------| -|None|0| -|SHA-1|0x8004| -|SHA-256|0x800c| -|SHA-384|0x800d| -|SHA-512|0x800e| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] - + [in] LPCWSTR pwzKeyContainer, + [in] BYTE *pbKeyBlob, + [in] ULONG cbKeyBlob, + [out] BYTE **ppbPublicKeyBlob, + [out] ULONG *pcbPublicKeyBlob + [in] ULONG uHashAlgId, + [in] ULONG uReserved, +); +``` + +## Parameters + + `pwzKeyContainer` + [in] The name of the key container that contains the public/private key pair. If `pbKeyBlob` is null, `szKeyContainer` must specify a valid container within the cryptographic service provider (CSP). In this case, the `StrongNameGetPublicKeyEx` method extracts the public key from the key pair stored in the container. + + If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). + + The keys must be 1024-bit Rivest-Shamir-Adleman (RSA) signing keys. No other types of keys are supported at this time. + + `pbKeyBlob` + [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `szKeyContainer` is assumed to contain the key pair. + + `cbKeyBlob` + [in] The size, in bytes, of `pbKeyBlob`. + + `ppbPublicKeyBlob` + [out] The returned public key BLOB. The `ppbPublicKeyBlob` parameter is allocated by the common language runtime and returned to the caller. The caller must free the memory by using the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method. + + `pcbPublicKeyBlob` + [out] The size of the returned public key BLOB. + + `uHashAlgId` + [in] The assembly hash algorithm. See the Remarks section for a list of accepted values. + + `uReserved` + [in] Reserved for future use; defaults to null. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + The public key is contained in a [PublicKeyBlob]((../../../framework/unmanaged-api/strong-naming/publickeyblob-structure.md) structure. + + The following table shows the set of accepted values for the `uHashAlgId` parameter. + +|Name|Value| +|----------|-----------| +|None|0| +|SHA-1|0x8004| +|SHA-256|0x800c| +|SHA-384|0x800d| +|SHA-512|0x800e| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] + ## See also - [StrongNameTokenFromPublicKey Method](iclrstrongname-strongnametokenfrompublickey-method.md) -- [PublicKeyBlob Structure](../strong-naming/publickeyblob-structure.md) +- [PublicKeyBlob Structure]((../../../framework/unmanaged-api/strong-naming/publickeyblob-structure.md) - [ICLRStrongName Interface](iclrstrongname-interface.md) - [StrongNameGetPublicKey Method](iclrstrongname-strongnamegetpublickey-method.md) diff --git a/docs/core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md b/docs/core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md index 3b145ee93ef05..18388ed0ec933 100644 --- a/docs/core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md +++ b/docs/core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md @@ -2,67 +2,66 @@ description: "Learn more about: StrongNameSignatureVerificationEx2 Method" title: "StrongNameSignatureVerificationEx2 Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName2.StrongNameSignatureVerificationEx2" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "StrongNameSignatureVerificationEx2" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameSignatureVerificationEx2 method, ICLRStrongName2 interface [.NET Framework hosting]" - "ICLRStrongName2::StrongNameSignatureVerificationEx2 method [.NET Framework hosting]" -ms.assetid: dfd4133f-a074-4db3-a7ee-4f250fe9ad3a -topic_type: +topic_type: - "apiref" --- # StrongNameSignatureVerificationEx2 Method -Verifies the signature of a strongly named assembly, and provides a mapping from the ECMA key to a real key. - -## Syntax - -```cpp -HRESULT StrongNameSignatureVerificationEx ( - [in] LPCWSTR wszFilePath, - [in] BOOLEAN fForceVerification, [in] BYTE *pbEcmaPublicKey, - [in] DWORD cbEcmaPublicKey, - [out] BOOLEAN *pfWasVerified -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the portable executable (.exe or .dll) file for the assembly to be verified. - - `fForceVerification` - [in] `true` to perform verification, even if it is necessary to override registry settings; otherwise, `false`. - - `pbEcmaPublicKey` - [in] A pointer to the mapping from the ECMA public key to the real key used for verification. - - `cbEcmaPublicKey` - [in] The length of the real ECMA public key. - - `pfWasVerified` - [out] `true` if the strong name signature was verified; otherwise, `false`. This parameter is also set to `false` if the verification was successful due to registry settings. - -## Return Value - - `S_OK` if the verification was successful; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] - +Verifies the signature of a strongly named assembly, and provides a mapping from the ECMA key to a real key. + +## Syntax + +```cpp +HRESULT StrongNameSignatureVerificationEx ( + [in] LPCWSTR wszFilePath, + [in] BOOLEAN fForceVerification, [in] BYTE *pbEcmaPublicKey, + [in] DWORD cbEcmaPublicKey, + [out] BOOLEAN *pfWasVerified +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the portable executable (.exe or .dll) file for the assembly to be verified. + + `fForceVerification` + [in] `true` to perform verification, even if it is necessary to override registry settings; otherwise, `false`. + + `pbEcmaPublicKey` + [in] A pointer to the mapping from the ECMA public key to the real key used for verification. + + `cbEcmaPublicKey` + [in] The length of the real ECMA public key. + + `pfWasVerified` + [out] `true` if the strong name signature was verified; otherwise, `false`. This parameter is also set to `false` if the verification was successful due to registry settings. + +## Return Value + + `S_OK` if the verification was successful; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MetaHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] + ## See also - [StrongNameSignatureVerification Method](iclrstrongname-strongnamesignatureverification-method.md) diff --git a/docs/core/unmanaged-api/hosting/toc.yml b/docs/core/unmanaged-api/hosting/toc.yml deleted file mode 100644 index e9f6cb68585b2..0000000000000 --- a/docs/core/unmanaged-api/hosting/toc.yml +++ /dev/null @@ -1,1000 +0,0 @@ -items: -- name: Hosting - href: index.md -- name: Hosting Coclasses - href: hosting-coclasses.md - items: - - name: CLRRuntimeHost Coclass - href: clrruntimehost-coclass.md - - name: ComCallUnmarshal Coclass - href: comcallunmarshal-coclass.md - - name: CorRuntimeHost Coclass - href: corruntimehost-coclass.md - - name: TypeNameFactory Coclass - href: typenamefactory-coclass.md -- name: Hosting Enumerations - href: hosting-enumerations.md - items: - - name: CLSID_RESOLUTION_FLAGS Enumeration - href: clsid-resolution-flags-enumeration.md - - name: COR_GC_STAT_TYPES Enumeration - href: cor-gc-stat-types-enumeration.md - - name: COR_GC_THREAD_STATS_TYPES Enumeration - href: cor-gc-thread-stats-types-enumeration.md - - name: EApiCategories Enumeration - href: eapicategories-enumeration.md - - name: EBindPolicyLevels Enumeration - href: ebindpolicylevels-enumeration.md - - name: ECLRAssemblyIdentityFlags Enumeration - href: eclrassemblyidentityflags-enumeration.md - - name: EClrEvent Enumeration - href: eclrevent-enumeration.md - - name: EClrFailure Enumeration - href: eclrfailure-enumeration.md - - name: EClrOperation Enumeration - href: eclroperation-enumeration.md - - name: EClrUnhandledException Enumeration - href: eclrunhandledexception-enumeration.md - - name: EContextType Enumeration - href: econtexttype-enumeration.md - - name: ECustomDumpFlavor Enumeration - href: ecustomdumpflavor-enumeration.md - - name: ECustomDumpItemKind Enumeration - href: ecustomdumpitemkind-enumeration.md - - name: EHostApplicationPolicy Enumeration - href: ehostapplicationpolicy-enumeration.md - - name: EHostBindingPolicyModifyFlags Enumeration - href: ehostbindingpolicymodifyflags-enumeration.md - - name: EInitializeNewDomainFlags Enumeration - href: einitializenewdomainflags-enumeration.md - - name: EMemoryAvailable Enumeration - href: ememoryavailable-enumeration.md - - name: EMemoryCriticalLevel Enumeration - href: ememorycriticallevel-enumeration.md - - name: EPolicyAction Enumeration - href: epolicyaction-enumeration.md - - name: ESymbolReadingPolicy Enumeration - href: esymbolreadingpolicy-enumeration.md - - name: ETaskType Enumeration - href: etasktype-enumeration.md - - name: HOST_TYPE Enumeration - href: host-type-enumeration.md - - name: MALLOC_TYPE Enumeration - href: malloc-type-enumeration.md - - name: METAHOST_CONFIG_FLAGS Enumeration - href: metahost-config-flags-enumeration.md - - name: METAHOST_POLICY_FLAGS Enumeration - href: metahost-policy-flags-enumeration.md - - name: RUNTIME_INFO_FLAGS Enumeration - href: runtime-info-flags-enumeration.md - - name: StackOverflowType Enumeration - href: stackoverflowtype-enumeration.md - - name: STARTUP_FLAGS Enumeration - href: startup-flags-enumeration.md - - name: ValidatorFlags Enumeration - href: validatorflags-enumeration.md - - name: WAIT_OPTION Enumeration - href: wait-option-enumeration.md -- name: Hosting Global Static Functions - href: hosting-global-static-functions.md - items: - - name: .NET Framework 4 Hosting Global Static Functions - href: net-framework-4-hosting-global-static-functions.md - items: - - name: CLRCreateInstance Function - href: clrcreateinstance-function.md - - name: Deprecated CLR Hosting Functions - href: deprecated-clr-hosting-functions.md - items: - - name: _CorDllMain Function - href: cordllmain-function.md - - name: _CorExeMain Function - href: corexemain-function.md - - name: _CorExeMain2 Function - href: corexemain2-function.md - - name: _CorImageUnloading Function - href: corimageunloading-function.md - - name: _CorValidateImage Function - href: corvalidateimage-function.md - - name: CallFunctionShim Function - href: callfunctionshim-function.md - - name: ClrCreateManagedInstance Function - href: clrcreatemanagedinstance-function.md - - name: CoEEShutDownCOM Function - href: coeeshutdowncom-function.md - - name: CoInitializeCor Function - href: coinitializecor-function.md - - name: CoInitializeEE Function - href: coinitializeee-function.md - - name: CorBindToCurrentRuntime Function - href: corbindtocurrentruntime-function.md - - name: CorBindToRuntime Function - href: corbindtoruntime-function.md - - name: CorBindToRuntimeByCfg Function - href: corbindtoruntimebycfg-function.md - - name: CorBindToRuntimeEx Function - href: corbindtoruntimeex-function.md - - name: CorBindToRuntimeHost Function - href: corbindtoruntimehost-function.md - - name: CorExitProcess Function - href: corexitprocess-function.md - - name: CorLaunchApplication Function - href: corlaunchapplication-function.md - - name: CorMarkThreadInThreadPool Function - href: cormarkthreadinthreadpool-function.md - - name: CoUninitializeCor Function - href: couninitializecor-function.md - - name: CoUninitializeEE Function - href: couninitializeee-function.md - - name: CreateDebuggingInterfaceFromVersion Function - href: createdebugginginterfacefromversion-function.md - - name: CreateICeeFileGen Function - href: createiceefilegen-function.md - - name: DestroyICeeFileGen Function - href: destroyiceefilegen-function.md - - name: FExecuteInAppDomainCallback Function Pointer - href: fexecuteinappdomaincallback-function-pointer.md - - name: FLockClrVersionCallback Function Pointer - href: flockclrversioncallback-function-pointer.md - - name: GetCLRIdentityManager Function - href: getclridentitymanager-function.md - - name: GetCORRequiredVersion Function - href: getcorrequiredversion-function.md - - name: GetCORSystemDirectory Function - href: getcorsystemdirectory-function.md - - name: GetCORVersion Function - href: getcorversion-function.md - - name: GetFileVersion Function - href: getfileversion-function.md - - name: GetRealProcAddress Function - href: getrealprocaddress-function.md - - name: GetRequestedRuntimeInfo Function - href: getrequestedruntimeinfo-function.md - - name: GetRequestedRuntimeVersion Function - href: getrequestedruntimeversion-function.md - - name: GetRequestedRuntimeVersionForCLSID Function - href: getrequestedruntimeversionforclsid-function.md - - name: GetVersionFromProcess Function - href: getversionfromprocess-function.md - - name: LoadLibraryShim Function - href: loadlibraryshim-function.md - - name: LoadStringRC Function - href: loadstringrc-function.md - - name: LoadStringRCEx Function - href: loadstringrcex-function.md - - name: LockClrVersion Function - href: lockclrversion-function.md - - name: LPOVERLAPPED_COMPLETION_ROUTINE Function Pointer - href: lpoverlapped-completion-routine-function-pointer.md - - name: LPTHREAD_START_ROUTINE Function Pointer - href: lpthread-start-routine-function-pointer.md - - name: RunDll32ShimW Function - href: rundll32shimw-function.md - - name: WAITORTIMERCALLBACK Function Pointer - href: waitortimercallback-function-pointer.md -- name: Hosting Interfaces - href: hosting-interfaces.md - items: - - name: Deprecated CLR Hosting Interfaces and Coclasses - href: deprecated-clr-hosting-interfaces-and-coclasses.md - items: - - name: IAppDomainSetup Interface - href: iappdomainsetup-interface.md - - name: ICeeFileGen Class - href: iceefilegen-class.md - - name: ICorRuntimeHost Interface - href: icorruntimehost-interface.md - items: - - name: CloseEnum Method - href: icorruntimehost-closeenum-method.md - - name: CreateDomain Method - href: icorruntimehost-createdomain-method.md - - name: CreateDomainSetup Method - href: icorruntimehost-createdomainsetup-method.md - - name: CreateDomainEx Method - href: icorruntimehost-createdomainex-method.md - - name: CreateEvidence Method - href: icorruntimehost-createevidence-method.md - - name: CreateLogicalThreadState Method - href: icorruntimehost-createlogicalthreadstate-method.md - - name: CurrentDomain Method - href: icorruntimehost-currentdomain-method.md - - name: DeleteLogicalThreadState Method - href: icorruntimehost-deletelogicalthreadstate-method.md - - name: EnumDomains Method - href: icorruntimehost-enumdomains-method.md - - name: GetConfiguration Method - href: icorruntimehost-getconfiguration-method.md - - name: GetDefaultDomain Method - href: icorruntimehost-getdefaultdomain-method.md - - name: LocksHeldByLogicalThread Method - href: icorruntimehost-locksheldbylogicalthread-method.md - - name: MapFile Method - href: icorruntimehost-mapfile-method.md - - name: NextDomain Method - href: icorruntimehost-nextdomain-method.md - - name: Start Method - href: icorruntimehost-start-method.md - - name: Stop Method - href: icorruntimehost-stop-method.md - - name: SwitchInLogicalThreadState Method - href: icorruntimehost-switchinlogicalthreadstate-method.md - - name: SwitchOutLogicalThreadState Method - href: icorruntimehost-switchoutlogicalthreadstate-method.md - - name: UnloadDomain Method - href: icorruntimehost-unloaddomain-method.md - - name: CLR Hosting Interfaces - href: clr-hosting-interfaces.md - items: - - name: IActionOnCLREvent Interface - href: iactiononclrevent-interface.md - items: - - name: OnEvent Method - href: iactiononclrevent-onevent-method.md - - name: IApartmentCallback Interface - href: iapartmentcallback-interface.md - items: - - name: DoCallback Method - href: iapartmentcallback-docallback-method.md - - name: IAppDomainBinding Interface - href: iappdomainbinding-interface.md - items: - - name: OnAppDomain Method - href: iappdomainbinding-onappdomain-method.md - - name: ICatalogServices Interface - href: icatalogservices-interface.md - items: - - name: Autodone Method - href: icatalogservices-autodone-method.md - - name: NotAutodone Method - href: icatalogservices-notautodone-method.md - - name: ICLRAssemblyIdentityManager Interface - href: iclrassemblyidentitymanager-interface.md - items: - - name: GetBindingIdentityFromFile Method - href: iclrassemblyidentitymanager-getbindingidentityfromfile-method.md - - name: GetBindingIdentityFromStream Method - href: iclrassemblyidentitymanager-getbindingidentityfromstream-method.md - - name: GetCLRAssemblyReferenceList Method - href: iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md - - name: GetProbingAssembliesFromReference Method - href: iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md - - name: GetReferencedAssembliesFromFile Method - href: iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md - - name: GetReferencedAssembliesFromStream Method - href: iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md - - name: IsStronglyNamed Method - href: iclrassemblyidentitymanager-isstronglynamed-method.md - - name: ICLRAssemblyReferenceList Interface - href: iclrassemblyreferencelist-interface.md - items: - - name: IsAssemblyReferenceInList Method - href: iclrassemblyreferencelist-isassemblyreferenceinlist-method.md - - name: IsStringAssemblyReferenceInList Method - href: iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md - - name: ICLRControl Interface - href: iclrcontrol-interface.md - items: - - name: GetCLRManager Method - href: iclrcontrol-getclrmanager-method.md - - name: SetAppDomainManagerType Method - href: iclrcontrol-setappdomainmanagertype-method.md - - name: ICLRDebugManager Interface - href: iclrdebugmanager-interface.md - items: - - name: BeginConnection Method - href: iclrdebugmanager-beginconnection-method.md - - name: EndConnection Method - href: iclrdebugmanager-endconnection-method.md - - name: GetDacl Method - href: iclrdebugmanager-getdacl-method.md - - name: IsDebuggerAttached Method - href: iclrdebugmanager-isdebuggerattached-method.md - - name: SetConnectionTasks Method - href: iclrdebugmanager-setconnectiontasks-method.md - - name: SetDacl Method - href: iclrdebugmanager-setdacl-method.md - - name: SetSymbolReadingPolicy Method - href: iclrdebugmanager-setsymbolreadingpolicy-method.md - - name: ICLRErrorReportingManager Interface - href: iclrerrorreportingmanager-interface.md - items: - - name: BeginCustomDump Method - href: iclrerrorreportingmanager-begincustomdump-method.md - - name: EndCustomDump Method - href: iclrerrorreportingmanager-endcustomdump-method.md - - name: GetBucketParametersForCurrentException Method - href: iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md - - name: ICLRGCManager Interface - href: iclrgcmanager-interface.md - items: - - name: Collect Method - href: iclrgcmanager-collect-method.md - - name: GetStats Method - href: iclrgcmanager-getstats-method.md - - name: SetGCStartupLimits Method - href: iclrgcmanager-setgcstartuplimits-method.md - - name: ICLRHostBindingPolicyManager Interface - href: iclrhostbindingpolicymanager-interface.md - items: - - name: EvaluatePolicy Method - href: iclrhostbindingpolicymanager-evaluatepolicy-method.md - - name: ModifyApplicationPolicy Method - href: iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md - - name: ICLRHostProtectionManager Interface - href: iclrhostprotectionmanager-interface.md - items: - - name: SetEagerSerializeGrantSets - href: iclrhostprotectionmanager-seteagerserializegrantsets-method.md - - name: SetProtectedCategories Method - href: iclrhostprotectionmanager-setprotectedcategories-method.md - - name: ICLRIoCompletionManager Interface - href: iclriocompletionmanager-interface.md - items: - - name: OnComplete Method - href: iclriocompletionmanager-oncomplete-method.md - - name: ICLRMemoryNotificationCallback Interface - href: iclrmemorynotificationcallback-interface.md - items: - - name: OnMemoryNotification Method - href: iclrmemorynotificationcallback-onmemorynotification-method.md - - name: ICLROnEventManager Interface - href: iclroneventmanager-interface.md - items: - - name: RegisterActionOnEvent Method - href: iclroneventmanager-registeractiononevent-method.md - - name: UnregisterActionOnEvent Method - href: iclroneventmanager-unregisteractiononevent-method.md - - name: ICLRPolicyManager Interface - href: iclrpolicymanager-interface.md - items: - - name: SetActionOnFailure Method - href: iclrpolicymanager-setactiononfailure-method.md - - name: SetActionOnTimeout Method - href: iclrpolicymanager-setactionontimeout-method.md - - name: SetDefaultAction Method - href: iclrpolicymanager-setdefaultaction-method.md - - name: SetTimeout Method - href: iclrpolicymanager-settimeout-method.md - - name: SetTimeoutAndAction Method - href: iclrpolicymanager-settimeoutandaction-method.md - - name: SetUnhandledExceptionPolicy Method - href: iclrpolicymanager-setunhandledexceptionpolicy-method.md - - name: ICLRProbingAssemblyEnum Interface - href: iclrprobingassemblyenum-interface.md - items: - - name: Get Method - href: iclrprobingassemblyenum-get-method.md - - name: ICLRReferenceAssemblyEnum Interface - href: iclrreferenceassemblyenum-interface.md - items: - - name: Get Method - href: iclrreferenceassemblyenum-get-method.md - - name: ICLRRuntimeHost Interface - href: iclrruntimehost-interface.md - items: - - name: ExecuteApplication Method - href: iclrruntimehost-executeapplication-method.md - - name: ExecuteInAppDomain Method - href: iclrruntimehost-executeinappdomain-method.md - - name: ExecuteInDefaultAppDomain Method - href: iclrruntimehost-executeindefaultappdomain-method.md - - name: GetCLRControl Method - href: iclrruntimehost-getclrcontrol-method.md - - name: GetCurrentAppDomainId Method - href: iclrruntimehost-getcurrentappdomainid-method.md - - name: SetHostControl Method - href: iclrruntimehost-sethostcontrol-method.md - - name: Start Method - href: iclrruntimehost-start-method.md - - name: Stop Method - href: iclrruntimehost-stop-method.md - - name: UnloadAppDomain Method - href: iclrruntimehost-unloadappdomain-method.md - - name: ICLRSyncManager Interface - href: iclrsyncmanager-interface.md - items: - - name: CreateRWLockOwnerIterator Method - href: iclrsyncmanager-createrwlockowneriterator-method.md - - name: DeleteRWLockOwnerIterator Method - href: iclrsyncmanager-deleterwlockowneriterator-method.md - - name: GetMonitorOwner Method - href: iclrsyncmanager-getmonitorowner-method.md - - name: GetRWLockOwnerNext Method - href: iclrsyncmanager-getrwlockownernext-method.md - - name: ICLRTask Interface - href: iclrtask-interface.md - items: - - name: Abort Method - href: iclrtask-abort-method.md - - name: ExitTask Method - href: iclrtask-exittask-method.md - - name: GetMemStats Method - href: iclrtask-getmemstats-method.md - - name: LocksHeld Method - href: iclrtask-locksheld-method.md - - name: NeedsPriorityScheduling Method - href: iclrtask-needspriorityscheduling-method.md - - name: Reset Method - href: iclrtask-reset-method.md - - name: RudeAbort Method - href: iclrtask-rudeabort-method.md - - name: SetTaskIdentifier Method - href: iclrtask-settaskidentifier-method.md - - name: SwitchIn Method - href: iclrtask-switchin-method.md - - name: SwitchOut Method - href: iclrtask-switchout-method.md - - name: YieldTask Method - href: iclrtask-yieldtask-method.md - - name: ICLRTaskManager Interface - href: iclrtaskmanager-interface.md - items: - - name: CreateTask Method - href: iclrtaskmanager-createtask-method.md - - name: GetCurrentTask Method - href: iclrtaskmanager-getcurrenttask-method.md - - name: GetCurrentTaskType Method - href: iclrtaskmanager-getcurrenttasktype-method.md - - name: SetLocale Method - href: iclrtaskmanager-setlocale-method.md - - name: SetUILocale Method - href: iclrtaskmanager-setuilocale-method.md - - name: ICLRValidator Interface - href: iclrvalidator-interface.md - items: - - name: FormatEventInfo Method - href: iclrvalidator-formateventinfo-method.md - - name: Validate Method - href: iclrvalidator-validate-method.md - - name: ICorConfiguration Interface - href: icorconfiguration-interface.md - items: - - name: AddDebuggerSpecialThread Method - href: icorconfiguration-adddebuggerspecialthread-method.md - - name: SetDebuggerThreadControl Method - href: icorconfiguration-setdebuggerthreadcontrol-method.md - - name: SetGCHostControl Method - href: icorconfiguration-setgchostcontrol-method.md - - name: SetGCThreadControl Method - href: icorconfiguration-setgcthreadcontrol-method.md - - name: ICorThreadpool Interface - href: icorthreadpool-interface.md - items: - - name: CorBindIoCompletionCallback Method - href: icorthreadpool-corbindiocompletioncallback-method.md - - name: CorCallOrQueueUserWorkItem Method - href: icorthreadpool-corcallorqueueuserworkitem-method.md - - name: CorChangeTimer Method - href: icorthreadpool-corchangetimer-method.md - - name: CorCreateTimer Method - href: icorthreadpool-corcreatetimer-method.md - - name: CorDeleteTimer Method - href: icorthreadpool-cordeletetimer-method.md - - name: CorGetAvailableThreads Method - href: icorthreadpool-corgetavailablethreads-method.md - - name: CorGetMaxThreads Method - href: icorthreadpool-corgetmaxthreads-method.md - - name: CorQueueUserWorkItem Method - href: icorthreadpool-corqueueuserworkitem-method.md - - name: CorRegisterWaitForSingleObject Method - href: icorthreadpool-corregisterwaitforsingleobject-method.md - - name: CorSetMaxThreads Method - href: icorthreadpool-corsetmaxthreads-method.md - - name: CorUnregisterWait Method - href: icorthreadpool-corunregisterwait-method.md - - name: IDebuggerInfo Interface - href: idebuggerinfo-interface.md - items: - - name: IsDebuggerAttached Method - href: idebuggerinfo-isdebuggerattached-method.md - - name: IDebuggerThreadControl Interface - href: idebuggerthreadcontrol-interface.md - items: - - name: ReleaseAllRuntimeThreads Method - href: idebuggerthreadcontrol-releaseallruntimethreads-method.md - - name: StartBlockingForDebugger Method - href: idebuggerthreadcontrol-startblockingfordebugger-method.md - - name: ThreadIsBlockingForDebugger Method - href: idebuggerthreadcontrol-threadisblockingfordebugger-method.md - - name: IGCHost Interface - href: igchost-interface.md - items: - - name: Collect Method - href: igchost-collect-method.md - - name: GetStats Method - href: igchost-getstats-method.md - - name: GetThreadStats Method - href: igchost-getthreadstats-method.md - - name: SetGCStartupLimits Method - href: igchost-setgcstartuplimits-method.md - - name: SetVirtualMemLimit Method - href: igchost-setvirtualmemlimit-method.md - - name: IGCHost2 Interface - href: igchost2-interface.md - items: - - name: SetGCStartupLimitsEx Method - href: igchost2-setgcstartuplimitsex-method.md - - name: IGCHostControl Interface - href: igchostcontrol-interface.md - items: - - name: RequestVirtualMemLimit Method - href: igchostcontrol-requestvirtualmemlimit-method.md - - name: IGCThreadControl Interface - href: igcthreadcontrol-interface.md - items: - - name: SuspensionEnding Method - href: igcthreadcontrol-suspensionending-method.md - - name: SuspensionStarting Method - href: igcthreadcontrol-suspensionstarting-method.md - - name: ThreadIsBlockingForSuspension Method - href: igcthreadcontrol-threadisblockingforsuspension-method.md - - name: IHostAssemblyManager Interface - href: ihostassemblymanager-interface.md - items: - - name: GetAssemblyStore Method - href: ihostassemblymanager-getassemblystore-method.md - - name: GetNonHostStoreAssemblies Method - href: ihostassemblymanager-getnonhoststoreassemblies-method.md - - name: IHostAssemblyStore Interface - href: ihostassemblystore-interface.md - items: - - name: ProvideAssembly Method - href: ihostassemblystore-provideassembly-method.md - - name: ProvideModule Method - href: ihostassemblystore-providemodule-method.md - - name: IHostAutoEvent Interface - href: ihostautoevent-interface.md - items: - - name: Set Method - href: ihostautoevent-set-method.md - - name: Wait Method - href: ihostautoevent-wait-method.md - - name: IHostControl Interface - href: ihostcontrol-interface.md - items: - - name: GetHostManager Method - href: ihostcontrol-gethostmanager-method.md - - name: SetAppDomainManager Method - href: ihostcontrol-setappdomainmanager-method.md - - name: IHostCrst Interface - href: ihostcrst-interface.md - items: - - name: Enter Method - href: ihostcrst-enter-method.md - - name: Leave Method - href: ihostcrst-leave-method.md - - name: SetSpinCount Method - href: ihostcrst-setspincount-method.md - - name: TryEnter Method - href: ihostcrst-tryenter-method.md - - name: IHostGCManager Interface - href: ihostgcmanager-interface.md - items: - - name: SuspensionEnding Method - href: ihostgcmanager-suspensionending-method.md - - name: SuspensionStarting Method - href: ihostgcmanager-suspensionstarting-method.md - - name: ThreadIsBlockingForSuspension Method - href: ihostgcmanager-threadisblockingforsuspension-method.md - - name: IHostIoCompletionManager Interface - href: ihostiocompletionmanager-interface.md - items: - - name: Bind Method - href: ihostiocompletionmanager-bind-method.md - - name: CloseIoCompletionPort Method - href: ihostiocompletionmanager-closeiocompletionport-method.md - - name: CreateIoCompletionPort Method - href: ihostiocompletionmanager-createiocompletionport-method.md - - name: GetAvailableThreads Method - href: ihostiocompletionmanager-getavailablethreads-method.md - - name: GetHostOverlappedSize Method - href: ihostiocompletionmanager-gethostoverlappedsize-method.md - - name: GetMaxThreads Method - href: ihostiocompletionmanager-getmaxthreads-method.md - - name: GetMinThreads Method - href: ihostiocompletionmanager-getminthreads-method.md - - name: InitializeHostOverlapped Method - href: ihostiocompletionmanager-initializehostoverlapped-method.md - - name: SetCLRIoCompletionManager Method - href: ihostiocompletionmanager-setclriocompletionmanager-method.md - - name: SetMaxThreads Method - href: ihostiocompletionmanager-setmaxthreads-method.md - - name: SetMinThreads Method - href: ihostiocompletionmanager-setminthreads-method.md - - name: IHostMalloc Interface - href: ihostmalloc-interface.md - items: - - name: Alloc Method - href: ihostmalloc-alloc-method.md - - name: DebugAlloc Method - href: ihostmalloc-debugalloc-method.md - - name: Free Method - href: ihostmalloc-free-method.md - - name: IHostManualEvent Interface - href: ihostmanualevent-interface.md - items: - - name: Reset Method - href: ihostmanualevent-reset-method.md - - name: Set Method - href: ihostmanualevent-set-method.md - - name: Wait Method - href: ihostmanualevent-wait-method.md - - name: IHostMemoryManager Interface - href: ihostmemorymanager-interface.md - items: - - name: AcquiredVirtualAddressSpace Method - href: ihostmemorymanager-acquiredvirtualaddressspace-method.md - - name: CreateMAlloc Method - href: ihostmemorymanager-createmalloc-method.md - - name: GetMemoryLoad Method - href: ihostmemorymanager-getmemoryload-method.md - - name: NeedsVirtualAddressSpace Method - href: ihostmemorymanager-needsvirtualaddressspace-method.md - - name: RegisterMemoryNotificationCallback Method - href: ihostmemorymanager-registermemorynotificationcallback-method.md - - name: ReleasedVirtualAddressSpace Method - href: ihostmemorymanager-releasedvirtualaddressspace-method.md - - name: VirtualAlloc Method - href: ihostmemorymanager-virtualalloc-method.md - - name: VirtualFree Method - href: ihostmemorymanager-virtualfree-method.md - - name: VirtualProtect Method - href: ihostmemorymanager-virtualprotect-method.md - - name: VirtualQuery Method - href: ihostmemorymanager-virtualquery-method.md - - name: IHostPolicyManager Interface - href: ihostpolicymanager-interface.md - items: - - name: OnDefaultAction Method - href: ihostpolicymanager-ondefaultaction-method.md - - name: OnFailure Method - href: ihostpolicymanager-onfailure-method.md - - name: OnTimeout Method - href: ihostpolicymanager-ontimeout-method.md - - name: IHostSecurityContext Interface - href: ihostsecuritycontext-interface.md - items: - - name: Capture Method - href: ihostsecuritycontext-capture-method.md - - name: IHostSecurityManager Interface - href: ihostsecuritymanager-interface.md - items: - - name: GetSecurityContext Method - href: ihostsecuritymanager-getsecuritycontext-method.md - - name: ImpersonateLoggedOnUser Method - href: ihostsecuritymanager-impersonateloggedonuser-method.md - - name: OpenThreadToken Method - href: ihostsecuritymanager-openthreadtoken-method.md - - name: RevertToSelf Method - href: ihostsecuritymanager-reverttoself-method.md - - name: SetSecurityContext Method - href: ihostsecuritymanager-setsecuritycontext-method.md - - name: SetThreadToken Method - href: ihostsecuritymanager-setthreadtoken-method.md - - name: IHostSemaphore Interface - href: ihostsemaphore-interface.md - items: - - name: ReleaseSemaphore Method - href: ihostsemaphore-releasesemaphore-method.md - - name: Wait Method - href: ihostsemaphore-wait-method.md - - name: IHostSyncManager Interface - href: ihostsyncmanager-interface.md - items: - - name: CreateAutoEvent Method - href: ihostsyncmanager-createautoevent-method.md - - name: CreateCrst Method - href: ihostsyncmanager-createcrst-method.md - - name: CreateCrstWithSpinCount Method - href: ihostsyncmanager-createcrstwithspincount-method.md - - name: CreateManualEvent Method - href: ihostsyncmanager-createmanualevent-method.md - - name: CreateMonitorEvent Method - href: ihostsyncmanager-createmonitorevent-method.md - - name: CreateRWLockReaderEvent Method - href: ihostsyncmanager-createrwlockreaderevent-method.md - - name: CreateRWLockWriterEvent Method - href: ihostsyncmanager-createrwlockwriterevent-method.md - - name: CreateSemaphore Method - href: ihostsyncmanager-createsemaphore-method.md - - name: SetCLRSyncManager Method - href: ihostsyncmanager-setclrsyncmanager-method.md - - name: IHostTask Interface - href: ihosttask-interface.md - items: - - name: Alert Method - href: ihosttask-alert-method.md - - name: GetPriority Method - href: ihosttask-getpriority-method.md - - name: Join Method - href: ihosttask-join-method.md - - name: SetCLRTask Method - href: ihosttask-setclrtask-method.md - - name: SetPriority Method - href: ihosttask-setpriority-method.md - - name: Start Method - href: ihosttask-start-method.md - - name: IHostTaskManager Interface - href: ihosttaskmanager-interface.md - items: - - name: BeginDelayAbort Method - href: ihosttaskmanager-begindelayabort-method.md - - name: BeginThreadAffinity Method - href: ihosttaskmanager-beginthreadaffinity-method.md - - name: CallNeedsHostHook Method - href: ihosttaskmanager-callneedshosthook-method.md - - name: CreateTask Method - href: ihosttaskmanager-createtask-method.md - - name: EndDelayAbort Method - href: ihosttaskmanager-enddelayabort-method.md - - name: EndThreadAffinity Method - href: ihosttaskmanager-endthreadaffinity-method.md - - name: EnterRuntime Method - href: ihosttaskmanager-enterruntime-method.md - - name: GetCurrentTask Method - href: ihosttaskmanager-getcurrenttask-method.md - - name: GetStackGuarantee Method - href: ihosttaskmanager-getstackguarantee-method.md - - name: LeaveRuntime Method - href: ihosttaskmanager-leaveruntime-method.md - - name: ReverseEnterRuntime Method - href: ihosttaskmanager-reverseenterruntime-method.md - - name: ReverseLeaveRuntime Method - href: ihosttaskmanager-reverseleaveruntime-method.md - - name: SetCLRTaskManager Method - href: ihosttaskmanager-setclrtaskmanager-method.md - - name: SetLocale Method - href: ihosttaskmanager-setlocale-method.md - - name: SetStackGuarantee Method - href: ihosttaskmanager-setstackguarantee-method.md - - name: SetUILocale Method - href: ihosttaskmanager-setuilocale-method.md - - name: Sleep Method - href: ihosttaskmanager-sleep-method.md - - name: SwitchToTask Method - href: ihosttaskmanager-switchtotask-method.md - - name: IHostThreadPoolManager Interface - href: ihostthreadpoolmanager-interface.md - items: - - name: GetAvailableThreads Method - href: ihostthreadpoolmanager-getavailablethreads-method.md - - name: GetMaxThreads Method - href: ihostthreadpoolmanager-getmaxthreads-method.md - - name: GetMinThreads Method - href: ihostthreadpoolmanager-getminthreads-method.md - - name: QueueUserWorkItem Method - href: ihostthreadpoolmanager-queueuserworkitem-method.md - - name: SetMaxThreads Method - href: ihostthreadpoolmanager-setmaxthreads-method.md - - name: SetMinThreads Method - href: ihostthreadpoolmanager-setminthreads-method.md - - name: IManagedObject Interface - href: imanagedobject-interface.md - items: - - name: GetObjectIdentity Method - href: imanagedobject-getobjectidentity-method.md - - name: GetSerializedBuffer Method - href: imanagedobject-getserializedbuffer-method.md - - name: IObjectHandle Interface - href: iobjecthandle-interface.md - items: - - name: Unwrap Method - href: iobjecthandle-unwrap-method.md - - name: ITypeName Interface - href: itypename-interface.md - items: - - name: GetAssemblyName Method - href: itypename-getassemblyname-method.md - - name: GetModifierLength Method - href: itypename-getmodifierlength-method.md - - name: GetModifiers Method - href: itypename-getmodifiers-method.md - - name: GetNameCount Method - href: itypename-getnamecount-method.md - - name: GetNames Method - href: itypename-getnames-method.md - - name: GetTypeArgumentCount Method - href: itypename-gettypeargumentcount-method.md - - name: GetTypeArguments Method - href: itypename-gettypearguments-method.md - - name: ITypeNameBuilder Interface - href: itypenamebuilder-interface.md - items: - - name: AddArray Method - href: itypenamebuilder-addarray-method.md - - name: AddAssemblySpec Method - href: itypenamebuilder-addassemblyspec-method.md - - name: AddByRef Method - href: itypenamebuilder-addbyref-method.md - - name: AddName Method - href: itypenamebuilder-addname-method.md - - name: AddPointer Method - href: itypenamebuilder-addpointer-method.md - - name: AddSzArray Method - href: itypenamebuilder-addszarray-method.md - - name: Clear Method - href: itypenamebuilder-clear-method.md - - name: CloseGenericArgument Method - href: itypenamebuilder-closegenericargument-method.md - - name: CloseGenericArguments Method - href: itypenamebuilder-closegenericarguments-method.md - - name: OpenGenericArgument Method - href: itypenamebuilder-opengenericargument-method.md - - name: OpenGenericArguments Method - href: itypenamebuilder-opengenericarguments-method.md - - name: ToString Method - href: itypenamebuilder-tostring-method.md - - name: ITypeNameFactory Interface - href: itypenamefactory-interface.md - items: - - name: GetTypeNameBuilder Method - href: itypenamefactory-gettypenamebuilder-method.md - - name: ParseTypeName Method - href: itypenamefactory-parsetypename-method.md - - name: IValidator Interface - href: ivalidator-interface.md - items: - - name: FormatEventInfo Method - href: ivalidator-formateventinfo-method.md - - name: Validate Method - href: ivalidator-validate-method.md - - name: CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5 - href: clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md - items: - - name: ICLRAppDomainResourceMonitor Interface - href: iclrappdomainresourcemonitor-interface.md - items: - - name: GetCurrentAllocated Method - href: iclrappdomainresourcemonitor-getcurrentallocated-method.md - - name: GetCurrentSurvived Method - href: iclrappdomainresourcemonitor-getcurrentsurvived-method.md - - name: GetCurrentCpuTime Method - href: iclrappdomainresourcemonitor-getcurrentcputime-method.md - - name: ICLRDomainManager Interface - href: iclrdomainmanager-interface.md - items: - - name: SetAppDomainManagerType Method - href: iclrdomainmanager-setappdomainmanagertype-method.md - - name: SetPropertiesForDefaultAppDomain Method - href: iclrdomainmanager-setpropertiesfordefaultappdomain-method.md - - name: ICLRGCManager2 Interface - href: iclrgcmanager2-interface.md - items: - - name: SetGCStartupLimitsEx Method - href: iclrgcmanager2-setgcstartuplimitsex-method.md - - name: ICLRMetaHost Interface - href: iclrmetahost-interface.md - items: - - name: EnumerateInstalledRuntimes Method - href: iclrmetahost-enumerateinstalledruntimes-method.md - - name: EnumerateLoadedRuntimes Method - href: iclrmetahost-enumerateloadedruntimes-method.md - - name: ExitProcess Method - href: iclrmetahost-exitprocess-method.md - - name: GetRuntime Method - href: iclrmetahost-getruntime-method.md - - name: GetVersionFromFile Method - href: iclrmetahost-getversionfromfile-method.md - - name: QueryLegacyV2RuntimeBinding Method - href: iclrmetahost-querylegacyv2runtimebinding-method.md - - name: RequestRuntimeLoadedNotification Method - href: iclrmetahost-requestruntimeloadednotification-method.md - - name: ICLRMetaHostPolicy Interface - href: iclrmetahostpolicy-interface.md - items: - - name: GetRequestedRuntime Method - href: iclrmetahostpolicy-getrequestedruntime-method.md - - name: ICLRRuntimeInfo Interface - href: iclrruntimeinfo-interface.md - items: - - name: BindAsLegacyV2Runtime Method - href: iclrruntimeinfo-bindaslegacyv2runtime-method.md - - name: GetDefaultStartupFlags Method - href: iclrruntimeinfo-getdefaultstartupflags-method.md - - name: GetInterface Method - href: iclrruntimeinfo-getinterface-method.md - - name: GetProcAddress Method - href: iclrruntimeinfo-getprocaddress-method.md - - name: GetRuntimeDirectory Method - href: iclrruntimeinfo-getruntimedirectory-method.md - - name: GetVersionString Method - href: iclrruntimeinfo-getversionstring-method.md - - name: IsLoadable Method - href: iclrruntimeinfo-isloadable-method.md - - name: IsLoaded Method - href: iclrruntimeinfo-isloaded-method.md - - name: IsStarted Method - href: iclrruntimeinfo-isstarted-method.md - - name: LoadErrorString Method - href: iclrruntimeinfo-loaderrorstring-method.md - - name: LoadLibrary Method - href: iclrruntimeinfo-loadlibrary-method.md - - name: SetDefaultStartupFlags Method - href: iclrruntimeinfo-setdefaultstartupflags-method.md - - name: ICLRStrongName Interface - href: iclrstrongname-interface.md - items: - - name: GetHashFromAssemblyFile Method - href: iclrstrongname-gethashfromassemblyfile-method.md - - name: GetHashFromAssemblyFileW Method - href: iclrstrongname-gethashfromassemblyfilew-method.md - - name: GetHashFromBlob Method - href: iclrstrongname-gethashfromblob-method.md - - name: GetHashFromFile Method - href: iclrstrongname-gethashfromfile-method.md - - name: GetHashFromFileW Method - href: iclrstrongname-gethashfromfilew-method.md - - name: GetHashFromHandle Method - href: iclrstrongname-gethashfromhandle-method.md - - name: StrongNameCompareAssemblies Method - href: iclrstrongname-strongnamecompareassemblies-method.md - - name: StrongNameFreeBuffer Method - href: iclrstrongname-strongnamefreebuffer-method.md - - name: StrongNameGetBlob Method - href: iclrstrongname-strongnamegetblob-method.md - - name: StrongNameGetBlobFromImage Method - href: iclrstrongname-strongnamegetblobfromimage-method.md - - name: StrongNameGetPublicKey Method - href: iclrstrongname-strongnamegetpublickey-method.md - - name: StrongNameHashSize Method - href: iclrstrongname-strongnamehashsize-method.md - - name: StrongNameKeyDelete Method - href: iclrstrongname-strongnamekeydelete-method.md - - name: StrongNameKeyGen Method - href: iclrstrongname-strongnamekeygen-method.md - - name: StrongNameKeyGenEx Method - href: iclrstrongname-strongnamekeygenex-method.md - - name: StrongNameKeyInstall Method - href: iclrstrongname-strongnamekeyinstall-method.md - - name: StrongNameSignatureGeneration Method - href: iclrstrongname-strongnamesignaturegeneration-method.md - - name: StrongNameSignatureGenerationEx Method - href: iclrstrongname-strongnamesignaturegenerationex-method.md - - name: StrongNameSignatureSize Method - href: iclrstrongname-strongnamesignaturesize-method.md - - name: StrongNameSignatureVerification Method - href: iclrstrongname-strongnamesignatureverification-method.md - - name: StrongNameSignatureVerificationEx Method - href: iclrstrongname-strongnamesignatureverificationex-method.md - - name: StrongNameSignatureVerificationFromImage Method - href: iclrstrongname-strongnamesignatureverificationfromimage-method.md - - name: StrongNameTokenFromAssembly Method - href: iclrstrongname-strongnametokenfromassembly-method.md - - name: StrongNameTokenFromAssemblyEx Method - href: iclrstrongname-strongnametokenfromassemblyex-method.md - - name: StrongNameTokenFromPublicKey Method - href: iclrstrongname-strongnametokenfrompublickey-method.md - - name: ICLRStrongName2 Interface - href: iclrstrongname2-interface.md - items: - - name: StrongNameGetPublicKeyEx Method - href: strongnamegetpublickeyex-method.md - - name: StrongNameSignatureVerificationEx2 Method - href: strongnamesignatureverificationex2-method.md - - name: ICLRTask2 Interface - href: iclrtask2-interface.md - items: - - name: BeginPreventAsyncAbort Method - href: iclrtask2-beginpreventasyncabort-method.md - - name: EndPreventAsyncAbort Method - href: iclrtask2-endpreventasyncabort-method.md -- name: Hosting Structures - href: hosting-structures.md - items: - - name: AssemblyBindInfo Structure - href: assemblybindinfo-structure.md - - name: BucketParameters Structure - href: bucketparameters-structure.md - - name: COR_GC_STATS Structure - href: cor-gc-stats-structure.md - - name: COR_GC_THREAD_STATS Structure - href: cor-gc-thread-stats-structure.md - - name: CustomDumpItem Structure - href: customdumpitem-structure.md - - name: MDAInfo Structure - href: mdainfo-structure.md - - name: ModuleBindInfo Structure - href: modulebindinfo-structure.md - - name: StackOverflowInfo Structure - href: stackoverflowinfo-structure.md diff --git a/docs/core/unmanaged-api/hosting/typenamefactory-coclass.md b/docs/core/unmanaged-api/hosting/typenamefactory-coclass.md index 3c08bddf86281..09b623f8dac85 100644 --- a/docs/core/unmanaged-api/hosting/typenamefactory-coclass.md +++ b/docs/core/unmanaged-api/hosting/typenamefactory-coclass.md @@ -2,48 +2,47 @@ description: "Learn more about: TypeNameFactory Coclass" title: "TypeNameFactory Coclass" ms.date: "03/30/2017" -api_name: +api_name: - "TypeNameFactory Coclass" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "TypeNameFactory" -helpviewer_keywords: +helpviewer_keywords: - "TypeNameFactory coclass [.NET Framework hosting]" -ms.assetid: c853bb58-c9c5-476b-8e80-608aa53ea18d -topic_type: +topic_type: - "apiref" --- # TypeNameFactory Coclass -Provides an interface for managing the deconstruction of a type name. - -## Syntax - -```cpp -coclass TypeNameFactory { - [default] interface ITypeNameFactory; -}; -``` - -## Interfaces - -|Interface|Description| -|---------------|-----------------| -|[ITypeNameFactory Interface](itypenamefactory-interface.md)|This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.idl - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Provides an interface for managing the deconstruction of a type name. + +## Syntax + +```cpp +coclass TypeNameFactory { + [default] interface ITypeNameFactory; +}; +``` + +## Interfaces + +|Interface|Description| +|---------------|-----------------| +|[ITypeNameFactory Interface](itypenamefactory-interface.md)|This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code.| + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.idl + + **Library:** Included as a resource in MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Hosting Coclasses](hosting-coclasses.md) diff --git a/docs/core/unmanaged-api/hosting/validatorflags-enumeration.md b/docs/core/unmanaged-api/hosting/validatorflags-enumeration.md index af26a394d4e61..d70dbbb4b5c81 100644 --- a/docs/core/unmanaged-api/hosting/validatorflags-enumeration.md +++ b/docs/core/unmanaged-api/hosting/validatorflags-enumeration.md @@ -12,7 +12,6 @@ f1_keywords: - "ValidatorFlags" helpviewer_keywords: - "ValidatorFlags enumeration [.NET Framework hosting]" -ms.assetid: a3f5c266-3fcc-4ad1-aaf5-4cdbe26304ad topic_type: - "apiref" --- @@ -50,7 +49,7 @@ enum ValidatorFlags { **Library:** 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/hosting/wait-option-enumeration.md b/docs/core/unmanaged-api/hosting/wait-option-enumeration.md index 975b72c598a83..f154977dd388b 100644 --- a/docs/core/unmanaged-api/hosting/wait-option-enumeration.md +++ b/docs/core/unmanaged-api/hosting/wait-option-enumeration.md @@ -2,56 +2,55 @@ description: "Learn more about: WAIT_OPTION Enumeration" title: "WAIT_OPTION Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "WAIT_OPTION" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "WAIT_OPTION" -helpviewer_keywords: +helpviewer_keywords: - "WAIT_OPTION enumeration [.NET Framework hosting]" -ms.assetid: 962fc293-8ded-4b3b-90ce-2c21a4f1b244 -topic_type: +topic_type: - "apiref" --- # WAIT_OPTION Enumeration -Contains values that indicate the action a host should take if an operation requested by the common language runtime (CLR) blocks. - -## Syntax - -```cpp -typedef enum { - WAIT_MSGPUMP = 0x1, - WAIT_ALERTABLE = 0x2, - WAIT_NOTINDEADLOCK = 0x4, -} WAIT_OPTION; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`WAIT_ALERTABLE`|Notifies the host that the task should be awakened if the CLR calls the [IHostTask::Alert](ihosttask-alert-method.md) method.| -|`WAIT_MSGPUMP`|Notifies the host that it must pump messages on the current OS thread if the thread becomes blocked. The runtime specifies this value only on an thread.| -|`WAIT_NOTINDEADLOCK`|Notifies the host that the specified synchronization request cannot be broken by a host. That is, the host cannot return `HOST_E_DEADLOCK`.| - -## Remarks - - The [IHostTaskManager::Sleep](ihosttaskmanager-sleep-method.md) and [IHostTaskManager::SwitchToTask](ihosttaskmanager-switchtotask-method.md) methods both take a parameter of this type. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Contains values that indicate the action a host should take if an operation requested by the common language runtime (CLR) blocks. + +## Syntax + +```cpp +typedef enum { + WAIT_MSGPUMP = 0x1, + WAIT_ALERTABLE = 0x2, + WAIT_NOTINDEADLOCK = 0x4, +} WAIT_OPTION; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`WAIT_ALERTABLE`|Notifies the host that the task should be awakened if the CLR calls the [IHostTask::Alert](ihosttask-alert-method.md) method.| +|`WAIT_MSGPUMP`|Notifies the host that it must pump messages on the current OS thread if the thread becomes blocked. The runtime specifies this value only on an thread.| +|`WAIT_NOTINDEADLOCK`|Notifies the host that the specified synchronization request cannot be broken by a host. That is, the host cannot return `HOST_E_DEADLOCK`.| + +## Remarks + + The [IHostTaskManager::Sleep](ihosttaskmanager-sleep-method.md) and [IHostTaskManager::SwitchToTask](ihosttaskmanager-switchtotask-method.md) methods both take a parameter of this type. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET versions:** Available since .NET Framework 2.0 + ## See also - [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/waitortimercallback-function-pointer.md b/docs/core/unmanaged-api/hosting/waitortimercallback-function-pointer.md index b528971fc54e7..16c0dddf803c1 100644 --- a/docs/core/unmanaged-api/hosting/waitortimercallback-function-pointer.md +++ b/docs/core/unmanaged-api/hosting/waitortimercallback-function-pointer.md @@ -2,57 +2,56 @@ description: "Learn more about: WAITORTIMERCALLBACK Function Pointer" title: "WAITORTIMERCALLBACK Function Pointer" ms.date: "03/30/2017" -api_name: +api_name: - "WAITORTIMERCALLBACK" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "WAITORTIMERCALLBACK" -helpviewer_keywords: +helpviewer_keywords: - "WAITORTIMERCALLBACK function pointer [.NET Framework hosting]" -ms.assetid: 1fec4aef-0a06-4df0-bae7-d31a9ef9603d -topic_type: +topic_type: - "apiref" --- # WAITORTIMERCALLBACK Function Pointer -Points to a function that notifies the host that a wait handle () has either been signaled or timed out. - - This function pointer has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -typedef VOID (__stdcall *WAITORTIMERCALLBACK) ( - [in] PVOID lpParameter, - [in] BOOL TimerOrWaitFired -); -``` - -## Parameters - - `lpParameter` - [in] A pointer to an object that contains information defined by the host. - - `TimerOrWaitFired` - [in] `true` if the wait handle timed out, or `false` if it was signaled. - -## Remarks - - The function to which `WAITORTIMERCALLBACK` points is a callback function and must be implemented by the writer of the hosting application. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorWks.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Points to a function that notifies the host that a wait handle () has either been signaled or timed out. + + This function pointer has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +typedef VOID (__stdcall *WAITORTIMERCALLBACK) ( + [in] PVOID lpParameter, + [in] BOOL TimerOrWaitFired +); +``` + +## Parameters + + `lpParameter` + [in] A pointer to an object that contains information defined by the host. + + `TimerOrWaitFired` + [in] `true` if the wait handle timed out, or `false` if it was signaled. + +## Remarks + + The function to which `WAITORTIMERCALLBACK` points is a callback function and must be implemented by the writer of the hosting application. + +## Requirements + + **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorWks.dll + + **.NET versions:** Available since .NET Framework 1.0 + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/metadata/assemblyflags-enumeration.md b/docs/core/unmanaged-api/metadata/assemblyflags-enumeration.md index c01132cb5faaf..5a9352d902023 100644 --- a/docs/core/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](../../../framework/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/core/unmanaged-api/metadata/assemblymetadata-structure.md b/docs/core/unmanaged-api/metadata/assemblymetadata-structure.md index adbeb1af3920c..13aeb5b649648 100644 --- a/docs/core/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](../../../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)] - ## See also - [Metadata Structures](metadata-structures.md) diff --git a/docs/core/unmanaged-api/metadata/assemblyrefflags-enumeration.md b/docs/core/unmanaged-api/metadata/assemblyrefflags-enumeration.md index 22cd9ebfeb14c..532035683bce5 100644 --- a/docs/core/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](../../../framework/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 index c12205a82764e..1bf9eafb52013 100644 --- a/docs/core/unmanaged-api/metadata/ceesectionattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/ceesectionattr-enumeration.md @@ -2,56 +2,55 @@ description: "Learn more about: CeeSectionAttr Enumeration" title: "CeeSectionAttr Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CeeSectionAttr" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CeeSectionAttr" -helpviewer_keywords: +helpviewer_keywords: - "CeeSectionAttr enumeration [.NET Framework metadata]" -ms.assetid: 0db51881-b869-4677-a715-1726a9216489 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index 4dfad73e11cec..bbac75150a16e 100644 --- a/docs/core/unmanaged-api/metadata/ceesectionrelocextra-union.md +++ b/docs/core/unmanaged-api/metadata/ceesectionrelocextra-union.md @@ -2,48 +2,47 @@ description: "Learn more about: CeeSectionRelocExtra Union" title: "CeeSectionRelocExtra Union" ms.date: "03/30/2017" -api_name: +api_name: - "CeeSectionRelocExtra Union" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CeeSectionRelocExtra" -helpviewer_keywords: +helpviewer_keywords: - "CeeSectionRelocExtra union [.NET Framework metadata]" -ms.assetid: d9568cf6-7f98-4cd6-ab36-0a2bd509afcc -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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/core/unmanaged-api/metadata/ceesectionreloctype-enumeration.md b/docs/core/unmanaged-api/metadata/ceesectionreloctype-enumeration.md index 91187e12efbc8..0c05b601eecc4 100644 --- a/docs/core/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](../../../framework/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 index c8a3aa75125dd..db47cb0f36659 100644 --- a/docs/core/unmanaged-api/metadata/coiniticor-enumeration.md +++ b/docs/core/unmanaged-api/metadata/coiniticor-enumeration.md @@ -2,49 +2,48 @@ description: "Learn more about: COINITICOR Enumeration" title: "COINITICOR Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "COINITICOR" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "COINITICOR" -helpviewer_keywords: +helpviewer_keywords: - "COINITICOR enumeration [.NET Framework metadata]" -ms.assetid: 67fefd89-28d6-4588-84ea-dc7a5870e014 -topic_type: +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](../../../framework/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)] - +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](../../../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 index 6543611acf6b8..69ecde0ea1a64 100644 --- a/docs/core/unmanaged-api/metadata/coinitiee-enumeration.md +++ b/docs/core/unmanaged-api/metadata/coinitiee-enumeration.md @@ -2,52 +2,51 @@ description: "Learn more about: COINITIEE Enumeration" title: "COINITIEE Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "COINITIEE" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "COINITIEE" -helpviewer_keywords: +helpviewer_keywords: - "COINITIEE enumeration [.NET Framework metadata]" -ms.assetid: 64264238-3b68-4bac-a887-36b552426a6c -topic_type: +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](../../../framework/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)] - +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](../../../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 index 70a5ca9161441..607d5417f130d 100644 --- a/docs/core/unmanaged-api/metadata/cor-field-offset-structure.md +++ b/docs/core/unmanaged-api/metadata/cor-field-offset-structure.md @@ -2,52 +2,51 @@ description: "Learn more about: COR_FIELD_OFFSET Structure" title: "COR_FIELD_OFFSET Structure" ms.date: "03/30/2017" -api_name: +api_name: - "COR_FIELD_OFFSET" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "COR_FIELD_OFFSET" -helpviewer_keywords: +helpviewer_keywords: - "COR_FIELD_OFFSET structure [.NET Framework metadata]" -ms.assetid: cced5298-277f-4a5a-8ecf-a0050c1096ea -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/cor-native-link-structure.md b/docs/core/unmanaged-api/metadata/cor-native-link-structure.md index 3473142f596ce..51d30be6786d6 100644 --- a/docs/core/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](../../../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)] - +{ + 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 index 0540d8910a0bf..0ec25e5030d73 100644 --- a/docs/core/unmanaged-api/metadata/corargtype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corargtype-enumeration.md @@ -2,52 +2,51 @@ description: "Learn more about: CorArgType Enumeration" title: "CorArgType Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorArgType" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorArgType" -helpviewer_keywords: +helpviewer_keywords: - "CorArgType enumeration [.NET Framework metadata]" -ms.assetid: 3c1cb268-57a0-4664-91c7-f6908ff29e32 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index c3a38f5ab3bdb..c3d558e6343aa 100644 --- a/docs/core/unmanaged-api/metadata/corassemblyflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corassemblyflags-enumeration.md @@ -2,84 +2,83 @@ description: "Learn more about: CorAssemblyFlags Enumeration" title: "CorAssemblyFlags Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorAssemblyFlags" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorAssemblyFlags" -helpviewer_keywords: +helpviewer_keywords: - "CorAssemblyFlags enumeration [.NET Framework metadata]" -ms.assetid: bb8db3b6-d81d-49fc-b74c-dbc908a9eab9 -topic_type: +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 +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 - **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)] - ## 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 index 946a1f9f4bfa5..ac5267baf8188 100644 --- a/docs/core/unmanaged-api/metadata/corattributetargets-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corattributetargets-enumeration.md @@ -2,93 +2,92 @@ description: "Learn more about: CorAttributeTargets Enumeration" title: "CorAttributeTargets Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorAttributeTargets" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorAttributeTargets" -helpviewer_keywords: +helpviewer_keywords: - "CorAttributeTargets enumeration [.NET Framework metadata]" -ms.assetid: 694c0fa0-7011-41a9-9dfd-f0e16ea574b5 -topic_type: +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, - +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, - + 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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + 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 index c1a48ee2b7f50..99633b8a3ecaa 100644 --- a/docs/core/unmanaged-api/metadata/corcallingconvention-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corcallingconvention-enumeration.md @@ -2,74 +2,73 @@ description: "Learn more about: CorCallingConvention Enumeration" title: "CorCallingConvention Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorCallingConvention" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorCallingConvention" -helpviewer_keywords: +helpviewer_keywords: - "CorCallingConvention enumeration [.NET Framework metadata]" -ms.assetid: 69156fbf-7219-43bf-b4b8-b13f1a2fcb86 -topic_type: +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 +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 - **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)] - ## 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 index a40023a0252b4..053eb6e6ed37e 100644 --- a/docs/core/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md @@ -2,104 +2,103 @@ description: "Learn more about: CorCheckDuplicatesFor Enumeration" title: "CorCheckDuplicatesFor Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorCheckDuplicatesFor" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorCheckDuplicatesFor" -helpviewer_keywords: +helpviewer_keywords: - "CorCheckDuplicatesFor enumeration [.NET Framework metadata]" -ms.assetid: d8ec8d3c-70f7-4cc6-9957-68068fd8f49c -topic_type: +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, - +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 + 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 - **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)] - ## 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 index d108457952890..7fb234cb53d17 100644 --- a/docs/core/unmanaged-api/metadata/cordeclsecurity-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cordeclsecurity-enumeration.md @@ -2,88 +2,87 @@ description: "Learn more about: CorDeclSecurity Enumeration" title: "CorDeclSecurity Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorDeclSecurity" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorDeclSecurity" -helpviewer_keywords: +helpviewer_keywords: - "CorDeclSecurity enumeration [.NET Framework metadata]" -ms.assetid: 864f1267-d267-4696-8df7-1f83f8444d6f -topic_type: +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 +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 - **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)] - ## See also - [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/corelementtype-enumeration.md b/docs/core/unmanaged-api/metadata/corelementtype-enumeration.md index 991ce638770d9..58b101a02ce31 100644 --- a/docs/core/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" --- @@ -139,7 +138,7 @@ The type modifiers form the basis for representing more complex types. A `CorEle **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 index d8451ea6c6013..2a23419ffeeda 100644 --- a/docs/core/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md @@ -2,62 +2,61 @@ description: "Learn more about: CorErrorIfEmitOutOfOrder Enumeration" title: "CorErrorIfEmitOutOfOrder Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorErrorIfEmitOutOfOrder" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorErrorIfEmitOutOfOrder" -helpviewer_keywords: +helpviewer_keywords: - "CorErrorIfEmitOutOfOrder enumeration [.NET Framework metadata]" -ms.assetid: 6d758aad-29a7-44fe-9481-bbff5b799a32 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index 0df491778d0ee..4e76be6e4a406 100644 --- a/docs/core/unmanaged-api/metadata/coreventattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/coreventattr-enumeration.md @@ -2,53 +2,52 @@ description: "Learn more about: CorEventAttr Enumeration" title: "CorEventAttr Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorEventAttr" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorEventAttr" -helpviewer_keywords: +helpviewer_keywords: - "CorEventAttr enumeration [.NET Framework metadata]" -ms.assetid: dc2b3281-3820-487e-930d-350b66dc6417 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index 981ddd7e24b81..ea5b9e9bce631 100644 --- a/docs/core/unmanaged-api/metadata/corfieldattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corfieldattr-enumeration.md @@ -2,88 +2,87 @@ description: "Learn more about: CorFieldAttr Enumeration" title: "CorFieldAttr Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorFieldAttr" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorFieldAttr" -helpviewer_keywords: +helpviewer_keywords: - "CorFieldAttr enumeration [.NET Framework metadata]" -ms.assetid: 6ae2c4be-212c-4e74-9288-40a11dc26522 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index 40a7fe6f8ef67..67bf745ba901b 100644 --- a/docs/core/unmanaged-api/metadata/corfileflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corfileflags-enumeration.md @@ -2,50 +2,49 @@ description: "Learn more about: CorFileFlags Enumeration" title: "CorFileFlags Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorFileFlags" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorFileFlags" -helpviewer_keywords: +helpviewer_keywords: - "CorFileFlags enumeration [.NET Framework metadata]" -ms.assetid: d16703fd-518f-412e-92cb-74433d11032e -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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/core/unmanaged-api/metadata/corfilemapping-enumeration.md b/docs/core/unmanaged-api/metadata/corfilemapping-enumeration.md index d4880780f88bd..7f8ea128da64a 100644 --- a/docs/core/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](../../../framework/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 index d731b2e4a8728..2ea2fd8b9d71c 100644 --- a/docs/core/unmanaged-api/metadata/corgenericparamattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corgenericparamattr-enumeration.md @@ -2,65 +2,64 @@ description: "Learn more about: CorGenericParamAttr Enumeration" title: "CorGenericParamAttr Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorGenericParamAttr" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorGenericParamAttr" -helpviewer_keywords: +helpviewer_keywords: - "CorGenericParamAttr enumeration [.NET Framework metadata]" -ms.assetid: 36c76266-71d8-48dc-bd89-54943fa659c1 -topic_type: +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, +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, + 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 + 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 - **Platforms:** See [System Requirements](../../../framework/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/core/unmanaged-api/metadata/corimportoptions-enumeration.md b/docs/core/unmanaged-api/metadata/corimportoptions-enumeration.md index 149599545d939..eebd2be59b08e 100644 --- a/docs/core/unmanaged-api/metadata/corimportoptions-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corimportoptions-enumeration.md @@ -2,64 +2,63 @@ description: "Learn more about: CorImportOptions Enumeration" title: "CorImportOptions Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorImportOptions" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorImportOptions" -helpviewer_keywords: +helpviewer_keywords: - "CorImportOptions enumeration [.NET Framework metadata]" -ms.assetid: 4e5d03cb-97c9-4ff4-8dbd-17d94ee374d3 -topic_type: +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 +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 - **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)] - ## 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 index c361b85e7a7a5..4f82cc84479c7 100644 --- a/docs/core/unmanaged-api/metadata/corlinkeroptions-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corlinkeroptions-enumeration.md @@ -2,48 +2,47 @@ description: "Learn more about: CorLinkerOptions Enumeration" title: "CorLinkerOptions Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorLinkerOptions" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorLinkerOptions" -helpviewer_keywords: +helpviewer_keywords: - "CorLinkerOptions enumeration [.NET Framework metadata]" -ms.assetid: a656aad6-cc7e-4994-8251-004a6a45e18f -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index aee6ffe13b9b0..485ee2aa8fe46 100644 --- a/docs/core/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md @@ -2,51 +2,50 @@ description: "Learn more about: CorLocalRefPreservation Enumeration" title: "CorLocalRefPreservation Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorLocalRefPreservation" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorLocalRefPreservation" -helpviewer_keywords: +helpviewer_keywords: - "CorLocalRefPreservation enumeration [.NET Framework metadata]" -ms.assetid: 44757163-1228-4213-a4c4-d4de503cc75d -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] - +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 index d937ef0c35e56..9ace935c7ba13 100644 --- a/docs/core/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md @@ -2,52 +2,51 @@ description: "Learn more about: CorManifestResourceFlags Enumeration" title: "CorManifestResourceFlags Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorManifestResourceFlags" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorManifestResourceFlags" -helpviewer_keywords: +helpviewer_keywords: - "CorManifestResourceFlags enumeration [.NET Framework metadata]" -ms.assetid: 1b0306b7-622b-4b57-8edc-3c713bb147ae -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index 3d021472a9b15..e2989854265b1 100644 --- a/docs/core/unmanaged-api/metadata/cormethodattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cormethodattr-enumeration.md @@ -2,99 +2,98 @@ description: "Learn more about: CorMethodAttr Enumeration" title: "CorMethodAttr Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorMethodAttr" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorMethodAttr" -helpviewer_keywords: +helpviewer_keywords: - "CorMethodAttr enumeration [.NET Framework metadata]" -ms.assetid: 4e0c3521-e54d-43c1-9857-cc76b49b8ffc -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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/core/unmanaged-api/metadata/cormethodimpl-enumeration.md b/docs/core/unmanaged-api/metadata/cormethodimpl-enumeration.md index e9c3145952678..8df215694fab8 100644 --- a/docs/core/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" --- @@ -75,7 +74,7 @@ typedef enum CorMethodImpl { **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 index 5b486bc39e1df..488c2cec0c2dd 100644 --- a/docs/core/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md @@ -2,58 +2,57 @@ description: "Learn more about: CorMethodSemanticsAttr Enumeration" title: "CorMethodSemanticsAttr Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorMethodSemanticsAttr" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorMethodSemanticsAttr" -helpviewer_keywords: +helpviewer_keywords: - "CorMethodSemanticsAttr enumeration [.NET Framework metadata]" -ms.assetid: ca2af325-eb9d-4a91-90e4-267e45b98611 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index 06ec772538c37..65578e1c0ceb0 100644 --- a/docs/core/unmanaged-api/metadata/cornativelinkflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cornativelinkflags-enumeration.md @@ -2,55 +2,54 @@ description: "Learn more about: CorNativeLinkFlags Enumeration" title: "CorNativeLinkFlags Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorNativeLinkFlags" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorNativeLinkFlags" -helpviewer_keywords: +helpviewer_keywords: - "CorNativeLinkFlags enumeration [.NET Framework metadata]" -ms.assetid: 8027df7c-cfad-4724-bda0-7538d9519070 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index f817fd6aab035..541da13cee47b 100644 --- a/docs/core/unmanaged-api/metadata/cornativelinktype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cornativelinktype-enumeration.md @@ -2,59 +2,58 @@ description: "Learn more about: CorNativeLinkType Enumeration" title: "CorNativeLinkType Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorNativeLinkType" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorNativeLinkType" -helpviewer_keywords: +helpviewer_keywords: - "CorNativeLinkType enumeration [.NET Framework metadata]" -ms.assetid: 4f86ff37-2dab-4e64-819a-76b3bfe828ff -topic_type: +topic_type: - "apiref" --- # CorNativeLinkType Enumeration -Provides values that indicate the type linked in native code. - -## Syntax - -```cpp +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +{ + 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 index e3f5c970f9f11..d08823c79690f 100644 --- a/docs/core/unmanaged-api/metadata/cornativetype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cornativetype-enumeration.md @@ -2,145 +2,144 @@ description: "Learn more about: CorNativeType Enumeration" title: "CorNativeType Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorNativeType" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorNativeType" -helpviewer_keywords: +helpviewer_keywords: - "CorNativeType enumeration [.NET Framework metadata]" -ms.assetid: e47a72f1-9609-48ed-bb34-97170d7f6890 -topic_type: +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, - +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + + 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 - diff --git a/docs/core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md b/docs/core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md index f647ceb3f55ae..cff99da82d74f 100644 --- a/docs/core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md @@ -2,99 +2,98 @@ description: "Learn more about: CorNotificationForTokenMovement Enumeration" title: "CorNotificationForTokenMovement Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorNotificationForTokenMovement" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorNotificationForTokenMovement" -helpviewer_keywords: +helpviewer_keywords: - "CorNotificationForTokenMovement enumeration [.NET Framework metadata]" -ms.assetid: 1edd1670-976a-4fc8-bef7-7c41e60ad989 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index 9bab4f7d4c1d2..2a5b5306d73c7 100644 --- a/docs/core/unmanaged-api/metadata/coropenflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/coropenflags-enumeration.md @@ -2,72 +2,71 @@ description: "Learn more about: CorOpenFlags Enumeration" title: "CorOpenFlags Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorOpenFlags" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorOpenFlags" -helpviewer_keywords: +helpviewer_keywords: - "CorOpenFlags enumeration [.NET Framework metadata]" -ms.assetid: e27a83b5-2698-4996-9032-1e0fed8b91ca -topic_type: +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 +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 - **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)] - ## 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 index 46cbd666b1c8f..bc8b4e4878797 100644 --- a/docs/core/unmanaged-api/metadata/corparamattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corparamattr-enumeration.md @@ -2,62 +2,61 @@ description: "Learn more about: CorParamAttr Enumeration" title: "CorParamAttr Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorParamAttr" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorParamAttr" -helpviewer_keywords: +helpviewer_keywords: - "CorParamAttr enumeration [.NET Framework metadata]" -ms.assetid: a7ff90ad-dad8-48e8-917d-4aa9a118cbc8 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index b77b74ab45ca6..91afd048eec55 100644 --- a/docs/core/unmanaged-api/metadata/corpekind-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corpekind-enumeration.md @@ -2,62 +2,61 @@ description: "Learn more about: CorPEKind Enumeration" title: "CorPEKind Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorPEKind" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorPEKind" -helpviewer_keywords: +helpviewer_keywords: - "CorPEKind enumeration [.NET Framework metadata]" -ms.assetid: 22dc6dea-b1b9-4982-a730-a022d586b117 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +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 index 606543ccb4e4b..695e91a4cb8a4 100644 --- a/docs/core/unmanaged-api/metadata/corpinvokemap-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corpinvokemap-enumeration.md @@ -2,96 +2,95 @@ description: "Learn more about: CorPinvokeMap Enumeration" title: "CorPinvokeMap Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorPinvokeMap" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorPinvokeMap" -helpviewer_keywords: +helpviewer_keywords: - "CorPinvokeMap enumeration [.NET Framework metadata]" -ms.assetid: f14f986e-f6ce-42bc-aa23-18150c46d28c -topic_type: +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, - +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + + 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 index 2963ed87fde98..c8f291e745526 100644 --- a/docs/core/unmanaged-api/metadata/corpropertyattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corpropertyattr-enumeration.md @@ -2,56 +2,55 @@ description: "Learn more about: CorPropertyAttr Enumeration" title: "CorPropertyAttr Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorPropertyAttr" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorPropertyAttr" -helpviewer_keywords: +helpviewer_keywords: - "CorPropertyAttr enumeration [.NET Framework metadata]" -ms.assetid: 58ac8202-854d-4efd-acfb-d2da8b446e12 -topic_type: +topic_type: - "apiref" --- # CorPropertyAttr Enumeration -Contains values that describe the metadata of a property. - -## Syntax - -```cpp -typedef enum CorPropertyAttr { - +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + 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 index 867e85335ec8a..2748e7b2fc59a 100644 --- a/docs/core/unmanaged-api/metadata/correftodefcheck-enumeration.md +++ b/docs/core/unmanaged-api/metadata/correftodefcheck-enumeration.md @@ -2,54 +2,53 @@ description: "Learn more about: CorRefToDefCheck Enumeration" title: "CorRefToDefCheck Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorRefToDefCheck" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorRefToDefCheck" -helpviewer_keywords: +helpviewer_keywords: - "CorRefToDefCheck enumeration [.NET Framework metadata]" -ms.assetid: f9a80f1a-55af-4459-b095-8441aae16119 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index 1648f23b1e9c9..05e754478a5a4 100644 --- a/docs/core/unmanaged-api/metadata/corregflags-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corregflags-enumeration.md @@ -2,53 +2,52 @@ description: "Learn more about: CorRegFlags Enumeration" title: "CorRegFlags Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorRegFlags" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorRegFlags" -helpviewer_keywords: +helpviewer_keywords: - "CorRegFlags enumeration [.NET Framework metadata]" -ms.assetid: 8d3080ee-39fe-4c57-8950-51323632d045 -topic_type: +topic_type: - "apiref" --- # CorRegFlags Enumeration -Provides flag values used for registration when installing a module or composite image. - -## Syntax - -```cpp +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +{ + 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 index 9270dbdeadd88..dbbf3c9c38231 100644 --- a/docs/core/unmanaged-api/metadata/corsavesize-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corsavesize-enumeration.md @@ -2,52 +2,51 @@ description: "Learn more about: CorSaveSize Enumeration" title: "CorSaveSize Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorSaveSize" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorSaveSize" -helpviewer_keywords: +helpviewer_keywords: - "CorSaveSize enumeration [.NET Framework metadata]" -ms.assetid: eb95ce39-5688-43c1-a34d-578794b32faa -topic_type: +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 { +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + 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 index 208374dc59761..f326613186d36 100644 --- a/docs/core/unmanaged-api/metadata/corserializationtype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corserializationtype-enumeration.md @@ -2,86 +2,85 @@ description: "Learn more about: CorSerializationType Enumeration" title: "CorSerializationType Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorSerializationType" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorSerializationType" -helpviewer_keywords: +helpviewer_keywords: - "CorSerializationType enumeration [.NET Framework metadata]" -ms.assetid: 6b1fcd11-c7fb-4be2-8910-abc862d4caf4 -topic_type: +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 +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 - **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)] - ## 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 index 39e4c40c1a863..be243d8b856ec 100644 --- a/docs/core/unmanaged-api/metadata/corsetenc-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corsetenc-enumeration.md @@ -2,63 +2,62 @@ description: "Learn more about: CorSetENC Enumeration" title: "CorSetENC Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorSetENC" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorSetENC" -helpviewer_keywords: +helpviewer_keywords: - "CorSetENC enumeration [.NET Framework metadata]" -ms.assetid: fe4150e8-071d-43fb-8e06-c3c616dbeed2 -topic_type: +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 +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 - **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)] - ## See also - [Metadata Enumerations](metadata-enumerations.md) diff --git a/docs/core/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md b/docs/core/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md index ff66a94517d38..3113fd165212f 100644 --- a/docs/core/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" --- @@ -45,7 +44,7 @@ typedef enum CorThreadSafetyOptions { **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 index 20452fd89e32b..da7785869dbec 100644 --- a/docs/core/unmanaged-api/metadata/cortokentype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cortokentype-enumeration.md @@ -2,102 +2,101 @@ description: "Learn more about: CorTokenType Enumeration" title: "CorTokenType Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorTokenType" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorTokenType" -helpviewer_keywords: +helpviewer_keywords: - "CorTokenType enumeration [.NET Framework metadata]" -ms.assetid: 93c9a369-225f-4eff-9b78-3fbee4902cf1 -topic_type: +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 +Indicates the type of a metadata token. - Each value is equal to the value of the top byte in the corresponding metadata token. - -## Requirements +## 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 - **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)] - ## 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 index 088551786904b..7c7c7af51a70c 100644 --- a/docs/core/unmanaged-api/metadata/cortypeattr-enumeration.md +++ b/docs/core/unmanaged-api/metadata/cortypeattr-enumeration.md @@ -2,119 +2,118 @@ description: "Learn more about: CorTypeAttr Enumeration" title: "CorTypeAttr Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorTypeAttr" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorTypeAttr" -helpviewer_keywords: +helpviewer_keywords: - "CorTypeAttr enumeration [.NET Framework metadata]" -ms.assetid: 9bede0ec-5fdf-42a2-b5b7-bee64056acb6 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index 479a285553eaf..17e53431fe3c3 100644 --- a/docs/core/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md @@ -2,67 +2,66 @@ description: "Learn more about: CorUnmanagedCallingConvention Enumeration" title: "CorUnmanagedCallingConvention Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorUnmanagedCallingConvention" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorUnmanagedCallingConvention" -helpviewer_keywords: +helpviewer_keywords: - "CorUnmanagedCallingConvention enumeration [.NET Framework metadata]" -ms.assetid: 83058790-160b-4703-a5eb-74b66acbdfa9 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index c083e5e85610d..2056d170ff14d 100644 --- a/docs/core/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md +++ b/docs/core/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md @@ -2,61 +2,60 @@ description: "Learn more about: CorValidatorModuleType Enumeration" title: "CorValidatorModuleType Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "CorValidatorModuleType" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorValidatorModuleType" -helpviewer_keywords: +helpviewer_keywords: - "CorValidatorModuleType enumeration [.NET Framework metadata]" -ms.assetid: 748f1ab2-fbcb-4f55-89ec-8d23d81ebc80 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index bec1b070362f5..2ae1f9b541fd7 100644 --- a/docs/core/unmanaged-api/metadata/couninitiee-enumeration.md +++ b/docs/core/unmanaged-api/metadata/couninitiee-enumeration.md @@ -2,51 +2,50 @@ description: "Learn more about: COUNINITIEE Enumeration" title: "COUNINITIEE Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "COUNINITIEE" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "COUNINITIEE" -helpviewer_keywords: +helpviewer_keywords: - "COUNINITIEE enumeration [.NET Framework metadata]" -ms.assetid: c42baa79-f469-4330-95a2-baf7f021c2fc -topic_type: +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 -{ +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](../../../framework/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)] - + 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 index be6640d56e228..70f7b9e337d48 100644 --- a/docs/core/unmanaged-api/metadata/cvstruct-structure.md +++ b/docs/core/unmanaged-api/metadata/cvstruct-structure.md @@ -2,54 +2,53 @@ description: "Learn more about: CVStruct Structure" title: "CVStruct Structure" ms.date: "03/30/2017" -api_name: +api_name: - "CVStruct" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CVStruct" -helpviewer_keywords: +helpviewer_keywords: - "CVStruct structure [.NET Framework metadata]" -ms.assetid: e9e4e497-d5fb-464b-991c-3bdd824664fd -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index e863ae36fcb7d..d80064d8947f8 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-addsectionreloc-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-addsectionreloc-method.md @@ -2,62 +2,61 @@ description: "Learn more about: ICeeGen::AddSectionReloc Method" title: "ICeeGen::AddSectionReloc Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICeeGen.AddSectionReloc" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICeeGen::AddSectionReloc" -helpviewer_keywords: +helpviewer_keywords: - "AddSectionReloc method [.NET Framework metadata]" - "ICeeGen::AddSectionReloc method [.NET Framework metadata]" -ms.assetid: b500a260-1d57-4953-95e1-c27063f7c8da -topic_type: +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, +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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 index 2512931d4b4c1..d6e3cd5539dc2 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-allocatemethodbuffer-method.md @@ -2,58 +2,57 @@ description: "Learn more about: ICeeGen::AllocateMethodBuffer Method" title: "ICeeGen::AllocateMethodBuffer Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICeeGen.AllocateMethodBuffer" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICeeGen::AllocateMethodBuffer" -helpviewer_keywords: +helpviewer_keywords: - "AllocateMethodBuffer method [.NET Framework metadata]" - "ICeeGen::AllocateMethodBuffer method [.NET Framework metadata]" -ms.assetid: 845ab77e-9639-47f5-99fb-f3b619e3e779 -topic_type: +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 +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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 index 0dfaebbf6907b..27ca9e21f874d 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-computepointer-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-computepointer-method.md @@ -2,58 +2,57 @@ description: "Learn more about: ICeeGen::ComputePointer Method" title: "ICeeGen::ComputePointer Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICeeGen.ComputePointer" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICeeGen::ComputePointer" -helpviewer_keywords: +helpviewer_keywords: - "ICeeGen::ComputePointer method [.NET Framework metadata]" - "ComputePointer method [.NET Framework metadata]" -ms.assetid: b6b95c04-0f2c-4fcc-a8bc-3b1dcbdba731 -topic_type: +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, +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 Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - + [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 index 896fb50f96ff0..cf74ba8b951e8 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-emitstring-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-emitstring-method.md @@ -2,54 +2,53 @@ description: "Learn more about: ICeeGen::EmitString Method" title: "ICeeGen::EmitString Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICeeGen.EmitString" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICeeGen::EmitString" -helpviewer_keywords: +helpviewer_keywords: - "EmitString method [.NET Framework metadata]" - "ICeeGen::EmitString method [.NET Framework metadata]" -ms.assetid: ad2710a7-edb8-4493-8619-3fce235e3334 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index e8759fa9daf49..9a0adfa1a9c47 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-generateceefile-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-generateceefile-method.md @@ -2,47 +2,46 @@ description: "Learn more about: ICeeGen::GenerateCeeFile Method" title: "ICeeGen::GenerateCeeFile Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICeeGen.GenerateCeeFile" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICeeGen::GenerateCeeFile" -helpviewer_keywords: +helpviewer_keywords: - "GenerateCeeFile method [.NET Framework metadata]" - "ICeeGen::GenerateCeeFile method [.NET Framework metadata]" -ms.assetid: cca4a9a1-731b-4411-9e04-00cffe7a56d8 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index 5768d4e3dda9d..cce2733394654 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-generateceememoryimage-method.md @@ -2,50 +2,49 @@ description: "Learn more about: ICeeGen::GenerateCeeMemoryImage Method" title: "ICeeGen::GenerateCeeMemoryImage Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICeeGen.GenerateCeeMemoryImage" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICeeGen::GenerateCeeMemoryImage" -helpviewer_keywords: +helpviewer_keywords: - "ICeeGen::GenerateCeeMemoryImage method [.NET Framework metadata]" - "GenerateCeeMemoryImage method [.NET Framework metadata]" -ms.assetid: b3847495-0ae6-4a72-b496-65ce2424afc6 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index 654acee9a616b..8b39595f51fb2 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getilsection-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getilsection-method.md @@ -2,50 +2,49 @@ description: "Learn more about: ICeeGen::GetIlSection Method" title: "ICeeGen::GetIlSection Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICeeGen.GetIlSection" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICeeGen::GetIlSection" -helpviewer_keywords: +helpviewer_keywords: - "GetIlSection method [.NET Framework metadata]" - "ICeeGen::GetIlSection method [.NET Framework metadata]" -ms.assetid: 6f2db2ca-203f-4ac3-9530-208642ca385e -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index 55b87b9d9dc33..6e6276b079e40 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getimaptokeniface-method.md @@ -2,50 +2,49 @@ description: "Learn more about: ICeeGen::GetIMapTokenIface Method" title: "ICeeGen::GetIMapTokenIface Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICeeGen.GetIMapTokenIface" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICeeGen::GetIMapTokenIface" -helpviewer_keywords: +helpviewer_keywords: - "GetIMapTokenIface method [.NET Framework metadata]" - "ICeeGen::GetIMapTokenIface method [.NET Framework metadata]" -ms.assetid: 847a5531-c37d-49cd-8844-9e54b5d86cf7 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index 332728bb2bbeb..c2be5e17fc4dc 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getmethodbuffer-method.md @@ -2,54 +2,53 @@ description: "Learn more about: ICeeGen::GetMethodBuffer Method" title: "ICeeGen::GetMethodBuffer Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICeeGen.GetMethodBuffer" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICeeGen::GetMethodBuffer" -helpviewer_keywords: +helpviewer_keywords: - "ICeeGen::GetMethodBuffer method [.NET Framework metadata]" - "GetMethodBuffer method [.NET Framework metadata]" -ms.assetid: c7c5b39a-d4ac-41f1-9d1e-44163f563a49 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index e2d7b163d33d3..626a4b193ccc4 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getsectionblock-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getsectionblock-method.md @@ -2,66 +2,65 @@ description: "Learn more about: ICeeGen::GetSectionBlock Method" title: "ICeeGen::GetSectionBlock Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICeeGen.GetSectionBlock" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICeeGen::GetSectionBlock" -helpviewer_keywords: +helpviewer_keywords: - "GetSectionBlock method [.NET Framework metadata]" - "ICeeGen::GetSectionBlock method [.NET Framework metadata]" -ms.assetid: 05c78aaf-5bbd-497e-9ae2-55f4fae0c5fb -topic_type: +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 ( +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 + [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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +``` + +## 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 index 15b797f020af4..b5e95acc88a8d 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getsectioncreate-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getsectioncreate-method.md @@ -2,62 +2,61 @@ description: "Learn more about: ICeeGen::GetSectionCreate Method" title: "ICeeGen::GetSectionCreate Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICeeGen.GetSectionCreate" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICeeGen::GetSectionCreate" -helpviewer_keywords: +helpviewer_keywords: - "ICeeGen::GetSectionCreate method [.NET Framework metadata]" - "GetSectionCreate method [.NET Framework metadata]" -ms.assetid: 154b2460-59ce-4874-a9f2-1b3353486ac5 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index aebdc46fcde21..fe373692b5a1d 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getsectiondatalen-method.md @@ -2,58 +2,57 @@ description: "Learn more about: ICeeGen::GetSectionDataLen Method" title: "ICeeGen::GetSectionDataLen Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICeeGen.GetSectionDataLen" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICeeGen::GetSectionDataLen" -helpviewer_keywords: +helpviewer_keywords: - "ICeeGen::GetSectionDataLen method [.NET Framework metadata]" - "GetSectionDataLen method [.NET Framework metadata]" -ms.assetid: e2a06ee4-b8ee-49c7-935a-c1031a29eef2 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index 2ab4c8ea98141..728f65a139636 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getstring-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getstring-method.md @@ -2,54 +2,53 @@ description: "Learn more about: ICeeGen::GetString Method" title: "ICeeGen::GetString Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICeeGen.GetString" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICeeGen::GetString" -helpviewer_keywords: +helpviewer_keywords: - "ICeeGen::GetString method [.NET Framework metadata]" - "GetString method, ICeeGen interface [.NET Framework metadata]" -ms.assetid: 7cc22562-128c-440a-9147-55ff20f173d7 -topic_type: +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 ( +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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 index 800aa0449551e..7bd2e6edd9506 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-getstringsection-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-getstringsection-method.md @@ -2,50 +2,49 @@ description: "Learn more about: ICeeGen::GetStringSection Method" title: "ICeeGen::GetStringSection Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICeeGen.GetStringSection" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICeeGen::GetStringSection" -helpviewer_keywords: +helpviewer_keywords: - "ICeeGen::GetStringSection method [.NET Framework metadata]" - "GetStringSection method [.NET Framework metadata]" -ms.assetid: a2267d39-69d1-4de1-bf37-f752cafacc71 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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/core/unmanaged-api/metadata/iceegen-interface.md b/docs/core/unmanaged-api/metadata/iceegen-interface.md index 99a5181b6fb89..4743026d12b92 100644 --- a/docs/core/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](../../../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)] - +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 index 952a23d2c2ae9..94c99448c0aa3 100644 --- a/docs/core/unmanaged-api/metadata/iceegen-truncatesection-method.md +++ b/docs/core/unmanaged-api/metadata/iceegen-truncatesection-method.md @@ -2,58 +2,57 @@ description: "Learn more about: ICeeGen::TruncateSection Method" title: "ICeeGen::TruncateSection Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICeeGen.TruncateSection" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICeeGen::TruncateSection" -helpviewer_keywords: +helpviewer_keywords: - "TruncateSection method [.NET Framework metadata]" - "ICeeGen::TruncateSection method [.NET Framework metadata]" -ms.assetid: 0451d752-1e5c-4c9a-8bad-6cd35b7ba3df -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index ad0ae8cc72372..04bef529970ff 100644 --- a/docs/core/unmanaged-api/metadata/ihostfilter-interface.md +++ b/docs/core/unmanaged-api/metadata/ihostfilter-interface.md @@ -2,43 +2,42 @@ description: "Learn more about: IHostFilter Interface" title: "IHostFilter Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostFilter" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostFilter" -helpviewer_keywords: +helpviewer_keywords: - "IHostFilter interface [.NET Framework metadata]" -ms.assetid: e79456b1-045b-4a84-9714-2ea560ff75ea -topic_type: +topic_type: - "apiref" --- # IHostFilter Interface -Provides a method to indicate that a specified token will be processed. - +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +> 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/core/unmanaged-api/metadata/ihostfilter-marktoken-method.md b/docs/core/unmanaged-api/metadata/ihostfilter-marktoken-method.md index 7efe010288417..46a79a8dc19c2 100644 --- a/docs/core/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](../../../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)] - +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 index bb3530e9ed719..0cb48e7995994 100644 --- a/docs/core/unmanaged-api/metadata/imaptoken-interface.md +++ b/docs/core/unmanaged-api/metadata/imaptoken-interface.md @@ -2,43 +2,42 @@ description: "Learn more about: IMapToken Interface" title: "IMapToken Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IMapToken" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMapToken" -helpviewer_keywords: +helpviewer_keywords: - "IMapToken interface [.NET Framework metadata]" -ms.assetid: 4c5c4df0-43f3-4830-a01b-8d029806f2c4 -topic_type: +topic_type: - "apiref" --- # IMapToken Interface -Provides mapping capabilities between assemblies. - +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +> 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/core/unmanaged-api/metadata/imaptoken-map-method.md b/docs/core/unmanaged-api/metadata/imaptoken-map-method.md index d15dcb574795d..8f54925c6e42c 100644 --- a/docs/core/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](../../../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)] - + [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 index 3be8042415cca..73b5ff24768e0 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassembly-method.md @@ -2,76 +2,75 @@ description: "Learn more about: IMetaDataAssemblyEmit::DefineAssembly Method" title: "IMetaDataAssemblyEmit::DefineAssembly Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyEmit.DefineAssembly" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyEmit::DefineAssembly" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataAssemblyEmit::DefineAssembly method [.NET Framework metadata]" - "DefineAssembly method [.NET Framework metadata]" -ms.assetid: a0637d66-74bf-4f2d-8137-9ff838bccece -topic_type: +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, +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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 index 39aa20a8c58fc..912315bcf1ad3 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineassemblyref-method.md @@ -2,82 +2,81 @@ description: "Learn more about: IMetaDataAssemblyEmit::DefineAssemblyRef Method" title: "IMetaDataAssemblyEmit::DefineAssemblyRef Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyEmit.DefineAssemblyRef" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyEmit::DefineAssemblyRef" -helpviewer_keywords: +helpviewer_keywords: - "DefineAssemblyRef method [.NET Framework metadata]" - "IMetaDataAssemblyEmit::DefineAssemblyRef method [.NET Framework metadata]" -ms.assetid: 0b284b18-0084-4b3a-912a-5ebe9f29c88b -topic_type: +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](../../../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)] - +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/core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-defineexportedtype-method.md index 97ea5f0ac692f..2d4f894f6de6c 100644 --- a/docs/core/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](../../../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)] - + [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 index faa77906e6b14..ad6392945e643 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definefile-method.md @@ -2,68 +2,67 @@ description: "Learn more about: IMetaDataAssemblyEmit::DefineFile Method" title: "IMetaDataAssemblyEmit::DefineFile Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyEmit.DefineFile" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyEmit::DefineFile" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataAssemblyEmit::DefineFile method [.NET Framework metadata]" - "DefineFile method [.NET Framework metadata]" -ms.assetid: c065aadf-c1ca-4981-bde6-597042cb29c4 -topic_type: +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 ( +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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/core/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-definemanifestresource-method.md index edc3c3f7d3920..c06835847e1f3 100644 --- a/docs/core/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](../../../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)] - + [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/core/unmanaged-api/metadata/imetadataassemblyemit-interface.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-interface.md index 07f0c06448022..0d48f1322b826 100644 --- a/docs/core/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](../../../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)] - +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 index 3e596075d324c..ef244eb65111a 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyprops-method.md @@ -2,76 +2,75 @@ description: "Learn more about: IMetaDataAssemblyEmit::SetAssemblyProps Method" title: "IMetaDataAssemblyEmit::SetAssemblyProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyEmit.SetAssemblyProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyEmit::SetAssemblyProps" -helpviewer_keywords: +helpviewer_keywords: - "SetAssemblyProps method [.NET Framework metadata]" - "IMetaDataAssemblyEmit::SetAssemblyProps method [.NET Framework metadata]" -ms.assetid: 91b633d7-9e75-43c3-a8d2-2144984e5f9e -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index fa4fed4b2b6de..fa33d1556c1bb 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setassemblyrefprops-method.md @@ -2,80 +2,79 @@ description: "Learn more about: IMetaDataAssemblyEmit::SetAssemblyRefProps Method" title: "IMetaDataAssemblyEmit::SetAssemblyRefProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyEmit.SetAssemblyRefProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyEmit::SetAssemblyRefProps" -helpviewer_keywords: +helpviewer_keywords: - "SetAssemblyRefProps method [.NET Framework metadata]" - "IMetaDataAssemblyEmit::SetAssemblyRefProps method [.NET Framework metadata]" -ms.assetid: 70a32bf3-9051-4f96-ae87-11356d06a073 -topic_type: +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, +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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 index fe3855a240c73..57db5efa3ae63 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setexportedtypeprops-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IMetaDataAssemblyEmit::SetExportedTypeProps Method" title: "IMetaDataAssemblyEmit::SetExportedTypeProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyEmit.SetExportedTypeProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyEmit::SetExportedTypeProps" -helpviewer_keywords: +helpviewer_keywords: - "SetExportedTypeProps method [.NET Framework metadata]" - "IMetaDataAssemblyEmit::SetExportedTypeProps method [.NET Framework metadata]" -ms.assetid: 1c090153-fd5f-46c7-9cff-39a78d992c8f -topic_type: +topic_type: - "apiref" --- # IMetaDataAssemblyEmit::SetExportedTypeProps Method -Modifies the specified `ExportedType` metadata structure. - -## Syntax - -```cpp -HRESULT SetExportedTypeProps ( +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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 index ccbf786f88848..5bff9e6408577 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IMetaDataAssemblyEmit::SetFileProps Method" title: "IMetaDataAssemblyEmit::SetFileProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyEmit.SetFileProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyEmit::SetFileProps" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataAssemblyEmit::SetFileProps method [.NET Framework metadata]" - "SetFileProps method [.NET Framework metadata]" -ms.assetid: 85667d38-611c-45a9-938d-930ac7a7b681 -topic_type: +topic_type: - "apiref" --- # IMetaDataAssemblyEmit::SetFileProps Method -Modifies the specified `File` metadata structure. - -## Syntax - -```cpp -HRESULT SetFileProps ( - [in] mdFile file, +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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/core/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md index cac93a67abe4b..3b4badee54d2f 100644 --- a/docs/core/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](../../../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)] - + [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 index fbc4ca7a83691..5ca28199ee0ed 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-closeenum-method.md @@ -2,48 +2,47 @@ description: "Learn more about: IMetaDataAssemblyImport::CloseEnum Method" title: "IMetaDataAssemblyImport::CloseEnum Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyImport.CloseEnum" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyImport::CloseEnum" -helpviewer_keywords: +helpviewer_keywords: - "CloseEnum method, IMetaDataAssemblyImport interface [.NET Framework metadata]" - "IMetaDataAssemblyImport::CloseEnum method [.NET Framework metadata]" -ms.assetid: c9df4087-12b3-46d9-b075-9067dd7805df -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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/core/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumassemblyrefs-method.md index d2a7b4413e8d2..ce4bcb4fbd806 100644 --- a/docs/core/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](../../../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)] - + [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/core/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumexportedtypes-method.md index 1c7ff80140be1..e329f3c27881f 100644 --- a/docs/core/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](../../../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)] - + [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/core/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enumfiles-method.md index 0954d8a946c2c..af1af282d5b42 100644 --- a/docs/core/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](../../../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)] - + [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/core/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-enummanifestresources-method.md index 73109b651b005..24bb333dba202 100644 --- a/docs/core/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](../../../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)] - +``` + +## 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/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md index 548f120048943..ac6eca704bade 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md @@ -2,85 +2,84 @@ 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](../../../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)] - + [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](../../../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) diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md index 277b76cfd6580..0b2d6bf99511b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md @@ -2,60 +2,59 @@ 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](../../../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)] - + [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) diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md index c7c67144ec387..ba3af4bdb3f34 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md @@ -2,56 +2,55 @@ 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](../../../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)] - +``` + +## 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) diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyfromscope-method.md index e82159b1a74f4..b8cda717d661b 100644 --- a/docs/core/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](../../../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)] - +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 index df331ffa41519..a931b05764c6b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyprops-method.md @@ -2,80 +2,79 @@ description: "Learn more about: IMetaDataAssemblyImport::GetAssemblyProps Method" title: "IMetaDataAssemblyImport::GetAssemblyProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataAssemblyImport.GetAssemblyProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataAssemblyImport::GetAssemblyProps" -helpviewer_keywords: +helpviewer_keywords: - "GetAssemblyProps method [.NET Framework metadata]" - "IMetaDataAssemblyImport::GetAssemblyProps method [.NET Framework metadata]" -ms.assetid: 0eaa4aa9-9441-444a-920c-e4b2a2db899e -topic_type: +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, +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getassemblyrefprops-method.md index 4d7a0cb291bb7..0d8774d92aee6 100644 --- a/docs/core/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](../../../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)] - + [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/core/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getexportedtypeprops-method.md index 9aab811958c47..3d43a75f34dee 100644 --- a/docs/core/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](../../../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)] - + [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/core/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md index 704f473744aba..323921d027a42 100644 --- a/docs/core/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](../../../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)] - + [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/core/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md index 671c412d6e382..6848aa23fde58 100644 --- a/docs/core/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](../../../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)] - + [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/core/unmanaged-api/metadata/imetadataassemblyimport-interface.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-interface.md index 9cf4d6faaf74e..5f4312800756f 100644 --- a/docs/core/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](../../../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)] - +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/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md b/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypeinfo-method.md index 140d52f89e675..dce238cda04e7 100644 --- a/docs/core/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](../../../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)] - +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/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md b/docs/core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md index bdd4128bf9b20..01322d4ef4186 100644 --- a/docs/core/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](../../../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)] - + [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 index 71222108f377c..907b69f7acbd8 100644 --- a/docs/core/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IMetaDataConverter::GetTypeLibFromMetaData Method" title: "IMetaDataConverter::GetTypeLibFromMetaData Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataConverter.GetTypeLibFromMetaData" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataConverter::GetTypeLibFromMetaData" -helpviewer_keywords: +helpviewer_keywords: - "GetTypeLibFromMetaData method [.NET Framework metadata]" - "IMetaDataConverter::GetTypeLibFromMetaData method [.NET Framework metadata]" -ms.assetid: 90eab7b3-1fae-4af4-8bce-f7bc0e188a99 -topic_type: +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 ( +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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/core/unmanaged-api/metadata/imetadataconverter-interface.md b/docs/core/unmanaged-api/metadata/imetadataconverter-interface.md index 045b7214de1d6..9e74e78740ddc 100644 --- a/docs/core/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](../../../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)] - +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/core/unmanaged-api/metadata/imetadatadispenser-definescope-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenser-definescope-method.md index a68994637274c..961cca0efee67 100644 --- a/docs/core/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](../../../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)] - + [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/core/unmanaged-api/metadata/imetadatadispenser-interface.md b/docs/core/unmanaged-api/metadata/imetadatadispenser-interface.md index b9439155cf0d6..b8a4985bc0416 100644 --- a/docs/core/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](../../../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)] - +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/core/unmanaged-api/metadata/imetadatadispenser-openscope-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenser-openscope-method.md index 1d646c19dcaf6..30cea8d004e29 100644 --- a/docs/core/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](../../../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)] - + [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/core/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md index 9f3a999425de7..58689ad3fdcc1 100644 --- a/docs/core/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](../../../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)] - + [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 index 1f28d011b5b94..12d7e84953c57 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassembly-method.md @@ -2,72 +2,71 @@ description: "Learn more about: IMetaDataDispenserEx::FindAssembly Method" title: "IMetaDataDispenserEx::FindAssembly Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataDispenserEx.FindAssembly" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataDispenserEx::FindAssembly" -helpviewer_keywords: +helpviewer_keywords: - "FindAssembly method [.NET Framework metadata]" - "IMetaDataDispenserEx::FindAssembly method [.NET Framework metadata]" -ms.assetid: 3afe7252-5f28-48d9-a74d-1927566c404c -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md index c6aededd82ad6..8d73da3495efc 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-findassemblymodule-method.md @@ -2,76 +2,75 @@ description: "Learn more about: IMetaDataDispenserEx::FindAssemblyModule Method" title: "IMetaDataDispenserEx::FindAssemblyModule Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataDispenserEx.FindAssemblyModule" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataDispenserEx::FindAssemblyModule" -helpviewer_keywords: +helpviewer_keywords: - "FindAssemblyModule method [.NET Framework metadata]" - "IMetaDataDispenserEx::FindAssemblyModule method [.NET Framework metadata]" -ms.assetid: d1fb65e1-7e19-4513-85b1-44f87c294d3e -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-getcorsystemdirectory-method.md index 837a545ebcf94..b8db8428a39be 100644 --- a/docs/core/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](../../../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)] - + [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/core/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-getoption-method.md index ed312439dd7bb..c451c8c973d2b 100644 --- a/docs/core/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](../../../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)] - + [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/core/unmanaged-api/metadata/imetadatadispenserex-interface.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-interface.md index 30848a997cd67..8e73ab8973268 100644 --- a/docs/core/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](../../../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)] - +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 index 1919a9de29cc6..089ce8fd76091 100644 --- a/docs/core/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md @@ -2,60 +2,59 @@ description: "Learn more about: IMetaDataDispenserEx::OpenScopeOnITypeInfo Method" title: "IMetaDataDispenserEx::OpenScopeOnITypeInfo Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataDispenserEx.OpenScopeOnITypeInfo" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataDispenserEx::OpenScopeOnITypeInfo" -helpviewer_keywords: +helpviewer_keywords: - "OpenScopeOnITypeInfo method [.NET Framework metadata]" - "IMetaDataDispenserEx::OpenScopeOnITypeInfo method [.NET Framework metadata]" -ms.assetid: 3480bbdb-c442-44a0-b7c6-333354503c52 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md b/docs/core/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md index 7f26a6778128a..c9c211d49abe2 100644 --- a/docs/core/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](../../../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)] - + [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/core/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-applyeditandcontinue-method.md index 6dcad6f118449..a45bdf2e9c40d 100644 --- a/docs/core/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](../../../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)] - + + 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/core/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definecustomattribute-method.md index 471cc35e1edd7..0331fa2844305 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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 index 7114304c9f72e..12424a85e5a5d 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-defineevent-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineevent-method.md @@ -2,28 +2,27 @@ description: "Learn more about: IMetaDataEmit::DefineEvent Method" title: "IMetaDataEmit::DefineEvent Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.DefineEvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::DefineEvent" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::DefineEvent method [.NET Framework metadata]" - "DefineEvent method [.NET Framework metadata]" -ms.assetid: cf064bac-9a9f-41c5-9e1d-108ff7af3afe -topic_type: +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 +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, @@ -34,48 +33,48 @@ HRESULT DefineEvent ( [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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## 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) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-definefield-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definefield-method.md index a681468bba886..13cf50a33ea3b 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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/core/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineimportmember-method.md index 40262c31712f1..bcfb8aacbece6 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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/core/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineimporttype-method.md index e80f02a100793..6ccc475cafa0e 100644 --- a/docs/core/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](../../../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)] - + [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/core/unmanaged-api/metadata/imetadataemit-definememberref-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definememberref-method.md index f9e9dd54b867a..f3c3d53efc63c 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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/core/unmanaged-api/metadata/imetadataemit-definemethod-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definemethod-method.md index 3d6cf476365ad..28791fc53a5d8 100644 --- a/docs/core/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](../../../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)] - + + 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/core/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definemethodimpl-method.md index c73cc7290fa7b..f69ef40a78b55 100644 --- a/docs/core/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](../../../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)] - + [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/core/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definemoduleref-method.md index 43bd80893b414..c7e17f5736255 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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/core/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definenestedtype-method.md index 2b883dcc6409f..44d6e111289c6 100644 --- a/docs/core/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](../../../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)] - + [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/core/unmanaged-api/metadata/imetadataemit-defineparam-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineparam-method.md index 9a9c7492c7d5e..5f1d490f43379 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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/core/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definepermissionset-method.md index 44b4a4c7733d2..12a55ee6ec116 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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/core/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definepinvokemap-method.md index f43e205eb4c05..e17dcea024ab4 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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/core/unmanaged-api/metadata/imetadataemit-defineproperty-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-defineproperty-method.md index 207027bc4a275..4186189acd323 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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/core/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definesecurityattributeset-method.md index d5cc8759ff6c6..0403c73d66691 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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/core/unmanaged-api/metadata/imetadataemit-definetypedef-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definetypedef-method.md index 99f2af435b520..49c4d70575a07 100644 --- a/docs/core/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](../../../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)] - + [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/core/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-definetyperefbyname-method.md index db27db9b45988..4a8a41ee2d310 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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 index a73dfd39c78fa..969476596dd47 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-defineuserstring-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IMetaDataEmit::DefineUserString Method" title: "IMetaDataEmit::DefineUserString Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.DefineUserString" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::DefineUserString" -helpviewer_keywords: +helpviewer_keywords: - "DefineUserString method [.NET Framework metadata]" - "IMetaDataEmit::DefineUserString method [.NET Framework metadata]" -ms.assetid: 88fb7ef3-bbdf-429c-b678-c9c153456461 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::DefineUserString Method -Gets a metadata token for the specified literal string. - -## Syntax - -```cpp +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## 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) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-deleteclasslayout-method.md index 7d034888a2e09..7336df2333691 100644 --- a/docs/core/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](../../../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)] - +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/core/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-deletefieldmarshal-method.md index 8b87f180a53b6..88afefec60fbd 100644 --- a/docs/core/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](../../../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)] - +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/core/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-deletepinvokemap-method.md index 6dcce1ac1a7d2..a8afbd64def42 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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 index 385c992a9ca2b..2fa9225b56424 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-deletetoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-deletetoken-method.md @@ -2,48 +2,47 @@ description: "Learn more about: IMetaDataEmit::DeleteToken Method" title: "IMetaDataEmit::DeleteToken Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.DeleteToken" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::DeleteToken" -helpviewer_keywords: +helpviewer_keywords: - "DeleteToken method [.NET Framework metadata]" - "IMetaDataEmit::DeleteToken method [.NET Framework metadata]" -ms.assetid: a4926d0a-261b-46b1-9994-82633661a64b -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::DeleteToken Method -Deletes the specified token from the current metadata scope. - -## Syntax - -```cpp +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## 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) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-getsavesize-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-getsavesize-method.md index 2fa3c8f111df2..e003ad11df5ae 100644 --- a/docs/core/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](../../../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)] - +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 index d1a539d5c21a0..05b694096c1af 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromsig-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IMetaDataEmit::GetTokenFromSig Method" title: "IMetaDataEmit::GetTokenFromSig Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.GetTokenFromSig" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::GetTokenFromSig" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::GetTokenFromSig method [.NET Framework metadata]" - "GetTokenFromSig method [.NET Framework metadata]" -ms.assetid: 50a58a83-6287-40a4-b315-47823cea0a5c -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::GetTokenFromSig Method -Gets a token for the specified metadata signature. - -## Syntax - -```cpp +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## 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) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-gettokenfromtypespec-method.md index 8774806e21621..e0ba0629727f1 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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/core/unmanaged-api/metadata/imetadataemit-interface.md b/docs/core/unmanaged-api/metadata/imetadataemit-interface.md index bf88000dabf1d..0b866baef8707 100644 --- a/docs/core/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](../../../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)] - ## See also - [Metadata Interfaces](metadata-interfaces.md) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-merge-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-merge-method.md index d11b8b13178e6..bed96413485d4 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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/core/unmanaged-api/metadata/imetadataemit-mergeend-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-mergeend-method.md index 0001ccf11ea4b..bd44b29361e1a 100644 --- a/docs/core/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" --- @@ -65,7 +64,7 @@ The following special conditions apply to the merge: **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/core/unmanaged-api/metadata/imetadataemit-save-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-save-method.md index 68dc7be102c77..d2b02994cb53d 100644 --- a/docs/core/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](../../../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)] - + [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/core/unmanaged-api/metadata/imetadataemit-savetomemory-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-savetomemory-method.md index dbf6c4a788324..cbd3b7c2c51de 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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 index 534777ecc6e8b..c16afdcb143ec 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-savetostream-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-savetostream-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataEmit::SaveToStream Method" title: "IMetaDataEmit::SaveToStream Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.SaveToStream" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::SaveToStream" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::SaveToStream method [.NET Framework metadata]" - "SaveToStream method [.NET Framework metadata]" -ms.assetid: e0290a49-3818-4a43-ad46-3014faa34f97 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::SaveToStream Method -Saves all metadata in the current scope to the specified `IStream`. - -## Syntax - -```cpp +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setclasslayout-method.md index 5f3e9e2b0470a..c899c30918228 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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/core/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setcustomattributevalue-method.md index 3aba824f50849..d0b6b74111ba2 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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/core/unmanaged-api/metadata/imetadataemit-seteventprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-seteventprops-method.md index 9c4e80470a7e3..b7a091ad12956 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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/core/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldmarshal-method.md index 008a76f20ccee..1dda9a749a081 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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/core/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldprops-method.md index 9209cf7204107..3283cb7448c25 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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/core/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setfieldrva-method.md index 37c89a476b041..7fab0a0d78dfc 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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/core/unmanaged-api/metadata/imetadataemit-sethandler-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-sethandler-method.md index 02431d893d8a7..b94669fdde392 100644 --- a/docs/core/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](../../../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)] - + [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/core/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setmethodimplflags-method.md index 191721e39564c..44730ef0c1c7f 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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 index 11b3e4a753bf8..0740583872df5 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setmethodprops-method.md @@ -2,60 +2,59 @@ description: "Learn more about: IMetaDataEmit::SetMethodProps Method" title: "IMetaDataEmit::SetMethodProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.SetMethodProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::SetMethodProps" -helpviewer_keywords: +helpviewer_keywords: - "SetMethodProps method [.NET Framework metadata]" - "IMetaDataEmit::SetMethodProps method [.NET Framework metadata]" -ms.assetid: e0c6ac12-22ea-43f5-b799-8cda0faf3336 -topic_type: +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 +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] 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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## 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) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setmoduleprops-method.md index a1ffdb94f8912..1abc568960b6e 100644 --- a/docs/core/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](../../../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)] - + [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 index c3e95e1dae0e2..59d9e87b80960 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setparamprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setparamprops-method.md @@ -2,28 +2,27 @@ description: "Learn more about: IMetaDataEmit::SetParamProps Method" title: "IMetaDataEmit::SetParamProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.SetParamProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::SetParamProps" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::SetParamProps method [.NET Framework metadata]" - "SetParamProps method [.NET Framework metadata]" -ms.assetid: a95a3908-9f87-4084-937e-8e01ef03ad63 -topic_type: +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 +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, @@ -31,39 +30,39 @@ HRESULT SetParamProps ( [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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## 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) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-setparent-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setparent-method.md index 40803fcdcd311..144650594a874 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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/core/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setpermissionsetprops-method.md index d09ee5f4cf4bc..896c6cf2b9945 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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/core/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setpinvokemap-method.md index 6ac9c33ba0123..9ca9bf1e48806 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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/core/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-setpropertyprops-method.md index 3102d9e291a20..eafa18a4c3614 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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 index 5333c35bbda6b..a54ab023f1e1e 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit-setrva-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit-setrva-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataEmit::SetRVA Method" title: "IMetaDataEmit::SetRVA Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit.SetRVA" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit::SetRVA" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit::SetRVA method [.NET Framework metadata]" - "SetRVA method [.NET Framework metadata]" -ms.assetid: 4d69fb6d-ee35-4318-8224-5eea2bd16818 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit::SetRVA Method -Sets the relative virtual address of the specified method. - -## Syntax - -```cpp -HRESULT SetRVA ( +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +); +``` + +## 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) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md index 67256db45ee20..1fe52495d0f5a 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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/core/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md b/docs/core/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md index 8eedf1ef092dc..2e79601e9aee0 100644 --- a/docs/core/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](../../../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)] - +); +``` + +## 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/core/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-definegenericparam-method.md index 7240b4ae3d63f..5e04036094750 100644 --- a/docs/core/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](../../../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)] - + [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/core/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-definemethodspec-method.md index 95138e12c69af..33eb4c4a74403 100644 --- a/docs/core/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](../../../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)] - + [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 index e9aa65c773baf..2e073adc174ec 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-getdeltasavesize-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataEmit2::GetDeltaSaveSize Method" title: "IMetaDataEmit2::GetDeltaSaveSize Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit2.GetDeltaSaveSize" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit2::GetDeltaSaveSize" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit2::GetDeltaSaveSize method [.NET Framework metadata]" - "GetDeltaSaveSize method [.NET Framework metadata]" -ms.assetid: 036db5e7-8211-4645-9a34-03d1a89be955 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-interface.md b/docs/core/unmanaged-api/metadata/imetadataemit2-interface.md index c791c2b20a0aa..23fd095640da5 100644 --- a/docs/core/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](../../../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)] - +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 index 68672882910f6..225dd5e0b8c80 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-resetenclog-method.md @@ -2,45 +2,44 @@ description: "Learn more about: IMetaDataEmit2::ResetENCLog Method" title: "IMetaDataEmit2::ResetENCLog Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit2.ResetENCLog" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit2::ResetENCLog" -helpviewer_keywords: +helpviewer_keywords: - "ResetENCLog method [.NET Framework metadata]" - "IMetaDataEmit2::ResetENCLog method [.NET Framework metadata]" -ms.assetid: 44b9fd76-a022-4e9a-aea3-dec5411a9c22 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-savedelta-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-savedelta-method.md index 925b9452f9596..8c2ccde55df48 100644 --- a/docs/core/unmanaged-api/metadata/imetadataemit2-savedelta-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataemit2-savedelta-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataEmit2::SaveDelta Method" title: "IMetaDataEmit2::SaveDelta Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataEmit2.SaveDelta" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataEmit2::SaveDelta" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataEmit2::SaveDelta method [.NET Framework metadata]" - "SaveDelta method [.NET Framework metadata]" -ms.assetid: b95739fe-d2fa-4776-ae0d-31d9707ef799 -topic_type: +topic_type: - "apiref" --- # IMetaDataEmit2::SaveDelta Method -Saves changes from the current edit-and-continue session to the specified file. - -## Syntax - -```cpp -HRESULT SaveDelta ( +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 Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - + [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) diff --git a/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatomemory-method.md index 8265de019bf07..8ce8979e98256 100644 --- a/docs/core/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](../../../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)] - + [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/core/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md index ccbf8cf797376..a71476184d697 100644 --- a/docs/core/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](../../../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)] - + [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/core/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md b/docs/core/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md index a3d29bad6a4a1..4e03a00f38494 100644 --- a/docs/core/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](../../../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)] - + [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 index e1dd0c9b15d1c..427bc8ec46f15 100644 --- a/docs/core/unmanaged-api/metadata/imetadataerror-interface.md +++ b/docs/core/unmanaged-api/metadata/imetadataerror-interface.md @@ -2,43 +2,42 @@ description: "Learn more about: IMetaDataError Interface" title: "IMetaDataError Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataError" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataError" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataError interface [.NET Framework metadata]" -ms.assetid: 0020b62c-ea88-40c7-a9ee-16b064f81624 -topic_type: +topic_type: - "apiref" --- # IMetaDataError Interface -Provides a callback mechanism for reporting errors during the metadata merge. - +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +> 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 index ed0f20ae26d0e..c77483c3a90c8 100644 --- a/docs/core/unmanaged-api/metadata/imetadataerror-onerror-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataerror-onerror-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataError::OnError Method" title: "IMetaDataError::OnError Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataError.OnError" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataError::OnError" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataError::OnError method [.NET Framework metadata]" - "OnError method, IMetaDataError interface [.NET Framework metadata]" -ms.assetid: c1e744b8-a6fb-4d9c-a971-8babc875d8f0 -topic_type: +topic_type: - "apiref" --- # IMetaDataError::OnError Method -Provides notification of errors that occur during the metadata merge. - -## Syntax - -```cpp -HRESULT OnError ( +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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/core/unmanaged-api/metadata/imetadatafilter-interface.md b/docs/core/unmanaged-api/metadata/imetadatafilter-interface.md index 1140d3c51c26a..a95b80c8cbec0 100644 --- a/docs/core/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](../../../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)] - +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 index 82baa90640551..2b06280662cb9 100644 --- a/docs/core/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatafilter-istokenmarked-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataFilter::IsTokenMarked Method" title: "IMetaDataFilter::IsTokenMarked Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataFilter.IsTokenMarked" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataFilter::IsTokenMarked" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataFilter::IsTokenMarked method [.NET Framework metadata]" - "IsTokenMarked method [.NET Framework metadata]" -ms.assetid: 7d90dcee-0206-4540-807b-06982fe65f1a -topic_type: +topic_type: - "apiref" --- # IMetaDataFilter::IsTokenMarked Method -Gets a value indicating whether the specified metadata token has been marked as processed. - -## Syntax - -```cpp -HRESULT IsTokenMarked ( +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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 index 50b9172e9883e..aeb1870c8ba7c 100644 --- a/docs/core/unmanaged-api/metadata/imetadatafilter-marktoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatafilter-marktoken-method.md @@ -2,48 +2,47 @@ description: "Learn more about: IMetaDataFilter::MarkToken Method" title: "IMetaDataFilter::MarkToken Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataFilter.MarkToken" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataFilter::MarkToken" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataFilter::MarkToken method [.NET Framework metadata]" - "MarkToken method, IMetaDataFilter interface [.NET Framework metadata]" -ms.assetid: bd492834-6529-4d39-b93d-f8cdbd3e297f -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 index fc64f947e8a2a..f34e6803ec181 100644 --- a/docs/core/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md @@ -2,45 +2,44 @@ description: "Learn more about: IMetaDataFilter::UnmarkAll Method" title: "IMetaDataFilter::UnmarkAll Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataFilter.UnmarkAll" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataFilter::UnmarkAll" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataFilter::UnmarkAll method [.NET Framework metadata]" - "UnmarkAll method [.NET Framework metadata]" -ms.assetid: a04d91dc-690f-4de8-8c97-55c69a8503b4 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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/core/unmanaged-api/metadata/imetadataimport-closeenum-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-closeenum-method.md index 7a96d30313d0a..926579f05b706 100644 --- a/docs/core/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](../../../framework/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/core/unmanaged-api/metadata/imetadataimport-countenum-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-countenum-method.md index bfbf2f01029bf..ba78c4b9c3d4e 100644 --- a/docs/core/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](../../../framework/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 index 0c708d122f449..cb930f88787f9 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumcustomattributes-method.md @@ -2,75 +2,74 @@ description: "Learn more about: IMetaDataImport::EnumCustomAttributes Method" title: "IMetaDataImport::EnumCustomAttributes Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.EnumCustomAttributes" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::EnumCustomAttributes" -helpviewer_keywords: +helpviewer_keywords: - "EnumCustomAttributes method [.NET Framework metadata]" - "IMetaDataImport::EnumCustomAttributes method [.NET Framework metadata]" -ms.assetid: 798513a0-68b1-4d04-bc5b-782a4445ea68 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::EnumCustomAttributes Method -Enumerates custom attribute-definition tokens associated with the specified type or member. - -## Syntax - -```cpp +Enumerates custom attribute-definition tokens associated with the specified type or member. + +## Syntax + +```cpp HRESULT EnumCustomAttributes ( - [in, out] HCORENUM *phEnum, + [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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumevents-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumevents-method.md index 48da8dd284dd1..ea5a196603c5c 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumevents-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumevents-method.md @@ -2,71 +2,70 @@ description: "Learn more about: IMetaDataImport::EnumEvents Method" title: "IMetaDataImport::EnumEvents Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.EnumEvents" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::EnumEvents" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::EnumEvents method [.NET Framework metadata]" - "EnumEvents method [.NET Framework metadata]" -ms.assetid: e1efedcb-3dd7-42ae-a399-21c24728aec5 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::EnumEvents Method -Enumerates event definition tokens for the specified TypeDef token. - -## Syntax - -```cpp +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumfields-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumfields-method.md index 6caf1dbc85416..989f7ab44897c 100644 --- a/docs/core/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](../../../framework/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/core/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumfieldswithname-method.md index d62635b8c6723..eff260e67ab3b 100644 --- a/docs/core/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](../../../framework/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/core/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enuminterfaceimpls-method.md index 39abd97be698e..5e201e5f0e9d3 100644 --- a/docs/core/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](../../../framework/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 index fa50607bd6219..e21bf2c2d3210 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummemberrefs-method.md @@ -2,71 +2,70 @@ description: "Learn more about: IMetaDataImport::EnumMemberRefs Method" title: "IMetaDataImport::EnumMemberRefs Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.EnumMemberRefs" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::EnumMemberRefs" -helpviewer_keywords: +helpviewer_keywords: - "EnumMemberRefs method [.NET Framework metadata]" - "IMetaDataImport::EnumMemberRefs method [.NET Framework metadata]" -ms.assetid: e97c97a6-6e4f-41f5-9af1-9b3cf3bdbd6b -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::EnumMemberRefs Method -Enumerates MemberRef tokens representing members of the specified type. - -## Syntax - -```cpp -HRESULT EnumMemberRefs ( +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummembers-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummembers-method.md index 94383bbbab42a..60f9e33a026b2 100644 --- a/docs/core/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](../../../framework/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-enummemberswithname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummemberswithname-method.md index ff7f34416ed26..17ce30b714c7d 100644 --- a/docs/core/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](../../../framework/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/core/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodimpls-method.md index 132960b9f04f0..2321262529e8d 100644 --- a/docs/core/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](../../../framework/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 index 4f669ca2cf1c1..de237a01b922d 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummethods-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummethods-method.md @@ -2,71 +2,70 @@ description: "Learn more about: IMetaDataImport::EnumMethods Method" title: "IMetaDataImport::EnumMethods Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.EnumMethods" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::EnumMethods" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::EnumMethods method [.NET Framework metadata]" - "EnumMethods method [.NET Framework metadata]" -ms.assetid: 8cc3b0c3-d97d-4f71-9e7d-ef2a92b4959a -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::EnumMethods Method -Enumerates MethodDef tokens representing methods of the specified type. - -## Syntax - -```cpp -HRESULT EnumMethods ( +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 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 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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodsemantics-method.md index eb129454fef80..1c85bb3877239 100644 --- a/docs/core/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](../../../framework/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 index 15173b826b4a1..ddff59ecd9f0a 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummethodswithname-method.md @@ -2,79 +2,78 @@ description: "Learn more about: IMetaDataImport::EnumMethodsWithName Method" title: "IMetaDataImport::EnumMethodsWithName Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.EnumMethodsWithName" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::EnumMethodsWithName" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::EnumMethodsWithName method [.NET Framework metadata]" - "EnumMethodsWithName method [.NET Framework metadata]" -ms.assetid: a8624913-2e23-46ad-a0c1-bb8eccbbf20f -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md index ac910b4503cff..515a1ecb908fc 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enummodulerefs-method.md @@ -2,67 +2,66 @@ description: "Learn more about: IMetaDataImport::EnumModuleRefs Method" title: "IMetaDataImport::EnumModuleRefs Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.EnumModuleRefs" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::EnumModuleRefs" -helpviewer_keywords: +helpviewer_keywords: - "EnumModuleRefs method [.NET Framework metadata]" - "IMetaDataImport::EnumModuleRefs method [.NET Framework metadata]" -ms.assetid: 53441f3a-68d2-477c-906e-37c55dfcfb4d -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumparams-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumparams-method.md index 0415403b0b319..d40c1a116c1bd 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumparams-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumparams-method.md @@ -2,71 +2,70 @@ description: "Learn more about: IMetaDataImport::EnumParams Method" title: "IMetaDataImport::EnumParams Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.EnumParams" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::EnumParams" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::EnumParams method [.NET Framework metadata]" - "EnumParams method [.NET Framework metadata]" -ms.assetid: 52118dc9-fe6e-4b39-aa48-c3cc3ea4214d -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md index bacf455a50bb5..80c4622ba50e1 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumpermissionsets-method.md @@ -2,75 +2,74 @@ description: "Learn more about: IMetaDataImport::EnumPermissionSets Method" title: "IMetaDataImport::EnumPermissionSets Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.EnumPermissionSets" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::EnumPermissionSets" -helpviewer_keywords: +helpviewer_keywords: - "EnumPermissionSets method [.NET Framework metadata]" - "IMetaDataImport::EnumPermissionSets method [.NET Framework metadata]" -ms.assetid: 347d7e5c-c90f-45ad-bd1e-2c7912b0b19c -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::EnumPermissionSets Method -Enumerates permissions for the objects in a specified metadata scope. - -## Syntax - -```cpp -HRESULT EnumPermissionSets +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumproperties-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumproperties-method.md index 94d84df26898a..78e8289b55971 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumproperties-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumproperties-method.md @@ -2,71 +2,70 @@ description: "Learn more about: IMetaDataImport::EnumProperties Method" title: "IMetaDataImport::EnumProperties Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.EnumProperties" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::EnumProperties" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::EnumProperties method [.NET Framework metadata]" - "EnumProperties method [.NET Framework metadata]" -ms.assetid: 60573ad7-8821-4721-a068-3f7a6d25926a -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md index 2be348bd36260..60148ecdedeb7 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumsignatures-method.md @@ -2,71 +2,70 @@ description: "Learn more about: IMetaDataImport::EnumSignatures Method" title: "IMetaDataImport::EnumSignatures Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.EnumSignatures" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::EnumSignatures" -helpviewer_keywords: +helpviewer_keywords: - "EnumSignatures method [.NET Framework metadata]" - "IMetaDataImport::EnumSignatures method [.NET Framework metadata]" -ms.assetid: d0d65060-6f90-42a2-95cf-6ffb04352996 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md index 14e479016eb48..d2b618e591f19 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumtypedefs-method.md @@ -2,71 +2,70 @@ description: "Learn more about: IMetaDataImport::EnumTypeDefs Method" title: "IMetaDataImport::EnumTypeDefs Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.EnumTypeDefs" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::EnumTypeDefs" -helpviewer_keywords: +helpviewer_keywords: - "EnumTypeDefs method [.NET Framework metadata]" - "IMetaDataImport::EnumTypeDefs method [.NET Framework metadata]" -ms.assetid: 4e508711-da92-4381-aaf8-6803075cdaa2 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::EnumTypeDefs Method -Enumerates TypeDef tokens representing all types within the current scope. - -## Syntax - -```cpp -HRESULT EnumTypeDefs ( +Enumerates TypeDef tokens representing all types within the current scope. + +## Syntax + +```cpp +HRESULT EnumTypeDefs ( [out] HCORENUM *phEnum, - [in] mdTypeDef rTypeDefs[], + [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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md index 24c26f3d6cbb4..5153cfd089fa3 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumtyperefs-method.md @@ -2,71 +2,70 @@ description: "Learn more about: IMetaDataImport::EnumTypeRefs Method" title: "IMetaDataImport::EnumTypeRefs Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.EnumTypeRefs" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::EnumTypeRefs" -helpviewer_keywords: +helpviewer_keywords: - "EnumTypeRefs method [.NET Framework metadata]" - "IMetaDataImport::EnumTypeRefs method [.NET Framework metadata]" -ms.assetid: b4896b8f-8e97-469c-8089-e72a025661b5 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::EnumTypeRefs Method -Enumerates TypeRef tokens defined in the current metadata scope. - -## Syntax - -```cpp -HRESULT EnumTypeRefs ( +Enumerates TypeRef tokens defined in the current metadata scope. + +## Syntax + +```cpp +HRESULT EnumTypeRefs ( [in, out] HCORENUM *phEnum, - [out] mdTypeRef rTypeRefs[], + [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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md index 9dda93b75ec31..8661016095815 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumtypespecs-method.md @@ -2,71 +2,70 @@ description: "Learn more about: IMetaDataImport::EnumTypeSpecs Method" title: "IMetaDataImport::EnumTypeSpecs Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.EnumTypeSpecs" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::EnumTypeSpecs" -helpviewer_keywords: +helpviewer_keywords: - "EnumTypeSpecs method [.NET Framework metadata]" - "IMetaDataImport::EnumTypeSpecs method [.NET Framework metadata]" -ms.assetid: 75331c7b-988b-436c-9eb9-a270d37b4f06 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-enumunresolvedmethods-method.md index 40d4142570ad4..f3c30dcc24b4d 100644 --- a/docs/core/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](../../../framework/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 index a9a134a0a1b0b..3aa26aed16aff 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-enumuserstrings-method.md @@ -2,71 +2,70 @@ description: "Learn more about: IMetaDataImport::EnumUserStrings Method" title: "IMetaDataImport::EnumUserStrings Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.EnumUserStrings" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::EnumUserStrings" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::EnumUserStrings method [.NET Framework metadata]" - "EnumUserStrings method [.NET Framework metadata]" -ms.assetid: 2b1f1418-4be8-4cdb-b418-b3abccc527a7 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-findfield-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findfield-method.md index f10c375070972..61bfdc0fb1246 100644 --- a/docs/core/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](../../../framework/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/core/unmanaged-api/metadata/imetadataimport-findmember-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findmember-method.md index 834c7cb1a6c8e..58bdbe2db6326 100644 --- a/docs/core/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](../../../framework/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/core/unmanaged-api/metadata/imetadataimport-findmemberref-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findmemberref-method.md index 3b7e723563cd7..3e6bc3dbb1642 100644 --- a/docs/core/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](../../../framework/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/core/unmanaged-api/metadata/imetadataimport-findmethod-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findmethod-method.md index ac3703bdabcfc..8a63a9dcae378 100644 --- a/docs/core/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](../../../framework/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 index 3067394f73551..011bf8f629b38 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findtypedefbyname-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IMetaDataImport::FindTypeDefByName Method" title: "IMetaDataImport::FindTypeDefByName Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.FindTypeDefByName" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::FindTypeDefByName" -helpviewer_keywords: +helpviewer_keywords: - "FindTypeDefByName method [.NET Framework metadata]" - "IMetaDataImport::FindTypeDefByName method [.NET Framework metadata]" -ms.assetid: f4c2cd88-ac28-4bad-9ab1-2cf9d2de41e6 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-findtyperef-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-findtyperef-method.md index 5b18e1bba035c..47e6d4e772651 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-findtyperef-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-findtyperef-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IMetaDataImport::FindTypeRef Method" title: "IMetaDataImport::FindTypeRef Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.FindTypeRef" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::FindTypeRef" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::FindTypeRef method [.NET Framework metadata]" - "FindTypeRef method [.NET Framework metadata]" -ms.assetid: 1b2bbf3f-943e-412e-b66c-e802431b055c -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md index 0a1bd9fa87261..2b9fb016f4212 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getclasslayout-method.md @@ -2,68 +2,67 @@ description: "Learn more about: IMetaDataImport::GetClassLayout Method" title: "IMetaDataImport::GetClassLayout Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetClassLayout" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetClassLayout" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::GetClassLayout method [.NET Framework metadata]" - "GetClassLayout method, IMetaDataImport interface [.NET Framework metadata]" -ms.assetid: 8f35414d-f40b-4b99-8768-9adb675c622a -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::GetClassLayout Method -Gets layout information for the class referenced by the specified TypeDef token. - -## Syntax - -```cpp +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributebyname-method.md index acdcba2c7b430..364967751bee9 100644 --- a/docs/core/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](../../../framework/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/core/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getcustomattributeprops-method.md index 555f907be2441..88271da3e6b42 100644 --- a/docs/core/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](../../../framework/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/core/unmanaged-api/metadata/imetadataimport-geteventprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-geteventprops-method.md index 5ec12493b8e9f..c22819a7b261e 100644 --- a/docs/core/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](../../../framework/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/core/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getfieldmarshal-method.md index 4eb7118f436ff..966f89e8923a0 100644 --- a/docs/core/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](../../../framework/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 index cd4937e429321..9544484dfeebc 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getfieldprops-method.md @@ -2,88 +2,87 @@ description: "Learn more about: IMetaDataImport::GetFieldProps Method" title: "IMetaDataImport::GetFieldProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetFieldProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetFieldProps" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::GetFieldProps method [.NET Framework metadata]" - "GetFieldProps method [.NET Framework metadata]" -ms.assetid: 7b0e9b10-8cef-4ba6-8432-40bf63e65ab1 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::GetFieldProps Method -Gets metadata associated with the field referenced by the specified FieldDef token. - -## Syntax - -```cpp -HRESULT GetFieldProps ( +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, + [out] mdTypeDef *pClass, + [out] LPWSTR szField, [in] ULONG cchField, - [out] ULONG *pchField, - [out] DWORD *pdwAttr, + [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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getinterfaceimplprops-method.md index 40f66b56bcf27..5f918d724de94 100644 --- a/docs/core/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](../../../framework/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-getmemberprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmemberprops-method.md index 869567c50b50b..0c968359a4508 100644 --- a/docs/core/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](../../../framework/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/core/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmemberrefprops-method.md index be9297b882737..8c6f56cc0fcf1 100644 --- a/docs/core/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](../../../framework/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 index b669bfd8e808e..98cec6269b508 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getmethodprops-method.md @@ -2,84 +2,83 @@ description: "Learn more about: IMetaDataImport::GetMethodProps Method" title: "IMetaDataImport::GetMethodProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetMethodProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetMethodProps" -helpviewer_keywords: +helpviewer_keywords: - "GetMethodProps method [.NET Framework metadata]" - "IMetaDataImport::GetMethodProps method [.NET Framework metadata]" -ms.assetid: e0667ef7-1d31-4c89-a2d3-d426f023f8d2 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmethodsemantics-method.md index 5ce36343a7796..3100c4cc0d3cb 100644 --- a/docs/core/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](../../../framework/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/core/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmodulefromscope-method.md index 2421c14343a9d..822a78c59fe25 100644 --- a/docs/core/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](../../../framework/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/core/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getmodulerefprops-method.md index 845702597f5ba..051d782260a96 100644 --- a/docs/core/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](../../../framework/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/core/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getnamefromtoken-method.md index 88766b1a36af3..21f945d2fbc10 100644 --- a/docs/core/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](../../../framework/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 index e9676c7c8244f..055d8a2f79f52 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getnativecallconvfromsig-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IMetaDataImport::GetNativeCallConvFromSig Method" title: "IMetaDataImport::GetNativeCallConvFromSig Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetNativeCallConvFromSig" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetNativeCallConvFromSig" -helpviewer_keywords: +helpviewer_keywords: - "GetNativeCallConvFromSig method [.NET Framework metadata]" - "IMetaDataImport::GetNativeCallConvFromSig method [.NET Framework metadata]" -ms.assetid: 50e04026-4d4a-47d9-96c1-f4677d6d938b -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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 - diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getnestedclassprops-method.md index 77b3fe0f7b689..75a7dd7f3bd7d 100644 --- a/docs/core/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](../../../framework/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/core/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getparamformethodindex-method.md index 661e432f52a78..f6763087920c8 100644 --- a/docs/core/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](../../../framework/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 index 3fbef4898df9c..14ed322e0dea0 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getparamprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getparamprops-method.md @@ -2,88 +2,87 @@ description: "Learn more about: IMetaDataImport::GetParamProps Method" title: "IMetaDataImport::GetParamProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetParamProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetParamProps" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::GetParamProps method [.NET Framework metadata]" - "GetParamProps method [.NET Framework metadata]" -ms.assetid: 4d5e5f00-bcab-4f41-b191-176511a186a7 -topic_type: +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. - +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 +## 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](../../../framework/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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getpermissionsetprops-method.md index b1f2bd6eae208..7963343b9d357 100644 --- a/docs/core/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](../../../framework/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 index 48b8708da920b..cd44e887bb85f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getpinvokemap-method.md @@ -2,68 +2,67 @@ description: "Learn more about: IMetaDataImport::GetPinvokeMap Method" title: "IMetaDataImport::GetPinvokeMap Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetPinvokeMap" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetPinvokeMap" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::GetPinvokeMap method [.NET Framework metadata]" - "GetPinvokeMap method [.NET Framework metadata]" -ms.assetid: b8685c1e-b80c-4198-8eb3-748d6f48a99e -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getpropertyprops-method.md index c8d172e32f17b..71140bb1d1ac9 100644 --- a/docs/core/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](../../../framework/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/core/unmanaged-api/metadata/imetadataimport-getrva-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getrva-method.md index d8092954eed92..283ff9693e1a2 100644 --- a/docs/core/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](../../../framework/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 index 265868650a35a..b969b86d76ce1 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getscopeprops-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IMetaDataImport::GetScopeProps Method" title: "IMetaDataImport::GetScopeProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetScopeProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetScopeProps" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::GetScopeProps method [.NET Framework metadata]" - "GetScopeProps method [.NET Framework metadata]" -ms.assetid: c8ba42d2-d9fa-43cb-bbc0-f33e1e592cb6 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-getsigfromtoken-method.md index 2ce9ca1c4a875..0a391463160fa 100644 --- a/docs/core/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](../../../framework/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 index d638a6c928668..ef09d9e0990d4 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-gettypedefprops-method.md @@ -2,68 +2,67 @@ description: "Learn more about: IMetaDataImport::GetTypeDefProps Method" title: "IMetaDataImport::GetTypeDefProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetTypeDefProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetTypeDefProps" -helpviewer_keywords: +helpviewer_keywords: - "GetTypeDefProps method [.NET Framework metadata]" - "IMetaDataImport::GetTypeDefProps method [.NET Framework metadata]" -ms.assetid: 00061a25-ba05-47a7-b984-fd916b06b149 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md index 7cfd1b7a4e3fa..153b5a7129e31 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-gettyperefprops-method.md @@ -2,64 +2,63 @@ description: "Learn more about: IMetaDataImport::GetTypeRefProps Method" title: "IMetaDataImport::GetTypeRefProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetTypeRefProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetTypeRefProps" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::GetTypeRefProps method [.NET Framework metadata]" - "GetTypeRefProps method [.NET Framework metadata]" -ms.assetid: 01837955-ce1e-4068-b338-fd473bd77d1d -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-gettypespecfromtoken-method.md index 98b179f31e82f..a73a923730975 100644 --- a/docs/core/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](../../../framework/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 index b5fe0eec88be6..dd3458aaf94a6 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-getuserstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-getuserstring-method.md @@ -2,60 +2,59 @@ description: "Learn more about: IMetaDataImport::GetUserString Method" title: "IMetaDataImport::GetUserString Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.GetUserString" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::GetUserString" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::GetUserString method [.NET Framework metadata]" - "GetUserString method, IMetaDataImport interface [.NET Framework metadata]" -ms.assetid: 0fd3bb47-58b5-4083-b241-b9719df7a285 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-interface.md b/docs/core/unmanaged-api/metadata/imetadataimport-interface.md index 7e24a139a106e..eea88e29a8646 100644 --- a/docs/core/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](../../../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)] - +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 index 1af50c8589fd6..b3f1cce92a41f 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-isglobal-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-isglobal-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataImport::IsGlobal Method" title: "IMetaDataImport::IsGlobal Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.IsGlobal" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::IsGlobal" -helpviewer_keywords: +helpviewer_keywords: - "IsGlobal method [.NET Framework metadata]" - "IMetaDataImport::IsGlobal method [.NET Framework metadata]" -ms.assetid: 44cf6908-f555-4ae8-b2cf-24bd974bf2fe -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md index 3d061824dda1a..51a1d533fc446 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-isvalidtoken-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataImport::IsValidToken Method" title: "IMetaDataImport::IsValidToken Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.IsValidToken" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::IsValidToken" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport::IsValidToken method [.NET Framework metadata]" - "IsValidToken method [.NET Framework metadata]" -ms.assetid: aeb0fc63-9eff-4384-9284-cb9900572d74 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-resetenum-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-resetenum-method.md index ee089fdb618e9..4a8bfd32e7c01 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport-resetenum-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport-resetenum-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataImport::ResetEnum Method" title: "IMetaDataImport::ResetEnum Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport.ResetEnum" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport::ResetEnum" -helpviewer_keywords: +helpviewer_keywords: - "ResetEnum method [.NET Framework metadata]" - "IMetaDataImport::ResetEnum method [.NET Framework metadata]" -ms.assetid: dda867b5-1050-49ba-b01c-fcc83b7a5617 -topic_type: +topic_type: - "apiref" --- # IMetaDataImport::ResetEnum Method -Resets the specified enumerator to the specified position. - -## Syntax - -```cpp -HRESULT ResetEnum ( +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md b/docs/core/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md index 9a5471f3afcbc..c3ebac75b7315 100644 --- a/docs/core/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](../../../framework/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/core/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparamconstraints-method.md index d768d63bb8813..d40147908f98a 100644 --- a/docs/core/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](../../../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)] - +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 index 837a8d660b4f2..bbe86a5e3531e 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-enumgenericparams-method.md @@ -2,71 +2,70 @@ description: "Learn more about: IMetaDataImport2::EnumGenericParams Method" title: "IMetaDataImport2::EnumGenericParams Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport2.EnumGenericParams" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport2::EnumGenericParams" -helpviewer_keywords: +helpviewer_keywords: - "EnumGenericParams method [.NET Framework metadata]" - "IMetaDataImport2::EnumGenericParams method [.NET Framework metadata]" -ms.assetid: b50488a5-3cf0-483c-82dc-2892a3ec61ac -topic_type: +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 - +Gets an enumerator for an array of generic parameter tokens associated with the specified TypeDef or MethodDef token. + +## Syntax + ```cpp -HRESULT EnumGenericParams ( +HRESULT EnumGenericParams ( [in, out] HCORENUM *phEnum, - [in] mdToken tk, + [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 Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - + [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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md index 5dfd47e307767..8de58087c5190 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-enummethodspecs-method.md @@ -2,71 +2,70 @@ description: "Learn more about: IMetaDataImport2::EnumMethodSpecs Method" title: "IMetaDataImport2::EnumMethodSpecs Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport2.EnumMethodSpecs" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport2::EnumMethodSpecs" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport2::EnumMethodSpecs method [.NET Framework metadata]" - "EnumMethodSpecs method [.NET Framework metadata]" -ms.assetid: b3fc1e6c-bcb6-4915-baf8-7dc0a31b8724 -topic_type: +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 ( +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 + [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 Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +``` + +## 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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamconstraintprops-method.md index c152f7171c6bd..b412e3f269a8a 100644 --- a/docs/core/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](../../../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)] - +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 index a41d207a8aebe..717b8e48d624b 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-getgenericparamprops-method.md @@ -2,76 +2,75 @@ description: "Learn more about: IMetaDataImport2::GetGenericParamProps Method" title: "IMetaDataImport2::GetGenericParamProps Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport2.GetGenericParamProps" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport2::GetGenericParamProps" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataImport2::GetGenericParamProps method [.NET Framework metadata]" - "GetGenericParamProps method [.NET Framework metadata]" -ms.assetid: dbb21e67-712b-49e7-a27c-a1e73ffd46c5 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getmethodspecprops-method.md index 417628b02d084..eb235eb454063 100644 --- a/docs/core/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](../../../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)] - +``` + +## 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 index 1fc494903a433..5bc3574a94464 100644 --- a/docs/core/unmanaged-api/metadata/imetadataimport2-getpekind-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataimport2-getpekind-method.md @@ -2,62 +2,61 @@ description: "Learn more about: IMetaDataImport2::GetPEKind Method" title: "IMetaDataImport2::GetPEKind Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataImport2.GetPEKind" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataImport2::GetPEKind" -helpviewer_keywords: +helpviewer_keywords: - "GetPEKind method [.NET Framework metadata]" - "IMetaDataImport2::GetPEKind method [.NET Framework metadata]" -ms.assetid: d91c3d89-8022-4a4c-a2a2-a8af2c387507 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md b/docs/core/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md index b6a49db8d97b7..3462169c1f555 100644 --- a/docs/core/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](../../../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)] - +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/core/unmanaged-api/metadata/imetadataimport2-interface.md b/docs/core/unmanaged-api/metadata/imetadataimport2-interface.md index cf8ef6b96a03c..4e3ee9fe58e41 100644 --- a/docs/core/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](../../../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)] - +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/core/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md b/docs/core/unmanaged-api/metadata/imetadatainfo-getfilemapping-method.md index 49eae99531d45..3c444bc789a68 100644 --- a/docs/core/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](../../../framework/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/core/unmanaged-api/metadata/imetadatainfo-interface.md b/docs/core/unmanaged-api/metadata/imetadatainfo-interface.md index b5cf3a873e2cd..b48fba1d402c1 100644 --- a/docs/core/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](../../../framework/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 index 49a1bc1e14276..fd0867fee6b8a 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getblob-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getblob-method.md @@ -2,56 +2,55 @@ description: "Learn more about: IMetaDataTables::GetBlob Method" title: "IMetaDataTables::GetBlob Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataTables.GetBlob" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataTables::GetBlob" -helpviewer_keywords: +helpviewer_keywords: - "GetBlob method [.NET Framework metadata]" - "IMetaDataTables::GetBlob method [.NET Framework metadata]" -ms.assetid: 94667c1c-6d58-4aa7-b74e-530b11e2a276 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getblobheapsize-method.md index aa387827afa3b..5874806c116de 100644 --- a/docs/core/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](../../../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)] - +``` + +## 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 index e287250832104..ad051c5cf5340 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getcodedtokeninfo-method.md @@ -2,60 +2,59 @@ description: "Learn more about: IMetaDataTables::GetCodedTokenInfo Method" title: "IMetaDataTables::GetCodedTokenInfo Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataTables.GetCodedTokenInfo" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataTables::GetCodedTokenInfo" -helpviewer_keywords: +helpviewer_keywords: - "GetCodedTokenInfo method [.NET Framework metadata]" - "IMetaDataTables::GetCodedTokenInfo method [.NET Framework metadata]" -ms.assetid: 31214d3a-715e-49af-92b3-0fd11e4f218a -topic_type: +topic_type: - "apiref" --- # IMetaDataTables::GetCodedTokenInfo Method -Gets a pointer to an array of tokens associated with the specified row index. - -## Syntax - -```cpp +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 Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - + [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) diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getcolumn-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getcolumn-method.md index 3085acef2e336..c31145c7ad910 100644 --- a/docs/core/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](../../../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)] - + +## 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/core/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getcolumninfo-method.md index 1d63282d513eb..9ce5a9a71c027 100644 --- a/docs/core/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](../../../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)] - ## See also - [IMetaDataTables Interface](imetadatatables-interface.md) diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getguid-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getguid-method.md index f54e3c5e46969..1471d63186084 100644 --- a/docs/core/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" --- @@ -50,7 +49,7 @@ HRESULT GetGuid ( **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 index 09ce5de51d6c7..5f6176abd48f0 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getguidheapsize-method.md @@ -2,48 +2,47 @@ description: "Learn more about: IMetaDataTables::GetGuidHeapSize Method" title: "IMetaDataTables::GetGuidHeapSize Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataTables.GetGuidHeapSize" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataTables::GetGuidHeapSize" -helpviewer_keywords: +helpviewer_keywords: - "GetGuidHeapSize method [.NET Framework metadata]" - "IMetaDataTables::GetGuidHeapSize method [.NET Framework metadata]" -ms.assetid: e875cbee-1ad9-4f1a-bf03-38cdb8ff371a -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getnextblob-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnextblob-method.md index 5916660a904a4..dc05b39d3a0fe 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getnextblob-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getnextblob-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataTables::GetNextBlob Method" title: "IMetaDataTables::GetNextBlob Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataTables.GetNextBlob" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataTables::GetNextBlob" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataTables::GetNextBlob method [.NET Framework metadata]" - "GetNextBlob method [.NET Framework metadata]" -ms.assetid: 017c8ab4-4c09-4754-9935-5b0b49cabecb -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getnextguid-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnextguid-method.md index cb8693888066d..9059952e3694e 100644 --- a/docs/core/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" --- @@ -50,7 +49,7 @@ HRESULT GetNextGuid ( **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 index 7a0cf75eb3b00..e639550134f9d 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getnextstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getnextstring-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataTables::GetNextString Method" title: "IMetaDataTables::GetNextString Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataTables.GetNextString" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataTables::GetNextString" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataTables::GetNextString method [.NET Framework metadata]" - "GetNextString method [.NET Framework metadata]" -ms.assetid: d9720428-c353-4f07-a7e8-899e106a1b37 -topic_type: +topic_type: - "apiref" --- # IMetaDataTables::GetNextString Method -Gets the index of the next string in the current table column. - -## Syntax - -```cpp +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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) diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnextuserstring-method.md index eadf88c2f7ccc..e3ce366838ab4 100644 --- a/docs/core/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" --- @@ -50,7 +49,7 @@ HRESULT GetNextUserString ( **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-getnumtables-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getnumtables-method.md index 442120bc2130f..60cc2a389e886 100644 --- a/docs/core/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](../../../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)] - +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/core/unmanaged-api/metadata/imetadatatables-getrow-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getrow-method.md index 5efee3c92d26b..2a3fdc1f50606 100644 --- a/docs/core/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" --- @@ -54,7 +53,7 @@ HRESULT GetRow ( **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 index f08f6ee90ac01..9152385b51be3 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getstring-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getstring-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataTables::GetString Method" title: "IMetaDataTables::GetString Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataTables.GetString" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataTables::GetString" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataTables::GetString method [.NET Framework metadata]" - "GetString method, IMetaDataTables interface [.NET Framework metadata]" -ms.assetid: 895c35cf-b95d-4e3b-93b5-cfc1cf9044fc -topic_type: +topic_type: - "apiref" --- # IMetaDataTables::GetString Method -Gets the string at the specified index from the table column in the current reference scope. - -## Syntax - -```cpp +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [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) diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md index ce6a28e6b19eb..62ae1472f017d 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-getstringheapsize-method.md @@ -2,48 +2,47 @@ description: "Learn more about: IMetaDataTables::GetStringHeapSize Method" title: "IMetaDataTables::GetStringHeapSize Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataTables.GetStringHeapSize" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataTables::GetStringHeapSize" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataTables::GetStringHeapSize method [.NET Framework metadata]" - "GetStringHeapSize method [.NET Framework metadata]" -ms.assetid: ed8f6335-81f5-4c09-81a9-2a909fc530c9 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-gettableindex-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-gettableindex-method.md index f53d202f94c1b..6468233060ff1 100644 --- a/docs/core/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" --- @@ -50,7 +49,7 @@ HRESULT GetTableIndex ( **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 index 4f4a27963fd96..a86e1c52e1a87 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables-gettableinfo-method.md @@ -2,68 +2,67 @@ description: "Learn more about: IMetaDataTables::GetTableInfo Method" title: "IMetaDataTables::GetTableInfo Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataTables.GetTableInfo" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataTables::GetTableInfo" -helpviewer_keywords: +helpviewer_keywords: - "IMetaDataTables::GetTableInfo method [.NET Framework metadata]" - "GetTableInfo method [.NET Framework metadata]" -ms.assetid: 50cbe557-2322-41aa-8e0d-f967602eaa0f -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadatatables-getuserstring-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getuserstring-method.md index 5980fec7aee68..d5d55f2771c6a 100644 --- a/docs/core/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" --- @@ -51,7 +50,7 @@ HRESULT GetUserString ( **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-getuserstringheapsize-method.md b/docs/core/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md index 92db01cd44741..00ad04f818cd9 100644 --- a/docs/core/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](../../../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)] - +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/core/unmanaged-api/metadata/imetadatatables-interface.md b/docs/core/unmanaged-api/metadata/imetadatatables-interface.md index 63464acf6e45e..ff4bdf2e559d0 100644 --- a/docs/core/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](../../../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)] - +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 index 6c543c98bd181..7bb15d889f5ed 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastorage-method.md @@ -2,52 +2,51 @@ description: "Learn more about: IMetaDataTables2::GetMetaDataStorage Method" title: "IMetaDataTables2::GetMetaDataStorage Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataTables2.GetMetaDataStorage" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataTables2::GetMetaDataStorage" -helpviewer_keywords: +helpviewer_keywords: - "GetMetaDataStorage method [.NET Framework metadata]" - "IMetaDataTables2::GetMetaDataStorage method [.NET Framework metadata]" -ms.assetid: 667a6d1e-753d-4ea2-8fd8-a8337d1bb9cd -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md b/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md index a527f37380a92..3f51e8d38e534 100644 --- a/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md +++ b/docs/core/unmanaged-api/metadata/imetadatatables2-getmetadatastreaminfo-method.md @@ -2,60 +2,59 @@ description: "Learn more about: IMetaDataTables2::GetMetaDataStreamInfo Method" title: "IMetaDataTables2::GetMetaDataStreamInfo Method" ms.date: "03/30/2017" -api_name: +api_name: - "IMetaDataTables2.GetMetaDataStreamInfo" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IMetaDataTables2::GetMetaDataStreamInfo" -helpviewer_keywords: +helpviewer_keywords: - "GetMetaDataStreamInfo method [.NET Framework metadata]" - "IMetaDataTables2::GetMetaDataStreamInfo method [.NET Framework metadata]" -ms.assetid: 8b280627-cc74-4789-95da-1fefc966de05 -topic_type: +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 Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +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) diff --git a/docs/core/unmanaged-api/metadata/imetadatatables2-interface.md b/docs/core/unmanaged-api/metadata/imetadatatables2-interface.md index 861302e685ddf..7c26a26f55813 100644 --- a/docs/core/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](../../../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)] - +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/core/unmanaged-api/metadata/imetadatavalidate-interface.md b/docs/core/unmanaged-api/metadata/imetadatavalidate-interface.md index 58c94701ec723..d4671c43691d2 100644 --- a/docs/core/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](../../../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)] - +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/core/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md b/docs/core/unmanaged-api/metadata/imetadatavalidate-validatemetadata-method.md index 5df8b6efeccb0..77a1b418f4ed0 100644 --- a/docs/core/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](../../../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)] - +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/core/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md b/docs/core/unmanaged-api/metadata/imetadatavalidate-validatorinit-method.md index 72b8103da5d17..9a570e24d36da 100644 --- a/docs/core/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](../../../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)] - +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 index feb9b5221e36c..5d3b6253c3cf2 100644 --- a/docs/core/unmanaged-api/metadata/index.md +++ b/docs/core/unmanaged-api/metadata/index.md @@ -2,31 +2,30 @@ description: "Learn more about unmanaged APIs for .NET metadata" title: ".NET metadata (unmanaged API reference)" ms.date: "09/19/2023" -helpviewer_keywords: +helpviewer_keywords: - "unmanaged API reference [.NET], metadata" - "native API reference [.NET], metadata" - "metadata [.NET], using the unmanaged API" -ms.assetid: 10cfea92-db5e-4bcb-b301-ef029bcf77a3 --- # .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 articles describe APIs that can be used with both .NET Framework and .NET. For .NET Framework-specific unmanaged APIs, see [.NET Framework metadata](../../../framework/unmanaged-api/metadata/index.md). - -## 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 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) + +## 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 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/core/unmanaged-api/metadata/metadata-enumerations.md b/docs/core/unmanaged-api/metadata/metadata-enumerations.md index dca6ba24eb7ee..fe4784bb9a075 100644 --- a/docs/core/unmanaged-api/metadata/metadata-enumerations.md +++ b/docs/core/unmanaged-api/metadata/metadata-enumerations.md @@ -2,162 +2,161 @@ description: "Learn more about: Metadata Enumerations" title: "Metadata Enumerations" ms.date: "03/30/2017" -helpviewer_keywords: +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) - +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/core/unmanaged-api/metadata/metadata-global-static-functions.md b/docs/core/unmanaged-api/metadata/metadata-global-static-functions.md index 10f704ae262ec..6f1e7aca4bd66 100644 --- a/docs/core/unmanaged-api/metadata/metadata-global-static-functions.md +++ b/docs/core/unmanaged-api/metadata/metadata-global-static-functions.md @@ -2,22 +2,21 @@ description: "Learn more about: Metadata Global Static Functions" title: "Metadata Global Static Functions" ms.date: "03/30/2017" -helpviewer_keywords: +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 +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 Interfaces](metadata-interfaces.md) - - [Metadata Enumerations](metadata-enumerations.md) - - [Metadata Structures](metadata-structures.md) - [Metadata Unions](metadata-unions.md) diff --git a/docs/core/unmanaged-api/metadata/metadata-interfaces.md b/docs/core/unmanaged-api/metadata/metadata-interfaces.md index bb386257141f1..994d97762b04d 100644 --- a/docs/core/unmanaged-api/metadata/metadata-interfaces.md +++ b/docs/core/unmanaged-api/metadata/metadata-interfaces.md @@ -2,78 +2,77 @@ 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) - +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) diff --git a/docs/core/unmanaged-api/metadata/metadata-structures.md b/docs/core/unmanaged-api/metadata/metadata-structures.md index 64e3c650f2a38..657ce90aab8b7 100644 --- a/docs/core/unmanaged-api/metadata/metadata-structures.md +++ b/docs/core/unmanaged-api/metadata/metadata-structures.md @@ -2,39 +2,38 @@ description: "Learn more about: Metadata Structures" title: "Metadata Structures" ms.date: "03/30/2017" -helpviewer_keywords: +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) - +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/core/unmanaged-api/metadata/metadata-unions.md b/docs/core/unmanaged-api/metadata/metadata-unions.md index 04f60f4b64d25..14695a1e17a8a 100644 --- a/docs/core/unmanaged-api/metadata/metadata-unions.md +++ b/docs/core/unmanaged-api/metadata/metadata-unions.md @@ -2,27 +2,26 @@ description: "Learn more about: Metadata Unions" title: "Metadata Unions" ms.date: "03/30/2017" -helpviewer_keywords: +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) - +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/core/unmanaged-api/metadata/osinfo-structure.md b/docs/core/unmanaged-api/metadata/osinfo-structure.md index dcbc1ec9701ab..736ce034aa7c5 100644 --- a/docs/core/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](../../../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)] - +} 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/metadata/toc.yml b/docs/core/unmanaged-api/metadata/toc.yml deleted file mode 100644 index 1acc1f731fb58..0000000000000 --- a/docs/core/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/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/core/unmanaged-api/toc.yml b/docs/core/unmanaged-api/toc.yml deleted file mode 100644 index 843bd09bf83a7..0000000000000 --- a/docs/core/unmanaged-api/toc.yml +++ /dev/null @@ -1,12 +0,0 @@ -items: - -- name: .NET unmanaged API reference - href: index.md -- name: Debugging - href: debugging/ -- name: Hosting - href: hosting/ -- name: Metadata - href: metadata/ -- name: Profiling - href: profiling/ diff --git a/docs/framework/app-domains/application-domains.md b/docs/framework/app-domains/application-domains.md index 9bd146b9669b0..a2c4c2d8a92ca 100644 --- a/docs/framework/app-domains/application-domains.md +++ b/docs/framework/app-domains/application-domains.md @@ -59,7 +59,7 @@ Operating systems and runtime environments typically provide some form of isolat - If an assembly is not loaded domain-neutral, it must be JIT-compiled in every application domain in which it is loaded. However, the assembly can be unloaded from the process by unloading all the application domains in which it is loaded. - The runtime host determines whether to load assemblies as domain-neutral when it loads the runtime into a process. For managed applications, apply the attribute to the entry-point method for the process, and specify a value from the associated enumeration. For unmanaged applications that host the common language runtime, specify the appropriate flag when you call the [CorBindToRuntimeEx Function](../unmanaged-api/hosting/corbindtoruntimeex-function.md) method. + The runtime host determines whether to load assemblies as domain-neutral when it loads the runtime into a process. For managed applications, apply the attribute to the entry-point method for the process, and specify a value from the associated enumeration. For unmanaged applications that host the common language runtime, specify the appropriate flag when you call the [CorBindToRuntimeEx Function](../../core/unmanaged-api/hosting/corbindtoruntimeex-function.md) method. There are three options for loading domain-neutral assemblies: diff --git a/docs/framework/deployment/how-to-debug-clr-activation-issues.md b/docs/framework/deployment/how-to-debug-clr-activation-issues.md index 0f3319ef34836..66f1fa7ee7d19 100644 --- a/docs/framework/deployment/how-to-debug-clr-activation-issues.md +++ b/docs/framework/deployment/how-to-debug-clr-activation-issues.md @@ -101,7 +101,7 @@ In the following example of an activation log, the most useful information is hi 532,205950.382,Installed Runtime: v4.0.30319. VERSION_ARCHITECTURE: 0 ``` -- **built with version** is the version of the CLR that was used to build the binary that was provided to a method such as [ICLRMetaHostPolicy::GetRequestedRuntime](../unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md). +- **built with version** is the version of the CLR that was used to build the binary that was provided to a method such as [ICLRMetaHostPolicy::GetRequestedRuntime](../../core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md). ```output 532,205950.382,C:\Tests\myapp.exe was built with version: v2.0.50727 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..e0c988d2444ef 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 @@ -52,15 +47,15 @@ To resolve the underlying issues and provide the best user experience (fewer err Displaying an error message to communicate that a requested .NET Framework version was not found can be viewed as either a helpful service or a minor annoyance to users. In either case, you can control this UI by passing flags to the activation APIs. -The [ICLRMetaHostPolicy::GetRequestedRuntime](../unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md) method accepts a [METAHOST_POLICY_FLAGS](../unmanaged-api/hosting/metahost-policy-flags-enumeration.md) enumeration member as input. You can include the METAHOST_POLICY_SHOW_ERROR_DIALOG flag to request an error message if the requested version of the CLR is not found. By default, the error message is not displayed. (The [ICLRMetaHost::GetRuntime](../unmanaged-api/hosting/iclrmetahost-getruntime-method.md) method does not accept this flag, and does not provide any other way to display the error message.) +The [ICLRMetaHostPolicy::GetRequestedRuntime](../../core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md) method accepts a [METAHOST_POLICY_FLAGS](../../core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md) enumeration member as input. You can include the METAHOST_POLICY_SHOW_ERROR_DIALOG flag to request an error message if the requested version of the CLR is not found. By default, the error message is not displayed. (The [ICLRMetaHost::GetRuntime](../../core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md) method does not accept this flag, and does not provide any other way to display the error message.) Windows provides a [SetErrorMode](/windows/win32/api/errhandlingapi/nf-errhandlingapi-seterrormode) function that you can use to declare whether you want error messages to be shown as a result of code that runs within your process. You can specify the SEM_FAILCRITICALERRORS flag to prevent the error message from being displayed. However, in some scenarios, it is important to override the SEM_FAILCRITICALERRORS setting set by an application process. For example, if you have a native COM component that hosts the CLR and that is hosted in a process where SEM_FAILCRITICALERRORS is set, you may want to override the flag, depending on the impact of displaying error messages within that particular application process. In this case, you can use one of the following flags to override SEM_FAILCRITICALERRORS: -- Use METAHOST_POLICY_IGNORE_ERROR_MODE with the [ICLRMetaHostPolicy::GetRequestedRuntime](../unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md) method. +- Use METAHOST_POLICY_IGNORE_ERROR_MODE with the [ICLRMetaHostPolicy::GetRequestedRuntime](../../core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md) method. -- Use RUNTIME_INFO_IGNORE_ERROR_MODE with the [GetRequestedRuntimeInfo](../unmanaged-api/hosting/getrequestedruntimeinfo-function.md) function. +- Use RUNTIME_INFO_IGNORE_ERROR_MODE with the [GetRequestedRuntimeInfo](../../core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md) function. ## UI policy for CLR-provided hosts 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..8930db9ed7d73 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](../../core/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/wcf/migrating-from-net-remoting-to-wcf.md b/docs/framework/wcf/migrating-from-net-remoting-to-wcf.md index e129a0ac1546b..237b6d785ab7b 100644 --- a/docs/framework/wcf/migrating-from-net-remoting-to-wcf.md +++ b/docs/framework/wcf/migrating-from-net-remoting-to-wcf.md @@ -6,14 +6,14 @@ ms.assetid: 16902a42-ef80-40e9-8c4c-90e61ddfdfe5 --- # Migrating from .NET Remoting to WCF -This article describes how to migrate an application that uses .NET Remoting to use Windows Communication Foundation (WCF). It compares similar concepts between these products and then describes how to accomplish several common Remoting scenarios in WCF. - - .NET Remoting is a legacy product that is supported only for backward compatibility. It is not secure across mixed-trust environments because it cannot maintain the separate trust levels between client and server. For example, you should never expose a .NET Remoting endpoint to the Internet or to untrusted clients. We recommend existing Remoting applications be migrated to newer and more secure technologies. If the application’s design uses only HTTP and is RESTful, we recommend ASP.NET Web API. For more information, see ASP.NET Web API. If the application is based on SOAP or requires non-Http protocols such as TCP, we recommend WCF. +This article describes how to migrate an application that uses .NET Remoting to use Windows Communication Foundation (WCF). It compares similar concepts between these products and then describes how to accomplish several common Remoting scenarios in WCF. -## Comparing .NET Remoting to WCF + .NET Remoting is a legacy product that is supported only for backward compatibility. It is not secure across mixed-trust environments because it cannot maintain the separate trust levels between client and server. For example, you should never expose a .NET Remoting endpoint to the Internet or to untrusted clients. We recommend existing Remoting applications be migrated to newer and more secure technologies. If the application’s design uses only HTTP and is RESTful, we recommend ASP.NET Web API. For more information, see ASP.NET Web API. If the application is based on SOAP or requires non-Http protocols such as TCP, we recommend WCF. + +## Comparing .NET Remoting to WCF + + This section compares the basic building blocks of .NET Remoting with their WCF equivalents. We will use these building blocks later to create some common client-server scenarios in WCF. The following chart summarizes the main similarities and differences between .NET Remoting and WCF. - This section compares the basic building blocks of .NET Remoting with their WCF equivalents. We will use these building blocks later to create some common client-server scenarios in WCF. The following chart summarizes the main similarities and differences between .NET Remoting and WCF. - | | .NET Remoting | WCF | |--------------------------|---------------------------------------------------------------------------------------|--------------------------------------------------------------------------------| | **Server type** | Subclass `MarshalByRefObject` | Mark with `[ServiceContract]` attribute | @@ -24,653 +24,653 @@ This article describes how to migrate an application that uses .NET Remoting to | **Client proxy objects** | Strongly typed transparent proxies are created automatically from MarshalByRefObjects | Strongly typed proxies are generated on-demand using ChannelFactory\ | | **Platform required** | Both client and server must use Microsoft OS and .NET | Cross-platform | | **Message format** | Private | Industry standards (for example, SOAP and WS-*) | - -### Server Implementation Comparison - -#### Creating a Server in .NET Remoting - .NET Remoting server types must derive from MarshalByRefObject and define methods the client can call, like the following: - +### Server Implementation Comparison + +#### Creating a Server in .NET Remoting + + .NET Remoting server types must derive from MarshalByRefObject and define methods the client can call, like the following: + ```csharp -public class RemotingServer : MarshalByRefObject -{ - public Customer GetCustomer(int customerId) { … } -} -``` - - The public methods of this server type become the public contract available to clients. There is no separation between the server's public interface and its implementation - one type handles both. - - Once the server type has been defined, it can be made available to clients, like in the following example: - +public class RemotingServer : MarshalByRefObject +{ + public Customer GetCustomer(int customerId) { … } +} +``` + + The public methods of this server type become the public contract available to clients. There is no separation between the server's public interface and its implementation - one type handles both. + + Once the server type has been defined, it can be made available to clients, like in the following example: + ```csharp -TcpChannel channel = new TcpChannel(8080); -ChannelServices.RegisterChannel(channel, ensureSecurity : true); -RemotingConfiguration.RegisterWellKnownServiceType( +TcpChannel channel = new TcpChannel(8080); +ChannelServices.RegisterChannel(channel, ensureSecurity : true); +RemotingConfiguration.RegisterWellKnownServiceType( typeof(RemotingServer), "RemotingServer", - WellKnownObjectMode.Singleton); -Console.WriteLine("RemotingServer is running. Press ENTER to terminate..."); -Console.ReadLine(); -``` - - There are many ways to make the Remoting type available as a server, including using configuration files. This is just one example. - -#### Creating a Server in WCF - - The equivalent step in WCF involves creating two types -- the public "service contract" and the concrete implementation. The first is declared as an interface marked with [ServiceContract]. Methods available to clients are marked with [OperationContract]: - + WellKnownObjectMode.Singleton); +Console.WriteLine("RemotingServer is running. Press ENTER to terminate..."); +Console.ReadLine(); +``` + + There are many ways to make the Remoting type available as a server, including using configuration files. This is just one example. + +#### Creating a Server in WCF + + The equivalent step in WCF involves creating two types -- the public "service contract" and the concrete implementation. The first is declared as an interface marked with [ServiceContract]. Methods available to clients are marked with [OperationContract]: + ```csharp -[ServiceContract] -public interface IWCFServer -{ - [OperationContract] - Customer GetCustomer(int customerId); -} -``` - - The server’s implementation is defined in a separate concrete class, like in the following example: - +[ServiceContract] +public interface IWCFServer +{ + [OperationContract] + Customer GetCustomer(int customerId); +} +``` + + The server’s implementation is defined in a separate concrete class, like in the following example: + ```csharp -public class WCFServer : IWCFServer -{ - public Customer GetCustomer(int customerId) { … } -} -``` - - Once these types have been defined, the WCF server can be made available to clients, like in the following example: - +public class WCFServer : IWCFServer +{ + public Customer GetCustomer(int customerId) { … } +} +``` + + Once these types have been defined, the WCF server can be made available to clients, like in the following example: + ```csharp -NetTcpBinding binding = new NetTcpBinding(); -Uri baseAddress = new Uri("net.tcp://localhost:8000/wcfserver"); - -using (ServiceHost serviceHost = new ServiceHost(typeof(WCFServer), baseAddress)) -{ - serviceHost.AddServiceEndpoint(typeof(IWCFServer), binding, baseAddress); - serviceHost.Open(); - +NetTcpBinding binding = new NetTcpBinding(); +Uri baseAddress = new Uri("net.tcp://localhost:8000/wcfserver"); + +using (ServiceHost serviceHost = new ServiceHost(typeof(WCFServer), baseAddress)) +{ + serviceHost.AddServiceEndpoint(typeof(IWCFServer), binding, baseAddress); + serviceHost.Open(); + Console.WriteLine($"The WCF server is ready at {baseAddress}."); - Console.WriteLine("Press to terminate service..."); - Console.WriteLine(); - Console.ReadLine(); -} -``` - + Console.WriteLine("Press to terminate service..."); + Console.WriteLine(); + Console.ReadLine(); +} +``` + > [!NOTE] -> TCP is used in both examples to keep them as similar as possible. Refer to the scenario walk-throughs later in this topic for examples using HTTP. - - There are many ways to configure and to host WCF services. This is just one example, known as "self-hosted". For more information, see the following topics: - -- [How to: Define a Service Contract](how-to-define-a-wcf-service-contract.md) - -- [Configuring Services Using Configuration Files](configuring-services-using-configuration-files.md) - -- [Hosting Services](hosting-services.md) - -### Client Implementation Comparison - -#### Creating a Client in .NET Remoting - - Once a .NET Remoting server object has been made available, it can be consumed by clients, like in the following example: - +> TCP is used in both examples to keep them as similar as possible. Refer to the scenario walk-throughs later in this topic for examples using HTTP. + + There are many ways to configure and to host WCF services. This is just one example, known as "self-hosted". For more information, see the following topics: + +- [How to: Define a Service Contract](how-to-define-a-wcf-service-contract.md) + +- [Configuring Services Using Configuration Files](configuring-services-using-configuration-files.md) + +- [Hosting Services](hosting-services.md) + +### Client Implementation Comparison + +#### Creating a Client in .NET Remoting + + Once a .NET Remoting server object has been made available, it can be consumed by clients, like in the following example: + ```csharp -TcpChannel channel = new TcpChannel(); -ChannelServices.RegisterChannel(channel, ensureSecurity : true); -RemotingServer server = (RemotingServer)Activator.GetObject( +TcpChannel channel = new TcpChannel(); +ChannelServices.RegisterChannel(channel, ensureSecurity : true); +RemotingServer server = (RemotingServer)Activator.GetObject( typeof(RemotingServer), - "tcp://localhost:8080/RemotingServer"); - -RemotingCustomer customer = server.GetCustomer(42); + "tcp://localhost:8080/RemotingServer"); + +RemotingCustomer customer = server.GetCustomer(42); Console.WriteLine($"Customer {customer.FirstName} {customer.LastName} received."); -``` - - The RemotingServer instance returned from Activator.GetObject() is known as a "transparent proxy." It implements the public API for the RemotingServer type on the client, but all the methods call the server object running in a different process or machine. - -#### Creating a Client in WCF - - The equivalent step in WCF involves using a channel factory to create the proxy explicitly. Like Remoting, the proxy object can be used to invoke operations on the server, like in the following example: - +``` + + The RemotingServer instance returned from Activator.GetObject() is known as a "transparent proxy." It implements the public API for the RemotingServer type on the client, but all the methods call the server object running in a different process or machine. + +#### Creating a Client in WCF + + The equivalent step in WCF involves using a channel factory to create the proxy explicitly. Like Remoting, the proxy object can be used to invoke operations on the server, like in the following example: + ```csharp -NetTcpBinding binding = new NetTcpBinding(); -String url = "net.tcp://localhost:8000/wcfserver"; -EndpointAddress address = new EndpointAddress(url); +NetTcpBinding binding = new NetTcpBinding(); +String url = "net.tcp://localhost:8000/wcfserver"; +EndpointAddress address = new EndpointAddress(url); ChannelFactory channelFactory = - new ChannelFactory(binding, address); -IWCFServer server = channelFactory.CreateChannel(); - -Customer customer = server.GetCustomer(42); + new ChannelFactory(binding, address); +IWCFServer server = channelFactory.CreateChannel(); + +Customer customer = server.GetCustomer(42); Console.WriteLine($" Customer {customer.FirstName} {customer.LastName} received."); -``` - - This example shows programming at the channel level because it is most similar to the Remoting example. Also available is the **Add Service Reference** approach in Visual Studio that generates code to simplify client programming. For more information, see the following topics: - -- [Client Channel-Level Programming](./extending/client-channel-level-programming.md) - -- [How to: Add, Update, or Remove a Service Reference](/visualstudio/data-tools/how-to-add-update-or-remove-a-wcf-data-service-reference) - -### Serialization Usage - - Both .NET Remoting and WCF use serialization to send objects between client and server, but they differ in these important ways: - -1. They use different serializers and conventions to indicate what to serialize. - -2. .NET Remoting supports "by reference" serialization that allows method or property access on one tier to execute code on the other tier, which is across security boundaries. This capability exposes security vulnerabilities and is one of the main reasons why Remoting endpoints should never be exposed to untrusted clients. - -3. Serialization used by Remoting is opt-out (explicitly exclude what not to serialize) and WCF serialization is opt-in (explicitly mark which members to serialize). - -#### Serialization in .NET Remoting - - .NET Remoting supports two ways to serialize and deserialize objects between the client and server: - -- *By value* – the values of the object are serialized across tier boundaries, and a new instance of that object is created on the other tier. Any calls to methods or properties of that new instance execute only locally and do not affect the original object or tier. - -- *By reference* – a special "object reference" is serialized across tier boundaries. When one tier interacts with methods or properties of that object, it communicates back to the original object on the original tier. By-reference objects can flow in either direction – server to client, or client to server. - - By-value types in Remoting are marked with the [Serializable] attribute or implement ISerializable, like in the following example: - +``` + + This example shows programming at the channel level because it is most similar to the Remoting example. Also available is the **Add Service Reference** approach in Visual Studio that generates code to simplify client programming. For more information, see the following topics: + +- [Client Channel-Level Programming](./extending/client-channel-level-programming.md) + +- [How to: Add, Update, or Remove a Service Reference](/visualstudio/data-tools/how-to-add-update-or-remove-a-wcf-data-service-reference) + +### Serialization Usage + + Both .NET Remoting and WCF use serialization to send objects between client and server, but they differ in these important ways: + +1. They use different serializers and conventions to indicate what to serialize. + +2. .NET Remoting supports "by reference" serialization that allows method or property access on one tier to execute code on the other tier, which is across security boundaries. This capability exposes security vulnerabilities and is one of the main reasons why Remoting endpoints should never be exposed to untrusted clients. + +3. Serialization used by Remoting is opt-out (explicitly exclude what not to serialize) and WCF serialization is opt-in (explicitly mark which members to serialize). + +#### Serialization in .NET Remoting + + .NET Remoting supports two ways to serialize and deserialize objects between the client and server: + +- *By value* – the values of the object are serialized across tier boundaries, and a new instance of that object is created on the other tier. Any calls to methods or properties of that new instance execute only locally and do not affect the original object or tier. + +- *By reference* – a special "object reference" is serialized across tier boundaries. When one tier interacts with methods or properties of that object, it communicates back to the original object on the original tier. By-reference objects can flow in either direction – server to client, or client to server. + + By-value types in Remoting are marked with the [Serializable] attribute or implement ISerializable, like in the following example: + ```csharp -[Serializable] -public class RemotingCustomer -{ - public string FirstName { get; set; } - public string LastName { get; set; } - public int CustomerId { get; set; } -} -``` - - By-reference types derive from the MarshalByRefObject class, like in the following example: - +[Serializable] +public class RemotingCustomer +{ + public string FirstName { get; set; } + public string LastName { get; set; } + public int CustomerId { get; set; } +} +``` + + By-reference types derive from the MarshalByRefObject class, like in the following example: + ```csharp -public class RemotingCustomerReference : MarshalByRefObject -{ - public string FirstName { get; set; } - public string LastName { get; set; } - public int CustomerId { get; set; } -} -``` - - It is extremely important to understand the implications of Remoting’s by-reference objects. If either tier (client or server) sends a by-reference object to the other tier, all method calls execute back on the tier owning the object. For example, a client calling methods on a by-reference object returned by the server will execute code on the server. Similarly, a server calling methods on a by-reference object provided by the client will execute code back on the client. For this reason, the use of .NET Remoting is recommended only within fully-trusted environments. Exposing a public .NET Remoting endpoint to untrusted clients will make a Remoting server vulnerable to attack. - -#### Serialization in WCF - - WCF supports only by-value serialization. The most common way to define a type to exchange between client and server is like in the following example: - +public class RemotingCustomerReference : MarshalByRefObject +{ + public string FirstName { get; set; } + public string LastName { get; set; } + public int CustomerId { get; set; } +} +``` + + It is extremely important to understand the implications of Remoting’s by-reference objects. If either tier (client or server) sends a by-reference object to the other tier, all method calls execute back on the tier owning the object. For example, a client calling methods on a by-reference object returned by the server will execute code on the server. Similarly, a server calling methods on a by-reference object provided by the client will execute code back on the client. For this reason, the use of .NET Remoting is recommended only within fully-trusted environments. Exposing a public .NET Remoting endpoint to untrusted clients will make a Remoting server vulnerable to attack. + +#### Serialization in WCF + + WCF supports only by-value serialization. The most common way to define a type to exchange between client and server is like in the following example: + ```csharp -[DataContract] -public class WCFCustomer -{ - [DataMember] - public string FirstName { get; set; } - - [DataMember] - public string LastName { get; set; } - - [DataMember] - public int CustomerId { get; set; } -} -``` - - The [DataContract] attribute identifies this type as one that can be serialized and deserialized between client and server. The [DataMember] attribute identifies the individual properties or fields to serialize. - - When WCF sends an object across tiers, it serializes only the values and creates a new instance of the object on the other tier. Any interactions with the values of the object occur only locally – they do not communicate with the other tier the way .NET Remoting by-reference objects do. For more information, see [Serialization and Deserialization](./feature-details/serialization-and-deserialization.md). - -### Exception Handling Capabilities - -#### Exceptions in .NET Remoting - - Exceptions thrown by a Remoting server are serialized, sent to the client, and thrown locally on the client like any other exception. Custom exceptions can be created by sub-classing the Exception type and marking it with [Serializable]. Most framework exceptions are already marked in this way, allowing most to be thrown by the server, serialized, and re-thrown on the client. Though this design is convenient during development, server-side information can inadvertently be disclosed to the client. This is one of many reasons Remoting should be used only in fully-trusted environments. - -#### Exceptions and Faults in WCF - - WCF does not allow arbitrary exception types to be returned from the server to the client because it could lead to inadvertent information disclosure. If a service operation throws an unexpected exception, it causes a general purpose FaultException to be thrown on the client. This exception does not carry any information why or where the problem occurred, and for some applications this is sufficient. Applications that need to communicate richer error information to the client do this by defining a fault contract. - - To do this, first create a [DataContract] type to carry the fault information. - +[DataContract] +public class WCFCustomer +{ + [DataMember] + public string FirstName { get; set; } + + [DataMember] + public string LastName { get; set; } + + [DataMember] + public int CustomerId { get; set; } +} +``` + + The [DataContract] attribute identifies this type as one that can be serialized and deserialized between client and server. The [DataMember] attribute identifies the individual properties or fields to serialize. + + When WCF sends an object across tiers, it serializes only the values and creates a new instance of the object on the other tier. Any interactions with the values of the object occur only locally – they do not communicate with the other tier the way .NET Remoting by-reference objects do. For more information, see [Serialization and Deserialization](./feature-details/serialization-and-deserialization.md). + +### Exception Handling Capabilities + +#### Exceptions in .NET Remoting + + Exceptions thrown by a Remoting server are serialized, sent to the client, and thrown locally on the client like any other exception. Custom exceptions can be created by sub-classing the Exception type and marking it with [Serializable]. Most framework exceptions are already marked in this way, allowing most to be thrown by the server, serialized, and re-thrown on the client. Though this design is convenient during development, server-side information can inadvertently be disclosed to the client. This is one of many reasons Remoting should be used only in fully-trusted environments. + +#### Exceptions and Faults in WCF + + WCF does not allow arbitrary exception types to be returned from the server to the client because it could lead to inadvertent information disclosure. If a service operation throws an unexpected exception, it causes a general purpose FaultException to be thrown on the client. This exception does not carry any information why or where the problem occurred, and for some applications this is sufficient. Applications that need to communicate richer error information to the client do this by defining a fault contract. + + To do this, first create a [DataContract] type to carry the fault information. + ```csharp -[DataContract] -public class CustomerServiceFault -{ - [DataMember] - public string ErrorMessage { get; set; } - - [DataMember] - public int CustomerId {get;set;} -} -``` - - Specify the fault contract to use for each service operation. - +[DataContract] +public class CustomerServiceFault +{ + [DataMember] + public string ErrorMessage { get; set; } + + [DataMember] + public int CustomerId {get;set;} +} +``` + + Specify the fault contract to use for each service operation. + ```csharp -[ServiceContract] -public interface IWCFServer -{ - [OperationContract] - [FaultContract(typeof(CustomerServiceFault))] - Customer GetCustomer(int customerId); -} -``` - - The server reports error conditions by throwing a FaultException. - +[ServiceContract] +public interface IWCFServer +{ + [OperationContract] + [FaultContract(typeof(CustomerServiceFault))] + Customer GetCustomer(int customerId); +} +``` + + The server reports error conditions by throwing a FaultException. + ```csharp -throw new FaultException( +throw new FaultException( new CustomerServiceFault() { CustomerId = customerId, ErrorMessage = "Illegal customer Id" - }); -``` - - And whenever the client makes a request to the server, it can catch faults as normal exceptions. - + }); +``` + + And whenever the client makes a request to the server, it can catch faults as normal exceptions. + ```csharp -try -{ - Customer customer = server.GetCustomer(-1); -} -catch (FaultException fault) -{ +try +{ + Customer customer = server.GetCustomer(-1); +} +catch (FaultException fault) +{ Console.WriteLine($"Fault received: {fault.Detail.ErrorMessage}"); -} -``` - - For more information about fault contracts, see . - -### Security Considerations - -#### Security in .NET Remoting - - Some .NET Remoting channels support security features such as authentication and encryption at the channel layer (IPC and TCP). The HTTP channel relies on Internet Information Services (IIS) for both authentication and encryption. Despite this support, you should consider .NET Remoting an unsecure communication protocol and use it only within fully-trusted environments. Never expose a public Remoting endpoint to the Internet or untrusted clients. - -#### Security in WCF - - WCF was designed with security in mind, in part to address the kinds of vulnerabilities found in .NET Remoting. WCF offers security at both the transport and message level, and offers many options for authentication, authorization, encryption, and so on. For more information, see the following topics: - -- [Security](./feature-details/security.md) - -- [WCF Security Guidance](./feature-details/security-guidance-and-best-practices.md) - -## Migrating to WCF - -### Why Migrate from Remoting to WCF? - -- **.NET Remoting is a legacy product.** As described in [.NET Remoting](/previous-versions/dotnet/netframework-4.0/72x4h507(v=vs.100)), it is considered a legacy product and is not recommended for new development. WCF or ASP.NET Web API are recommended for new and existing applications. - +} +``` + + For more information about fault contracts, see . + +### Security Considerations + +#### Security in .NET Remoting + + Some .NET Remoting channels support security features such as authentication and encryption at the channel layer (IPC and TCP). The HTTP channel relies on Internet Information Services (IIS) for both authentication and encryption. Despite this support, you should consider .NET Remoting an unsecure communication protocol and use it only within fully-trusted environments. Never expose a public Remoting endpoint to the Internet or untrusted clients. + +#### Security in WCF + + WCF was designed with security in mind, in part to address the kinds of vulnerabilities found in .NET Remoting. WCF offers security at both the transport and message level, and offers many options for authentication, authorization, encryption, and so on. For more information, see the following topics: + +- [Security](./feature-details/security.md) + +- [WCF Security Guidance](./feature-details/security-guidance-and-best-practices.md) + +## Migrating to WCF + +### Why Migrate from Remoting to WCF? + +- **.NET Remoting is a legacy product.** As described in [.NET Remoting](/previous-versions/dotnet/netframework-4.0/72x4h507(v=vs.100)), it is considered a legacy product and is not recommended for new development. WCF or ASP.NET Web API are recommended for new and existing applications. + - **WCF uses cross-platform standards.** WCF was designed with cross-platform interoperability in mind and supports many industry standards (SOAP, WS-Security, WS-Trust, etc.). A WCF service can interoperate with clients running on operating systems other than Windows. Remoting was designed primarily for environments where both the server and client applications run using .NET Framework on a Windows operating system. - -- **WCF has built-in security.** WCF was designed with security in mind and offers many options for authentication, transport level security, message level security, etc. Remoting was designed to make it easy for applications to interoperate but was not designed to be secure in non-trusted environments. WCF was designed to work in both trusted and non-trusted environments. - -### Migration Recommendations - - The following are the recommended steps to migrate from .NET Remoting to WCF: - -- **Create the service contract.** Define your service interface types, and mark them with the [ServiceContract] attribute.Mark all the methods the clients will be allowed to call with [OperationContract]. - -- **Create the data contract.** Define the data types that will be exchanged between server and client, and mark them with the [DataContract] attribute. Mark all the fields and properties the client will be allowed to use with [DataMember]. - -- **Create the fault contract (optional).** Create the types that will be exchanged between server and client when errors are encountered. Mark these types with [DataContract] and [DataMember] to make them serializable. For all service operations you marked with [OperationContract], also mark them with [FaultContract] to indicate which errors they may return. - -- **Configure and host the service.** Once the service contract has been created, the next step is to configure a binding to expose the service at an endpoint. For more information, see [Endpoints: Addresses, Bindings, and Contracts](./feature-details/endpoints-addresses-bindings-and-contracts.md). - - Once a Remoting application has been migrated to WCF, it is still important to remove dependencies on .NET Remoting. This ensures that any Remoting vulnerabilities are removed from the application. These steps include the following: - -- **Discontinue use of MarshalByRefObject.** The MarshalByRefObject type exists only for Remoting and is not used by WCF. Any application types that sub-class MarshalByRefObject should be removed or changed. - -- **Discontinue use of [Serializable] and ISerializable.** The [Serializable] attribute and ISerializable interface were originally designed to serialize types within trusted environments, and they are used by Remoting. WCF serialization relies on types being marked with [DataContract] and [DataMember]. Data types used by an application should be modified to use [DataContract] and not to use ISerializable or [Serializable]. - -### Migration Scenarios - - Now let’s see how to accomplish the following common Remoting scenarios in WCF: - -1. Server returns an object by-value to the client - -2. Server returns an object by-reference to the client - -3. Client sends an object by-value to the server - + +- **WCF has built-in security.** WCF was designed with security in mind and offers many options for authentication, transport level security, message level security, etc. Remoting was designed to make it easy for applications to interoperate but was not designed to be secure in non-trusted environments. WCF was designed to work in both trusted and non-trusted environments. + +### Migration Recommendations + + The following are the recommended steps to migrate from .NET Remoting to WCF: + +- **Create the service contract.** Define your service interface types, and mark them with the [ServiceContract] attribute.Mark all the methods the clients will be allowed to call with [OperationContract]. + +- **Create the data contract.** Define the data types that will be exchanged between server and client, and mark them with the [DataContract] attribute. Mark all the fields and properties the client will be allowed to use with [DataMember]. + +- **Create the fault contract (optional).** Create the types that will be exchanged between server and client when errors are encountered. Mark these types with [DataContract] and [DataMember] to make them serializable. For all service operations you marked with [OperationContract], also mark them with [FaultContract] to indicate which errors they may return. + +- **Configure and host the service.** Once the service contract has been created, the next step is to configure a binding to expose the service at an endpoint. For more information, see [Endpoints: Addresses, Bindings, and Contracts](./feature-details/endpoints-addresses-bindings-and-contracts.md). + + Once a Remoting application has been migrated to WCF, it is still important to remove dependencies on .NET Remoting. This ensures that any Remoting vulnerabilities are removed from the application. These steps include the following: + +- **Discontinue use of MarshalByRefObject.** The MarshalByRefObject type exists only for Remoting and is not used by WCF. Any application types that sub-class MarshalByRefObject should be removed or changed. + +- **Discontinue use of [Serializable] and ISerializable.** The [Serializable] attribute and ISerializable interface were originally designed to serialize types within trusted environments, and they are used by Remoting. WCF serialization relies on types being marked with [DataContract] and [DataMember]. Data types used by an application should be modified to use [DataContract] and not to use ISerializable or [Serializable]. + +### Migration Scenarios + + Now let’s see how to accomplish the following common Remoting scenarios in WCF: + +1. Server returns an object by-value to the client + +2. Server returns an object by-reference to the client + +3. Client sends an object by-value to the server + > [!NOTE] -> Sending an object by-reference from the client to the server is not allowed in WCF. - - When reading through these scenarios, assume our baseline interfaces for .NET Remoting look like the following example. The .NET Remoting implementation is not important here because we want to illustrate only how to use WCF to implement equivalent functionality. - +> Sending an object by-reference from the client to the server is not allowed in WCF. + + When reading through these scenarios, assume our baseline interfaces for .NET Remoting look like the following example. The .NET Remoting implementation is not important here because we want to illustrate only how to use WCF to implement equivalent functionality. + ```csharp -public class RemotingServer : MarshalByRefObject -{ - // Demonstrates server returning object by-value - public Customer GetCustomer(int customerId) {…} - - // Demonstrates server returning object by-reference - public CustomerReference GetCustomerReference(int customerId) {…} - - // Demonstrates client passing object to server by-value - public bool UpdateCustomer(Customer customer) {…} -} -``` - -#### Scenario 1: Service Returns an Object by Value - - This scenario demonstrates a server returning an object to the client by value. WCF always returns objects from the server by value, so the following steps simply describe how to build a normal WCF service. - -1. Start by defining a public interface for the WCF service and mark it with the [ServiceContract] attribute. We use [OperationContract] to identify the server-side methods our client will call. - +public class RemotingServer : MarshalByRefObject +{ + // Demonstrates server returning object by-value + public Customer GetCustomer(int customerId) {…} + + // Demonstrates server returning object by-reference + public CustomerReference GetCustomerReference(int customerId) {…} + + // Demonstrates client passing object to server by-value + public bool UpdateCustomer(Customer customer) {…} +} +``` + +#### Scenario 1: Service Returns an Object by Value + + This scenario demonstrates a server returning an object to the client by value. WCF always returns objects from the server by value, so the following steps simply describe how to build a normal WCF service. + +1. Start by defining a public interface for the WCF service and mark it with the [ServiceContract] attribute. We use [OperationContract] to identify the server-side methods our client will call. + ```csharp - [ServiceContract] - public interface ICustomerService - { - [OperationContract] - Customer GetCustomer(int customerId); - - [OperationContract] - bool UpdateCustomer(Customer customer); - } - ``` - -2. The next step is to create the data contract for this service. We do this by creating classes (not interfaces) marked with the [DataContract] attribute. The individual properties or fields we want visible to both client and server are marked with [DataMember]. If we want derived types to be allowed, we must use the [KnownType] attribute to identify them. The only types WCF will allow to be serialized or deserialized for this service are those in the service interface and these "known types". Attempting to exchange any other type not in this list will be rejected. - + [ServiceContract] + public interface ICustomerService + { + [OperationContract] + Customer GetCustomer(int customerId); + + [OperationContract] + bool UpdateCustomer(Customer customer); + } + ``` + +2. The next step is to create the data contract for this service. We do this by creating classes (not interfaces) marked with the [DataContract] attribute. The individual properties or fields we want visible to both client and server are marked with [DataMember]. If we want derived types to be allowed, we must use the [KnownType] attribute to identify them. The only types WCF will allow to be serialized or deserialized for this service are those in the service interface and these "known types". Attempting to exchange any other type not in this list will be rejected. + ```csharp - [DataContract] - [KnownType(typeof(PremiumCustomer))] - public class Customer - { - [DataMember] - public string FirstName { get; set; } - - [DataMember] - public string LastName { get; set; } - - [DataMember] - public int CustomerId { get; set; } - } - - [DataContract] + [DataContract] + [KnownType(typeof(PremiumCustomer))] + public class Customer + { + [DataMember] + public string FirstName { get; set; } + + [DataMember] + public string LastName { get; set; } + + [DataMember] + public int CustomerId { get; set; } + } + + [DataContract] public class PremiumCustomer : Customer - { - [DataMember] - public int AccountId { get; set; } - } - ``` - -3. Next, we provide the implementation for the service interface. - - ```csharp - public class CustomerService : ICustomerService - { - public Customer GetCustomer(int customerId) - { - // read from database - } - - public bool UpdateCustomer(Customer customer) - { - // write to database - } - } - ``` - -4. To run the WCF service, we need to declare an endpoint that exposes that service interface at a specific URL using a specific WCF binding. This is typically done by adding the following sections to the server project’s web.config file. - - ```xml - - - - - - - - - - ``` - -5. The WCF service can then be started with the following code: - + { + [DataMember] + public int AccountId { get; set; } + } + ``` + +3. Next, we provide the implementation for the service interface. + + ```csharp + public class CustomerService : ICustomerService + { + public Customer GetCustomer(int customerId) + { + // read from database + } + + public bool UpdateCustomer(Customer customer) + { + // write to database + } + } + ``` + +4. To run the WCF service, we need to declare an endpoint that exposes that service interface at a specific URL using a specific WCF binding. This is typically done by adding the following sections to the server project’s web.config file. + + ```xml + + + + + + + + + + ``` + +5. The WCF service can then be started with the following code: + ```csharp - ServiceHost customerServiceHost = new ServiceHost(typeof(CustomerService)); - customerServiceHost.Open(); - ``` - - When this ServiceHost is started, it uses the web.config file to establish the proper contract, binding and endpoint. For more information about configuration files, see [Configuring Services Using Configuration Files](./configuring-services-using-configuration-files.md). This style of starting the server is known as self-hosting. To learn more about other choices for hosting WCF services, see [Hosting Services](./hosting-services.md). - -6. The client project’s app.config must declare matching binding information for the service’s endpoint. The easiest way to do this in Visual Studio is to use **Add Service Reference**, which will automatically update the app.config file. Alternatively, these same changes can be added manually. - - ```xml - - - - - - - - ``` - - For more information about using **Add Service Reference**, see [How to: Add, Update, or Remove a Service Reference](/visualstudio/data-tools/how-to-add-update-or-remove-a-wcf-data-service-reference). - -7. Now we can call the WCF service from the client. We do this by creating a channel factory for that service, asking it for a channel, and directly calling the method we want on that channel. We can do this because the channel implements the service’s interface and handles the underlying request/reply logic for us. The return value from that method call is the deserialized copy of the server’s response. - + ServiceHost customerServiceHost = new ServiceHost(typeof(CustomerService)); + customerServiceHost.Open(); + ``` + + When this ServiceHost is started, it uses the web.config file to establish the proper contract, binding and endpoint. For more information about configuration files, see [Configuring Services Using Configuration Files](./configuring-services-using-configuration-files.md). This style of starting the server is known as self-hosting. To learn more about other choices for hosting WCF services, see [Hosting Services](../../core/unmanaged-api/hosting-services.md). + +6. The client project’s app.config must declare matching binding information for the service’s endpoint. The easiest way to do this in Visual Studio is to use **Add Service Reference**, which will automatically update the app.config file. Alternatively, these same changes can be added manually. + + ```xml + + + + + + + + ``` + + For more information about using **Add Service Reference**, see [How to: Add, Update, or Remove a Service Reference](/visualstudio/data-tools/how-to-add-update-or-remove-a-wcf-data-service-reference). + +7. Now we can call the WCF service from the client. We do this by creating a channel factory for that service, asking it for a channel, and directly calling the method we want on that channel. We can do this because the channel implements the service’s interface and handles the underlying request/reply logic for us. The return value from that method call is the deserialized copy of the server’s response. + ```csharp - ChannelFactory factory = - new ChannelFactory("customerservice"); - ICustomerService service = factory.CreateChannel(); - Customer customer = service.GetCustomer(42); + ChannelFactory factory = + new ChannelFactory("customerservice"); + ICustomerService service = factory.CreateChannel(); + Customer customer = service.GetCustomer(42); Console.WriteLine($" Customer {customer.FirstName} {customer.LastName} received."); - ``` - - Objects returned by WCF from the server to the client are always by value. The objects are deserialized copies of the data sent by the server. The client can call methods on these local copies without any danger of invoking server code through callbacks. - -#### Scenario 2: Server Returns an Object By Reference - - This scenario demonstrates the server providing an object to the client by reference. In .NET Remoting, this is handled automatically for any type derived from MarshalByRefObject, which is serialized by-reference. An example of this scenario is allowing multiple clients to have independent sessionful server-side objects. As previously mentioned, objects returned by a WCF service are always by value, so there is no direct equivalent of a by-reference object, but it is possible to achieve something similar to by-reference semantics using an object. This is a serializable by-value object that can be used by the client to obtain a sessionful by-reference object on the server. This enables the scenario of having multiple clients with independent sessionful server-side objects. - -1. First, we need to define a WCF service contract that corresponds to the sessionful object itself. - + ``` + + Objects returned by WCF from the server to the client are always by value. The objects are deserialized copies of the data sent by the server. The client can call methods on these local copies without any danger of invoking server code through callbacks. + +#### Scenario 2: Server Returns an Object By Reference + + This scenario demonstrates the server providing an object to the client by reference. In .NET Remoting, this is handled automatically for any type derived from MarshalByRefObject, which is serialized by-reference. An example of this scenario is allowing multiple clients to have independent sessionful server-side objects. As previously mentioned, objects returned by a WCF service are always by value, so there is no direct equivalent of a by-reference object, but it is possible to achieve something similar to by-reference semantics using an object. This is a serializable by-value object that can be used by the client to obtain a sessionful by-reference object on the server. This enables the scenario of having multiple clients with independent sessionful server-side objects. + +1. First, we need to define a WCF service contract that corresponds to the sessionful object itself. + ```csharp - [ServiceContract(SessionMode = SessionMode.Allowed)] - public interface ISessionBoundObject - { - [OperationContract] - string GetCurrentValue(); - - [OperationContract] - void SetCurrentValue(string value); - } - ``` - + [ServiceContract(SessionMode = SessionMode.Allowed)] + public interface ISessionBoundObject + { + [OperationContract] + string GetCurrentValue(); + + [OperationContract] + void SetCurrentValue(string value); + } + ``` + > [!TIP] - > Notice that the sessionful object is marked with [ServiceContract], making it a normal WCF service interface. Setting the SessionMode property indicates it will be a sessionful service. In WCF, a session is a way of correlating multiple messages sent between two endpoints. This means that once a client obtains a connection to this service, a session will be established between the client and the server. The client will use a single unique instance of the server-side object for all its interactions within this single session. - -2. Next, we need to provide the implementation of this service interface. By denoting it with [ServiceBehavior] and setting the InstanceContextMode, we tell WCF we want to use a unique instance of this type for an each session. - + > Notice that the sessionful object is marked with [ServiceContract], making it a normal WCF service interface. Setting the SessionMode property indicates it will be a sessionful service. In WCF, a session is a way of correlating multiple messages sent between two endpoints. This means that once a client obtains a connection to this service, a session will be established between the client and the server. The client will use a single unique instance of the server-side object for all its interactions within this single session. + +2. Next, we need to provide the implementation of this service interface. By denoting it with [ServiceBehavior] and setting the InstanceContextMode, we tell WCF we want to use a unique instance of this type for an each session. + ```csharp - [ServiceBehavior(InstanceContextMode = InstanceContextMode.PerSession)] - public class MySessionBoundObject : ISessionBoundObject - { - private string _value; - - public string GetCurrentValue() - { - return _value; - } - - public void SetCurrentValue(string val) - { - _value = val; - } - - } - ``` - -3. Now we need a way to obtain an instance of this sessionful object. We do this by creating another WCF service interface that returns an EndpointAddress10 object. This is a serializable form of an endpoint that the client can use to create the sessionful object. - + [ServiceBehavior(InstanceContextMode = InstanceContextMode.PerSession)] + public class MySessionBoundObject : ISessionBoundObject + { + private string _value; + + public string GetCurrentValue() + { + return _value; + } + + public void SetCurrentValue(string val) + { + _value = val; + } + + } + ``` + +3. Now we need a way to obtain an instance of this sessionful object. We do this by creating another WCF service interface that returns an EndpointAddress10 object. This is a serializable form of an endpoint that the client can use to create the sessionful object. + ```csharp - [ServiceContract] - public interface ISessionBoundFactory - { - [OperationContract] - EndpointAddress10 GetInstanceAddress(); - } - ``` - - And we implement this WCF service: - + [ServiceContract] + public interface ISessionBoundFactory + { + [OperationContract] + EndpointAddress10 GetInstanceAddress(); + } + ``` + + And we implement this WCF service: + ```csharp - public class SessionBoundFactory : ISessionBoundFactory - { + public class SessionBoundFactory : ISessionBoundFactory + { public static ChannelFactory _factory = - new ChannelFactory("sessionbound"); - - public SessionBoundFactory() - { - } - - public EndpointAddress10 GetInstanceAddress() - { - IClientChannel channel = (IClientChannel)_factory.CreateChannel(); - return EndpointAddress10.FromEndpointAddress(channel.RemoteAddress); - } - } - ``` - - This implementation maintains a singleton channel factory to create sessionful objects. When GetInstanceAddress() is called, it creates a channel and creates an EndpointAddress10 object that effectively points to the remote address associated with this channel. EndpointAddress10 is simply a data type that can be returned to the client by-value. - -4. We need to modify the server’s configuration file by doing the following two things as shown in the example below: - - 1. Declare a \ section that describes the endpoint for the sessionful object. This is necessary because the server also acts as a client in this situation. - - 2. Declare endpoints for the factory and sessionful object. This is necessary to allow the client to communicate with the service endpoints to acquire the EndpointAddress10 and to create the sessionful channel. - - ```xml - - - - - - - - - - - - - - - - - - - ``` - - And then we can start these services: - + new ChannelFactory("sessionbound"); + + public SessionBoundFactory() + { + } + + public EndpointAddress10 GetInstanceAddress() + { + IClientChannel channel = (IClientChannel)_factory.CreateChannel(); + return EndpointAddress10.FromEndpointAddress(channel.RemoteAddress); + } + } + ``` + + This implementation maintains a singleton channel factory to create sessionful objects. When GetInstanceAddress() is called, it creates a channel and creates an EndpointAddress10 object that effectively points to the remote address associated with this channel. EndpointAddress10 is simply a data type that can be returned to the client by-value. + +4. We need to modify the server’s configuration file by doing the following two things as shown in the example below: + + 1. Declare a \ section that describes the endpoint for the sessionful object. This is necessary because the server also acts as a client in this situation. + + 2. Declare endpoints for the factory and sessionful object. This is necessary to allow the client to communicate with the service endpoints to acquire the EndpointAddress10 and to create the sessionful channel. + + ```xml + + + + + + + + + + + + + + + + + + + ``` + + And then we can start these services: + ```csharp - ServiceHost factoryHost = new ServiceHost(typeof(SessionBoundFactory)); - factoryHost.Open(); - - ServiceHost sessionHost = new ServiceHost(typeof(MySessionBoundObject)); - sessionHost.Open(); - ``` - -5. We configure the client by declaring these same endpoints in its project’s app.config file. - - ```xml - - - - - - - - - - ``` - -6. In order to create and use this sessionful object, the client must do the following steps: - - 1. Create a channel to the ISessionBoundFactory service. - - 2. Use that channel to invoke that service to obtain an EndpointAddress10. - - 3. Use the EndpointAddress10 to create a channel to obtain a sessionful object. - - 4. Interact with the sessionful object to demonstrate it remains the same instance across multiple calls. - + ServiceHost factoryHost = new ServiceHost(typeof(SessionBoundFactory)); + factoryHost.Open(); + + ServiceHost sessionHost = new ServiceHost(typeof(MySessionBoundObject)); + sessionHost.Open(); + ``` + +5. We configure the client by declaring these same endpoints in its project’s app.config file. + + ```xml + + + + + + + + + + ``` + +6. In order to create and use this sessionful object, the client must do the following steps: + + 1. Create a channel to the ISessionBoundFactory service. + + 2. Use that channel to invoke that service to obtain an EndpointAddress10. + + 3. Use the EndpointAddress10 to create a channel to obtain a sessionful object. + + 4. Interact with the sessionful object to demonstrate it remains the same instance across multiple calls. + ```csharp ChannelFactory channelFactory = - new ChannelFactory("factory"); - ISessionBoundFactory sessionFactory = channelFactory.CreateChannel(); - - EndpointAddress10 address1 = sessionFactory.GetInstanceAddress(); - EndpointAddress10 address2 = sessionFactory.GetInstanceAddress(); - + new ChannelFactory("factory"); + ISessionBoundFactory sessionFactory = channelFactory.CreateChannel(); + + EndpointAddress10 address1 = sessionFactory.GetInstanceAddress(); + EndpointAddress10 address2 = sessionFactory.GetInstanceAddress(); + ChannelFactory sessionObjectFactory1 = new ChannelFactory(new NetTcpBinding(), - address1.ToEndpointAddress()); + address1.ToEndpointAddress()); ChannelFactory sessionObjectFactory2 = new ChannelFactory(new NetTcpBinding(), - address2.ToEndpointAddress()); - - ISessionBoundObject sessionInstance1 = sessionObjectFactory1.CreateChannel(); - ISessionBoundObject sessionInstance2 = sessionObjectFactory2.CreateChannel(); - - sessionInstance1.SetCurrentValue("Hello"); - sessionInstance2.SetCurrentValue("World"); - - if (sessionInstance1.GetCurrentValue() == "Hello" && - sessionInstance2.GetCurrentValue() == "World") - { - Console.WriteLine("sessionful server object works as expected"); - } - ``` - - WCF always returns objects by value, but it is possible to support the equivalent of by-reference semantics through the use of EndpointAddress10. This permits the client to request a sessionful WCF service instance, after which it can interact with it like any other WCF service. - -#### Scenario 3: Client Sends Server a By-Value Instance - - This scenario demonstrates the client sending a non-primitive object instance to the server by value. Because WCF only sends objects by value, this scenario demonstrates normal WCF usage. - -1. Use the same WCF Service from Scenario 1. - -2. Use the client to create a new by-value object (Customer), create a channel to communicate with the ICustomerService service, and send the object to it. - + address2.ToEndpointAddress()); + + ISessionBoundObject sessionInstance1 = sessionObjectFactory1.CreateChannel(); + ISessionBoundObject sessionInstance2 = sessionObjectFactory2.CreateChannel(); + + sessionInstance1.SetCurrentValue("Hello"); + sessionInstance2.SetCurrentValue("World"); + + if (sessionInstance1.GetCurrentValue() == "Hello" && + sessionInstance2.GetCurrentValue() == "World") + { + Console.WriteLine("sessionful server object works as expected"); + } + ``` + + WCF always returns objects by value, but it is possible to support the equivalent of by-reference semantics through the use of EndpointAddress10. This permits the client to request a sessionful WCF service instance, after which it can interact with it like any other WCF service. + +#### Scenario 3: Client Sends Server a By-Value Instance + + This scenario demonstrates the client sending a non-primitive object instance to the server by value. Because WCF only sends objects by value, this scenario demonstrates normal WCF usage. + +1. Use the same WCF Service from Scenario 1. + +2. Use the client to create a new by-value object (Customer), create a channel to communicate with the ICustomerService service, and send the object to it. + ```csharp - ChannelFactory factory = - new ChannelFactory("customerservice"); - ICustomerService service = factory.CreateChannel(); + ChannelFactory factory = + new ChannelFactory("customerservice"); + ICustomerService service = factory.CreateChannel(); PremiumCustomer customer = new PremiumCustomer { FirstName = "Bob", LastName = "Jones", CustomerId = 43, - AccountId = 99}; - bool success = service.UpdateCustomer(customer); + AccountId = 99}; + bool success = service.UpdateCustomer(customer); Console.WriteLine($" Server returned {success}."); - ``` - - The customer object will be serialized, and sent to the server, where it is deserialized into a new copy of that object. - + ``` + + The customer object will be serialized, and sent to the server, where it is deserialized into a new copy of that object. + > [!NOTE] - > This code also illustrates sending a derived type (PremiumCustomer). The service interface expects a Customer object, but the [KnownType] attribute on the Customer class indicated PremiumCustomer was also allowed. WCF will fail any attempt to serialize or deserialize any other type through this service interface. - - Normal WCF exchanges of data are by value. This guarantees that invoking methods on one of these data objects executes only locally – it will not invoke code on the other tier. While it is possible to achieve something like by-reference objects returned *from* the server, it is not possible for a client to pass a by-reference object *to* the server. A scenario that requires a conversation back and forth between client and server can be achieved in WCF using a duplex service. For more information, see [Duplex Services](./feature-details/duplex-services.md). - -## Summary + > This code also illustrates sending a derived type (PremiumCustomer). The service interface expects a Customer object, but the [KnownType] attribute on the Customer class indicated PremiumCustomer was also allowed. WCF will fail any attempt to serialize or deserialize any other type through this service interface. + + Normal WCF exchanges of data are by value. This guarantees that invoking methods on one of these data objects executes only locally – it will not invoke code on the other tier. While it is possible to achieve something like by-reference objects returned *from* the server, it is not possible for a client to pass a by-reference object *to* the server. A scenario that requires a conversation back and forth between client and server can be achieved in WCF using a duplex service. For more information, see [Duplex Services](./feature-details/duplex-services.md). + +## Summary .NET Remoting is a communication framework intended to be used only within fully-trusted environments. It is a legacy product and supported only for backward compatibility. It should not be used to build new applications. Conversely, WCF was designed with security in mind and is recommended for new and existing applications. Microsoft recommends that existing Remoting applications be migrated to use WCF or ASP.NET Web API instead. diff --git a/docs/navigate/tools-diagnostics/toc.yml b/docs/navigate/tools-diagnostics/toc.yml index e78549125f464..a814ff794c53b 100644 --- a/docs/navigate/tools-diagnostics/toc.yml +++ b/docs/navigate/tools-diagnostics/toc.yml @@ -635,6 +635,1599 @@ items: items: - name: PSTARTUP_CALLBACK function pointer href: ../../core/unmanaged-api/debugging/pstartup_callback-function-pointer.md + - name: Hosting + items: + - name: Overview + href: ../../core/unmanaged-api/hosting/index.md + - name: Hosting Coclasses + href: ../../core/unmanaged-api/hosting/hosting-coclasses.md + items: + - name: CLRRuntimeHost Coclass + href: ../../core/unmanaged-api/hosting/clrruntimehost-coclass.md + - name: ComCallUnmarshal Coclass + href: ../../core/unmanaged-api/hosting/comcallunmarshal-coclass.md + - name: CorRuntimeHost Coclass + href: ../../core/unmanaged-api/hosting/corruntimehost-coclass.md + - name: TypeNameFactory Coclass + href: ../../core/unmanaged-api/hosting/typenamefactory-coclass.md + - name: Hosting Enumerations + href: ../../core/unmanaged-api/hosting/hosting-enumerations.md + items: + - name: CLSID_RESOLUTION_FLAGS Enumeration + href: ../../core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md + - name: COR_GC_STAT_TYPES Enumeration + href: ../../core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md + - name: COR_GC_THREAD_STATS_TYPES Enumeration + href: ../../core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md + - name: EApiCategories Enumeration + href: ../../core/unmanaged-api/hosting/eapicategories-enumeration.md + - name: EBindPolicyLevels Enumeration + href: ../../core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md + - name: ECLRAssemblyIdentityFlags Enumeration + href: ../../core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md + - name: EClrEvent Enumeration + href: ../../core/unmanaged-api/hosting/eclrevent-enumeration.md + - name: EClrFailure Enumeration + href: ../../core/unmanaged-api/hosting/eclrfailure-enumeration.md + - name: EClrOperation Enumeration + href: ../../core/unmanaged-api/hosting/eclroperation-enumeration.md + - name: EClrUnhandledException Enumeration + href: ../../core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md + - name: EContextType Enumeration + href: ../../core/unmanaged-api/hosting/econtexttype-enumeration.md + - name: ECustomDumpFlavor Enumeration + href: ../../core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md + - name: ECustomDumpItemKind Enumeration + href: ../../core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md + - name: EHostApplicationPolicy Enumeration + href: ../../core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md + - name: EHostBindingPolicyModifyFlags Enumeration + href: ../../core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md + - name: EInitializeNewDomainFlags Enumeration + href: ../../core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md + - name: EMemoryAvailable Enumeration + href: ../../core/unmanaged-api/hosting/ememoryavailable-enumeration.md + - name: EMemoryCriticalLevel Enumeration + href: ../../core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md + - name: EPolicyAction Enumeration + href: ../../core/unmanaged-api/hosting/epolicyaction-enumeration.md + - name: ESymbolReadingPolicy Enumeration + href: ../../core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md + - name: ETaskType Enumeration + href: ../../core/unmanaged-api/hosting/etasktype-enumeration.md + - name: HOST_TYPE Enumeration + href: ../../core/unmanaged-api/hosting/host-type-enumeration.md + - name: MALLOC_TYPE Enumeration + href: ../../core/unmanaged-api/hosting/malloc-type-enumeration.md + - name: METAHOST_CONFIG_FLAGS Enumeration + href: ../../core/unmanaged-api/hosting/metahost-config-flags-enumeration.md + - name: METAHOST_POLICY_FLAGS Enumeration + href: ../../core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md + - name: RUNTIME_INFO_FLAGS Enumeration + href: ../../core/unmanaged-api/hosting/runtime-info-flags-enumeration.md + - name: StackOverflowType Enumeration + href: ../../core/unmanaged-api/hosting/stackoverflowtype-enumeration.md + - name: STARTUP_FLAGS Enumeration + href: ../../core/unmanaged-api/hosting/startup-flags-enumeration.md + - name: ValidatorFlags Enumeration + href: ../../core/unmanaged-api/hosting/validatorflags-enumeration.md + - name: WAIT_OPTION Enumeration + href: ../../core/unmanaged-api/hosting/wait-option-enumeration.md + - name: Hosting Global Static Functions + href: ../../core/unmanaged-api/hosting/hosting-global-static-functions.md + items: + - name: .NET Framework 4 Hosting Global Static Functions + href: ../../core/unmanaged-api/hosting/net-framework-4-hosting-global-static-functions.md + items: + - name: CLRCreateInstance Function + href: ../../core/unmanaged-api/hosting/clrcreateinstance-function.md + - name: Deprecated CLR Hosting Functions + href: ../../core/unmanaged-api/hosting/deprecated-clr-hosting-functions.md + items: + - name: _CorDllMain Function + href: ../../core/unmanaged-api/hosting/cordllmain-function.md + - name: _CorExeMain Function + href: ../../core/unmanaged-api/hosting/corexemain-function.md + - name: _CorExeMain2 Function + href: ../../core/unmanaged-api/hosting/corexemain2-function.md + - name: _CorImageUnloading Function + href: ../../core/unmanaged-api/hosting/corimageunloading-function.md + - name: _CorValidateImage Function + href: ../../core/unmanaged-api/hosting/corvalidateimage-function.md + - name: CallFunctionShim Function + href: ../../core/unmanaged-api/hosting/callfunctionshim-function.md + - name: ClrCreateManagedInstance Function + href: ../../core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md + - name: CoEEShutDownCOM Function + href: ../../core/unmanaged-api/hosting/coeeshutdowncom-function.md + - name: CoInitializeCor Function + href: ../../core/unmanaged-api/hosting/coinitializecor-function.md + - name: CoInitializeEE Function + href: ../../core/unmanaged-api/hosting/coinitializeee-function.md + - name: CorBindToCurrentRuntime Function + href: ../../core/unmanaged-api/hosting/corbindtocurrentruntime-function.md + - name: CorBindToRuntime Function + href: ../../core/unmanaged-api/hosting/corbindtoruntime-function.md + - name: CorBindToRuntimeByCfg Function + href: ../../core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md + - name: CorBindToRuntimeEx Function + href: ../../core/unmanaged-api/hosting/corbindtoruntimeex-function.md + - name: CorBindToRuntimeHost Function + href: ../../core/unmanaged-api/hosting/corbindtoruntimehost-function.md + - name: CorExitProcess Function + href: ../../core/unmanaged-api/hosting/corexitprocess-function.md + - name: CorLaunchApplication Function + href: ../../core/unmanaged-api/hosting/corlaunchapplication-function.md + - name: CorMarkThreadInThreadPool Function + href: ../../core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md + - name: CoUninitializeCor Function + href: ../../core/unmanaged-api/hosting/couninitializecor-function.md + - name: CoUninitializeEE Function + href: ../../core/unmanaged-api/hosting/couninitializeee-function.md + - name: CreateDebuggingInterfaceFromVersion Function + href: ../../core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md + - name: CreateICeeFileGen Function + href: ../../core/unmanaged-api/hosting/createiceefilegen-function.md + - name: DestroyICeeFileGen Function + href: ../../core/unmanaged-api/hosting/destroyiceefilegen-function.md + - name: FExecuteInAppDomainCallback Function Pointer + href: ../../core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md + - name: FLockClrVersionCallback Function Pointer + href: ../../core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md + - name: GetCLRIdentityManager Function + href: ../../core/unmanaged-api/hosting/getclridentitymanager-function.md + - name: GetCORRequiredVersion Function + href: ../../core/unmanaged-api/hosting/getcorrequiredversion-function.md + - name: GetCORSystemDirectory Function + href: ../../core/unmanaged-api/hosting/getcorsystemdirectory-function.md + - name: GetCORVersion Function + href: ../../core/unmanaged-api/hosting/getcorversion-function.md + - name: GetFileVersion Function + href: ../../core/unmanaged-api/hosting/getfileversion-function.md + - name: GetRealProcAddress Function + href: ../../core/unmanaged-api/hosting/getrealprocaddress-function.md + - name: GetRequestedRuntimeInfo Function + href: ../../core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md + - name: GetRequestedRuntimeVersion Function + href: ../../core/unmanaged-api/hosting/getrequestedruntimeversion-function.md + - name: GetRequestedRuntimeVersionForCLSID Function + href: ../../core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md + - name: GetVersionFromProcess Function + href: ../../core/unmanaged-api/hosting/getversionfromprocess-function.md + - name: LoadLibraryShim Function + href: ../../core/unmanaged-api/hosting/loadlibraryshim-function.md + - name: LoadStringRC Function + href: ../../core/unmanaged-api/hosting/loadstringrc-function.md + - name: LoadStringRCEx Function + href: ../../core/unmanaged-api/hosting/loadstringrcex-function.md + - name: LockClrVersion Function + href: ../../core/unmanaged-api/hosting/lockclrversion-function.md + - name: LPOVERLAPPED_COMPLETION_ROUTINE Function Pointer + href: ../../core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md + - name: LPTHREAD_START_ROUTINE Function Pointer + href: ../../core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md + - name: RunDll32ShimW Function + href: ../../core/unmanaged-api/hosting/rundll32shimw-function.md + - name: WAITORTIMERCALLBACK Function Pointer + href: ../../core/unmanaged-api/hosting/waitortimercallback-function-pointer.md + - name: Hosting Interfaces + href: ../../core/unmanaged-api/hosting/hosting-interfaces.md + items: + - name: Deprecated CLR Hosting Interfaces and Coclasses + href: ../../core/unmanaged-api/hosting/deprecated-clr-hosting-interfaces-and-coclasses.md + items: + - name: IAppDomainSetup Interface + href: ../../core/unmanaged-api/hosting/iappdomainsetup-interface.md + - name: ICeeFileGen Class + href: ../../core/unmanaged-api/hosting/iceefilegen-class.md + - name: ICorRuntimeHost Interface + href: ../../core/unmanaged-api/hosting/icorruntimehost-interface.md + items: + - name: CloseEnum Method + href: ../../core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md + - name: CreateDomain Method + href: ../../core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md + - name: CreateDomainSetup Method + href: ../../core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md + - name: CreateDomainEx Method + href: ../../core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md + - name: CreateEvidence Method + href: ../../core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md + - name: CreateLogicalThreadState Method + href: ../../core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md + - name: CurrentDomain Method + href: ../../core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md + - name: DeleteLogicalThreadState Method + href: ../../core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md + - name: EnumDomains Method + href: ../../core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md + - name: GetConfiguration Method + href: ../../core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md + - name: GetDefaultDomain Method + href: ../../core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md + - name: LocksHeldByLogicalThread Method + href: ../../core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md + - name: MapFile Method + href: ../../core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md + - name: NextDomain Method + href: ../../core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md + - name: Start Method + href: ../../core/unmanaged-api/hosting/icorruntimehost-start-method.md + - name: Stop Method + href: ../../core/unmanaged-api/hosting/icorruntimehost-stop-method.md + - name: SwitchInLogicalThreadState Method + href: ../../core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md + - name: SwitchOutLogicalThreadState Method + href: ../../core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md + - name: UnloadDomain Method + href: ../../core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md + - name: CLR Hosting Interfaces + href: ../../core/unmanaged-api/hosting/clr-hosting-interfaces.md + items: + - name: IActionOnCLREvent Interface + href: ../../core/unmanaged-api/hosting/iactiononclrevent-interface.md + items: + - name: OnEvent Method + href: ../../core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md + - name: IApartmentCallback Interface + href: ../../core/unmanaged-api/hosting/iapartmentcallback-interface.md + items: + - name: DoCallback Method + href: ../../core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md + - name: IAppDomainBinding Interface + href: ../../core/unmanaged-api/hosting/iappdomainbinding-interface.md + items: + - name: OnAppDomain Method + href: ../../core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md + - name: ICatalogServices Interface + href: ../../core/unmanaged-api/hosting/icatalogservices-interface.md + items: + - name: Autodone Method + href: ../../core/unmanaged-api/hosting/icatalogservices-autodone-method.md + - name: NotAutodone Method + href: ../../core/unmanaged-api/hosting/icatalogservices-notautodone-method.md + - name: ICLRAssemblyIdentityManager Interface + href: ../../core/unmanaged-api/hosting/iclrassemblyidentitymanager-interface.md + items: + - name: GetBindingIdentityFromFile Method + href: ../../core/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromfile-method.md + - name: GetBindingIdentityFromStream Method + href: ../../core/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromstream-method.md + - name: GetCLRAssemblyReferenceList Method + href: ../../core/unmanaged-api/hosting/iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md + - name: GetProbingAssembliesFromReference Method + href: ../../core/unmanaged-api/hosting/iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md + - name: GetReferencedAssembliesFromFile Method + href: ../../core/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md + - name: GetReferencedAssembliesFromStream Method + href: ../../core/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md + - name: IsStronglyNamed Method + href: ../../core/unmanaged-api/hosting/iclrassemblyidentitymanager-isstronglynamed-method.md + - name: ICLRAssemblyReferenceList Interface + href: ../../core/unmanaged-api/hosting/iclrassemblyreferencelist-interface.md + items: + - name: IsAssemblyReferenceInList Method + href: ../../core/unmanaged-api/hosting/iclrassemblyreferencelist-isassemblyreferenceinlist-method.md + - name: IsStringAssemblyReferenceInList Method + href: ../../core/unmanaged-api/hosting/iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md + - name: ICLRControl Interface + href: ../../core/unmanaged-api/hosting/iclrcontrol-interface.md + items: + - name: GetCLRManager Method + href: ../../core/unmanaged-api/hosting/iclrcontrol-getclrmanager-method.md + - name: SetAppDomainManagerType Method + href: ../../core/unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.md + - name: ICLRDebugManager Interface + href: ../../core/unmanaged-api/hosting/iclrdebugmanager-interface.md + items: + - name: BeginConnection Method + href: ../../core/unmanaged-api/hosting/iclrdebugmanager-beginconnection-method.md + - name: EndConnection Method + href: ../../core/unmanaged-api/hosting/iclrdebugmanager-endconnection-method.md + - name: GetDacl Method + href: ../../core/unmanaged-api/hosting/iclrdebugmanager-getdacl-method.md + - name: IsDebuggerAttached Method + href: ../../core/unmanaged-api/hosting/iclrdebugmanager-isdebuggerattached-method.md + - name: SetConnectionTasks Method + href: ../../core/unmanaged-api/hosting/iclrdebugmanager-setconnectiontasks-method.md + - name: SetDacl Method + href: ../../core/unmanaged-api/hosting/iclrdebugmanager-setdacl-method.md + - name: SetSymbolReadingPolicy Method + href: ../../core/unmanaged-api/hosting/iclrdebugmanager-setsymbolreadingpolicy-method.md + - name: ICLRErrorReportingManager Interface + href: ../../core/unmanaged-api/hosting/iclrerrorreportingmanager-interface.md + items: + - name: BeginCustomDump Method + href: ../../core/unmanaged-api/hosting/iclrerrorreportingmanager-begincustomdump-method.md + - name: EndCustomDump Method + href: ../../core/unmanaged-api/hosting/iclrerrorreportingmanager-endcustomdump-method.md + - name: GetBucketParametersForCurrentException Method + href: ../../core/unmanaged-api/hosting/iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md + - name: ICLRGCManager Interface + href: ../../core/unmanaged-api/hosting/iclrgcmanager-interface.md + items: + - name: Collect Method + href: ../../core/unmanaged-api/hosting/iclrgcmanager-collect-method.md + - name: GetStats Method + href: ../../core/unmanaged-api/hosting/iclrgcmanager-getstats-method.md + - name: SetGCStartupLimits Method + href: ../../core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md + - name: ICLRHostBindingPolicyManager Interface + href: ../../core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md + items: + - name: EvaluatePolicy Method + href: ../../core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md + - name: ModifyApplicationPolicy Method + href: ../../core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md + - name: ICLRHostProtectionManager Interface + href: ../../core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md + items: + - name: SetEagerSerializeGrantSets + href: ../../core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md + - name: SetProtectedCategories Method + href: ../../core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md + - name: ICLRIoCompletionManager Interface + href: ../../core/unmanaged-api/hosting/iclriocompletionmanager-interface.md + items: + - name: OnComplete Method + href: ../../core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md + - name: ICLRMemoryNotificationCallback Interface + href: ../../core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md + items: + - name: OnMemoryNotification Method + href: ../../core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md + - name: ICLROnEventManager Interface + href: ../../core/unmanaged-api/hosting/iclroneventmanager-interface.md + items: + - name: RegisterActionOnEvent Method + href: ../../core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md + - name: UnregisterActionOnEvent Method + href: ../../core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md + - name: ICLRPolicyManager Interface + href: ../../core/unmanaged-api/hosting/iclrpolicymanager-interface.md + items: + - name: SetActionOnFailure Method + href: ../../core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md + - name: SetActionOnTimeout Method + href: ../../core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md + - name: SetDefaultAction Method + href: ../../core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md + - name: SetTimeout Method + href: ../../core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md + - name: SetTimeoutAndAction Method + href: ../../core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md + - name: SetUnhandledExceptionPolicy Method + href: ../../core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md + - name: ICLRProbingAssemblyEnum Interface + href: ../../core/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md + items: + - name: Get Method + href: ../../core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md + - name: ICLRReferenceAssemblyEnum Interface + href: ../../core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md + items: + - name: Get Method + href: ../../core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md + - name: ICLRRuntimeHost Interface + href: ../../core/unmanaged-api/hosting/iclrruntimehost-interface.md + items: + - name: ExecuteApplication Method + href: ../../core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md + - name: ExecuteInAppDomain Method + href: ../../core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md + - name: ExecuteInDefaultAppDomain Method + href: ../../core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md + - name: GetCLRControl Method + href: ../../core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md + - name: GetCurrentAppDomainId Method + href: ../../core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md + - name: SetHostControl Method + href: ../../core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md + - name: Start Method + href: ../../core/unmanaged-api/hosting/iclrruntimehost-start-method.md + - name: Stop Method + href: ../../core/unmanaged-api/hosting/iclrruntimehost-stop-method.md + - name: UnloadAppDomain Method + href: ../../core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md + - name: ICLRSyncManager Interface + href: ../../core/unmanaged-api/hosting/iclrsyncmanager-interface.md + items: + - name: CreateRWLockOwnerIterator Method + href: ../../core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md + - name: DeleteRWLockOwnerIterator Method + href: ../../core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md + - name: GetMonitorOwner Method + href: ../../core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md + - name: GetRWLockOwnerNext Method + href: ../../core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md + - name: ICLRTask Interface + href: ../../core/unmanaged-api/hosting/iclrtask-interface.md + items: + - name: Abort Method + href: ../../core/unmanaged-api/hosting/iclrtask-abort-method.md + - name: ExitTask Method + href: ../../core/unmanaged-api/hosting/iclrtask-exittask-method.md + - name: GetMemStats Method + href: ../../core/unmanaged-api/hosting/iclrtask-getmemstats-method.md + - name: LocksHeld Method + href: ../../core/unmanaged-api/hosting/iclrtask-locksheld-method.md + - name: NeedsPriorityScheduling Method + href: ../../core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md + - name: Reset Method + href: ../../core/unmanaged-api/hosting/iclrtask-reset-method.md + - name: RudeAbort Method + href: ../../core/unmanaged-api/hosting/iclrtask-rudeabort-method.md + - name: SetTaskIdentifier Method + href: ../../core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md + - name: SwitchIn Method + href: ../../core/unmanaged-api/hosting/iclrtask-switchin-method.md + - name: SwitchOut Method + href: ../../core/unmanaged-api/hosting/iclrtask-switchout-method.md + - name: YieldTask Method + href: ../../core/unmanaged-api/hosting/iclrtask-yieldtask-method.md + - name: ICLRTaskManager Interface + href: ../../core/unmanaged-api/hosting/iclrtaskmanager-interface.md + items: + - name: CreateTask Method + href: ../../core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md + - name: GetCurrentTask Method + href: ../../core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md + - name: GetCurrentTaskType Method + href: ../../core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md + - name: SetLocale Method + href: ../../core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md + - name: SetUILocale Method + href: ../../core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md + - name: ICLRValidator Interface + href: ../../core/unmanaged-api/hosting/iclrvalidator-interface.md + items: + - name: FormatEventInfo Method + href: ../../core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md + - name: Validate Method + href: ../../core/unmanaged-api/hosting/iclrvalidator-validate-method.md + - name: ICorConfiguration Interface + href: ../../core/unmanaged-api/hosting/icorconfiguration-interface.md + items: + - name: AddDebuggerSpecialThread Method + href: ../../core/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md + - name: SetDebuggerThreadControl Method + href: ../../core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md + - name: SetGCHostControl Method + href: ../../core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md + - name: SetGCThreadControl Method + href: ../../core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md + - name: ICorThreadpool Interface + href: ../../core/unmanaged-api/hosting/icorthreadpool-interface.md + items: + - name: CorBindIoCompletionCallback Method + href: ../../core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md + - name: CorCallOrQueueUserWorkItem Method + href: ../../core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md + - name: CorChangeTimer Method + href: ../../core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md + - name: CorCreateTimer Method + href: ../../core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md + - name: CorDeleteTimer Method + href: ../../core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md + - name: CorGetAvailableThreads Method + href: ../../core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md + - name: CorGetMaxThreads Method + href: ../../core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md + - name: CorQueueUserWorkItem Method + href: ../../core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md + - name: CorRegisterWaitForSingleObject Method + href: ../../core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md + - name: CorSetMaxThreads Method + href: ../../core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md + - name: CorUnregisterWait Method + href: ../../core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md + - name: IDebuggerInfo Interface + href: ../../core/unmanaged-api/hosting/idebuggerinfo-interface.md + items: + - name: IsDebuggerAttached Method + href: ../../core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md + - name: IDebuggerThreadControl Interface + href: ../../core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md + items: + - name: ReleaseAllRuntimeThreads Method + href: ../../core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md + - name: StartBlockingForDebugger Method + href: ../../core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md + - name: ThreadIsBlockingForDebugger Method + href: ../../core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md + - name: IGCHost Interface + href: ../../core/unmanaged-api/hosting/igchost-interface.md + items: + - name: Collect Method + href: ../../core/unmanaged-api/hosting/igchost-collect-method.md + - name: GetStats Method + href: ../../core/unmanaged-api/hosting/igchost-getstats-method.md + - name: GetThreadStats Method + href: ../../core/unmanaged-api/hosting/igchost-getthreadstats-method.md + - name: SetGCStartupLimits Method + href: ../../core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md + - name: SetVirtualMemLimit Method + href: ../../core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md + - name: IGCHost2 Interface + href: ../../core/unmanaged-api/hosting/igchost2-interface.md + items: + - name: SetGCStartupLimitsEx Method + href: ../../core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md + - name: IGCHostControl Interface + href: ../../core/unmanaged-api/hosting/igchostcontrol-interface.md + items: + - name: RequestVirtualMemLimit Method + href: ../../core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md + - name: IGCThreadControl Interface + href: ../../core/unmanaged-api/hosting/igcthreadcontrol-interface.md + items: + - name: SuspensionEnding Method + href: ../../core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md + - name: SuspensionStarting Method + href: ../../core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md + - name: ThreadIsBlockingForSuspension Method + href: ../../core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md + - name: IHostAssemblyManager Interface + href: ../../core/unmanaged-api/hosting/ihostassemblymanager-interface.md + items: + - name: GetAssemblyStore Method + href: ../../core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md + - name: GetNonHostStoreAssemblies Method + href: ../../core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md + - name: IHostAssemblyStore Interface + href: ../../core/unmanaged-api/hosting/ihostassemblystore-interface.md + items: + - name: ProvideAssembly Method + href: ../../core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md + - name: ProvideModule Method + href: ../../core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md + - name: IHostAutoEvent Interface + href: ../../core/unmanaged-api/hosting/ihostautoevent-interface.md + items: + - name: Set Method + href: ../../core/unmanaged-api/hosting/ihostautoevent-set-method.md + - name: Wait Method + href: ../../core/unmanaged-api/hosting/ihostautoevent-wait-method.md + - name: IHostControl Interface + href: ../../core/unmanaged-api/hosting/ihostcontrol-interface.md + items: + - name: GetHostManager Method + href: ../../core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md + - name: SetAppDomainManager Method + href: ../../core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md + - name: IHostCrst Interface + href: ../../core/unmanaged-api/hosting/ihostcrst-interface.md + items: + - name: Enter Method + href: ../../core/unmanaged-api/hosting/ihostcrst-enter-method.md + - name: Leave Method + href: ../../core/unmanaged-api/hosting/ihostcrst-leave-method.md + - name: SetSpinCount Method + href: ../../core/unmanaged-api/hosting/ihostcrst-setspincount-method.md + - name: TryEnter Method + href: ../../core/unmanaged-api/hosting/ihostcrst-tryenter-method.md + - name: IHostGCManager Interface + href: ../../core/unmanaged-api/hosting/ihostgcmanager-interface.md + items: + - name: SuspensionEnding Method + href: ../../core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md + - name: SuspensionStarting Method + href: ../../core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md + - name: ThreadIsBlockingForSuspension Method + href: ../../core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md + - name: IHostIoCompletionManager Interface + href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md + items: + - name: Bind Method + href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md + - name: CloseIoCompletionPort Method + href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md + - name: CreateIoCompletionPort Method + href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md + - name: GetAvailableThreads Method + href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md + - name: GetHostOverlappedSize Method + href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md + - name: GetMaxThreads Method + href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md + - name: GetMinThreads Method + href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md + - name: InitializeHostOverlapped Method + href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md + - name: SetCLRIoCompletionManager Method + href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md + - name: SetMaxThreads Method + href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md + - name: SetMinThreads Method + href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md + - name: IHostMalloc Interface + href: ../../core/unmanaged-api/hosting/ihostmalloc-interface.md + items: + - name: Alloc Method + href: ../../core/unmanaged-api/hosting/ihostmalloc-alloc-method.md + - name: DebugAlloc Method + href: ../../core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md + - name: Free Method + href: ../../core/unmanaged-api/hosting/ihostmalloc-free-method.md + - name: IHostManualEvent Interface + href: ../../core/unmanaged-api/hosting/ihostmanualevent-interface.md + items: + - name: Reset Method + href: ../../core/unmanaged-api/hosting/ihostmanualevent-reset-method.md + - name: Set Method + href: ../../core/unmanaged-api/hosting/ihostmanualevent-set-method.md + - name: Wait Method + href: ../../core/unmanaged-api/hosting/ihostmanualevent-wait-method.md + - name: IHostMemoryManager Interface + href: ../../core/unmanaged-api/hosting/ihostmemorymanager-interface.md + items: + - name: AcquiredVirtualAddressSpace Method + href: ../../core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md + - name: CreateMAlloc Method + href: ../../core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md + - name: GetMemoryLoad Method + href: ../../core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md + - name: NeedsVirtualAddressSpace Method + href: ../../core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md + - name: RegisterMemoryNotificationCallback Method + href: ../../core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md + - name: ReleasedVirtualAddressSpace Method + href: ../../core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md + - name: VirtualAlloc Method + href: ../../core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md + - name: VirtualFree Method + href: ../../core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md + - name: VirtualProtect Method + href: ../../core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md + - name: VirtualQuery Method + href: ../../core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md + - name: IHostPolicyManager Interface + href: ../../core/unmanaged-api/hosting/ihostpolicymanager-interface.md + items: + - name: OnDefaultAction Method + href: ../../core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md + - name: OnFailure Method + href: ../../core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md + - name: OnTimeout Method + href: ../../core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md + - name: IHostSecurityContext Interface + href: ../../core/unmanaged-api/hosting/ihostsecuritycontext-interface.md + items: + - name: Capture Method + href: ../../core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md + - name: IHostSecurityManager Interface + href: ../../core/unmanaged-api/hosting/ihostsecuritymanager-interface.md + items: + - name: GetSecurityContext Method + href: ../../core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md + - name: ImpersonateLoggedOnUser Method + href: ../../core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md + - name: OpenThreadToken Method + href: ../../core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md + - name: RevertToSelf Method + href: ../../core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md + - name: SetSecurityContext Method + href: ../../core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md + - name: SetThreadToken Method + href: ../../core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md + - name: IHostSemaphore Interface + href: ../../core/unmanaged-api/hosting/ihostsemaphore-interface.md + items: + - name: ReleaseSemaphore Method + href: ../../core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md + - name: Wait Method + href: ../../core/unmanaged-api/hosting/ihostsemaphore-wait-method.md + - name: IHostSyncManager Interface + href: ../../core/unmanaged-api/hosting/ihostsyncmanager-interface.md + items: + - name: CreateAutoEvent Method + href: ../../core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md + - name: CreateCrst Method + href: ../../core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md + - name: CreateCrstWithSpinCount Method + href: ../../core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md + - name: CreateManualEvent Method + href: ../../core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md + - name: CreateMonitorEvent Method + href: ../../core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md + - name: CreateRWLockReaderEvent Method + href: ../../core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md + - name: CreateRWLockWriterEvent Method + href: ../../core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md + - name: CreateSemaphore Method + href: ../../core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md + - name: SetCLRSyncManager Method + href: ../../core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md + - name: IHostTask Interface + href: ../../core/unmanaged-api/hosting/ihosttask-interface.md + items: + - name: Alert Method + href: ../../core/unmanaged-api/hosting/ihosttask-alert-method.md + - name: GetPriority Method + href: ../../core/unmanaged-api/hosting/ihosttask-getpriority-method.md + - name: Join Method + href: ../../core/unmanaged-api/hosting/ihosttask-join-method.md + - name: SetCLRTask Method + href: ../../core/unmanaged-api/hosting/ihosttask-setclrtask-method.md + - name: SetPriority Method + href: ../../core/unmanaged-api/hosting/ihosttask-setpriority-method.md + - name: Start Method + href: ../../core/unmanaged-api/hosting/ihosttask-start-method.md + - name: IHostTaskManager Interface + href: ../../core/unmanaged-api/hosting/ihosttaskmanager-interface.md + items: + - name: BeginDelayAbort Method + href: ../../core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md + - name: BeginThreadAffinity Method + href: ../../core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md + - name: CallNeedsHostHook Method + href: ../../core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md + - name: CreateTask Method + href: ../../core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md + - name: EndDelayAbort Method + href: ../../core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md + - name: EndThreadAffinity Method + href: ../../core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md + - name: EnterRuntime Method + href: ../../core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md + - name: GetCurrentTask Method + href: ../../core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md + - name: GetStackGuarantee Method + href: ../../core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md + - name: LeaveRuntime Method + href: ../../core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md + - name: ReverseEnterRuntime Method + href: ../../core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md + - name: ReverseLeaveRuntime Method + href: ../../core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md + - name: SetCLRTaskManager Method + href: ../../core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md + - name: SetLocale Method + href: ../../core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md + - name: SetStackGuarantee Method + href: ../../core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md + - name: SetUILocale Method + href: ../../core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md + - name: Sleep Method + href: ../../core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md + - name: SwitchToTask Method + href: ../../core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md + - name: IHostThreadPoolManager Interface + href: ../../core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md + items: + - name: GetAvailableThreads Method + href: ../../core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md + - name: GetMaxThreads Method + href: ../../core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md + - name: GetMinThreads Method + href: ../../core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md + - name: QueueUserWorkItem Method + href: ../../core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md + - name: SetMaxThreads Method + href: ../../core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md + - name: SetMinThreads Method + href: ../../core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md + - name: IManagedObject Interface + href: ../../core/unmanaged-api/hosting/imanagedobject-interface.md + items: + - name: GetObjectIdentity Method + href: ../../core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md + - name: GetSerializedBuffer Method + href: ../../core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md + - name: IObjectHandle Interface + href: ../../core/unmanaged-api/hosting/iobjecthandle-interface.md + items: + - name: Unwrap Method + href: ../../core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md + - name: ITypeName Interface + href: ../../core/unmanaged-api/hosting/itypename-interface.md + items: + - name: GetAssemblyName Method + href: ../../core/unmanaged-api/hosting/itypename-getassemblyname-method.md + - name: GetModifierLength Method + href: ../../core/unmanaged-api/hosting/itypename-getmodifierlength-method.md + - name: GetModifiers Method + href: ../../core/unmanaged-api/hosting/itypename-getmodifiers-method.md + - name: GetNameCount Method + href: ../../core/unmanaged-api/hosting/itypename-getnamecount-method.md + - name: GetNames Method + href: ../../core/unmanaged-api/hosting/itypename-getnames-method.md + - name: GetTypeArgumentCount Method + href: ../../core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md + - name: GetTypeArguments Method + href: ../../core/unmanaged-api/hosting/itypename-gettypearguments-method.md + - name: ITypeNameBuilder Interface + href: ../../core/unmanaged-api/hosting/itypenamebuilder-interface.md + items: + - name: AddArray Method + href: ../../core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md + - name: AddAssemblySpec Method + href: ../../core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md + - name: AddByRef Method + href: ../../core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md + - name: AddName Method + href: ../../core/unmanaged-api/hosting/itypenamebuilder-addname-method.md + - name: AddPointer Method + href: ../../core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md + - name: AddSzArray Method + href: ../../core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md + - name: Clear Method + href: ../../core/unmanaged-api/hosting/itypenamebuilder-clear-method.md + - name: CloseGenericArgument Method + href: ../../core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md + - name: CloseGenericArguments Method + href: ../../core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md + - name: OpenGenericArgument Method + href: ../../core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md + - name: OpenGenericArguments Method + href: ../../core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md + - name: ToString Method + href: ../../core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md + - name: ITypeNameFactory Interface + href: ../../core/unmanaged-api/hosting/itypenamefactory-interface.md + items: + - name: GetTypeNameBuilder Method + href: ../../core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md + - name: ParseTypeName Method + href: ../../core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md + - name: IValidator Interface + href: ../../core/unmanaged-api/hosting/ivalidator-interface.md + items: + - name: FormatEventInfo Method + href: ../../core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md + - name: Validate Method + href: ../../core/unmanaged-api/hosting/ivalidator-validate-method.md + - name: CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5 + href: ../../core/unmanaged-api/hosting/clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md + items: + - name: ICLRAppDomainResourceMonitor Interface + href: ../../core/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md + items: + - name: GetCurrentAllocated Method + href: ../../core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentallocated-method.md + - name: GetCurrentSurvived Method + href: ../../core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md + - name: GetCurrentCpuTime Method + href: ../../core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentcputime-method.md + - name: ICLRDomainManager Interface + href: ../../core/unmanaged-api/hosting/iclrdomainmanager-interface.md + items: + - name: SetAppDomainManagerType Method + href: ../../core/unmanaged-api/hosting/iclrdomainmanager-setappdomainmanagertype-method.md + - name: SetPropertiesForDefaultAppDomain Method + href: ../../core/unmanaged-api/hosting/iclrdomainmanager-setpropertiesfordefaultappdomain-method.md + - name: ICLRGCManager2 Interface + href: ../../core/unmanaged-api/hosting/iclrgcmanager2-interface.md + items: + - name: SetGCStartupLimitsEx Method + href: ../../core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md + - name: ICLRMetaHost Interface + href: ../../core/unmanaged-api/hosting/iclrmetahost-interface.md + items: + - name: EnumerateInstalledRuntimes Method + href: ../../core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md + - name: EnumerateLoadedRuntimes Method + href: ../../core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md + - name: ExitProcess Method + href: ../../core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md + - name: GetRuntime Method + href: ../../core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md + - name: GetVersionFromFile Method + href: ../../core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md + - name: QueryLegacyV2RuntimeBinding Method + href: ../../core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md + - name: RequestRuntimeLoadedNotification Method + href: ../../core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md + - name: ICLRMetaHostPolicy Interface + href: ../../core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md + items: + - name: GetRequestedRuntime Method + href: ../../core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md + - name: ICLRRuntimeInfo Interface + href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-interface.md + items: + - name: BindAsLegacyV2Runtime Method + href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md + - name: GetDefaultStartupFlags Method + href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md + - name: GetInterface Method + href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md + - name: GetProcAddress Method + href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md + - name: GetRuntimeDirectory Method + href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md + - name: GetVersionString Method + href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md + - name: IsLoadable Method + href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md + - name: IsLoaded Method + href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md + - name: IsStarted Method + href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md + - name: LoadErrorString Method + href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md + - name: LoadLibrary Method + href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md + - name: SetDefaultStartupFlags Method + href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md + - name: ICLRStrongName Interface + href: ../../core/unmanaged-api/hosting/iclrstrongname-interface.md + items: + - name: GetHashFromAssemblyFile Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md + - name: GetHashFromAssemblyFileW Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md + - name: GetHashFromBlob Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md + - name: GetHashFromFile Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md + - name: GetHashFromFileW Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md + - name: GetHashFromHandle Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md + - name: StrongNameCompareAssemblies Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md + - name: StrongNameFreeBuffer Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md + - name: StrongNameGetBlob Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md + - name: StrongNameGetBlobFromImage Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md + - name: StrongNameGetPublicKey Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md + - name: StrongNameHashSize Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md + - name: StrongNameKeyDelete Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md + - name: StrongNameKeyGen Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md + - name: StrongNameKeyGenEx Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md + - name: StrongNameKeyInstall Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md + - name: StrongNameSignatureGeneration Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md + - name: StrongNameSignatureGenerationEx Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md + - name: StrongNameSignatureSize Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md + - name: StrongNameSignatureVerification Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md + - name: StrongNameSignatureVerificationEx Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md + - name: StrongNameSignatureVerificationFromImage Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md + - name: StrongNameTokenFromAssembly Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md + - name: StrongNameTokenFromAssemblyEx Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md + - name: StrongNameTokenFromPublicKey Method + href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md + - name: ICLRStrongName2 Interface + href: ../../core/unmanaged-api/hosting/iclrstrongname2-interface.md + items: + - name: StrongNameGetPublicKeyEx Method + href: ../../core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md + - name: StrongNameSignatureVerificationEx2 Method + href: ../../core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md + - name: ICLRTask2 Interface + href: ../../core/unmanaged-api/hosting/iclrtask2-interface.md + items: + - name: BeginPreventAsyncAbort Method + href: ../../core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md + - name: EndPreventAsyncAbort Method + href: ../../core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md + - name: Hosting Structures + href: ../../core/unmanaged-api/hosting/hosting-structures.md + items: + - name: AssemblyBindInfo Structure + href: ../../core/unmanaged-api/hosting/assemblybindinfo-structure.md + - name: BucketParameters Structure + href: ../../core/unmanaged-api/hosting/bucketparameters-structure.md + - name: COR_GC_STATS Structure + href: ../../core/unmanaged-api/hosting/cor-gc-stats-structure.md + - name: COR_GC_THREAD_STATS Structure + href: ../../core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md + - name: CustomDumpItem Structure + href: ../../core/unmanaged-api/hosting/customdumpitem-structure.md + - name: MDAInfo Structure + href: ../../core/unmanaged-api/hosting/mdainfo-structure.md + - name: ModuleBindInfo Structure + href: ../../core/unmanaged-api/hosting/modulebindinfo-structure.md + - name: StackOverflowInfo Structure + href: ../../core/unmanaged-api/hosting/stackoverflowinfo-structure.md + - name: Metadata + items: + - name: Overview + href: ../../core/unmanaged-api/metadata/index.md + - name: Metadata 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: Metadata Global Static Functions + href: ../../core/unmanaged-api/metadata/metadata-global-static-functions.md + - name: Metadata 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: Metadata 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: Metadata 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 From ad67a4ce6c9db291e33e63e62c30777dd04b5d8d Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Thu, 26 Jun 2025 18:02:44 +0200 Subject: [PATCH 09/20] more human edits --- .../alwaysflowimpersonationpolicy-element.md | 184 ++++++++-------- .../appdomainmanagerassembly-element.md | 120 +++++------ .../runtime/appdomainmanagertype-element.md | 120 +++++------ .../appdomainresourcemonitoring-element.md | 118 +++++------ .../disablecommitthreadstack-element.md | 116 +++++----- .../legacyimpersonationpolicy-element.md | 198 +++++++++--------- ...efercominsteadofmanagedremoting-element.md | 122 +++++------ .../startup/requiredruntime-element.md | 14 +- .../file-schema/startup/startup-element.md | 12 +- .../startup/supportedruntime-element.md | 20 +- .../unmanaged-api/alink/addfile-method.md | 84 ++++---- .../unmanaged-api/alink/addfile2-method.md | 84 ++++---- .../unmanaged-api/alink/addimport-method.md | 82 ++++---- .../alink/embedresource-method.md | 84 ++++---- .../alink/exportnestedtype-method.md | 104 ++++----- .../unmanaged-api/alink/exporttype-method.md | 98 ++++----- .../alink/exporttypeforwarder-method.md | 82 ++++---- .../unmanaged-api/alink/getscope-method.md | 82 ++++---- .../unmanaged-api/alink/getscope2-method.md | 80 +++---- .../unmanaged-api/alink/ialink2-interface.md | 56 ++--- .../unmanaged-api/alink/importfile-method.md | 98 ++++----- .../unmanaged-api/alink/importfile2-method.md | 106 +++++----- .../alink/importfileex-method.md | 106 +++++----- .../alink/importfileex2-method.md | 114 +++++----- .../unmanaged-api/alink/importtypes-method.md | 98 ++++----- .../alink/importtypes2-method.md | 98 ++++----- .../unmanaged-api/alink/init-method.md | 66 +++--- .../alink/linkresource-method.md | 84 ++++---- .../alink/setassemblyfile-method.md | 82 ++++---- .../alink/setassemblyfile2-method.md | 82 ++++---- .../unmanaged-api/alink/setpekind-method.md | 82 ++++---- .../certverifyauthenticodelicense-function.md | 6 +- .../cordebuginterfaceversion-enumeration.md | 2 +- .../cordebugthreadstate-enumeration.md | 2 +- .../debugging/iclrdebugging-interface.md | 2 +- .../debugging/icordebug-interface.md | 2 +- ...n-getmodulefrommetadatainterface-method.md | 66 +++--- .../icordebugclass-gettoken-method.md | 64 +++--- .../icordebugeval-createvalue-method.md | 2 +- ...ilframe2-enumeratetypeparameters-method.md | 2 +- ...anagedcallback2-changeconnection-method.md | 2 +- ...anagedcallback2-createconnection-method.md | 2 +- ...nagedcallback2-destroyconnection-method.md | 2 +- ...debugmetadatalocator-getmetadata-method.md | 2 +- ...debugmodule-getmetadatainterface-method.md | 6 +- .../icordebugmodule-gettoken-method.md | 4 +- .../icordebugmodule2-applychanges-method.md | 8 +- ...debugprocess2-getthreadfortaskid-method.md | 2 +- ...ss6-enablevirtualmodulesplitting-method.md | 4 +- ...typedefinition-getcorelementtype-method.md | 2 +- .../clr-profilers-and-windows-store-apps.md | 95 ++++----- ...allback3-profilerdetachsucceeded-method.md | 74 +++---- ...rcallback6-getassemblyreferences-method.md | 96 ++++----- ...orprofilerinfo-getmodulemetadata-method.md | 96 ++++----- ...corprofilerinfo2-getclassidinfo2-method.md | 128 +++++------ ...icorprofilerinfo2-getclasslayout-method.md | 112 +++++----- ...orprofilerinfo2-getfunctioninfo2-method.md | 148 ++++++------- ...icorprofilerinfo3-getmoduleinfo2-method.md | 130 ++++++------ .../icorprofilerinfo7-applymetadata-method.md | 96 ++++----- ...ilerinfo8-getdynamicfunctioninfo-method.md | 2 +- .../gethashfromassemblyfile-function.md | 104 ++++----- .../gethashfromassemblyfilew-function.md | 104 ++++----- .../strong-naming/gethashfromblob-function.md | 6 +- .../strong-naming/gethashfromfile-function.md | 106 +++++----- .../gethashfromfilew-function.md | 108 +++++----- .../gethashfromhandle-function.md | 102 ++++----- .../unmanaged-api/strong-naming/index.md | 182 ++++++++-------- .../strongnamecompareassemblies-function.md | 116 +++++----- .../strongnamefreebuffer-function.md | 68 +++--- .../strongnamegetblob-function.md | 104 ++++----- .../strongnamegetblobfromimage-function.md | 112 +++++----- .../strongnamegetpublickey-function.md | 130 ++++++------ .../strongnamehashsize-function.md | 94 ++++----- .../strongnamekeydelete-function.md | 8 +- .../strongnamekeygen-function.md | 124 +++++------ .../strongnamekeygenex-function.md | 136 ++++++------ .../strongnamekeyinstall-function.md | 8 +- .../strongnamesignaturegeneration-function.md | 148 ++++++------- ...trongnamesignaturegenerationex-function.md | 172 +++++++-------- .../strongnamesignaturesize-function.md | 96 ++++----- ...trongnamesignatureverification-function.md | 124 +++++------ ...ongnamesignatureverificationex-function.md | 104 ++++----- ...signatureverificationfromimage-function.md | 138 ++++++------ .../strongnametokenfromassembly-function.md | 112 +++++----- .../strongnametokenfromassemblyex-function.md | 128 +++++------ .../strongnametokenfrompublickey-function.md | 112 +++++----- 86 files changed, 3388 insertions(+), 3393 deletions(-) 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..ea3c4f19f77ad 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](../../../../core/unmanaged-api/hosting/corbindtoruntimeex-function.md) function. To enable the compatibility mode for the entire process, set the `flags` parameter for [CorBindToRuntimeEx Function](../../../../core/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..3805af8f3824b 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) @@ -79,4 +79,4 @@ Specifies the assembly that provides the application domain manager for the defa - [\ Element](appdomainmanagertype-element.md) - [Runtime Settings Schema](index.md) - [Configuration File Schema](../index.md) -- [SetAppDomainManagerType Method](../../../unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.md) +- [SetAppDomainManagerType Method](../../../../core/unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.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..4b62ff4b59683 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) @@ -79,4 +79,4 @@ Specifies the type that serves as the application domain manager for the default - [\ Element](appdomainmanagerassembly-element.md) - [Runtime Settings Schema](index.md) - [Configuration File Schema](../index.md) -- [SetAppDomainManagerType Method](../../../unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.md) +- [SetAppDomainManagerType Method](../../../../core/unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.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..60168e5f35dec 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](../../../../core/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..a79a845f40452 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](../../../../core/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..78a75cffee4fe 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](../../../../core/unmanaged-api/hosting/corbindtoruntimeex-function.md) function. To enable the compatibility mode for the entire process, set the `flags` parameter for [CorBindToRuntimeEx Function](../../../../core/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..cad7d389030a6 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](../../../../core/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](../../../../core/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..c7e580d513982 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 - ``` @@ -61,7 +61,7 @@ None. Applications built to support only version 1.0 of the runtime must use the `` element. Applications built using version 1.1 or later of the runtime must use the `` 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](../../../../core/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](../../../../core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md). The `version` attribute string must match the installation folder name for the specified version of the .NET Framework. This string is not interpreted. If the runtime startup code does not find a matching folder, the runtime is not loaded; the startup code shows an error message and quits. 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..5bc6b25e0feaf 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 @@ -39,7 +39,7 @@ Specifies common language runtime startup information. |Value|Description| |-----------|-----------------| -|`true`|Enable .NET Framework 2.0 runtime activation policy for the chosen runtime, which is to bind legacy runtime activation techniques (such as the [CorBindToRuntimeEx function](../../../unmanaged-api/hosting/corbindtoruntimeex-function.md)) to the runtime chosen from the configuration file instead of capping them at CLR version 2.0. Thus, if CLR version 4 or later is chosen from the configuration file, mixed-mode assemblies created with earlier versions of the .NET Framework are loaded with the chosen CLR version. Setting this value prevents CLR version 1.1 or CLR version 2.0 from loading into the same process, effectively disabling the in-process side-by-side feature.| +|`true`|Enable .NET Framework 2.0 runtime activation policy for the chosen runtime, which is to bind legacy runtime activation techniques (such as the [CorBindToRuntimeEx function](../../../../core/unmanaged-api/hosting/corbindtoruntimeex-function.md)) to the runtime chosen from the configuration file instead of capping them at CLR version 2.0. Thus, if CLR version 4 or later is chosen from the configuration file, mixed-mode assemblies created with earlier versions of the .NET Framework are loaded with the chosen CLR version. Setting this value prevents CLR version 1.1 or CLR version 2.0 from loading into the same process, effectively disabling the in-process side-by-side feature.| |`false`|Use the default activation policy for the .NET Framework 4 and later, which is to allow legacy runtime activation techniques to load CLR version 1.1 or 2.0 into the process. Setting this value prevents mixed-mode assemblies from loading into the .NET Framework 4 or later unless they were built with the .NET Framework 4 or later. This value is the default.| ### Child elements @@ -61,7 +61,7 @@ Specifies common language runtime startup information. ## The useLegacyV2RuntimeActivationPolicy attribute - This attribute is useful 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. In those scenarios, set the attribute to `true`. + This attribute is useful if your application uses legacy activation paths, such as the [CorBindToRuntimeEx function](../../../../core/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. In those scenarios, set the attribute to `true`. > [!NOTE] > Setting the attribute to `true` prevents CLR version 1.1 or CLR version 2.0 from loading into the same process, effectively disabling the in-process side-by-side feature (see [Side-by-Side Execution for COM Interop](/previous-versions/dotnet/netframework-4.0/8t8td04t(v=vs.100))). 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..e1294d7e8bf7c 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,14 +38,14 @@ 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](../../../../core/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](../../../../core/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. +> If your application uses legacy activation paths, such as the [CorBindToRuntimeEx function](../../../../core/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. We recommend that you test applications with all the .NET Framework versions that they can run on. diff --git a/docs/framework/unmanaged-api/alink/addfile-method.md b/docs/framework/unmanaged-api/alink/addfile-method.md index d2d583ea7a1f9..be476bfdbc390 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-apis/metadata/imetadataassemblyemit-definefile-method.md). + + `pEmitter` + [IMetaDataEmit Interface](../../../core/unmanaged-apis/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..e9999c0cd8718 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-apis/metadata/imetadataassemblyemit-definefile-method.md). + + `pEmitter` + Interface to [IMetaDataEmit2 Interface](../../../core/unmanaged-apis/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..d82d239d5aa5f 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-apis/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..c92599ea539e6 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-apis/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..a596c153b087a 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-apis/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..0d75f7702fea1 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-apis/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..5afbe3b1a5c10 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-apis/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..09438cfd91df2 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-apis/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..0e1da2f1ee11d 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-apis/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..81741d616bc4b 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-apis/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..f105b4e482f98 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-apis/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..c4314f98448ac 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-apis/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-apis/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..40d8d3301a19a 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-apis/metadata/imetadatadispenser-openscope-method.md). + + `pImportToken` + Receives ID of the file being imported. + + `ppAssemblyScope` + Receives assembly import scope [IMetaDataAssemblyImport Interface](../../../core/unmanaged-apis/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..aafe2eb97a6ff 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-apis/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-apis/metadata/imetadatadispenser-openscope-method.md). + + `pImportToken` + Receives unique ID for the assembly or file. + + `ppAssemblyScope` + Receives assembly import scope [IMetaDataAssemblyImport Interface](../../../core/unmanaged-apis/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..b506d31f6cfd4 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-apis/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..dc020c59d5367 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-apis/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..7cd2e71cc40c1 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-apis/metadata/imetadatadispenserex-interface.md) pointer to the metadata dispenser. + + `pErrorHandler` + [IMetaDataError Interface](../../../core/unmanaged-apis/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..50f0e194db6f2 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-apis/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..251988f57c292 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-apis/metadata/imetadataemit-interface.md) interface. + + `afFlags` + Flags as defined in [AssemblyFlags Enumeration](../../../core/unmanaged-apis/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..b341edec06fa7 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-apis/metadata/imetadataemit2-interface.md) interface for this file. + + `afFlags` + Options represented by [AssemblyFlags Enumeration](../../../core/unmanaged-apis/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..dad70b3448a53 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-apis/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-apis/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..cb6d13b245dac 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 @@ -70,5 +70,5 @@ HRESULT CertVerifyAuthenticodeLicense ( ## See also - [Authenticode](index.md) -- [GetHashFromHandle Method](../hosting/iclrstrongname-gethashfromhandle-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [GetHashFromHandle Method](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/debugging/cordebuginterfaceversion-enumeration.md b/docs/framework/unmanaged-api/debugging/cordebuginterfaceversion-enumeration.md index c3ea31c940ac0..42999ba3dbb1f 100644 --- a/docs/framework/unmanaged-api/debugging/cordebuginterfaceversion-enumeration.md +++ b/docs/framework/unmanaged-api/debugging/cordebuginterfaceversion-enumeration.md @@ -218,7 +218,7 @@ typedef enum CorDebugInterfaceVersion { ## Remarks - A debugger can use the `CorDebugInterfaceVersion` enumeration in the [CreateDebuggingInterfaceFromVersion](../hosting/createdebugginginterfacefromversion-function.md) function to specify the highest version of the .NET Framework that the debugger supports. + A debugger can use the `CorDebugInterfaceVersion` enumeration in the [CreateDebuggingInterfaceFromVersion](../../../core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md) function to specify the highest version of the .NET Framework that the debugger supports. ## Interface Names diff --git a/docs/framework/unmanaged-api/debugging/cordebugthreadstate-enumeration.md b/docs/framework/unmanaged-api/debugging/cordebugthreadstate-enumeration.md index 4744569bd97e3..21eaf83557aa0 100644 --- a/docs/framework/unmanaged-api/debugging/cordebugthreadstate-enumeration.md +++ b/docs/framework/unmanaged-api/debugging/cordebugthreadstate-enumeration.md @@ -40,7 +40,7 @@ typedef enum CorDebugThreadState { The debugger uses the `CorDebugThreadState` enumeration to control a thread's execution. The state of a thread can be set by using the [ICorDebugThread::SetDebugState](icordebugthread-setdebugstate-method.md) or [ICorDebugController::SetAllThreadsDebugState](icordebugcontroller-setallthreadsdebugstate-method.md) method. - A callback provided to the [hosting API](../hosting/index.md) enables message pumping, so an interrupted state is not needed. + A callback provided to the [hosting API](../../../core/unmanaged-api/hosting/index.md) enables message pumping, so an interrupted state is not needed. ## Requirements diff --git a/docs/framework/unmanaged-api/debugging/iclrdebugging-interface.md b/docs/framework/unmanaged-api/debugging/iclrdebugging-interface.md index 290d21d555268..3fbbd624824af 100644 --- a/docs/framework/unmanaged-api/debugging/iclrdebugging-interface.md +++ b/docs/framework/unmanaged-api/debugging/iclrdebugging-interface.md @@ -29,7 +29,7 @@ Provides methods that handle loading and unloading modules for debugging. ## Remarks - You can obtain an instance of the `ICLRDebugging` interface by using the [CLRCreateInstance](../hosting/clrcreateinstance-function.md) function. + You can obtain an instance of the `ICLRDebugging` interface by using the [CLRCreateInstance](../../../core/unmanaged-api/hosting/clrcreateinstance-function.md) function. ## Requirements diff --git a/docs/framework/unmanaged-api/debugging/icordebug-interface.md b/docs/framework/unmanaged-api/debugging/icordebug-interface.md index 61dec178ae5e2..f86e59a8eb537 100644 --- a/docs/framework/unmanaged-api/debugging/icordebug-interface.md +++ b/docs/framework/unmanaged-api/debugging/icordebug-interface.md @@ -41,7 +41,7 @@ Provides methods that allow developers to debug applications in the common langu `ICorDebug` represents an event processing loop for a debugger process. The debugger must wait for the [ICorDebugManagedCallback::ExitProcess](icordebugmanagedcallback-exitprocess-method.md) callback from all processes being debugged before releasing this interface. - The `ICorDebug` object is the initial object to control all further managed debugging. In the .NET Framework versions 1.0 and 1.1, this object was a `CoClass` object created from COM. In .NET Framework version 2.0, this object is no longer a `CoClass` object. It must be created by the [CreateDebuggingInterfaceFromVersion](../hosting/createdebugginginterfacefromversion-function.md) function, which is more version-aware. This new creation function enables clients to get a specific implementation of `ICorDebug`, which also emulates a specific version of the debugging API. + The `ICorDebug` object is the initial object to control all further managed debugging. In the .NET Framework versions 1.0 and 1.1, this object was a `CoClass` object created from COM. In .NET Framework version 2.0, this object is no longer a `CoClass` object. It must be created by the [CreateDebuggingInterfaceFromVersion](../../../core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md) function, which is more version-aware. This new creation function enables clients to get a specific implementation of `ICorDebug`, which also emulates a specific version of the debugging API. > [!NOTE] > This interface does not support being called remotely, either cross-machine or cross-process. diff --git a/docs/framework/unmanaged-api/debugging/icordebugappdomain-getmodulefrommetadatainterface-method.md b/docs/framework/unmanaged-api/debugging/icordebugappdomain-getmodulefrommetadatainterface-method.md index 5a9fd2830eac6..7c5e2c8c619bd 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-apis/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..405d31ccb3b77 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-apis/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..7195faa3bc81d 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-apis/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..5c58961a2eb8b 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-apis/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/icordebugmanagedcallback2-changeconnection-method.md b/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-changeconnection-method.md index 238b50ea449e3..bbd373a6d5fa6 100644 --- a/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-changeconnection-method.md +++ b/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-changeconnection-method.md @@ -44,7 +44,7 @@ HRESULT ChangeConnection ( - When a debugger attaches to a process that contains connections. In this case, the runtime will generate and dispatch a [ICorDebugManagedCallback2::CreateConnection](icordebugmanagedcallback2-createconnection-method.md) event and a `ChangeConnection` event for each connection in the process. A `ChangeConnection` event is generated for every existing connection, regardless of whether that connection’s set of tasks has been changed since its creation. -- When a host calls [ICLRDebugManager::SetConnectionTasks](../hosting/iclrdebugmanager-setconnectiontasks-method.md) in the [Hosting API](../hosting/index.md). +- When a host calls [ICLRDebugManager::SetConnectionTasks](../../../core/unmanaged-api/hosting/iclrdebugmanager-setconnectiontasks-method.md) in the [Hosting API](../../../core/unmanaged-api/hosting/index.md). The debugger should scan all threads in the process to pick up the new changes. diff --git a/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-createconnection-method.md b/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-createconnection-method.md index a410986005df2..1d606ac5372be 100644 --- a/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-createconnection-method.md +++ b/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-createconnection-method.md @@ -48,7 +48,7 @@ HRESULT CreateConnection ( - When a debugger attaches to a process that contains connections. In this case, the runtime will generate and dispatch a `CreateConnection` event and a [ICorDebugManagedCallback2::ChangeConnection](icordebugmanagedcallback2-changeconnection-method.md) event for each connection in the process. -- When a host calls [ICLRDebugManager::BeginConnection](../hosting/iclrdebugmanager-beginconnection-method.md) in the [Hosting API](../hosting/index.md). +- When a host calls [ICLRDebugManager::BeginConnection](../../../core/unmanaged-api/hosting/iclrdebugmanager-beginconnection-method.md) in the [Hosting API](../../../core/unmanaged-api/hosting/index.md). ## Requirements diff --git a/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-destroyconnection-method.md b/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-destroyconnection-method.md index 9f5d5d6a7f0f3..d1bb2a0e4e1bd 100644 --- a/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-destroyconnection-method.md +++ b/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-destroyconnection-method.md @@ -40,7 +40,7 @@ HRESULT DestroyConnection ( ## Remarks - A `DestroyConnection` callback will be fired when a host calls [ICLRDebugManager::EndConnection](../hosting/iclrdebugmanager-endconnection-method.md) in the [Hosting API](../hosting/index.md). + A `DestroyConnection` callback will be fired when a host calls [ICLRDebugManager::EndConnection](../../../core/unmanaged-api/hosting/iclrdebugmanager-endconnection-method.md) in the [Hosting API](../../../core/unmanaged-api/hosting/index.md). ## Requirements diff --git a/docs/framework/unmanaged-api/debugging/icordebugmetadatalocator-getmetadata-method.md b/docs/framework/unmanaged-api/debugging/icordebugmetadatalocator-getmetadata-method.md index 50156265e8e36..3f8584733c2d9 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-apis/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..4cfceb0bb9188 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-apis/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-apis/metadata/imetadataemit-interface.md) interface object for the module, then calls [IMetaDataEmit::SaveToMemory](../../../core/unmanaged-apis/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-apis/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..ea272cd3d7c04 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-apis/metadata/imetadataimport-interface.md), [IMetaDataImport2](../../../core/unmanaged-apis/metadata/imetadataimport2-interface.md), and [IMetaDataAssemblyImport](../../../core/unmanaged-apis/metadata/imetadataassemblyimport-interface.md) metadata import interfaces. ## Requirements @@ -50,4 +50,4 @@ HRESULT GetToken( ## See also -- [Metadata](../metadata/index.md) +- [Metadata](../../../core/unmanaged-apis/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..fd36961be7292 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-apis/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-apis/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-apis/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-apis/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/icordebugprocess2-getthreadfortaskid-method.md b/docs/framework/unmanaged-api/debugging/icordebugprocess2-getthreadfortaskid-method.md index 93f69797d28a4..0706ff8ca12c2 100644 --- a/docs/framework/unmanaged-api/debugging/icordebugprocess2-getthreadfortaskid-method.md +++ b/docs/framework/unmanaged-api/debugging/icordebugprocess2-getthreadfortaskid-method.md @@ -40,7 +40,7 @@ HRESULT GetThreadForTaskID ( ## Remarks - The host can set the task identifier by using the [ICLRTask::SetTaskIdentifier](../hosting/iclrtask-settaskidentifier-method.md) method. + The host can set the task identifier by using the [ICLRTask::SetTaskIdentifier](../../../core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md) method. ## Requirements diff --git a/docs/framework/unmanaged-api/debugging/icordebugprocess6-enablevirtualmodulesplitting-method.md b/docs/framework/unmanaged-api/debugging/icordebugprocess6-enablevirtualmodulesplitting-method.md index 7acf170941ab2..8b85e70aafca8 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-apis/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-apis/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..43cc90a1d57e8 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-apis/metadata/corelementtype-enumeration.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..a226ded99d49c 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-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). -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-apis/metadata/imetadataimport-interface.md), you can choose to set [ofNoTransform](../../../core/unmanaged-apis/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-apis/metadata/coropenflags-enumeration.md) in the `dwOpenFlags` parameter or ask for a writeable metadata interface such as [IMetaDataEmit](../../../core/unmanaged-apis/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-apis/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..fa7378c17b172 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-apis/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..2eb14ebd99ae3 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-apis/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..6cedbe2f2b3de 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-apis/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-apis/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..73d44b528726d 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-apis/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..f21f459dd070d 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-apis/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..2fc6ee4d4ea9d 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-apis/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..129a94007e17b 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-apis/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..cb5342014ed8e 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-apis/metadata/imetadataassemblyemit-defineassemblyref-method.md). method. + +- `TypeRef` records, which you create by calling the [IMetaDataEmit::DefineTypeRefByName](../../../core/unmanaged-apis/metadata/imetadataemit-definetyperefbyname-method.md) method. + +- `TypeSpec` records, which you create by calling the [IMetaDataEmit::GetTokenFromTypeSpec](../../../core/unmanaged-apis/metadata/imetadataemit-gettokenfromtypespec-method.md) method. + +- `MemberRef` records, which you create by calling the [IMetaDataEmit::DefineMemberRef](../../../core/unmanaged-apis/metadata/imetadataemit-definememberref-method.md) method. + +- `MemberSpec` records, which you create by calling the [IMetaDataEmit2::DefineMethodSpec](../../../core/unmanaged-apis/metadata/imetadataemit2-definemethodspec-method.md) method. + +- `UserString` records, which you create by calling the [IMetaDataEmit::DefineUserString](../../../core/unmanaged-apis/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-apis/metadata/imetadataemit-definetypedef-method.md) method. + +- `MethodDef` records, which you create by calling the [IMetaDataEmit::DefineMethod](../../../core/unmanaged-apis/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..e2e84dcad1d61 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-apis/metadata/imetadataimport-interface.md) and [IMetaDataImport2](../../../core/unmanaged-apis/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/strong-naming/gethashfromassemblyfile-function.md b/docs/framework/unmanaged-api/strong-naming/gethashfromassemblyfile-function.md index b42e77a1591e6..f2233406a4f67 100644 --- a/docs/framework/unmanaged-api/strong-naming/gethashfromassemblyfile-function.md +++ b/docs/framework/unmanaged-api/strong-naming/gethashfromassemblyfile-function.md @@ -2,67 +2,67 @@ description: "Learn more about: GetHashFromAssemblyFile Function" title: "GetHashFromAssemblyFile Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetHashFromAssemblyFile" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "GetHashFromAssemblyFile" -helpviewer_keywords: +helpviewer_keywords: - "GetHashFromAssemblyFile function [.NET Framework strong naming]" ms.assetid: 751ed69f-b7ab-4e07-80de-e17ca9319b0c -topic_type: +topic_type: - "apiref" --- # GetHashFromAssemblyFile Function -Gets a hash of the specified assembly file, using the specified hash algorithm. - - This function has been deprecated. Use the [ICLRStrongName::GetHashFromAssemblyFile](../hosting/iclrstrongname-gethashfromassemblyfile-method.md) method instead. - -## Syntax - -```cpp -HRESULT GetHashFromAssemblyFile ( - [in] LPCSTR szFilePath, - [in, out] unsigned int *piHashAlg, - [out] BYTE *pbHash, - [in] DWORD cchHash, - [out] DWORD *pchHash -); -``` - -## Parameters - - `szFilePath` - [in] The path to the file to be hashed. - - `piHashAlg` - [in, out] A constant that specifies the hash algorithm. Use zero for the default hash algorithm. - - `pbHash` - [out] The returned hash buffer. - - `cchHash` - [in] The requested maximum size of `pbHash`. - - `pchHash` - [out] The returned size, in bytes, of `pbHash`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets a hash of the specified assembly file, using the specified hash algorithm. + + This function has been deprecated. Use the [ICLRStrongName::GetHashFromAssemblyFile](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md) method instead. + +## Syntax + +```cpp +HRESULT GetHashFromAssemblyFile ( + [in] LPCSTR szFilePath, + [in, out] unsigned int *piHashAlg, + [out] BYTE *pbHash, + [in] DWORD cchHash, + [out] DWORD *pchHash +); +``` + +## Parameters + + `szFilePath` + [in] The path to the file to be hashed. + + `piHashAlg` + [in, out] A constant that specifies the hash algorithm. Use zero for the default hash algorithm. + + `pbHash` + [out] The returned hash buffer. + + `cchHash` + [in] The requested maximum size of `pbHash`. + + `pchHash` + [out] The returned size, in bytes, of `pbHash`. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [GetHashFromAssemblyFile Method](../hosting/iclrstrongname-gethashfromassemblyfile-method.md) -- [GetHashFromAssemblyFileW Method](../hosting/iclrstrongname-gethashfromassemblyfilew-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [GetHashFromAssemblyFile Method](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md) +- [GetHashFromAssemblyFileW Method](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/gethashfromassemblyfilew-function.md b/docs/framework/unmanaged-api/strong-naming/gethashfromassemblyfilew-function.md index 15c082ff30ae1..e65b128ef38d3 100644 --- a/docs/framework/unmanaged-api/strong-naming/gethashfromassemblyfilew-function.md +++ b/docs/framework/unmanaged-api/strong-naming/gethashfromassemblyfilew-function.md @@ -2,67 +2,67 @@ description: "Learn more about: GetHashFromAssemblyFileW Function" title: "GetHashFromAssemblyFileW Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetHashFromAssemblyFileW" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "GetHashFromAssemblyFileW" -helpviewer_keywords: +helpviewer_keywords: - "GetHashFromAssemblyFileW function [.NET Framework strong naming]" ms.assetid: d1b2b172-5353-42af-a877-cf653c68ece0 -topic_type: +topic_type: - "apiref" --- # GetHashFromAssemblyFileW Function -Gets a hash of the specified assembly file, using the specified hash algorithm. The path to the assembly file must be specified as a Unicode string. - - This function has been deprecated. Use the [ICLRStrongName::GetHashFromAssemblyFileW](../hosting/iclrstrongname-gethashfromassemblyfilew-method.md) method instead. - -## Syntax - -```cpp -HRESULT GetHashFromAssemblyFileW ( - [in] LPCWSTR wszFilePath, - [in, out] unsigned int *piHashAlg, - [out] BYTE *pbHash, - [in] DWORD cchHash, - [out] DWORD *pchHash -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the file to be hashed. This parameter must be a Unicode string. - - `piHashAlg` - [in, out] A constant that specifies the hash algorithm. Use zero for the default hash algorithm. - - `pbHash` - [out] The returned hash buffer. - - `cchHash` - [in] The requested maximum size of `pbHash`. - - `pchHash` - [out] The returned size, in bytes, of `pbHash`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets a hash of the specified assembly file, using the specified hash algorithm. The path to the assembly file must be specified as a Unicode string. + + This function has been deprecated. Use the [ICLRStrongName::GetHashFromAssemblyFileW](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md) method instead. + +## Syntax + +```cpp +HRESULT GetHashFromAssemblyFileW ( + [in] LPCWSTR wszFilePath, + [in, out] unsigned int *piHashAlg, + [out] BYTE *pbHash, + [in] DWORD cchHash, + [out] DWORD *pchHash +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the file to be hashed. This parameter must be a Unicode string. + + `piHashAlg` + [in, out] A constant that specifies the hash algorithm. Use zero for the default hash algorithm. + + `pbHash` + [out] The returned hash buffer. + + `cchHash` + [in] The requested maximum size of `pbHash`. + + `pchHash` + [out] The returned size, in bytes, of `pbHash`. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [GetHashFromAssemblyFileW Method](../hosting/iclrstrongname-gethashfromassemblyfilew-method.md) -- [GetHashFromAssemblyFile Method](../hosting/iclrstrongname-gethashfromassemblyfile-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [GetHashFromAssemblyFileW Method](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md) +- [GetHashFromAssemblyFile Method](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/gethashfromblob-function.md b/docs/framework/unmanaged-api/strong-naming/gethashfromblob-function.md index 81da83646e2f3..9e823b5ebd670 100644 --- a/docs/framework/unmanaged-api/strong-naming/gethashfromblob-function.md +++ b/docs/framework/unmanaged-api/strong-naming/gethashfromblob-function.md @@ -21,7 +21,7 @@ topic_type: Gets a hash of the assembly at the specified memory address, using the specified hash algorithm. -This function has been deprecated. Use the [ICLRStrongName::GetHashFromBlob](../hosting/iclrstrongname-gethashfromblob-method.md) method instead. +This function has been deprecated. Use the [ICLRStrongName::GetHashFromBlob](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md) method instead. ## Syntax @@ -68,5 +68,5 @@ HRESULT GetHashFromBlob ( ## See also -- [GetHashFromBlob Method](../hosting/iclrstrongname-gethashfromblob-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [GetHashFromBlob Method](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/gethashfromfile-function.md b/docs/framework/unmanaged-api/strong-naming/gethashfromfile-function.md index dc6ad7b78d834..8babe191b7282 100644 --- a/docs/framework/unmanaged-api/strong-naming/gethashfromfile-function.md +++ b/docs/framework/unmanaged-api/strong-naming/gethashfromfile-function.md @@ -2,71 +2,71 @@ description: "Learn more about: GetHashFromFile Function" title: "GetHashFromFile Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetHashFromFile" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "GetHashFromFile" -helpviewer_keywords: +helpviewer_keywords: - "GetHashFromFile function [.NET Framework strong naming]" ms.assetid: b3c526a4-8fb4-4ad6-b6af-42ce9c06492e -topic_type: +topic_type: - "apiref" --- # GetHashFromFile Function -Generates a hash over the contents of the specified file. - - This function has been deprecated. Use the [ICLRStrongName::GetHashFromFile](../hosting/iclrstrongname-gethashfromfile-method.md) method instead. - -## Syntax - -```cpp -HRESULT GetHashFromFile ( - [in] LPCSTR szFilePath, +Generates a hash over the contents of the specified file. + + This function has been deprecated. Use the [ICLRStrongName::GetHashFromFile](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md) method instead. + +## Syntax + +```cpp +HRESULT GetHashFromFile ( + [in] LPCSTR szFilePath, [in, out] unsigned int *piHashAlg, [out] BYTE *pbHash, [in] DWORD cchHash, - [out] DWORD *pchHash -); -``` - -## Parameters - - `szFilePath` - [in] The name of the file to hash. - - `piHashAlg` - [in, out] The algorithm to use when generating the hash. Valid algorithms are those defined by the Win32 CryptoAPI. If `piHashAlg` is set to 0, the default algorithm CALG_SHA-1 is used. - - `pbHash` - [out] A byte array containing the generated hash. - - `cchHash` - [in] The maximum size of the buffer that `pbHash` points to. - - `pchHash` - [out] The size, in bytes, of the returned `pbHash`. - -## Remarks - - This function is the same as [GetHashFromFileW](gethashfromfilew-function.md), except that the file name specification is ANSI instead of Unicode. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - + [out] DWORD *pchHash +); +``` + +## Parameters + + `szFilePath` + [in] The name of the file to hash. + + `piHashAlg` + [in, out] The algorithm to use when generating the hash. Valid algorithms are those defined by the Win32 CryptoAPI. If `piHashAlg` is set to 0, the default algorithm CALG_SHA-1 is used. + + `pbHash` + [out] A byte array containing the generated hash. + + `cchHash` + [in] The maximum size of the buffer that `pbHash` points to. + + `pchHash` + [out] The size, in bytes, of the returned `pbHash`. + +## Remarks + + This function is the same as [GetHashFromFileW](gethashfromfilew-function.md), except that the file name specification is ANSI instead of Unicode. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also -- [GetHashFromFile Method](../hosting/iclrstrongname-gethashfromfile-method.md) -- [GetHashFromFileW Method](../hosting/iclrstrongname-gethashfromfilew-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [GetHashFromFile Method](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md) +- [GetHashFromFileW Method](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/gethashfromfilew-function.md b/docs/framework/unmanaged-api/strong-naming/gethashfromfilew-function.md index c0f01fc646c87..b7c103db476ec 100644 --- a/docs/framework/unmanaged-api/strong-naming/gethashfromfilew-function.md +++ b/docs/framework/unmanaged-api/strong-naming/gethashfromfilew-function.md @@ -2,71 +2,71 @@ description: "Learn more about: GetHashFromFileW Function" title: "GetHashFromFileW Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetHashFromFileW" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "GetHashFromFileW" -helpviewer_keywords: +helpviewer_keywords: - "GetHashFromFileW function [.NET Framework strong naming]" ms.assetid: 97c2d7a6-5376-45a1-ba65-146a249147cc -topic_type: +topic_type: - "apiref" --- # GetHashFromFileW Function -Generates a hash over the contents of the file specified by a Unicode string. - - This function has been deprecated. Use the [ICLRStrongName::GetHashFromFileW](../hosting/iclrstrongname-gethashfromfilew-method.md) method instead. - -## Syntax - -```cpp +Generates a hash over the contents of the file specified by a Unicode string. + + This function has been deprecated. Use the [ICLRStrongName::GetHashFromFileW](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md) method instead. + +## Syntax + +```cpp HRESULT GetHashFromFileW ( - [in] LPCWSTR wszFilePath, - [in, out] unsigned int *piHashAlg, - [out] BYTE *pbHash, - [in] DWORD cchHash, - [out] DWORD *pchHash + [in] LPCWSTR wszFilePath, + [in, out] unsigned int *piHashAlg, + [out] BYTE *pbHash, + [in] DWORD cchHash, + [out] DWORD *pchHash ); -``` - -## Parameters - - `wszFilePath` - [in] The Unicode name of the file to hash. - - `piHashAlg` - [in, out] The algorithm to use when generating the hash. Valid algorithms are those defined by the Win32 CryptoAPI. If `piHashAlg` is set to 0, the default algorithm CALG_SHA-1 is used. - - `pbHash` - [out] A byte array containing the generated hash. - - `cchHash` - [in] The maximum size of the buffer pointed to by `pbHash`. - - `pchHash` - [out] The size, in bytes, of `pbHash`. - -## Remarks - - This function is the same as [GetHashFromFile](gethashfromfile-function.md), except that the file name specification is Unicode instead of ANSI. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +``` + +## Parameters + + `wszFilePath` + [in] The Unicode name of the file to hash. + + `piHashAlg` + [in, out] The algorithm to use when generating the hash. Valid algorithms are those defined by the Win32 CryptoAPI. If `piHashAlg` is set to 0, the default algorithm CALG_SHA-1 is used. + + `pbHash` + [out] A byte array containing the generated hash. + + `cchHash` + [in] The maximum size of the buffer pointed to by `pbHash`. + + `pchHash` + [out] The size, in bytes, of `pbHash`. + +## Remarks + + This function is the same as [GetHashFromFile](gethashfromfile-function.md), except that the file name specification is Unicode instead of ANSI. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [GetHashFromFileW Method](../hosting/iclrstrongname-gethashfromfilew-method.md) -- [GetHashFromFile Method](../hosting/iclrstrongname-gethashfromfile-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [GetHashFromFileW Method](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md) +- [GetHashFromFile Method](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/gethashfromhandle-function.md b/docs/framework/unmanaged-api/strong-naming/gethashfromhandle-function.md index 75b6921fda915..59cff51dca3ec 100644 --- a/docs/framework/unmanaged-api/strong-naming/gethashfromhandle-function.md +++ b/docs/framework/unmanaged-api/strong-naming/gethashfromhandle-function.md @@ -2,66 +2,66 @@ description: "Learn more about: GetHashFromHandle Function" title: "GetHashFromHandle Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetHashFromHandle" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "GetHashFromHandle" -helpviewer_keywords: +helpviewer_keywords: - "GetHashFromHandle function [.NET Framework strong naming]" ms.assetid: 9e00337f-b307-4602-9bc3-965a8dbf02cd -topic_type: +topic_type: - "apiref" --- # GetHashFromHandle Function -Generates a hash over the contents of the file with the specified file handle, using the specified hash algorithm. - - This function has been deprecated. Use the [ICLRStrongName::GetHashFromHandle](../hosting/iclrstrongname-gethashfromhandle-method.md) method instead. - -## Syntax - -```cpp -HRESULT GetHashFromHandle ( - [in] HANDLE hFile, - [in, out] unsigned int *piHashAlg, - [out] BYTE *pbHash, - [in] DWORD cchHash, - [out] DWORD *pchHash -); -``` - -## Parameters - - `hFile` - [in] The handle of the file to be hashed. - - `piHashAlg` - [in, out] A constant that specifies the hash algorithm. Use zero for the default algorithm. - - `pbHash` - [out] The returned hash buffer. - - `cchHash` - [in] The requested maximum size of `pbHash`. - - `pchHash` - [out] The size, in bytes, of the returned `pbHash`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Generates a hash over the contents of the file with the specified file handle, using the specified hash algorithm. + + This function has been deprecated. Use the [ICLRStrongName::GetHashFromHandle](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md) method instead. + +## Syntax + +```cpp +HRESULT GetHashFromHandle ( + [in] HANDLE hFile, + [in, out] unsigned int *piHashAlg, + [out] BYTE *pbHash, + [in] DWORD cchHash, + [out] DWORD *pchHash +); +``` + +## Parameters + + `hFile` + [in] The handle of the file to be hashed. + + `piHashAlg` + [in, out] A constant that specifies the hash algorithm. Use zero for the default algorithm. + + `pbHash` + [out] The returned hash buffer. + + `cchHash` + [in] The requested maximum size of `pbHash`. + + `pchHash` + [out] The size, in bytes, of the returned `pbHash`. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [GetHashFromHandle Method](../hosting/iclrstrongname-gethashfromhandle-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [GetHashFromHandle Method](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/index.md b/docs/framework/unmanaged-api/strong-naming/index.md index 1071c7f02c117..66b4619deb633 100644 --- a/docs/framework/unmanaged-api/strong-naming/index.md +++ b/docs/framework/unmanaged-api/strong-naming/index.md @@ -2,7 +2,7 @@ description: "Learn more about: Strong Naming (Unmanaged API Reference)" title: "Strong Naming (Unmanaged API Reference)" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - "strong naming [.NET Framework], using the unmanaged API" - "native API reference [.NET Framework], strong naming" - "unmanaged API reference [.NET Framework], strong naming" @@ -10,97 +10,97 @@ ms.assetid: 428c68b6-a7b4-44be-b280-75905f46612c --- # Strong Naming (Unmanaged API Reference) -The strong naming API enables a client to administer strong name signing for assemblies. - - Signing an assembly with a strong name adds a public key encryption to the file containing the assembly manifest. Strong name signing helps verify name uniqueness, prevents name spoofing, and provides callers with a unique identity when a reference is resolved. However, no level of trust is associated with a strong name. - -## In This Section - +The strong naming API enables a client to administer strong name signing for assemblies. + + Signing an assembly with a strong name adds a public key encryption to the file containing the assembly manifest. Strong name signing helps verify name uniqueness, prevents name spoofing, and provides callers with a unique identity when a reference is resolved. However, no level of trust is associated with a strong name. + +## In This Section + > [!NOTE] -> All of these functions have been deprecated starting with the .NET Framework 4. For suggested alternatives, see the [ICLRStrongName](../hosting/iclrstrongname-interface.md) interface. - - [GetHashFromAssemblyFile Function](gethashfromassemblyfile-function.md) - Gets a hash of the specified assembly file, using the specified hash algorithm. Deprecated starting with the .NET Framework 4. - - [GetHashFromAssemblyFileW Function](gethashfromassemblyfilew-function.md) - Gets a hash of the assembly file specified as a Unicode string, using the specified hash algorithm. Deprecated starting with the .NET Framework 4. - - [GetHashFromBlob Function](gethashfromblob-function.md) - Gets a hash of the assembly at the specified memory address, using the specified hash algorithm. Deprecated starting with the .NET Framework 4. - - [GetHashFromFile Function](gethashfromfile-function.md) - Generates a hash over the contents of the specified file. Deprecated starting with the .NET Framework 4. - - [GetHashFromFileW Function](gethashfromfilew-function.md) - Generates a hash over the contents of the file specified by a Unicode string. Deprecated starting with the .NET Framework 4. - - [GetHashFromHandle Function](gethashfromhandle-function.md) - Generates a hash over the contents of the file with the specified file handle, using the specified hash algorithm. Deprecated starting with the .NET Framework 4. - - [StrongNameCompareAssemblies Function](strongnamecompareassemblies-function.md) - Determines whether two assemblies differ only by their strong name signatures. Deprecated starting with the .NET Framework 4. - - [StrongNameErrorInfo Function](strongnameerrorinfo-function.md) - Gets the last error code that was raised by one of the strong name functions. - - [StrongNameFreeBuffer Function](strongnamefreebuffer-function.md) - Frees memory that was allocated with a previous call to a strong name function such as [StrongNameGetPublicKey](strongnamegetpublickey-function.md), [StrongNameTokenFromPublicKey](strongnametokenfrompublickey-function.md), or [StrongNameSignatureGeneration](strongnamesignaturegeneration-function.md). Deprecated starting with the .NET Framework 4. - - [StrongNameGetBlob Function](strongnamegetblob-function.md) - Fills the specified buffer with the binary representation of the executable file at the specified address. Deprecated starting with the .NET Framework 4. - - [StrongNameGetBlobFromImage Function](strongnamegetblobfromimage-function.md) - Gets a binary representation of the assembly image at the specified memory address. Deprecated starting with the .NET Framework 4. - - [StrongNameGetPublicKey Function](strongnamegetpublickey-function.md) - Gets the public key from a private/public key pair. Deprecated starting with the .NET Framework 4. - - [StrongNameHashSize Function](strongnamehashsize-function.md) - Gets the buffer size required for a hash, using the specified hash algorithm. Deprecated starting with the .NET Framework 4. - - [StrongNameKeyDelete Function](strongnamekeydelete-function.md) - Deletes the specified key container. Deprecated starting with the .NET Framework 4. - - [StrongNameKeyGen Function](strongnamekeygen-function.md) - Creates a new public/private key pair for strong name use. Deprecated starting with the .NET Framework 4. - - [StrongNameKeyGenEx Function](strongnamekeygenex-function.md) - Generates a new public/private key pair with the specified key size for strong name use. Deprecated starting with the .NET Framework 4. - - [StrongNameKeyInstall Function](strongnamekeyinstall-function.md) - Imports a public/private key pair into a container. Deprecated starting with the .NET Framework 4. - - [StrongNameSignatureGeneration Function](strongnamesignaturegeneration-function.md) - Generates a strong name signature for the specified assembly. Deprecated starting with the .NET Framework 4. - - [StrongNameSignatureGenerationEx Function](strongnamesignaturegenerationex-function.md) - Generates a strong name signature for the specified assembly, based on the specified flags. Deprecated starting with the .NET Framework 4. - - [StrongNameSignatureSize Function](strongnamesignaturesize-function.md) - Returns the size of the strong name signature. Deprecated starting with the .NET Framework 4. - - [StrongNameSignatureVerification Function](strongnamesignatureverification-function.md) - Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature, which is verified according to the specified flags. Deprecated starting with the .NET Framework 4. - - [StrongNameSignatureVerificationEx Function](strongnamesignatureverificationex-function.md) - Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature. Deprecated starting with the .NET Framework 4. - - [StrongNameSignatureVerificationFromImage Function](strongnamesignatureverificationfromimage-function.md) - Verifies that an assembly that has already been mapped to memory is valid for the associated public key. Deprecated starting with the .NET Framework 4. - - [StrongNameTokenFromAssembly Function](strongnametokenfromassembly-function.md) - Creates a strong name token from the specified assembly file. Deprecated starting with the .NET Framework 4. - - [StrongNameTokenFromAssemblyEx Function](strongnametokenfromassemblyex-function.md) - Creates a strong name token from the specified assembly file, and returns the public key. Deprecated starting with the .NET Framework 4. - - [StrongNameTokenFromPublicKey Function](strongnametokenfrompublickey-function.md) - Gets a token representing a public key. Deprecated starting with the .NET Framework 4. - - [PublicKeyBlob Structure](publickeyblob-structure.md) - Represents the public key of a public/private key pair in binary format. - +> All of these functions have been deprecated starting with the .NET Framework 4. For suggested alternatives, see the [ICLRStrongName](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) interface. + + [GetHashFromAssemblyFile Function](gethashfromassemblyfile-function.md) + Gets a hash of the specified assembly file, using the specified hash algorithm. Deprecated starting with the .NET Framework 4. + + [GetHashFromAssemblyFileW Function](gethashfromassemblyfilew-function.md) + Gets a hash of the assembly file specified as a Unicode string, using the specified hash algorithm. Deprecated starting with the .NET Framework 4. + + [GetHashFromBlob Function](gethashfromblob-function.md) + Gets a hash of the assembly at the specified memory address, using the specified hash algorithm. Deprecated starting with the .NET Framework 4. + + [GetHashFromFile Function](gethashfromfile-function.md) + Generates a hash over the contents of the specified file. Deprecated starting with the .NET Framework 4. + + [GetHashFromFileW Function](gethashfromfilew-function.md) + Generates a hash over the contents of the file specified by a Unicode string. Deprecated starting with the .NET Framework 4. + + [GetHashFromHandle Function](gethashfromhandle-function.md) + Generates a hash over the contents of the file with the specified file handle, using the specified hash algorithm. Deprecated starting with the .NET Framework 4. + + [StrongNameCompareAssemblies Function](strongnamecompareassemblies-function.md) + Determines whether two assemblies differ only by their strong name signatures. Deprecated starting with the .NET Framework 4. + + [StrongNameErrorInfo Function](strongnameerrorinfo-function.md) + Gets the last error code that was raised by one of the strong name functions. + + [StrongNameFreeBuffer Function](strongnamefreebuffer-function.md) + Frees memory that was allocated with a previous call to a strong name function such as [StrongNameGetPublicKey](strongnamegetpublickey-function.md), [StrongNameTokenFromPublicKey](strongnametokenfrompublickey-function.md), or [StrongNameSignatureGeneration](strongnamesignaturegeneration-function.md). Deprecated starting with the .NET Framework 4. + + [StrongNameGetBlob Function](strongnamegetblob-function.md) + Fills the specified buffer with the binary representation of the executable file at the specified address. Deprecated starting with the .NET Framework 4. + + [StrongNameGetBlobFromImage Function](strongnamegetblobfromimage-function.md) + Gets a binary representation of the assembly image at the specified memory address. Deprecated starting with the .NET Framework 4. + + [StrongNameGetPublicKey Function](strongnamegetpublickey-function.md) + Gets the public key from a private/public key pair. Deprecated starting with the .NET Framework 4. + + [StrongNameHashSize Function](strongnamehashsize-function.md) + Gets the buffer size required for a hash, using the specified hash algorithm. Deprecated starting with the .NET Framework 4. + + [StrongNameKeyDelete Function](strongnamekeydelete-function.md) + Deletes the specified key container. Deprecated starting with the .NET Framework 4. + + [StrongNameKeyGen Function](strongnamekeygen-function.md) + Creates a new public/private key pair for strong name use. Deprecated starting with the .NET Framework 4. + + [StrongNameKeyGenEx Function](strongnamekeygenex-function.md) + Generates a new public/private key pair with the specified key size for strong name use. Deprecated starting with the .NET Framework 4. + + [StrongNameKeyInstall Function](strongnamekeyinstall-function.md) + Imports a public/private key pair into a container. Deprecated starting with the .NET Framework 4. + + [StrongNameSignatureGeneration Function](strongnamesignaturegeneration-function.md) + Generates a strong name signature for the specified assembly. Deprecated starting with the .NET Framework 4. + + [StrongNameSignatureGenerationEx Function](strongnamesignaturegenerationex-function.md) + Generates a strong name signature for the specified assembly, based on the specified flags. Deprecated starting with the .NET Framework 4. + + [StrongNameSignatureSize Function](strongnamesignaturesize-function.md) + Returns the size of the strong name signature. Deprecated starting with the .NET Framework 4. + + [StrongNameSignatureVerification Function](strongnamesignatureverification-function.md) + Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature, which is verified according to the specified flags. Deprecated starting with the .NET Framework 4. + + [StrongNameSignatureVerificationEx Function](strongnamesignatureverificationex-function.md) + Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature. Deprecated starting with the .NET Framework 4. + + [StrongNameSignatureVerificationFromImage Function](strongnamesignatureverificationfromimage-function.md) + Verifies that an assembly that has already been mapped to memory is valid for the associated public key. Deprecated starting with the .NET Framework 4. + + [StrongNameTokenFromAssembly Function](strongnametokenfromassembly-function.md) + Creates a strong name token from the specified assembly file. Deprecated starting with the .NET Framework 4. + + [StrongNameTokenFromAssemblyEx Function](strongnametokenfromassemblyex-function.md) + Creates a strong name token from the specified assembly file, and returns the public key. Deprecated starting with the .NET Framework 4. + + [StrongNameTokenFromPublicKey Function](strongnametokenfrompublickey-function.md) + Gets a token representing a public key. Deprecated starting with the .NET Framework 4. + + [PublicKeyBlob Structure](publickeyblob-structure.md) + Represents the public key of a public/private key pair in binary format. + ## See also -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) - [Unmanaged API Reference](../index.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamecompareassemblies-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamecompareassemblies-function.md index 455267b1b84bf..01905b2e4515d 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamecompareassemblies-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamecompareassemblies-function.md @@ -2,74 +2,72 @@ description: "Learn more about: StrongNameCompareAssemblies Function" title: "StrongNameCompareAssemblies Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameCompareAssemblies" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameCompareAssemblies" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameCompareAssemblies function [.NET Framework strong naming]" ms.assetid: 763f2375-efc6-4219-8806-a3b0567ef72b -topic_type: +topic_type: - "apiref" --- # StrongNameCompareAssemblies Function -Determines whether two assemblies differ only by their strong name signatures. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameCompareAssemblies](../hosting/iclrstrongname-strongnamecompareassemblies-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameCompareAssemblies ( - [in] LPCWSTR wszAssembly1, - [in] LPCWSTR wszAssembly2, - [out] DWORD *pdwResult -); -``` - -## Parameters - - `wszAssembly1` - [in] The path to the first assembly. - - `wszAssembly2` - [in] The path to the second assembly. - - `pdwResult` - [out] One of the following values: - -- `SN_CMP_DIFFERENT` (0) - Specifies that the assemblies contain different data. - -- `SN_CMP_IDENTICAL` (1) - Specifies that the assemblies are exactly the same, including their signatures and checksum. - -- `SN_CMP_SIGONLY` (2) - Specifies that the assemblies differ only by signature and checksum. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## Remarks - - The strong name signature of an assembly consists of the assembly's text name, version, culture, and public key token. - - If the `StrongNameCompareAssemblies` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - +Determines whether two assemblies differ only by their strong name signatures. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameCompareAssemblies](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameCompareAssemblies ( + [in] LPCWSTR wszAssembly1, + [in] LPCWSTR wszAssembly2, + [out] DWORD *pdwResult +); +``` + +## Parameters + + `wszAssembly1` + [in] The path to the first assembly. + + `wszAssembly2` + [in] The path to the second assembly. + + `pdwResult` + [out] One of the following values: + +- `SN_CMP_DIFFERENT` (0) - Specifies that the assemblies contain different data. +- `SN_CMP_IDENTICAL` (1) - Specifies that the assemblies are exactly the same, including their signatures and checksum. +- `SN_CMP_SIGONLY` (2) - Specifies that the assemblies differ only by signature and checksum. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + +## Remarks + + The strong name signature of an assembly consists of the assembly's text name, version, culture, and public key token. + + If the `StrongNameCompareAssemblies` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + ## See also -- [StrongNameCompareAssemblies Method](../hosting/iclrstrongname-strongnamecompareassemblies-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [StrongNameCompareAssemblies Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamefreebuffer-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamefreebuffer-function.md index 47ac1026c963a..3f9147945f866 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamefreebuffer-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamefreebuffer-function.md @@ -2,54 +2,54 @@ description: "Learn more about: StrongNameFreeBuffer Function" title: "StrongNameFreeBuffer Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameFreeBuffer" -api_location: +api_location: - "mscoree.dll" - "mscorsn.dll" - "clr.dll" - "mscorwks.dll" - "mscoreei.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameFreeBuffer" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameFreeBuffer function [.NET Framework strong naming]" ms.assetid: eda21ecf-4734-4f92-aaba-9f34884385db -topic_type: +topic_type: - "apiref" --- # StrongNameFreeBuffer Function -Frees memory that was allocated with a previous call to a strong name function such as [StrongNameGetPublicKey](strongnamegetpublickey-function.md), [StrongNameTokenFromPublicKey](strongnametokenfrompublickey-function.md), or [StrongNameSignatureGeneration](strongnamesignaturegeneration-function.md). - - This function has been deprecated. Use the [ICLRStrongName::StrongNameFreeBuffer](../hosting/iclrstrongname-strongnamefreebuffer-method.md) method instead. - -## Syntax - -```cpp +Frees memory that was allocated with a previous call to a strong name function such as [StrongNameGetPublicKey](strongnamegetpublickey-function.md), [StrongNameTokenFromPublicKey](strongnametokenfrompublickey-function.md), or [StrongNameSignatureGeneration](strongnamesignaturegeneration-function.md). + + This function has been deprecated. Use the [ICLRStrongName::StrongNameFreeBuffer](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md) method instead. + +## Syntax + +```cpp VOID StrongNameFreeBuffer ( - [in] BYTE *pbMemory -); -``` - -## Parameters - - `pbMemory` - [in] A pointer to the memory to free. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [in] BYTE *pbMemory +); +``` + +## Parameters + + `pbMemory` + [in] A pointer to the memory to free. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameFreeBuffer Method](../hosting/iclrstrongname-strongnamefreebuffer-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [StrongNameFreeBuffer Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamegetblob-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamegetblob-function.md index f9abbac4d3e5d..fd068b5cfc287 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamegetblob-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamegetblob-function.md @@ -2,67 +2,67 @@ description: "Learn more about: StrongNameGetBlob Function" title: "StrongNameGetBlob Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameGetBlob" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameGetBlob" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameGetBlob function [.NET Framework strong naming]" ms.assetid: 15d09166-be00-4696-913f-2c1fbc7ac2e1 -topic_type: +topic_type: - "apiref" --- # StrongNameGetBlob Function -Fills the specified buffer with the binary representation of the executable file at the specified address. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameGetBLob](../hosting/iclrstrongname-strongnamegetblob-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameGetBlob ( - [in] LPCWSTR wszFilePath, - [in] BYTE *pbBlob, - [in, out] DWORD *pcbBlob -); -``` - -## Parameters - - `wszFilePath` - [in] A valid path to the executable file to be loaded. - - `pbBlob` - [in] The buffer into which to load the executable file. - - `pcbBlob` - [in, out] The requested maximum size, in bytes, of `pbBlob`. Upon return, the actual size, in bytes, of `pbBlob`. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - If the `StrongNameGetBlob` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Fills the specified buffer with the binary representation of the executable file at the specified address. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameGetBLob](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameGetBlob ( + [in] LPCWSTR wszFilePath, + [in] BYTE *pbBlob, + [in, out] DWORD *pcbBlob +); +``` + +## Parameters + + `wszFilePath` + [in] A valid path to the executable file to be loaded. + + `pbBlob` + [in] The buffer into which to load the executable file. + + `pcbBlob` + [in, out] The requested maximum size, in bytes, of `pbBlob`. Upon return, the actual size, in bytes, of `pbBlob`. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + If the `StrongNameGetBlob` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also -- [StrongNameGetBlob Method](../hosting/iclrstrongname-strongnamegetblob-method.md) -- [StrongNameGetBlobFromImage Method](../hosting/iclrstrongname-strongnamegetblobfromimage-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [StrongNameGetBlob Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md) +- [StrongNameGetBlobFromImage Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamegetblobfromimage-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamegetblobfromimage-function.md index 85ef10483d3c6..8d2b67559268f 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamegetblobfromimage-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamegetblobfromimage-function.md @@ -2,71 +2,71 @@ description: "Learn more about: StrongNameGetBlobFromImage Function" title: "StrongNameGetBlobFromImage Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameGetBlobFromImage" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameGetBlobFromImage" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameGetBlobFromImage function [.NET Framework strong naming]" ms.assetid: 1de658e6-da32-4d01-9097-6f43c92222e1 -topic_type: +topic_type: - "apiref" --- # StrongNameGetBlobFromImage Function -Gets a binary representation of the assembly image at the specified memory address. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameGetBlobFromImage](../hosting/iclrstrongname-strongnamegetblobfromimage-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameGetBlobFromImage ( - [in] BYTE *pbBase, - [in] DWORD dwLength, - [in] BYTE *pbBlob, - [in, out] DWORD *pcbBlob -); -``` - -## Parameters - - `pbBase` - [in] The memory address of the mapped assembly manifest. - - `dwLength` - [in] The size, in bytes, of the image at `pbBase`. - - `pbBlob` - [in] A buffer to contain the binary representation of the image. - - `pcbBlob` - [in, out] The requested maximum size, in bytes, of `pbBlob`. Upon return, the actual size, in bytes, of `pbBlob`. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - If the `StrongNameGetBlobFromImage` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets a binary representation of the assembly image at the specified memory address. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameGetBlobFromImage](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameGetBlobFromImage ( + [in] BYTE *pbBase, + [in] DWORD dwLength, + [in] BYTE *pbBlob, + [in, out] DWORD *pcbBlob +); +``` + +## Parameters + + `pbBase` + [in] The memory address of the mapped assembly manifest. + + `dwLength` + [in] The size, in bytes, of the image at `pbBase`. + + `pbBlob` + [in] A buffer to contain the binary representation of the image. + + `pcbBlob` + [in, out] The requested maximum size, in bytes, of `pbBlob`. Upon return, the actual size, in bytes, of `pbBlob`. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + If the `StrongNameGetBlobFromImage` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameGetBlobFromImage Method](../hosting/iclrstrongname-strongnamegetblobfromimage-method.md) -- [StrongNameGetBlob Method](../hosting/iclrstrongname-strongnamegetblob-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [StrongNameGetBlobFromImage Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md) +- [StrongNameGetBlob Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamegetpublickey-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamegetpublickey-function.md index 1b746b7a8f41c..98d11b89d68fe 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamegetpublickey-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamegetpublickey-function.md @@ -2,83 +2,83 @@ description: "Learn more about: StrongNameGetPublicKey Function" title: "StrongNameGetPublicKey Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameGetPublicKey" -api_location: +api_location: - "mscoree.dll" - "mscorsn.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameGetPublicKey" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameGetPublicKey function [.NET Framework strong naming]" ms.assetid: 5b58c87f-3f72-40df-9b9a-291076931cc3 -topic_type: +topic_type: - "apiref" --- # StrongNameGetPublicKey Function -Gets the public key from a private/public key pair. The key pair can be supplied either as a key container name within a cryptographic service provider (CSP) or as a raw collection of bytes. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameGetPublicKey](../hosting/iclrstrongname-strongnamegetpublickey-method.md) method instead. - -## Syntax - -```cpp +Gets the public key from a private/public key pair. The key pair can be supplied either as a key container name within a cryptographic service provider (CSP) or as a raw collection of bytes. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameGetPublicKey](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md) method instead. + +## Syntax + +```cpp BOOLEAN StrongNameGetPublicKey ( - [in] LPCWSTR szKeyContainer, - [in] BYTE *pbKeyBlob, - [in] ULONG cbKeyBlob, - [out] BYTE **ppbPublicKeyBlob, - [out] ULONG *pcbPublicKeyBlob -); -``` - -## Parameters - - `szKeyContainer` - [in] The name of the key container that contains the public/private key pair. If `pbKeyBlob` is null, `szKeyContainer` must specify a valid container within the CSP. In this case, `StrongNameGetPublicKey` extracts the public key from the key pair stored in the container. - - If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). - - The keys must be 1024-bit Rivest-Shamir-Adleman (RSA) signing keys. No other types of keys are supported at this time. - - `pbKeyBlob` - [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `szKeyContainer` is assumed to contain the key pair. - - `cbKeyBlob` - [in] The size, in bytes, of `pbKeyBlob`. - - `ppbPublicKeyBlob` - [out] The returned public key BLOB. The `ppbPublicKeyBlob` parameter is allocated by the common language runtime and returned to the caller. The caller must free the memory by using the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function. - - `pcbPublicKeyBlob` - [out] The size of the returned public key BLOB. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - The public key is contained in a [PublicKeyBlob](publickeyblob-structure.md) structure. - - If the `StrongNameGetPublicKey` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [in] LPCWSTR szKeyContainer, + [in] BYTE *pbKeyBlob, + [in] ULONG cbKeyBlob, + [out] BYTE **ppbPublicKeyBlob, + [out] ULONG *pcbPublicKeyBlob +); +``` + +## Parameters + + `szKeyContainer` + [in] The name of the key container that contains the public/private key pair. If `pbKeyBlob` is null, `szKeyContainer` must specify a valid container within the CSP. In this case, `StrongNameGetPublicKey` extracts the public key from the key pair stored in the container. + + If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). + + The keys must be 1024-bit Rivest-Shamir-Adleman (RSA) signing keys. No other types of keys are supported at this time. + + `pbKeyBlob` + [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `szKeyContainer` is assumed to contain the key pair. + + `cbKeyBlob` + [in] The size, in bytes, of `pbKeyBlob`. + + `ppbPublicKeyBlob` + [out] The returned public key BLOB. The `ppbPublicKeyBlob` parameter is allocated by the common language runtime and returned to the caller. The caller must free the memory by using the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function. + + `pcbPublicKeyBlob` + [out] The size of the returned public key BLOB. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + The public key is contained in a [PublicKeyBlob](publickeyblob-structure.md) structure. + + If the `StrongNameGetPublicKey` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameGetPublicKey Method](../hosting/iclrstrongname-strongnamegetpublickey-method.md) -- [StrongNameTokenFromPublicKey Method](../hosting/iclrstrongname-strongnametokenfrompublickey-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [StrongNameGetPublicKey Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md) +- [StrongNameTokenFromPublicKey Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) - [PublicKeyBlob Structure](publickeyblob-structure.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamehashsize-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamehashsize-function.md index 60627bafc4c1e..112ce83878514 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamehashsize-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamehashsize-function.md @@ -2,62 +2,62 @@ description: "Learn more about: StrongNameHashSize Function" title: "StrongNameHashSize Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameHashSize" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameHashSize" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameHashSize function [.NET Framework strong naming]" ms.assetid: 738c98d7-a60c-45fe-a296-220af05e6991 -topic_type: +topic_type: - "apiref" --- # StrongNameHashSize Function -Gets the buffer size required for a hash, using the specified hash algorithm. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameHashSize](../hosting/iclrstrongname-strongnamehashsize-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameHashSize ( - [in] ULONG ulHashAlg, - [out] DWORD *pcbSize -); -``` - -## Parameters - - `ulHashAlg` - [in] The hash algorithm used to compute the buffer size. - - `pcbSize` - [out] The returned buffer size, in bytes. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - If the `StrongNameHashSize` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets the buffer size required for a hash, using the specified hash algorithm. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameHashSize](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameHashSize ( + [in] ULONG ulHashAlg, + [out] DWORD *pcbSize +); +``` + +## Parameters + + `ulHashAlg` + [in] The hash algorithm used to compute the buffer size. + + `pcbSize` + [out] The returned buffer size, in bytes. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + If the `StrongNameHashSize` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameHashSize Method](../hosting/iclrstrongname-strongnamehashsize-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [StrongNameHashSize Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamekeydelete-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamekeydelete-function.md index 360583928e657..71fbe95d45111 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamekeydelete-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamekeydelete-function.md @@ -21,7 +21,7 @@ topic_type: Deletes the specified key container. -This function has been deprecated. Use the [ICLRStrongName::StrongNameKeyDelete](../hosting/iclrstrongname-strongnamekeydelete-method.md) method instead. +This function has been deprecated. Use the [ICLRStrongName::StrongNameKeyDelete](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md) method instead. ## Syntax @@ -58,6 +58,6 @@ If the `StrongNameKeyDelete` function does not complete successfully, call the [ ## See also -- [StrongNameKeyDelete Method](../hosting/iclrstrongname-strongnamekeydelete-method.md) -- [StrongNameKeyInstall Method](../hosting/iclrstrongname-strongnamekeyinstall-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [StrongNameKeyDelete Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md) +- [StrongNameKeyInstall Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamekeygen-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamekeygen-function.md index 98e16f366066f..0ab47575bcdfb 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamekeygen-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamekeygen-function.md @@ -2,77 +2,77 @@ description: "Learn more about: StrongNameKeyGen Function" title: "StrongNameKeyGen Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameKeyGen" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameKeyGen" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameKeyGen function [.NET Framework strong naming]" ms.assetid: 883e413a-ad2f-4f7f-b1b9-aeb8fe5b65f8 -topic_type: +topic_type: - "apiref" --- # StrongNameKeyGen Function -Creates a new public/private key pair for strong name use. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameKeyGen](../hosting/iclrstrongname-strongnamekeygen-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameKeyGen ( - [in] LPCWSTR wszKeyContainer, - [in] DWORD dwFlags, - [out] BYTE **ppbKeyBlob, - [out] ULONG *pcbKeyBlob -); -``` - -## Parameters - - `wszKeyContainer` - [in] The requested key container name. `wszKeyContainer` must be a non-empty string, or null to generate a temporary name. - - `dwFlags` - [in] Specifies whether to leave the key registered. The following values are supported: - -- 0x00000000 - Used when `wszKeyContainer` is null to generate a temporary key container name. - -- 0x00000001 (`SN_LEAVE_KEY`) - Specifies that the key should be left registered. - - `ppbKeyBlob` - [out] The returned public/private key pair. - - `pcbKeyBlob` - [out] The size, in bytes, of `ppbKeyBlob`. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - The `StrongNameKeyGen` function creates a 1024-bit key. After the key is retrieved, you should call the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function to release the allocated memory. - - If the `StrongNameKeyGen` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Creates a new public/private key pair for strong name use. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameKeyGen](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameKeyGen ( + [in] LPCWSTR wszKeyContainer, + [in] DWORD dwFlags, + [out] BYTE **ppbKeyBlob, + [out] ULONG *pcbKeyBlob +); +``` + +## Parameters + + `wszKeyContainer` + [in] The requested key container name. `wszKeyContainer` must be a non-empty string, or null to generate a temporary name. + + `dwFlags` + [in] Specifies whether to leave the key registered. The following values are supported: + +- 0x00000000 - Used when `wszKeyContainer` is null to generate a temporary key container name. + +- 0x00000001 (`SN_LEAVE_KEY`) - Specifies that the key should be left registered. + + `ppbKeyBlob` + [out] The returned public/private key pair. + + `pcbKeyBlob` + [out] The size, in bytes, of `ppbKeyBlob`. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + The `StrongNameKeyGen` function creates a 1024-bit key. After the key is retrieved, you should call the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function to release the allocated memory. + + If the `StrongNameKeyGen` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameKeyGen Method](../hosting/iclrstrongname-strongnamekeygen-method.md) -- [StrongNameKeyGenEx Method](../hosting/iclrstrongname-strongnamekeygenex-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [StrongNameKeyGen Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md) +- [StrongNameKeyGenEx Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamekeygenex-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamekeygenex-function.md index 5d1cbdbbd5e99..400e373c8303c 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamekeygenex-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamekeygenex-function.md @@ -2,83 +2,83 @@ description: "Learn more about: StrongNameKeyGenEx Function" title: "StrongNameKeyGenEx Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameKeyGenEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameKeyGenEx" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameKeyGenEx function [.NET Framework strong naming]" ms.assetid: 36bd10b9-9857-45f3-8d3b-0da091d6169e -topic_type: +topic_type: - "apiref" --- # StrongNameKeyGenEx Function -Generates a new public/private key pair with the specified key size, for strong name use. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameKeyGenEx](../hosting/iclrstrongname-strongnamekeygenex-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameKeyGenEx ( - [in] LPCWSTR wszKeyContainer, - [in] DWORD dwFlags, - [in] DWORD dwKeySize, - [out] BYTE **ppbKeyBlob, - [out] ULONG *pcbKeyBlob -); -``` - -## Parameters - - `wszKeyContainer` - [in] The requested key container name. `wszKeyContainer` must be a non-empty string, or null to generate a temporary name. - - `dwFlags` - [in] Specifies whether to leave the key registered. The following values are supported: - -- 0x00000000 - Used when `wszKeyContainer` is null to generate a temporary key container name. - -- 0x00000001 (`SN_LEAVE_KEY`) - Specifies that the key should be left registered. - - `dwKeySize` - [in] The requested size of the key, in bits. - - `ppbKeyBlob` - [out] The returned public/private key pair. - - `pcbKeyBlob` - [out] The size, in bytes, of `ppbKeyBlob`. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - The .NET Framework versions 1.0 and 1.1 require a `dwKeySize` of 1024 bits to sign an assembly with a strong name; version 2.0 adds supports for 2048-bit keys. - - After the key is retrieved, you should call the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function to release the allocated memory. - - If the `StrongNameKeyGenEx` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Generates a new public/private key pair with the specified key size, for strong name use. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameKeyGenEx](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameKeyGenEx ( + [in] LPCWSTR wszKeyContainer, + [in] DWORD dwFlags, + [in] DWORD dwKeySize, + [out] BYTE **ppbKeyBlob, + [out] ULONG *pcbKeyBlob +); +``` + +## Parameters + + `wszKeyContainer` + [in] The requested key container name. `wszKeyContainer` must be a non-empty string, or null to generate a temporary name. + + `dwFlags` + [in] Specifies whether to leave the key registered. The following values are supported: + +- 0x00000000 - Used when `wszKeyContainer` is null to generate a temporary key container name. + +- 0x00000001 (`SN_LEAVE_KEY`) - Specifies that the key should be left registered. + + `dwKeySize` + [in] The requested size of the key, in bits. + + `ppbKeyBlob` + [out] The returned public/private key pair. + + `pcbKeyBlob` + [out] The size, in bytes, of `ppbKeyBlob`. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + The .NET Framework versions 1.0 and 1.1 require a `dwKeySize` of 1024 bits to sign an assembly with a strong name; version 2.0 adds supports for 2048-bit keys. + + After the key is retrieved, you should call the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function to release the allocated memory. + + If the `StrongNameKeyGenEx` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameKeyGenEx Method](../hosting/iclrstrongname-strongnamekeygenex-method.md) -- [StrongNameKeyGen Method](../hosting/iclrstrongname-strongnamekeygen-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [StrongNameKeyGenEx Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md) +- [StrongNameKeyGen Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamekeyinstall-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamekeyinstall-function.md index ca205e86cab79..51491b2b2567a 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamekeyinstall-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamekeyinstall-function.md @@ -21,7 +21,7 @@ topic_type: Imports a public/private key pair into a container. -This function has been deprecated. Use the [ICLRStrongName::StrongNameKeyInstall](../hosting/iclrstrongname-strongnamekeyinstall-method.md) method instead. +This function has been deprecated. Use the [ICLRStrongName::StrongNameKeyInstall](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md) method instead. ## Syntax @@ -66,6 +66,6 @@ If the `StrongNameKeyInstall` function does not complete successfully, call the ## See also -- [StrongNameKeyInstall Method](../hosting/iclrstrongname-strongnamekeyinstall-method.md) -- [StrongNameKeyDelete Method](../hosting/iclrstrongname-strongnamekeydelete-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [StrongNameKeyInstall Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md) +- [StrongNameKeyDelete Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamesignaturegeneration-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamesignaturegeneration-function.md index e7a579a9fa2c9..39e7c9dbf87d3 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamesignaturegeneration-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamesignaturegeneration-function.md @@ -2,90 +2,90 @@ description: "Learn more about: StrongNameSignatureGeneration Function" title: "StrongNameSignatureGeneration Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameSignatureGeneration" -api_location: +api_location: - "mscoree.dll" - "mscorsn.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameSignatureGeneration" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameSignatureGeneration function [.NET Framework strong naming]" ms.assetid: 839b765c-3e41-44ce-bf1b-dc10453db18e --- # StrongNameSignatureGeneration Function -Generates a strong name signature for the specified assembly. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameSignatureGeneration](../hosting/iclrstrongname-strongnamesignaturegeneration-method.md) method instead. - -## Syntax - -```cpp +Generates a strong name signature for the specified assembly. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameSignatureGeneration](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md) method instead. + +## Syntax + +```cpp BOOLEAN StrongNameSignatureGeneration ( - [in] LPCWSTR wszFilePath, - [in] LPCWSTR wszKeyContainer, - [in] BYTE *pbKeyBlob, - [in] ULONG cbKeyBlob, - [out] BYTE **ppbSignatureBlob, - [out] ULONG *pcbSignatureBlob -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the file that contains the manifest of the assembly for which the strong name signature will be generated. - - `wszKeyContainer` - [in] The name of the key container that contains the public/private key pair. - - If `pbKeyBlob` is null, `wszKeyContainer` must specify a valid container within the cryptographic service provider (CSP). In this case, the key pair stored in the container is used to sign the file. - - If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). - - The keys must be 1024-bit Rivest-Shamir-Adleman (RSA) signing keys. No other types of keys are supported at this time. - - `pbKeyBlob` - [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `wszKeyContainer` is assumed to contain the key pair. - - `cbKeyBlob` - [in] The size, in bytes, of `pbKeyBlob`. - - `ppbSignatureBlob` - [out] A pointer to the location to which the common language runtime returns the signature. If `ppbSignatureBlob` is null, the runtime stores the signature in the file specified by `wszFilePath`. - - If `ppbSignatureBlob` is not null, the common language runtime allocates space in which to return the signature. The caller must free this space using the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function. - - `pcbSignatureBlob` - [out] The size, in bytes, of the returned signature. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - Specify null for `wszFilePath` to calculate the size of the signature without creating the signature. - - The signature can be stored either directly in the file, or returned to the caller. - - If the `StrongNameSignatureGeneration` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [in] LPCWSTR wszFilePath, + [in] LPCWSTR wszKeyContainer, + [in] BYTE *pbKeyBlob, + [in] ULONG cbKeyBlob, + [out] BYTE **ppbSignatureBlob, + [out] ULONG *pcbSignatureBlob +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the file that contains the manifest of the assembly for which the strong name signature will be generated. + + `wszKeyContainer` + [in] The name of the key container that contains the public/private key pair. + + If `pbKeyBlob` is null, `wszKeyContainer` must specify a valid container within the cryptographic service provider (CSP). In this case, the key pair stored in the container is used to sign the file. + + If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). + + The keys must be 1024-bit Rivest-Shamir-Adleman (RSA) signing keys. No other types of keys are supported at this time. + + `pbKeyBlob` + [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `wszKeyContainer` is assumed to contain the key pair. + + `cbKeyBlob` + [in] The size, in bytes, of `pbKeyBlob`. + + `ppbSignatureBlob` + [out] A pointer to the location to which the common language runtime returns the signature. If `ppbSignatureBlob` is null, the runtime stores the signature in the file specified by `wszFilePath`. + + If `ppbSignatureBlob` is not null, the common language runtime allocates space in which to return the signature. The caller must free this space using the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function. + + `pcbSignatureBlob` + [out] The size, in bytes, of the returned signature. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + Specify null for `wszFilePath` to calculate the size of the signature without creating the signature. + + The signature can be stored either directly in the file, or returned to the caller. + + If the `StrongNameSignatureGeneration` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameSignatureGeneration Method](../hosting/iclrstrongname-strongnamesignaturegeneration-method.md) -- [StrongNameSignatureGenerationEx Method](../hosting/iclrstrongname-strongnamesignaturegenerationex-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [StrongNameSignatureGeneration Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md) +- [StrongNameSignatureGenerationEx Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamesignaturegenerationex-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamesignaturegenerationex-function.md index fb7f01f117337..e21e63dd3a55f 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamesignaturegenerationex-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamesignaturegenerationex-function.md @@ -2,101 +2,101 @@ description: "Learn more about: StrongNameSignatureGenerationEx Function" title: "StrongNameSignatureGenerationEx Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameSignatureGenerationEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameSignatureGenerationEx" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameSignatureGenerationEx function [.NET Framework strong naming]" ms.assetid: 9a75469e-aa49-4e32-ad48-3bafd5202f09 -topic_type: +topic_type: - "apiref" --- # StrongNameSignatureGenerationEx Function -Generates a strong name signature for the specified assembly, according to the specified flags. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameSignatureGenerationEx](../hosting/iclrstrongname-strongnamesignaturegenerationex-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameSignatureGenerationEx ( - [in] LPCWSTR wszFilePath, - [in] LPCWSTR wszKeyContainer, - [in] BYTE *pbKeyBlob, - [in] ULONG cbKeyBlob, - [out] BYTE **ppbSignatureBlob, - [out] ULONG *pcbSignatureBlob, - [in] DWORD dwFlags -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the file that contains the manifest of the assembly for which the strong name signature will be generated. - - `wszKeyContainer` - [in] The name of the key container that contains the public/private key pair. - - If `pbKeyBlob` is null, `wszKeyContainer` must specify a valid container within the cryptographic service provider (CSP). In this case, the key pair stored in the container is used to sign the file. - - If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). - - `pbKeyBlob` - [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `wszKeyContainer` is assumed to contain the key pair. - - `cbKeyBlob` - [in] The size, in bytes, of `pbKeyBlob`. - - `ppbSignatureBlob` - [out] A pointer to the location to which the common language runtime returns the signature. If `ppbSignatureBlob` is null, the runtime stores the signature in the file specified by `wszFilePath`. - - If `ppbSignatureBlob` is not null, the common language runtime allocates space in which to return the signature. The caller must free this space using the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function. - - `pcbSignatureBlob` - [out] The size, in bytes, of the returned signature. - - `dwFlags` - [in] One or more of the following values: - -- `SN_SIGN_ALL_FILES` (0x00000001) - Recompute all hashes for linked modules. - -- `SN_TEST_SIGN` (0x00000002) - Test-sign the assembly. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - Specify null for `wszFilePath` to calculate the size of the signature without creating the signature. - - The signature can be either stored directly in the file, or returned to the caller. - - If `SN_SIGN_ALL_FILES` is specified but a public key is not included (both `pbKeyBlob` and `wszFilePath` are null), hashes for linked modules are recomputed, but the assembly is not re-signed. - - If `SN_TEST_SIGN` is specified, the common language runtime header is not modified to indicate that the assembly is signed with a strong name. - - If the `StrongNameSignatureGenerationEx` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Generates a strong name signature for the specified assembly, according to the specified flags. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameSignatureGenerationEx](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameSignatureGenerationEx ( + [in] LPCWSTR wszFilePath, + [in] LPCWSTR wszKeyContainer, + [in] BYTE *pbKeyBlob, + [in] ULONG cbKeyBlob, + [out] BYTE **ppbSignatureBlob, + [out] ULONG *pcbSignatureBlob, + [in] DWORD dwFlags +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the file that contains the manifest of the assembly for which the strong name signature will be generated. + + `wszKeyContainer` + [in] The name of the key container that contains the public/private key pair. + + If `pbKeyBlob` is null, `wszKeyContainer` must specify a valid container within the cryptographic service provider (CSP). In this case, the key pair stored in the container is used to sign the file. + + If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). + + `pbKeyBlob` + [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `wszKeyContainer` is assumed to contain the key pair. + + `cbKeyBlob` + [in] The size, in bytes, of `pbKeyBlob`. + + `ppbSignatureBlob` + [out] A pointer to the location to which the common language runtime returns the signature. If `ppbSignatureBlob` is null, the runtime stores the signature in the file specified by `wszFilePath`. + + If `ppbSignatureBlob` is not null, the common language runtime allocates space in which to return the signature. The caller must free this space using the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function. + + `pcbSignatureBlob` + [out] The size, in bytes, of the returned signature. + + `dwFlags` + [in] One or more of the following values: + +- `SN_SIGN_ALL_FILES` (0x00000001) - Recompute all hashes for linked modules. + +- `SN_TEST_SIGN` (0x00000002) - Test-sign the assembly. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + Specify null for `wszFilePath` to calculate the size of the signature without creating the signature. + + The signature can be either stored directly in the file, or returned to the caller. + + If `SN_SIGN_ALL_FILES` is specified but a public key is not included (both `pbKeyBlob` and `wszFilePath` are null), hashes for linked modules are recomputed, but the assembly is not re-signed. + + If `SN_TEST_SIGN` is specified, the common language runtime header is not modified to indicate that the assembly is signed with a strong name. + + If the `StrongNameSignatureGenerationEx` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameSignatureGenerationEx Method](../hosting/iclrstrongname-strongnamesignaturegenerationex-method.md) -- [StrongNameSignatureGeneration Method](../hosting/iclrstrongname-strongnamesignaturegeneration-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [StrongNameSignatureGenerationEx Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md) +- [StrongNameSignatureGeneration Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamesignaturesize-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamesignaturesize-function.md index e90f48d6778fa..7d940f24a1d75 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamesignaturesize-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamesignaturesize-function.md @@ -2,66 +2,66 @@ description: "Learn more about: StrongNameSignatureSize Function" title: "StrongNameSignatureSize Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameSignatureSize" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameSignatureSize" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameSignatureSize function [.NET Framework strong naming]" ms.assetid: 4fde4cd0-f53e-4411-a2fe-fc5c54472f95 -topic_type: +topic_type: - "apiref" --- # StrongNameSignatureSize Function -Returns the size of the strong name signature. `StrongNameSignatureSize` is typically used by compilers to determine how much space to reserve in the file when creating a delay-signed assembly. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameSignatureSize](../hosting/iclrstrongname-strongnamesignaturesize-method.md) method instead. - -## Syntax - -```cpp +Returns the size of the strong name signature. `StrongNameSignatureSize` is typically used by compilers to determine how much space to reserve in the file when creating a delay-signed assembly. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameSignatureSize](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md) method instead. + +## Syntax + +```cpp BOOLEAN StrongNameSignatureSize ( - [in] BYTE *pbPublicKeyBlob, + [in] BYTE *pbPublicKeyBlob, [in] ULONG cbPublicKeyBlob, - [in] DWORD *pcbSize + [in] DWORD *pcbSize ); -``` - -## Parameters - - `pbPublicKeyBlob` - [in] A structure of type [PublicKeyBlob](publickeyblob-structure.md) that contains the public portion of the key pair used to generate the strong name signature. - - `cbPublicKeyBlob` - [in] The size, in bytes, of `pbPublicKeyBlob`. - - `pcbSize` - [in] The number of bytes required to store the strong name signature. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - If the `StrongNameSignatureSize` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +``` + +## Parameters + + `pbPublicKeyBlob` + [in] A structure of type [PublicKeyBlob](publickeyblob-structure.md) that contains the public portion of the key pair used to generate the strong name signature. + + `cbPublicKeyBlob` + [in] The size, in bytes, of `pbPublicKeyBlob`. + + `pcbSize` + [in] The number of bytes required to store the strong name signature. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + If the `StrongNameSignatureSize` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameSignatureSize Method](../hosting/iclrstrongname-strongnamesignaturesize-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [StrongNameSignatureSize Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverification-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverification-function.md index 1d556e1553f79..0ddc7d6d4ae39 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverification-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverification-function.md @@ -2,77 +2,77 @@ description: "Learn more about: StrongNameSignatureVerification Function" title: "StrongNameSignatureVerification Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameSignatureVerification" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameSignatureVerification" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameSignatureVerification function [.NET Framework strong naming]" ms.assetid: 933758dd-231e-4382-8819-242c0a13a4b7 -topic_type: +topic_type: - "apiref" --- # StrongNameSignatureVerification Function -Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature, which is verified according to the specified flags. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameSignatureVerification](../hosting/iclrstrongname-strongnamesignatureverification-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameSignatureVerification ( - [in] LPCWSTR wszFilePath, - [in] DWORD dwInFlags, - [out] DWORD *pdwOutFlags -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the portable executable (.dll or .exe) file for the assembly to verify. - - `dwInFlags` - [in] Flags to modify the verification behavior. The following values are supported: - -- `SN_INFLAG_FORCE_VER` (0x00000001) - Forces verification even if it is necessary to override registry settings. - -- `SN_INFLAG_INSTALL` (0x00000002) - Specifies that this is the first time the manifest is verified. - -- `SN_INFLAG_ADMIN_ACCESS` (0x00000004) - Specifies that the cache will allow access only to users who have administrative privileges. - -- `SN_INFLAG_USER_ACCESS` (0x00000008) - Specifies that the assembly will be accessible only to the current user. - -- `SN_INFLAG_ALL_ACCESS` (0x00000010) - Specifies that the cache will provide no guarantees of access restriction. - -- `SN_INFLAG_RUNTIME` (0x80000000) - Reserved for internal debugging. - - `pdwOutFlags` - [out] Flags indicating whether the strong name signature was verified. The following value is supported: - -- `SN_OUTFLAG_WAS_VERIFIED` (0x00000001) - This value is set to `false` to specify that the verification succeeded due to registry settings. - -## Return Value - - `true` if the verification was successful; otherwise, `false`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature, which is verified according to the specified flags. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameSignatureVerification](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameSignatureVerification ( + [in] LPCWSTR wszFilePath, + [in] DWORD dwInFlags, + [out] DWORD *pdwOutFlags +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the portable executable (.dll or .exe) file for the assembly to verify. + + `dwInFlags` + [in] Flags to modify the verification behavior. The following values are supported: + +- `SN_INFLAG_FORCE_VER` (0x00000001) - Forces verification even if it is necessary to override registry settings. + +- `SN_INFLAG_INSTALL` (0x00000002) - Specifies that this is the first time the manifest is verified. + +- `SN_INFLAG_ADMIN_ACCESS` (0x00000004) - Specifies that the cache will allow access only to users who have administrative privileges. + +- `SN_INFLAG_USER_ACCESS` (0x00000008) - Specifies that the assembly will be accessible only to the current user. + +- `SN_INFLAG_ALL_ACCESS` (0x00000010) - Specifies that the cache will provide no guarantees of access restriction. + +- `SN_INFLAG_RUNTIME` (0x80000000) - Reserved for internal debugging. + + `pdwOutFlags` + [out] Flags indicating whether the strong name signature was verified. The following value is supported: + +- `SN_OUTFLAG_WAS_VERIFIED` (0x00000001) - This value is set to `false` to specify that the verification succeeded due to registry settings. + +## Return Value + + `true` if the verification was successful; otherwise, `false`. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameSignatureVerification Method](../hosting/iclrstrongname-strongnamesignatureverification-method.md) -- [StrongNameSignatureVerificationEx Method](../hosting/iclrstrongname-strongnamesignatureverificationex-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [StrongNameSignatureVerification Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md) +- [StrongNameSignatureVerificationEx Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverificationex-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverificationex-function.md index 3b793d1f8c696..bca1fe54d19f1 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverificationex-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverificationex-function.md @@ -2,68 +2,68 @@ description: "Learn more about: StrongNameSignatureVerificationEx Function" title: "StrongNameSignatureVerificationEx Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameSignatureVerificationEx" -api_location: +api_location: - "mscoree.dll" - "mscorwks.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameSignatureVerificationEx" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameSignatureVerificationEx function [.NET Framework strong naming]" ms.assetid: cfe4b634-18bf-44b8-9773-d94fb7e8a480 -topic_type: +topic_type: - "apiref" --- # StrongNameSignatureVerificationEx Function -Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameSignatureVerificationEx](../hosting/iclrstrongname-strongnamesignatureverificationex-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameSignatureVerificationEx ( - [in] LPCWSTR wszFilePath, - [in] BOOLEAN fForceVerification, - [out] BOOLEAN *pfWasVerified -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the portable executable (.exe or .dll) file for the assembly to be verified. - - `fForceVerification` - [in] `true` to perform verification, even if it is necessary to override registry settings; otherwise, `false`. - - `pfWasVerified` - [out] `true` if the strong name signature was verified; otherwise, `false`. `pfWasVerified` is also set to `false` if the verification was successful due to registry settings. - -## Return Value - - `true` if the verification was successful; otherwise, `false`. - -## Remarks - - `StrongNameSignatureVerificationEx` provides a capability similar to the [StrongNameSignatureVerification](strongnamesignatureverification-function.md) function. However, the second input parameter and the output parameter for `StrongNameSignatureVerificationEx` are of type `BOOLEAN` instead of `DWORD`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in mscoree.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameSignatureVerificationEx](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameSignatureVerificationEx ( + [in] LPCWSTR wszFilePath, + [in] BOOLEAN fForceVerification, + [out] BOOLEAN *pfWasVerified +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the portable executable (.exe or .dll) file for the assembly to be verified. + + `fForceVerification` + [in] `true` to perform verification, even if it is necessary to override registry settings; otherwise, `false`. + + `pfWasVerified` + [out] `true` if the strong name signature was verified; otherwise, `false`. `pfWasVerified` is also set to `false` if the verification was successful due to registry settings. + +## Return Value + + `true` if the verification was successful; otherwise, `false`. + +## Remarks + + `StrongNameSignatureVerificationEx` provides a capability similar to the [StrongNameSignatureVerification](strongnamesignatureverification-function.md) function. However, the second input parameter and the output parameter for `StrongNameSignatureVerificationEx` are of type `BOOLEAN` instead of `DWORD`. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in mscoree.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameSignatureVerificationEx Method](../hosting/iclrstrongname-strongnamesignatureverificationex-method.md) -- [StrongNameSignatureVerification Method](../hosting/iclrstrongname-strongnamesignatureverification-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [StrongNameSignatureVerificationEx Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md) +- [StrongNameSignatureVerification Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverificationfromimage-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverificationfromimage-function.md index 63e49d3c65244..5e9ed0ab92097 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverificationfromimage-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverificationfromimage-function.md @@ -2,84 +2,84 @@ description: "Learn more about: StrongNameSignatureVerificationFromImage Function" title: "StrongNameSignatureVerificationFromImage Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameSignatureVerificationFromImage" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameSignatureVerificationFromImage" -helpviewer_keywords: +helpviewer_keywords: - "StrongnameSignatureVerificationFromImage function [.NET Framework strong naming]" ms.assetid: 9fb144d2-07e0-4a0e-8e05-907bbb6c9e03 -topic_type: +topic_type: - "apiref" --- # StrongNameSignatureVerificationFromImage Function -Verifies that an assembly that has already been mapped to memory is valid for the associated public key. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameVerificationFromImage](../hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameSignatureVerificationFromImage ( - [in] BYTE *pbBase, - [in] DWORD dwLength, - [in] DWORD dwInFlags, - [out] DWORD *pdwOutFlags -); -``` - -## Parameters - - `pbBase` - [in] The relative virtual address of the mapped assembly manifest. - - `dwLength` - [in] The size, in bytes, of the mapped image. - - `dwInFlags` - [in] Flags that influence verification behavior. The following values are supported: - -- `SN_INFLAG_FORCE_VER` (0x00000001) - Forces verification even if it is necessary to override registry settings. - -- `SN_INFLAG_INSTALL` (0x00000002) - Specifies that this is the first verification performed on this image. - -- `SN_INFLAG_ADMIN_ACCESS` (0x00000004) - Specifies that the cache will allow access only to users who have administrative privileges. - -- `SN_INFLAG_USER_ACCESS` (0x00000008) - Specifies that the assembly will be accessible only to the current user. - -- `SN_INFLAG_ALL_ACCESS` (0x00000010) - Specifies that the cache will provide no guarantees of access restriction. - -- `SN_INFLAG_RUNTIME` (0x80000000) - Reserved for internal debugging. - - `pdwOutFlags` - [out] A flag for additional output information. The following value is supported: - -- `SN_OUTFLAG_WAS_VERIFIED` (0x00000001) - This value is set to `false` to specify that the verification succeeded due to registry settings. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - If the `StrongNameSignatureVerificationFromImage` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in mscoree.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Verifies that an assembly that has already been mapped to memory is valid for the associated public key. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameVerificationFromImage](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameSignatureVerificationFromImage ( + [in] BYTE *pbBase, + [in] DWORD dwLength, + [in] DWORD dwInFlags, + [out] DWORD *pdwOutFlags +); +``` + +## Parameters + + `pbBase` + [in] The relative virtual address of the mapped assembly manifest. + + `dwLength` + [in] The size, in bytes, of the mapped image. + + `dwInFlags` + [in] Flags that influence verification behavior. The following values are supported: + +- `SN_INFLAG_FORCE_VER` (0x00000001) - Forces verification even if it is necessary to override registry settings. + +- `SN_INFLAG_INSTALL` (0x00000002) - Specifies that this is the first verification performed on this image. + +- `SN_INFLAG_ADMIN_ACCESS` (0x00000004) - Specifies that the cache will allow access only to users who have administrative privileges. + +- `SN_INFLAG_USER_ACCESS` (0x00000008) - Specifies that the assembly will be accessible only to the current user. + +- `SN_INFLAG_ALL_ACCESS` (0x00000010) - Specifies that the cache will provide no guarantees of access restriction. + +- `SN_INFLAG_RUNTIME` (0x80000000) - Reserved for internal debugging. + + `pdwOutFlags` + [out] A flag for additional output information. The following value is supported: + +- `SN_OUTFLAG_WAS_VERIFIED` (0x00000001) - This value is set to `false` to specify that the verification succeeded due to registry settings. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + If the `StrongNameSignatureVerificationFromImage` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in mscoree.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameSignatureVerificationFromImage Method](../hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [StrongNameSignatureVerificationFromImage Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnametokenfromassembly-function.md b/docs/framework/unmanaged-api/strong-naming/strongnametokenfromassembly-function.md index 444bc965e67bc..9ac20e98fa5f1 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnametokenfromassembly-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnametokenfromassembly-function.md @@ -2,71 +2,71 @@ description: "Learn more about: StrongNameTokenFromAssembly Function" title: "StrongNameTokenFromAssembly Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameTokenFromAssembly" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameTokenFromAssembly" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameTokenFromAssembly function [.NET Framework strong naming]" ms.assetid: 0a4b47ee-02f6-4a98-864e-a6f11ca3f2d9 -topic_type: +topic_type: - "apiref" --- # StrongNameTokenFromAssembly Function -Creates a strong name token from the specified assembly file. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameTokenFromAssembly](../hosting/iclrstrongname-strongnametokenfromassembly-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameTokenFromAssembly ( - [in] LPCWSTR wszFilePath, - [out] BYTE **ppbStrongNameToken, - [out] ULONG *pcbStrongNameToken -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the portable executable (PE) file for the assembly. - - `ppbStrongNameToken` - [out] The returned strong name token. - - `pcbStrongNameToken` - [out] The size, in bytes, of the strong name token. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - A strong name token is the shortened form of a public key. The token is a 64-bit hash that is created from the public key used to sign the assembly. The token is a part of the strong name for the assembly, and can be read from the assembly metadata. - - After the token is created, you should call the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function to release the allocated memory. - - If the `StrongNameTokenFromAssembly` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in mscoree.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Creates a strong name token from the specified assembly file. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameTokenFromAssembly](../../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameTokenFromAssembly ( + [in] LPCWSTR wszFilePath, + [out] BYTE **ppbStrongNameToken, + [out] ULONG *pcbStrongNameToken +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the portable executable (PE) file for the assembly. + + `ppbStrongNameToken` + [out] The returned strong name token. + + `pcbStrongNameToken` + [out] The size, in bytes, of the strong name token. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + A strong name token is the shortened form of a public key. The token is a 64-bit hash that is created from the public key used to sign the assembly. The token is a part of the strong name for the assembly, and can be read from the assembly metadata. + + After the token is created, you should call the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function to release the allocated memory. + + If the `StrongNameTokenFromAssembly` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in mscoree.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameTokenFromAssembly Method](../hosting/iclrstrongname-strongnametokenfromassembly-method.md) -- [StrongNameTokenFromAssemblyEx Method](../hosting/iclrstrongname-strongnametokenfromassemblyex-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [StrongNameTokenFromAssembly Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md) +- [StrongNameTokenFromAssemblyEx Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnametokenfromassemblyex-function.md b/docs/framework/unmanaged-api/strong-naming/strongnametokenfromassemblyex-function.md index 85852b0858807..e286fb9071f89 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnametokenfromassemblyex-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnametokenfromassemblyex-function.md @@ -2,79 +2,79 @@ description: "Learn more about: StrongNameTokenFromAssemblyEx Function" title: "StrongNameTokenFromAssemblyEx Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameTokenFromAssemblyEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameTokenFromAssemblyEx" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameTokenFromAssemblyEx function [.NET Framework strong naming]" ms.assetid: 67a8a9f2-dee3-44b2-a1c0-f307a3bdf90f -topic_type: +topic_type: - "apiref" --- # StrongNameTokenFromAssemblyEx Function -Creates a strong name token from the specified assembly file, and returns the public key that the token represents. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameTokenFromAssemblyEx](../hosting/iclrstrongname-strongnametokenfromassemblyex-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameTokenFromAssemblyEx ( - [in] LPCWSTR wszFilePath, - [out] BYTE **ppbStrongNameToken, - [out] ULONG *pcbStrongNameToken, - [out] BYTE **ppbPublicKeyBlob, - [out] ULONG *pcbPublicKeyBlob -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the portable executable (PE) file for the assembly. - - `ppbStrongNameToken` - [out] The returned strong name token. - - `pcbStrongNameToken` - [out] The size, in bytes, of the strong name token. - - `ppbPublicKeyBlob` - [out] The returned public key. - - `pcbPublicKeyBlob` - [out] The size, in bytes, of the public key. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - A strong name token is the shortened form of a public key. The token is a 64-bit hash that is created from the public key used to sign the assembly. The token is a part of the strong name for the assembly, and can be read from the assembly metadata. - - After the key is retrieved and the token is created, you should call the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function to release the allocated memory. - - If the `StrongNameTokenFromAssemblyEx` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in mscoree.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Creates a strong name token from the specified assembly file, and returns the public key that the token represents. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameTokenFromAssemblyEx](../../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameTokenFromAssemblyEx ( + [in] LPCWSTR wszFilePath, + [out] BYTE **ppbStrongNameToken, + [out] ULONG *pcbStrongNameToken, + [out] BYTE **ppbPublicKeyBlob, + [out] ULONG *pcbPublicKeyBlob +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the portable executable (PE) file for the assembly. + + `ppbStrongNameToken` + [out] The returned strong name token. + + `pcbStrongNameToken` + [out] The size, in bytes, of the strong name token. + + `ppbPublicKeyBlob` + [out] The returned public key. + + `pcbPublicKeyBlob` + [out] The size, in bytes, of the public key. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + A strong name token is the shortened form of a public key. The token is a 64-bit hash that is created from the public key used to sign the assembly. The token is a part of the strong name for the assembly, and can be read from the assembly metadata. + + After the key is retrieved and the token is created, you should call the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function to release the allocated memory. + + If the `StrongNameTokenFromAssemblyEx` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in mscoree.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameTokenFromAssemblyEx Method](../hosting/iclrstrongname-strongnametokenfromassemblyex-method.md) -- [StrongNameTokenFromAssembly Method](../hosting/iclrstrongname-strongnametokenfromassembly-method.md) -- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) +- [StrongNameTokenFromAssemblyEx Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md) +- [StrongNameTokenFromAssembly Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md) +- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnametokenfrompublickey-function.md b/docs/framework/unmanaged-api/strong-naming/strongnametokenfrompublickey-function.md index c53be651407e6..f8950de3a38ea 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnametokenfrompublickey-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnametokenfrompublickey-function.md @@ -2,77 +2,77 @@ description: "Learn more about: StrongNameTokenFromPublicKey Function" title: "StrongNameTokenFromPublicKey Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameTokenFromPublicKey" -api_location: +api_location: - "mscoree.dll" - "mscorsn.dll" - "clr.dll" - "mscorwks.dll" - "mscoreei.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "StrongNameTokenFromPublicKey" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameTokenFromPublicKey function [.NET Framework strong naming]" ms.assetid: 997e9e57-abb2-4217-bf20-1df621a75add -topic_type: +topic_type: - "apiref" --- # StrongNameTokenFromPublicKey Function -Gets a token representing a public key. A strong name token is the shortened form of a public key. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameTokenFromPublicKey](../hosting/iclrstrongname-strongnametokenfrompublickey-method.md) method instead. - -## Syntax - -```cpp +Gets a token representing a public key. A strong name token is the shortened form of a public key. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameTokenFromPublicKey](../../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md) method instead. + +## Syntax + +```cpp BOOLEAN StrongNameTokenFromPublicKey ( - [in] BYTE *pbPublicKeyBlob, - [in] ULONG cbPublicKeyBlob, - [out] BYTE **ppbStrongNameToken, - [out] ULONG *pcbStrongNameToken -); -``` - -## Parameters - - `pbPublicKeyBlob` - [in] A structure of type [PublicKeyBlob](publickeyblob-structure.md) that contains the public portion of the key pair used to generate the strong name signature. - - `cbPublicKeyBlob` - [in] The size, in bytes, of `pbPublicKeyBlob`. - - `ppbStrongNameToken` - [out] The strong name token corresponding to the key passed in `pbPublicKeyBlob`. The common language runtime allocates the memory in which to return the token. The caller must free this memory by using the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function. - - `pcbStrongNameToken` - [out] The size, in bytes, of the returned strong name token. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - A strong name token is the shortened form of a public key used to save space when storing key information in metadata. Specifically, strong name tokens are used in assembly references to refer to the dependent assembly. - - If the `StrongNameTokenFromPublicKey` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in mscoree.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [in] BYTE *pbPublicKeyBlob, + [in] ULONG cbPublicKeyBlob, + [out] BYTE **ppbStrongNameToken, + [out] ULONG *pcbStrongNameToken +); +``` + +## Parameters + + `pbPublicKeyBlob` + [in] A structure of type [PublicKeyBlob](publickeyblob-structure.md) that contains the public portion of the key pair used to generate the strong name signature. + + `cbPublicKeyBlob` + [in] The size, in bytes, of `pbPublicKeyBlob`. + + `ppbStrongNameToken` + [out] The strong name token corresponding to the key passed in `pbPublicKeyBlob`. The common language runtime allocates the memory in which to return the token. The caller must free this memory by using the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function. + + `pcbStrongNameToken` + [out] The size, in bytes, of the returned strong name token. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + A strong name token is the shortened form of a public key used to save space when storing key information in metadata. Specifically, strong name tokens are used in assembly references to refer to the dependent assembly. + + If the `StrongNameTokenFromPublicKey` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in mscoree.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameTokenFromPublicKey Method](../hosting/iclrstrongname-strongnametokenfrompublickey-method.md) -- [StrongNameGetPublicKey Method](../hosting/iclrstrongname-strongnamegetpublickey-method.md) +- [StrongNameTokenFromPublicKey Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md) +- [StrongNameGetPublicKey Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md) - [PublicKeyBlob Structure](publickeyblob-structure.md) From 2430742fbb33f3c5315c9d3a6983fc8bfea2c9c6 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Thu, 26 Jun 2025 18:47:33 +0200 Subject: [PATCH 10/20] more human edits --- ...edebugginginterfacefromversion-function.md | 4 +- .../deprecated-clr-hosting-functions.md | 9 +-- docs/core/unmanaged-api/hosting/index.md | 2 + ...emblyimport-findassembliesbyname-method.md | 4 +- ...blyimport-findexportedtypebyname-method.md | 2 +- ...mport-findmanifestresourcebyname-method.md | 2 +- docs/core/unmanaged-api/metadata/index.md | 24 +++--- .../unmanaged-api/alink/addfile-method.md | 14 ++-- .../unmanaged-api/alink/addfile2-method.md | 4 +- .../unmanaged-api/alink/addimport-method.md | 2 +- .../alink/embedresource-method.md | 2 +- .../alink/exportnestedtype-method.md | 2 +- .../unmanaged-api/alink/exporttype-method.md | 2 +- .../alink/exporttypeforwarder-method.md | 2 +- .../unmanaged-api/alink/getscope-method.md | 2 +- .../unmanaged-api/alink/getscope2-method.md | 2 +- .../unmanaged-api/alink/ialink2-interface.md | 2 +- .../unmanaged-api/alink/importfile-method.md | 2 +- .../unmanaged-api/alink/importfile2-method.md | 4 +- .../alink/importfileex-method.md | 4 +- .../alink/importfileex2-method.md | 6 +- .../unmanaged-api/alink/importtypes-method.md | 2 +- .../alink/importtypes2-method.md | 2 +- .../unmanaged-api/alink/init-method.md | 4 +- .../alink/linkresource-method.md | 2 +- .../alink/setassemblyfile-method.md | 4 +- .../alink/setassemblyfile2-method.md | 4 +- .../unmanaged-api/alink/setpekind-method.md | 4 +- ...n-getmodulefrommetadatainterface-method.md | 2 +- .../icordebugclass-gettoken-method.md | 2 +- .../icordebugeval-createvalue-method.md | 2 +- ...ilframe2-enumeratetypeparameters-method.md | 2 +- ...debugmetadatalocator-getmetadata-method.md | 2 +- ...debugmodule-getmetadatainterface-method.md | 6 +- .../icordebugmodule-gettoken-method.md | 4 +- .../icordebugmodule2-applychanges-method.md | 8 +- ...ss6-enablevirtualmodulesplitting-method.md | 4 +- ...typedefinition-getcorelementtype-method.md | 2 +- .../clr-profilers-and-windows-store-apps.md | 8 +- ...allback3-profilerdetachsucceeded-method.md | 2 +- ...rcallback6-getassemblyreferences-method.md | 2 +- ...orprofilerinfo-getmodulemetadata-method.md | 4 +- ...corprofilerinfo2-getclassidinfo2-method.md | 2 +- ...icorprofilerinfo2-getclasslayout-method.md | 2 +- ...orprofilerinfo2-getfunctioninfo2-method.md | 2 +- ...icorprofilerinfo3-getmoduleinfo2-method.md | 2 +- .../icorprofilerinfo7-applymetadata-method.md | 16 ++-- ...ilerinfo8-getdynamicfunctioninfo-method.md | 2 +- .../wcf/migrating-from-net-remoting-to-wcf.md | 74 +++++++++---------- 49 files changed, 133 insertions(+), 136 deletions(-) diff --git a/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md b/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md index 3fe36f5688a9a..7c33e9f9f005e 100644 --- a/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md +++ b/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md @@ -18,7 +18,7 @@ topic_type: --- # CreateDebuggingInterfaceFromVersion Function (.NET Framework) -Creates an [ICorDebug](../../../framework/debuggingicordebug-interface.md) object based on the specified version information. +Creates an [ICorDebug](../../../framework/debugging/icordebug-interface.md) object based on the specified version information. This function is obsolete in the .NET Framework 4. Instead, to get an interface for the common language runtime (CLR) 2.0, use the [ICLRRuntimeInfo::GetInterface](iclrruntimeinfo-getinterface-method.md) method and specify the class identifier CLSID_CLRDebuggingLegacy and the interface identifier IID_ICorDebug. To get an interface for CLR 4 or later, call the [CLRCreateInstance](clrcreateinstance-function.md) function and specify the class identifier CLSID_CLRDebugging and the interface identifier IID_ICLRDebugging. @@ -35,7 +35,7 @@ HRESULT CreateDebuggingInterfaceFromVersion ( ## Parameters `iDebuggerVersion`\ - [in] The version of `ICorDebug` that is expected by the debugger. See the [CorDebugInterfaceVersion](../../../framework/debuggingcordebuginterfaceversion-enumeration.md) enumeration for valid values. + [in] The version of `ICorDebug` that is expected by the debugger. See the [CorDebugInterfaceVersion](../../../framework/debugging/cordebuginterfaceversion-enumeration.md) enumeration for valid values. `szDebuggeeVersion`\ [in] The common language runtime version associated with the application or process to be debugged. See the [GetVersionFromProcess](getversionfromprocess-function.md) or [GetRequestedRuntimeVersion](getrequestedruntimeversion-function.md) method for information on retrieving this value. diff --git a/docs/core/unmanaged-api/hosting/deprecated-clr-hosting-functions.md b/docs/core/unmanaged-api/hosting/deprecated-clr-hosting-functions.md index 8a6d0bf0a2106..68ec5e60e081d 100644 --- a/docs/core/unmanaged-api/hosting/deprecated-clr-hosting-functions.md +++ b/docs/core/unmanaged-api/hosting/deprecated-clr-hosting-functions.md @@ -2,17 +2,12 @@ description: "Learn more about: Deprecated CLR Hosting Functions" title: "Deprecated CLR Hosting Functions" ms.date: "03/30/2017" -helpviewer_keywords: - - ".NET Framework 1.1, hosting global static functions" - - "global static functions [.NET Framework hosting], version 2.0" - - ".NET Framework 2.0, hosting global static functions" - - "hosting global static functions [.NET Framework], version 2.0" --- # Deprecated CLR Hosting Functions This section describes the unmanaged global static functions that earlier versions of the hosting API used. - With the exception of the infrastructure functions (`_Cor*` functions), which are used only by the .NET Framework, these functions have been deprecated in the .NET Framework 4. + With the exception of the infrastructure functions (`_Cor*` functions), which are used only by .NET Framework, these functions are deprecated starting in .NET Framework 4. ## Activation functions @@ -98,7 +93,7 @@ This section describes the unmanaged global static functions that earlier versio Obsolete. [CreateDebuggingInterfaceFromVersion Function](createdebugginginterfacefromversion-function.md) - Deprecated. Creates an [ICorDebug](../../../framework/debuggingicordebug-interface.md) object based on the specified version information. + Deprecated. Creates an [ICorDebug](../../../framework/debugging/icordebug-interface.md) object based on the specified version information. [CreateICeeFileGen Function](createiceefilegen-function.md) Deprecated. Creates an [ICeeFileGen](iceefilegen-class.md) object. diff --git a/docs/core/unmanaged-api/hosting/index.md b/docs/core/unmanaged-api/hosting/index.md index 3690543948e0b..6252ee1c363ad 100644 --- a/docs/core/unmanaged-api/hosting/index.md +++ b/docs/core/unmanaged-api/hosting/index.md @@ -11,6 +11,8 @@ helpviewer_keywords: The hosting API enables unmanaged hosts to integrate the common language runtime (CLR) into their applications. +These APIs that can be used with both .NET Framework and .NET. + ## In This Section [Hosting Coclasses](hosting-coclasses.md)\ diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md index ac6eca704bade..6ad929430a545 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md @@ -62,7 +62,7 @@ HRESULT FindAssembliesByName ( ## 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. + 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](../hosting/coinitializeee-function.md) (passing COINITEE_DEFAULT) before calling `FindAssembliesByName`, and then follow with a call to [CoUninitializeCor](../hosting/couninitializecor-function.md). @@ -82,5 +82,5 @@ HRESULT FindAssembliesByName ( ## 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/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md index 0b2d6bf99511b..46712c3f5f0cc 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findexportedtypebyname-method.md @@ -58,4 +58,4 @@ HRESULT FindExportedTypeByName ( ## 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/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md index ba3af4bdb3f34..fd24754a201c8 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findmanifestresourcebyname-method.md @@ -54,4 +54,4 @@ HRESULT FindManifestResourceByName ( ## 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/core/unmanaged-api/metadata/index.md b/docs/core/unmanaged-api/metadata/index.md index 5d3b6253c3cf2..c447c48fdcad5 100644 --- a/docs/core/unmanaged-api/metadata/index.md +++ b/docs/core/unmanaged-api/metadata/index.md @@ -11,21 +11,21 @@ helpviewer_keywords: 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 articles describe APIs that can be used with both .NET Framework and .NET. For .NET Framework-specific unmanaged APIs, see [.NET Framework metadata](../../../framework/unmanaged-api/metadata/index.md). +These APIs that can be used with both .NET Framework and .NET. -## In This Section +## 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 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 Global Static Functions](metadata-global-static-functions.md) - Describes the unmanaged global static functions that the metadata API uses. +[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 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 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. +[Metadata Unions](metadata-unions.md)\ +Describes the unmanaged unions that the metadata API uses. diff --git a/docs/framework/unmanaged-api/alink/addfile-method.md b/docs/framework/unmanaged-api/alink/addfile-method.md index be476bfdbc390..052b40eaf27b6 100644 --- a/docs/framework/unmanaged-api/alink/addfile-method.md +++ b/docs/framework/unmanaged-api/alink/addfile-method.md @@ -35,19 +35,19 @@ HRESULT AddFile( ## Parameters - `AssemblyID` + `AssemblyID`\ Unique ID of the assembly to be augmented. - `pszFilename` + `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-apis/metadata/imetadataassemblyemit-definefile-method.md). + `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-apis/metadata/imetadataemit-interface.md) interface to be used to emit metadata, if necessary. + `pEmitter`\ + [IMetaDataEmit Interface](../../../core/unmanaged-api/metadata/imetadataemit-interface.md) interface to be used to emit metadata, if necessary. - `pFileToken` + `pFileToken`\ Pointer to where the unique ID of the added file will be stored. ## Return Value diff --git a/docs/framework/unmanaged-api/alink/addfile2-method.md b/docs/framework/unmanaged-api/alink/addfile2-method.md index e9999c0cd8718..a67a20ed47a5c 100644 --- a/docs/framework/unmanaged-api/alink/addfile2-method.md +++ b/docs/framework/unmanaged-api/alink/addfile2-method.md @@ -42,10 +42,10 @@ HRESULT AddFile2( Name of the file to be added. `dwFlags` - COM+ `FileDef` flags such as `ffContainsNoMetaData` and `ffWriteable`. `dwFlags` is passed to [DefineFile Method](../../../core/unmanaged-apis/metadata/imetadataassemblyemit-definefile-method.md). + 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-apis/metadata/imetadataemit2-interface.md) interface. + Interface to [IMetaDataEmit2 Interface](../../../core/unmanaged-api/metadata/imetadataemit2-interface.md) interface. `pFileToken` Receives ID for the file being added. diff --git a/docs/framework/unmanaged-api/alink/addimport-method.md b/docs/framework/unmanaged-api/alink/addimport-method.md index d82d239d5aa5f..f71bc7acd2d5c 100644 --- a/docs/framework/unmanaged-api/alink/addimport-method.md +++ b/docs/framework/unmanaged-api/alink/addimport-method.md @@ -41,7 +41,7 @@ HRESULT AddImport( 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-apis/metadata/imetadataassemblyemit-definefile-method.md). + 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. diff --git a/docs/framework/unmanaged-api/alink/embedresource-method.md b/docs/framework/unmanaged-api/alink/embedresource-method.md index c92599ea539e6..48b296128da55 100644 --- a/docs/framework/unmanaged-api/alink/embedresource-method.md +++ b/docs/framework/unmanaged-api/alink/embedresource-method.md @@ -48,7 +48,7 @@ HRESULT EmbedResource( Offset of resource from RVA. `dwFlags` - Accessibility flags such as `mrPublic` and `mrPrivate`. These flags may be passed to [DefineExportedType Method](../../../core/unmanaged-apis/metadata/imetadataassemblyemit-defineexportedtype-method.md). + 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 diff --git a/docs/framework/unmanaged-api/alink/exportnestedtype-method.md b/docs/framework/unmanaged-api/alink/exportnestedtype-method.md index a596c153b087a..812d96c37cc7d 100644 --- a/docs/framework/unmanaged-api/alink/exportnestedtype-method.md +++ b/docs/framework/unmanaged-api/alink/exportnestedtype-method.md @@ -53,7 +53,7 @@ HRESULT ExportNestedType( Fully qualified type name to export. `dwFlags` - `ComType` flags such as `tdPublic` or `tdNested`. This value may be passed to [DefineExportedType Method](../../../core/unmanaged-apis/metadata/imetadataassemblyemit-defineexportedtype-method.md). + `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. diff --git a/docs/framework/unmanaged-api/alink/exporttype-method.md b/docs/framework/unmanaged-api/alink/exporttype-method.md index 0d75f7702fea1..12d9ee9707b78 100644 --- a/docs/framework/unmanaged-api/alink/exporttype-method.md +++ b/docs/framework/unmanaged-api/alink/exporttype-method.md @@ -48,7 +48,7 @@ HRESULT ExportType( 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-apis/metadata/imetadataassemblyemit-defineexportedtype-method.md). + `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. diff --git a/docs/framework/unmanaged-api/alink/exporttypeforwarder-method.md b/docs/framework/unmanaged-api/alink/exporttypeforwarder-method.md index 5afbe3b1a5c10..38ab04c5ae872 100644 --- a/docs/framework/unmanaged-api/alink/exporttypeforwarder-method.md +++ b/docs/framework/unmanaged-api/alink/exporttypeforwarder-method.md @@ -40,7 +40,7 @@ HRESULT ExportTypeForwarder( Fully qualified type name to export. `dwFlags` - `ComType` flags such as `tdPublic` or `tdNested`. This value may be passed to [DefineExportedType Method](../../../core/unmanaged-apis/metadata/imetadataassemblyemit-defineexportedtype-method.md). + `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. diff --git a/docs/framework/unmanaged-api/alink/getscope-method.md b/docs/framework/unmanaged-api/alink/getscope-method.md index 09438cfd91df2..d3de3b3d3ceb7 100644 --- a/docs/framework/unmanaged-api/alink/getscope-method.md +++ b/docs/framework/unmanaged-api/alink/getscope-method.md @@ -43,7 +43,7 @@ HRESULT GetScope( Zero-based scope to import. `ppImportScope` - Receives [IMetaDataImport Interface](../../../core/unmanaged-apis/metadata/imetadataimport-interface.md) interface for the scope. + Receives [IMetaDataImport Interface](../../../core/unmanaged-api/metadata/imetadataimport-interface.md) interface for the scope. ## Return Value diff --git a/docs/framework/unmanaged-api/alink/getscope2-method.md b/docs/framework/unmanaged-api/alink/getscope2-method.md index 0e1da2f1ee11d..2181db201469b 100644 --- a/docs/framework/unmanaged-api/alink/getscope2-method.md +++ b/docs/framework/unmanaged-api/alink/getscope2-method.md @@ -43,7 +43,7 @@ HRESULT GetScope2( Zero-based scope to import. `ppImportScope` - Receives pointer to [IMetaDataImport2 Interface](../../../core/unmanaged-apis/metadata/imetadataimport2-interface.md) interface for indicated scope. + Receives pointer to [IMetaDataImport2 Interface](../../../core/unmanaged-api/metadata/imetadataimport2-interface.md) interface for indicated scope. ## Return Value diff --git a/docs/framework/unmanaged-api/alink/ialink2-interface.md b/docs/framework/unmanaged-api/alink/ialink2-interface.md index 81741d616bc4b..f1722ff5c2a45 100644 --- a/docs/framework/unmanaged-api/alink/ialink2-interface.md +++ b/docs/framework/unmanaged-api/alink/ialink2-interface.md @@ -10,7 +10,7 @@ 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](../../../core/unmanaged-apis/metadata/imetadataemit2-interface.md). Additionally, IALink2 declares methods that provide additional usage flexibility over the original IALink interfaces. +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 diff --git a/docs/framework/unmanaged-api/alink/importfile-method.md b/docs/framework/unmanaged-api/alink/importfile-method.md index f105b4e482f98..81f9a184f58ca 100644 --- a/docs/framework/unmanaged-api/alink/importfile-method.md +++ b/docs/framework/unmanaged-api/alink/importfile-method.md @@ -48,7 +48,7 @@ HRESULT ImportFile( 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-apis/metadata/imetadataassemblyimport-interface.md). Can be NULL if the file is not an assembly. + 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. diff --git a/docs/framework/unmanaged-api/alink/importfile2-method.md b/docs/framework/unmanaged-api/alink/importfile2-method.md index c4314f98448ac..17139bcde61b8 100644 --- a/docs/framework/unmanaged-api/alink/importfile2-method.md +++ b/docs/framework/unmanaged-api/alink/importfile2-method.md @@ -43,7 +43,7 @@ HRESULT ImportFile2( 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-apis/metadata/imetadataassemblyimport-interface.md) interface. + Optional scope [IMetaDataAssemblyImport Interface](../../../core/unmanaged-api/metadata/imetadataassemblyimport-interface.md) interface. `fSmartImport` If TRUE, ImportTypes is used, otherwise importing must be performed manually. @@ -52,7 +52,7 @@ HRESULT ImportFile2( Receives the ID for the file or assembly. `ppAssemblyScope` - Receives the [IMetaDataAssemblyImport Interface](../../../core/unmanaged-apis/metadata/imetadataassemblyimport-interface.md) interface. NULL if the file is not an assembly. + 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. diff --git a/docs/framework/unmanaged-api/alink/importfileex-method.md b/docs/framework/unmanaged-api/alink/importfileex-method.md index 40d8d3301a19a..38101032f5588 100644 --- a/docs/framework/unmanaged-api/alink/importfileex-method.md +++ b/docs/framework/unmanaged-api/alink/importfileex-method.md @@ -46,13 +46,13 @@ HRESULT ImportFileEx( If TRUE, ImportTypes is used, otherwise importing must be performed manually. `dwOpenFlags` - Flags to be passed along to [OpenScope Method](../../../core/unmanaged-apis/metadata/imetadatadispenser-openscope-method.md). + 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-apis/metadata/imetadataassemblyimport-interface.md) interface. Is set to NULL if file is not an assembly. + 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. diff --git a/docs/framework/unmanaged-api/alink/importfileex2-method.md b/docs/framework/unmanaged-api/alink/importfileex2-method.md index aafe2eb97a6ff..1345bf55d88ed 100644 --- a/docs/framework/unmanaged-api/alink/importfileex2-method.md +++ b/docs/framework/unmanaged-api/alink/importfileex2-method.md @@ -44,19 +44,19 @@ HRESULT ImportFileEx2( Optional name of target file. `pAssemblyScopeIn` - Optional import scope [IMetaDataAssemblyImport Interface](../../../core/unmanaged-apis/metadata/imetadataassemblyimport-interface.md) interface. + 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-apis/metadata/imetadatadispenser-openscope-method.md). + 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-apis/metadata/imetadataassemblyimport-interface.md) interface. Can be NULL if the file is not an assembly. + 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. diff --git a/docs/framework/unmanaged-api/alink/importtypes-method.md b/docs/framework/unmanaged-api/alink/importtypes-method.md index b506d31f6cfd4..af4e9d156c5bb 100644 --- a/docs/framework/unmanaged-api/alink/importtypes-method.md +++ b/docs/framework/unmanaged-api/alink/importtypes-method.md @@ -48,7 +48,7 @@ HRESULT ImportTypes( Receives enumerator handle for the types in this scope. `ppImportScope` - Optionally receives [IMetaDataImport Interface](../../../core/unmanaged-apis/metadata/imetadataimport-interface.md) interface. + Optionally receives [IMetaDataImport Interface](../../../core/unmanaged-api/metadata/imetadataimport-interface.md) interface. `pdwCountOfTypes` Optionally receives count of types in the indicated scope. diff --git a/docs/framework/unmanaged-api/alink/importtypes2-method.md b/docs/framework/unmanaged-api/alink/importtypes2-method.md index dc020c59d5367..c858985050043 100644 --- a/docs/framework/unmanaged-api/alink/importtypes2-method.md +++ b/docs/framework/unmanaged-api/alink/importtypes2-method.md @@ -48,7 +48,7 @@ HRESULT ImportTypes2( Receives enumerator handle for the types in the given scope. `ppImportScope` - Optionally receives [IMetaDataImport2 Interface](../../../core/unmanaged-apis/metadata/imetadataimport2-interface.md) interface. + Optionally receives [IMetaDataImport2 Interface](../../../core/unmanaged-api/metadata/imetadataimport2-interface.md) interface. `pdwCountOfTypes` Optionally receives count of types in the specified scope. diff --git a/docs/framework/unmanaged-api/alink/init-method.md b/docs/framework/unmanaged-api/alink/init-method.md index 7cd2e71cc40c1..4c424f8f4e0d1 100644 --- a/docs/framework/unmanaged-api/alink/init-method.md +++ b/docs/framework/unmanaged-api/alink/init-method.md @@ -32,10 +32,10 @@ HRESULT Init( ## Parameters `pDispenser` - [IMetaDataDispenserEx Interface](../../../core/unmanaged-apis/metadata/imetadatadispenserex-interface.md) pointer to the metadata dispenser. + [IMetaDataDispenserEx Interface](../../../core/unmanaged-api/metadata/imetadatadispenserex-interface.md) pointer to the metadata dispenser. `pErrorHandler` - [IMetaDataError Interface](../../../core/unmanaged-apis/metadata/imetadataerror-interface.md) pointer to an optional error handling interface. + [IMetaDataError Interface](../../../core/unmanaged-api/metadata/imetadataerror-interface.md) pointer to an optional error handling interface. ## Return Value diff --git a/docs/framework/unmanaged-api/alink/linkresource-method.md b/docs/framework/unmanaged-api/alink/linkresource-method.md index 50f0e194db6f2..f6bfa2b4bd406 100644 --- a/docs/framework/unmanaged-api/alink/linkresource-method.md +++ b/docs/framework/unmanaged-api/alink/linkresource-method.md @@ -47,7 +47,7 @@ HRESULT LinkResource( Name of the resource. `dwFlags` - Accessibility flags such as `mrPublic` and `mrPrivate`. This parameter may be passed to [DefineManifestResource Method](../../../core/unmanaged-apis/metadata/imetadataassemblyemit-definemanifestresource-method.md). + 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 diff --git a/docs/framework/unmanaged-api/alink/setassemblyfile-method.md b/docs/framework/unmanaged-api/alink/setassemblyfile-method.md index 251988f57c292..d0828716011ae 100644 --- a/docs/framework/unmanaged-api/alink/setassemblyfile-method.md +++ b/docs/framework/unmanaged-api/alink/setassemblyfile-method.md @@ -37,10 +37,10 @@ HRESULT SetAssemblyFile( Fully qualified name of the manifest file. `pEmitter` - Pointer to [IMetaDataEmit Interface](../../../core/unmanaged-apis/metadata/imetadataemit-interface.md) interface. + Pointer to [IMetaDataEmit Interface](../../../core/unmanaged-api/metadata/imetadataemit-interface.md) interface. `afFlags` - Flags as defined in [AssemblyFlags Enumeration](../../../core/unmanaged-apis/metadata/assemblyflags-enumeration.md). + Flags as defined in [AssemblyFlags Enumeration](../../../core/unmanaged-api/metadata/assemblyflags-enumeration.md). `pAssemblyID` Pointer to ID of resulting assembly. diff --git a/docs/framework/unmanaged-api/alink/setassemblyfile2-method.md b/docs/framework/unmanaged-api/alink/setassemblyfile2-method.md index b341edec06fa7..c272e9a498c7b 100644 --- a/docs/framework/unmanaged-api/alink/setassemblyfile2-method.md +++ b/docs/framework/unmanaged-api/alink/setassemblyfile2-method.md @@ -37,10 +37,10 @@ HRESULT SetAssemblyFile2( Name of manifest file. `pEmitter` - [IMetaDataEmit2 Interface](../../../core/unmanaged-apis/metadata/imetadataemit2-interface.md) interface for this file. + [IMetaDataEmit2 Interface](../../../core/unmanaged-api/metadata/imetadataemit2-interface.md) interface for this file. `afFlags` - Options represented by [AssemblyFlags Enumeration](../../../core/unmanaged-apis/metadata/assemblyflags-enumeration.md). + Options represented by [AssemblyFlags Enumeration](../../../core/unmanaged-api/metadata/assemblyflags-enumeration.md). `pAssemblyID` Receives unique ID for the assembly being constructed. diff --git a/docs/framework/unmanaged-api/alink/setpekind-method.md b/docs/framework/unmanaged-api/alink/setpekind-method.md index dad70b3448a53..bebbfbc79f461 100644 --- a/docs/framework/unmanaged-api/alink/setpekind-method.md +++ b/docs/framework/unmanaged-api/alink/setpekind-method.md @@ -40,7 +40,7 @@ HRESULT SetPEKind( 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-apis/metadata/corpekind-enumeration.md). + 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. @@ -55,7 +55,7 @@ HRESULT SetPEKind( ## See also -- [GetPEKind Method](../../../core/unmanaged-apis/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/debugging/icordebugappdomain-getmodulefrommetadatainterface-method.md b/docs/framework/unmanaged-api/debugging/icordebugappdomain-getmodulefrommetadatainterface-method.md index 7c5e2c8c619bd..ef6c4f550aa65 100644 --- a/docs/framework/unmanaged-api/debugging/icordebugappdomain-getmodulefrommetadatainterface-method.md +++ b/docs/framework/unmanaged-api/debugging/icordebugappdomain-getmodulefrommetadatainterface-method.md @@ -33,7 +33,7 @@ HRESULT GetModuleFromMetaDataInterface ( ## Parameters `pIMetaData` - [in] A pointer to an object that is one of the [Metadata interfaces](../../../core/unmanaged-apis/metadata/metadata-interfaces.md). + [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. diff --git a/docs/framework/unmanaged-api/debugging/icordebugclass-gettoken-method.md b/docs/framework/unmanaged-api/debugging/icordebugclass-gettoken-method.md index 405d31ccb3b77..19d19358f3d0d 100644 --- a/docs/framework/unmanaged-api/debugging/icordebugclass-gettoken-method.md +++ b/docs/framework/unmanaged-api/debugging/icordebugclass-gettoken-method.md @@ -46,4 +46,4 @@ HRESULT GetToken ( ## See also -- [Metadata Interfaces](../../../core/unmanaged-apis/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 7195faa3bc81d..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](../../../core/unmanaged-apis/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 5c58961a2eb8b..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](../../../core/unmanaged-apis/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 3f8584733c2d9..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](../../../core/unmanaged-apis/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 4cfceb0bb9188..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](../../../core/unmanaged-apis/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](../../../core/unmanaged-apis/metadata/imetadataemit-interface.md) interface object for the module, then calls [IMetaDataEmit::SaveToMemory](../../../core/unmanaged-apis/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](../../../core/unmanaged-apis/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 ea272cd3d7c04..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](../../../core/unmanaged-apis/metadata/imetadataimport-interface.md), [IMetaDataImport2](../../../core/unmanaged-apis/metadata/imetadataimport2-interface.md), and [IMetaDataAssemblyImport](../../../core/unmanaged-apis/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](../../../core/unmanaged-apis/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 fd36961be7292..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](../../../core/unmanaged-apis/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](../../../core/unmanaged-apis/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](../../../core/unmanaged-apis/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](../../../core/unmanaged-apis/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 8b85e70aafca8..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](../../../core/unmanaged-apis/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](../../../core/unmanaged-apis/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 43cc90a1d57e8..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](../../../core/unmanaged-apis/metadata/corelementtype-enumeration.md) +- [CorElementType Enumeration](../../../core/unmanaged-api/metadata/corelementtype-enumeration.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 a226ded99d49c..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 @@ -348,15 +348,15 @@ Your Profiler DLL can distinguish WinMD files from other modules by calling the ### Reading metadata from WinMDs -WinMD files, like regular modules, contain metadata that can be read via the [Metadata APIs](../../../core/unmanaged-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. -When you call the [ICorProfilerInfo::GetModuleMetaData](icorprofilerinfo-getmodulemetadata-method.md) method on a WinMD to obtain a metadata interface, such as [IMetaDataImport](../../../core/unmanaged-apis/metadata/imetadataimport-interface.md), you can choose to set [ofNoTransform](../../../core/unmanaged-apis/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](../../../core/unmanaged-apis/metadata/coropenflags-enumeration.md) in the `dwOpenFlags` parameter or ask for a writeable metadata interface such as [IMetaDataEmit](../../../core/unmanaged-apis/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 @@ -394,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)](../../../core/unmanaged-apis/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 fa7378c17b172..ad1f501f723a8 100644 --- a/docs/framework/unmanaged-api/profiling/icorprofilercallback3-profilerdetachsucceeded-method.md +++ b/docs/framework/unmanaged-api/profiling/icorprofilercallback3-profilerdetachsucceeded-method.md @@ -51,7 +51,7 @@ HRESULT ProfilerDetachSucceeded(); ## See also -- [Metadata Interfaces](../../../core/unmanaged-apis/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 2eb14ebd99ae3..8395aef5bc0c9 100644 --- a/docs/framework/unmanaged-api/profiling/icorprofilercallback6-getassemblyreferences-method.md +++ b/docs/framework/unmanaged-api/profiling/icorprofilercallback6-getassemblyreferences-method.md @@ -47,7 +47,7 @@ HRESULT GetAssemblyReferences( [in, string] const WCHAR* wszAssemblyPath, 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-apis/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 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). diff --git a/docs/framework/unmanaged-api/profiling/icorprofilerinfo-getmodulemetadata-method.md b/docs/framework/unmanaged-api/profiling/icorprofilerinfo-getmodulemetadata-method.md index 6cedbe2f2b3de..65c8edc755723 100644 --- a/docs/framework/unmanaged-api/profiling/icorprofilerinfo-getmodulemetadata-method.md +++ b/docs/framework/unmanaged-api/profiling/icorprofilerinfo-getmodulemetadata-method.md @@ -37,10 +37,10 @@ HRESULT GetModuleMetaData( [in] The ID of the module to which the interface instance will be mapped. `dwOpenFlags` - [in] A value of the [CorOpenFlags](../../../core/unmanaged-apis/metadata/coropenflags-enumeration.md) enumeration that specifies the mode for opening manifest files. Only the `ofRead`, `ofWrite` and `ofNoTransform` bits are valid. + [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-apis/metadata/metadata-interfaces.md) for a list of the interfaces. + [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. diff --git a/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getclassidinfo2-method.md b/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getclassidinfo2-method.md index 73d44b528726d..b5b93ab8000b6 100644 --- a/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getclassidinfo2-method.md +++ b/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getclassidinfo2-method.md @@ -61,7 +61,7 @@ HRESULT GetClassIDInfo2( 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-apis/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. + 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. diff --git a/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getclasslayout-method.md b/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getclasslayout-method.md index f21f459dd070d..d1a89b446dd54 100644 --- a/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getclasslayout-method.md +++ b/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getclasslayout-method.md @@ -38,7 +38,7 @@ HRESULT GetClassLayout( [in] The ID of the class for which the layout will be retrieved. `rFieldOffset` - [in, out] An array of [COR_FIELD_OFFSET](../../../core/unmanaged-apis/metadata/cor-field-offset-structure.md) structures, each of which contains the tokens and offsets of the class's fields. + [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. diff --git a/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getfunctioninfo2-method.md b/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getfunctioninfo2-method.md index 2fc6ee4d4ea9d..93ce7274487d2 100644 --- a/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getfunctioninfo2-method.md +++ b/docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getfunctioninfo2-method.md @@ -63,7 +63,7 @@ HRESULT GetFunctionInfo2( ## Remarks - The profiler code can call [ICorProfilerInfo::GetModuleMetaData](icorprofilerinfo-getmodulemetadata-method.md) to obtain a [metadata](../../../core/unmanaged-apis/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 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. diff --git a/docs/framework/unmanaged-api/profiling/icorprofilerinfo3-getmoduleinfo2-method.md b/docs/framework/unmanaged-api/profiling/icorprofilerinfo3-getmoduleinfo2-method.md index 129a94007e17b..03f16f6bd5728 100644 --- a/docs/framework/unmanaged-api/profiling/icorprofilerinfo3-getmoduleinfo2-method.md +++ b/docs/framework/unmanaged-api/profiling/icorprofilerinfo3-getmoduleinfo2-method.md @@ -60,7 +60,7 @@ HRESULT GetModuleInfo2( ## 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-apis/metadata/imetadataimport-getscopeprops-method.md) method to unmanaged metadata client code. + 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. diff --git a/docs/framework/unmanaged-api/profiling/icorprofilerinfo7-applymetadata-method.md b/docs/framework/unmanaged-api/profiling/icorprofilerinfo7-applymetadata-method.md index cb5342014ed8e..b567068b80838 100644 --- a/docs/framework/unmanaged-api/profiling/icorprofilerinfo7-applymetadata-method.md +++ b/docs/framework/unmanaged-api/profiling/icorprofilerinfo7-applymetadata-method.md @@ -37,23 +37,23 @@ HRESULT ApplyMetaData( `ApplyMetaData` only supports adding the following types of metadata: -- `AssemblyRef` records, which you create by calling the [IMetaDataAssemblyEmit::DefineAssemblyRef](../../../core/unmanaged-apis/metadata/imetadataassemblyemit-defineassemblyref-method.md). method. +- `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-apis/metadata/imetadataemit-definetyperefbyname-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-apis/metadata/imetadataemit-gettokenfromtypespec-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-apis/metadata/imetadataemit-definememberref-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-apis/metadata/imetadataemit2-definemethodspec-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-apis/metadata/imetadataemit-defineuserstring-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](../../../core/unmanaged-apis/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-apis/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. +- `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 diff --git a/docs/framework/unmanaged-api/profiling/icorprofilerinfo8-getdynamicfunctioninfo-method.md b/docs/framework/unmanaged-api/profiling/icorprofilerinfo8-getdynamicfunctioninfo-method.md index e2e84dcad1d61..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](../../../core/unmanaged-apis/metadata/imetadataimport-interface.md) and [IMetaDataImport2](../../../core/unmanaged-apis/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/wcf/migrating-from-net-remoting-to-wcf.md b/docs/framework/wcf/migrating-from-net-remoting-to-wcf.md index 237b6d785ab7b..c2ed3361d886f 100644 --- a/docs/framework/wcf/migrating-from-net-remoting-to-wcf.md +++ b/docs/framework/wcf/migrating-from-net-remoting-to-wcf.md @@ -4,26 +4,26 @@ description: Learn how to migrate an application that uses .NET Remoting to use ms.date: "03/30/2017" ms.assetid: 16902a42-ef80-40e9-8c4c-90e61ddfdfe5 --- -# Migrating from .NET Remoting to WCF +# Migrate from .NET Remoting to WCF This article describes how to migrate an application that uses .NET Remoting to use Windows Communication Foundation (WCF). It compares similar concepts between these products and then describes how to accomplish several common Remoting scenarios in WCF. - .NET Remoting is a legacy product that is supported only for backward compatibility. It is not secure across mixed-trust environments because it cannot maintain the separate trust levels between client and server. For example, you should never expose a .NET Remoting endpoint to the Internet or to untrusted clients. We recommend existing Remoting applications be migrated to newer and more secure technologies. If the application’s design uses only HTTP and is RESTful, we recommend ASP.NET Web API. For more information, see ASP.NET Web API. If the application is based on SOAP or requires non-Http protocols such as TCP, we recommend WCF. + .NET Remoting is a legacy product that is supported only for backward compatibility. It is not secure across mixed-trust environments because it cannot maintain the separate trust levels between client and server. For example, you should never expose a .NET Remoting endpoint to the Internet or to untrusted clients. We recommend existing Remoting applications be migrated to newer and more secure technologies. If the application's design uses only HTTP and is RESTful, we recommend ASP.NET Web API. For more information, see ASP.NET Web API. If the application is based on SOAP or requires non-Http protocols such as TCP, we recommend WCF. ## Comparing .NET Remoting to WCF This section compares the basic building blocks of .NET Remoting with their WCF equivalents. We will use these building blocks later to create some common client-server scenarios in WCF. The following chart summarizes the main similarities and differences between .NET Remoting and WCF. -| | .NET Remoting | WCF | -|--------------------------|---------------------------------------------------------------------------------------|--------------------------------------------------------------------------------| -| **Server type** | Subclass `MarshalByRefObject` | Mark with `[ServiceContract]` attribute | -| **Service operations** | Public methods on server type | Mark with `[OperationContract]` attribute | -| **Serialization** | `ISerializable` or `[Serializable]` | `DataContractSerializer` or `XmlSerializer` | -| **Objects passed** | By-value or by-reference | By-value only | -| **Errors/exceptions** | Any serializable exception | `FaultContract` | -| **Client proxy objects** | Strongly typed transparent proxies are created automatically from MarshalByRefObjects | Strongly typed proxies are generated on-demand using ChannelFactory\ | -| **Platform required** | Both client and server must use Microsoft OS and .NET | Cross-platform | -| **Message format** | Private | Industry standards (for example, SOAP and WS-*) | +| | .NET Remoting | WCF | +|------------------------|-------------------------------------|-------------------------------------------------| +| **Server type** | Subclass `MarshalByRefObject` | Mark with `[ServiceContract]` attribute | +| **Service operations** | Public methods on server type | Mark with `[OperationContract]` attribute | +| **Serialization** | `ISerializable` or `[Serializable]` | `DataContractSerializer` or `XmlSerializer` | +| **Objects passed** | By-value or by-reference | By-value only | +| **Errors/exceptions** | Any serializable exception | `FaultContract` | +| **Client proxy objects** | Strongly typed transparent proxies are created automatically from MarshalByRefObjects | Strongly typed proxies are generated on-demand using ChannelFactory\ | +| **Platform required** | Both client and server must use Microsoft OS and .NET | Cross-platform | +| **Message format** | Private | Industry standards (for example, SOAP and WS-*) | ### Server Implementation Comparison @@ -68,7 +68,7 @@ public interface IWCFServer } ``` - The server’s implementation is defined in a separate concrete class, like in the following example: + The server's implementation is defined in a separate concrete class, like in the following example: ```csharp public class WCFServer : IWCFServer @@ -188,7 +188,7 @@ public class RemotingCustomerReference : MarshalByRefObject } ``` - It is extremely important to understand the implications of Remoting’s by-reference objects. If either tier (client or server) sends a by-reference object to the other tier, all method calls execute back on the tier owning the object. For example, a client calling methods on a by-reference object returned by the server will execute code on the server. Similarly, a server calling methods on a by-reference object provided by the client will execute code back on the client. For this reason, the use of .NET Remoting is recommended only within fully-trusted environments. Exposing a public .NET Remoting endpoint to untrusted clients will make a Remoting server vulnerable to attack. + It is extremely important to understand the implications of Remoting's by-reference objects. If either tier (client or server) sends a by-reference object to the other tier, all method calls execute back on the tier owning the object. For example, a client calling methods on a by-reference object returned by the server will execute code on the server. Similarly, a server calling methods on a by-reference object provided by the client will execute code back on the client. For this reason, the use of .NET Remoting is recommended only within fully-trusted environments. Exposing a public .NET Remoting endpoint to untrusted clients will make a Remoting server vulnerable to attack. #### Serialization in WCF @@ -318,7 +318,7 @@ catch (FaultException fault) ### Migration Scenarios - Now let’s see how to accomplish the following common Remoting scenarios in WCF: + Now let's see how to accomplish the following common Remoting scenarios in WCF: 1. Server returns an object by-value to the client @@ -405,7 +405,7 @@ public class RemotingServer : MarshalByRefObject } ``` -4. To run the WCF service, we need to declare an endpoint that exposes that service interface at a specific URL using a specific WCF binding. This is typically done by adding the following sections to the server project’s web.config file. +4. To run the WCF service, we need to declare an endpoint that exposes that service interface at a specific URL using a specific WCF binding. This is typically done by adding the following sections to the server project's web.config file. ```xml @@ -428,26 +428,26 @@ public class RemotingServer : MarshalByRefObject customerServiceHost.Open(); ``` - When this ServiceHost is started, it uses the web.config file to establish the proper contract, binding and endpoint. For more information about configuration files, see [Configuring Services Using Configuration Files](./configuring-services-using-configuration-files.md). This style of starting the server is known as self-hosting. To learn more about other choices for hosting WCF services, see [Hosting Services](../../core/unmanaged-api/hosting-services.md). - -6. The client project’s app.config must declare matching binding information for the service’s endpoint. The easiest way to do this in Visual Studio is to use **Add Service Reference**, which will automatically update the app.config file. Alternatively, these same changes can be added manually. - - ```xml - - - - - - - - ``` + When this ServiceHost is started, it uses the web.config file to establish the proper contract, binding and endpoint. For more information about configuration files, see [Configuring Services Using Configuration Files](./configuring-services-using-configuration-files.md). This style of starting the server is known as self-hosting. To learn more about other choices for hosting WCF services, see [Hosting Services](./hosting-services.md). + +6. The client project's app.config must declare matching binding information for the service's endpoint. The easiest way to do this in Visual Studio is to use **Add Service Reference**, which automatically updates the app.config file. Alternatively, these same changes can be added manually: + + ```xml + + + + + + + + ``` - For more information about using **Add Service Reference**, see [How to: Add, Update, or Remove a Service Reference](/visualstudio/data-tools/how-to-add-update-or-remove-a-wcf-data-service-reference). + For more information about using **Add Service Reference**, see [How to: Add, Update, or Remove a Service Reference](/visualstudio/data-tools/how-to-add-update-or-remove-a-wcf-data-service-reference). -7. Now we can call the WCF service from the client. We do this by creating a channel factory for that service, asking it for a channel, and directly calling the method we want on that channel. We can do this because the channel implements the service’s interface and handles the underlying request/reply logic for us. The return value from that method call is the deserialized copy of the server’s response. +7. Now you can call the WCF service from the client. We do this by creating a channel factory for that service, asking it for a channel, and directly calling the method we want on that channel. We can do this because the channel implements the service's interface and handles the underlying request/reply logic for us. The return value from that method call is the deserialized copy of the server's response. ```csharp ChannelFactory factory = @@ -534,7 +534,7 @@ public class RemotingServer : MarshalByRefObject This implementation maintains a singleton channel factory to create sessionful objects. When GetInstanceAddress() is called, it creates a channel and creates an EndpointAddress10 object that effectively points to the remote address associated with this channel. EndpointAddress10 is simply a data type that can be returned to the client by-value. -4. We need to modify the server’s configuration file by doing the following two things as shown in the example below: +4. We need to modify the server's configuration file by doing the following two things as shown in the example below: 1. Declare a \ section that describes the endpoint for the sessionful object. This is necessary because the server also acts as a client in this situation. @@ -580,7 +580,7 @@ public class RemotingServer : MarshalByRefObject sessionHost.Open(); ``` -5. We configure the client by declaring these same endpoints in its project’s app.config file. +5. We configure the client by declaring these same endpoints in its project's app.config file. ```xml @@ -673,4 +673,4 @@ public class RemotingServer : MarshalByRefObject ## Summary - .NET Remoting is a communication framework intended to be used only within fully-trusted environments. It is a legacy product and supported only for backward compatibility. It should not be used to build new applications. Conversely, WCF was designed with security in mind and is recommended for new and existing applications. Microsoft recommends that existing Remoting applications be migrated to use WCF or ASP.NET Web API instead. +.NET Remoting is a communication framework intended to be used only within fully-trusted environments. It is a legacy product and supported only for backward compatibility. It should not be used to build new applications. Conversely, WCF was designed with security in mind and is recommended for new and existing applications. Microsoft recommends that existing Remoting applications be migrated to use WCF or ASP.NET Web API instead. From aa85d44c335b48110fec8cd97f26d339720d73a1 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Thu, 26 Jun 2025 19:27:47 +0200 Subject: [PATCH 11/20] more human edits --- .../debugging/clrcreateinstance-function.md | 6 ++--- .../hosting/clrcreateinstance-function.md | 24 +++++++++---------- ...edebugginginterfacefromversion-function.md | 4 ++-- .../unmanaged-api/alink/addfile-method.md | 2 +- .../debugging/iclrdebugging-interface.md | 4 ++-- 5 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/core/unmanaged-api/debugging/clrcreateinstance-function.md b/docs/core/unmanaged-api/debugging/clrcreateinstance-function.md index 3f30b7aa3763e..d2dfc8c37d04a 100644 --- a/docs/core/unmanaged-api/debugging/clrcreateinstance-function.md +++ b/docs/core/unmanaged-api/debugging/clrcreateinstance-function.md @@ -1,6 +1,6 @@ --- -description: "Learn more about: CLRCreateInstance Function" -title: "CLRCreateInstance Function" +description: "Learn more about: CLRCreateInstance Function for debugging" +title: "CLRCreateInstance Function (debugging)" ms.date: "03/25/2022" api_name: - "CLRCreateInstance" @@ -19,7 +19,7 @@ helpviewer_keywords: topic_type: - "apiref" --- -# CLRCreateInstance function +# CLRCreateInstance function (debugging) Provides the [ICLRDebugging](../../../framework/unmanaged-api/debugging/iclrdebugging-interface.md) interface. diff --git a/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md b/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md index 25e1bb3f18af4..6b15997f95b40 100644 --- a/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md +++ b/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md @@ -1,6 +1,6 @@ --- -description: "Learn more about: CLRCreateInstance Function (.NET Framework)" -title: "CLRCreateInstance Function for .NET Framework" +description: "Learn more about: CLRCreateInstance Function (hosting)" +title: "CLRCreateInstance Function for hosting" ms.date: "03/30/2017" api_name: - "CLRCreateInstance" @@ -19,7 +19,7 @@ helpviewer_keywords: topic_type: - "apiref" --- -# CLRCreateInstance Function (.NET Framework) +# CLRCreateInstance Function (hosting) Provides one of three interfaces: [ICLRMetaHost](iclrmetahost-interface.md), [ICLRMetaHostPolicy](iclrmetahostpolicy-interface.md), or [ICLRDebugging](../../../framework/unmanaged-api/debugging/iclrdebugging-interface.md). @@ -48,20 +48,20 @@ HRESULT CLRCreateInstance( 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|`ppInterface` is null.| +| HRESULT | Description | +|-----------|------------------------------------| +| S_OK | The method completed successfully. | +| E_POINTER | `ppInterface` is null. | ## Remarks The following table shows the supported combinations for `clsid` and `riid`. -|`clsid`|`riid`| -|--------------|------------| -|CLSID_CLRMetaHost|IID_ICLRMetaHost| -|CLSID_CLRMetaHostPolicy|IID_ICLRMetaHostPolicy| -|CLSID_CLRDebugging|IID_ICLRDebugging| +| `clsid` | `riid` | +|-------------------------|------------------------| +| CLSID_CLRMetaHost | IID_ICLRMetaHost | +| CLSID_CLRMetaHostPolicy | IID_ICLRMetaHostPolicy | +| CLSID_CLRDebugging | IID_ICLRDebugging | The following code shows how to use `CLRCreateInstance` to get all three interfaces: diff --git a/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md b/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md index 7c33e9f9f005e..ffae4220449ec 100644 --- a/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md +++ b/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md @@ -18,9 +18,9 @@ topic_type: --- # CreateDebuggingInterfaceFromVersion Function (.NET Framework) -Creates an [ICorDebug](../../../framework/debugging/icordebug-interface.md) object based on the specified version information. +Creates an [ICorDebug](../debugging/icordebug-interface.md) object based on the specified version information. - This function is obsolete in the .NET Framework 4. Instead, to get an interface for the common language runtime (CLR) 2.0, use the [ICLRRuntimeInfo::GetInterface](iclrruntimeinfo-getinterface-method.md) method and specify the class identifier CLSID_CLRDebuggingLegacy and the interface identifier IID_ICorDebug. To get an interface for CLR 4 or later, call the [CLRCreateInstance](clrcreateinstance-function.md) function and specify the class identifier CLSID_CLRDebugging and the interface identifier IID_ICLRDebugging. + This function is obsolete starting in .NET Framework 4. Instead, to get an interface for the common language runtime (CLR) 2.0, use the [ICLRRuntimeInfo::GetInterface](iclrruntimeinfo-getinterface-method.md) method and specify the class identifier `CLSID_CLRDebuggingLegacy` and the interface identifier `IID_ICorDebug`. To get an interface for CLR 4 or later, call the [CLRCreateInstance](clrcreateinstance-function.md) function and specify the class identifier `CLSID_CLRDebugging` and the interface identifier `IID_ICLRDebugging`. ## Syntax diff --git a/docs/framework/unmanaged-api/alink/addfile-method.md b/docs/framework/unmanaged-api/alink/addfile-method.md index 052b40eaf27b6..e84a9e967313d 100644 --- a/docs/framework/unmanaged-api/alink/addfile-method.md +++ b/docs/framework/unmanaged-api/alink/addfile-method.md @@ -52,7 +52,7 @@ HRESULT AddFile( ## Return Value - Returns S_OK if the method succeeds. + Returns `S_OK` if the method succeeds. ## Requirements diff --git a/docs/framework/unmanaged-api/debugging/iclrdebugging-interface.md b/docs/framework/unmanaged-api/debugging/iclrdebugging-interface.md index 3fbbd624824af..6bedc473882f8 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.| From b0895af53a5451c9481497cee46c34c8f8987b19 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Thu, 26 Jun 2025 19:28:24 +0200 Subject: [PATCH 12/20] undo separate changes --- .../debugging/closeclrenumeration-function.md | 1 + .../unmanaged-api/debugging/closeresumehandle-function.md | 1 + .../unmanaged-api/debugging/clrcreateinstance-function.md | 7 ++++--- .../createdebugginginterfacefromversion-function.md | 1 + .../createdebugginginterfacefromversion2-function.md | 1 + .../createdebugginginterfacefromversion3-function.md | 1 + .../createdebugginginterfacefromversionex-function.md | 1 + .../debugging/createprocessforlaunch-function.md | 1 + .../debugging/createversionstringfrommodule-function.md | 1 + .../core/unmanaged-api/debugging/enumerateclrs-function.md | 1 + .../debugging/getstartupnotificationevent-function.md | 1 + .../debugging/iclrdebugginglibraryprovider2-interface.md | 1 + ...iclrdebugginglibraryprovider2-providelibrary2-method.md | 1 + .../debugging/iclrdebugginglibraryprovider3-interface.md | 1 + ...rdebugginglibraryprovider3-provideunixlibrary-method.md | 1 + ...bugginglibraryprovider3-providewindowslibrary-method.md | 1 + .../debugging/libraryproviderindextype-enumeration.md | 1 + .../debugging/registerforruntimestartup-function.md | 1 + .../debugging/registerforruntimestartup3-function.md | 1 + .../debugging/registerforruntimestartupex-function.md | 1 + .../core/unmanaged-api/debugging/resumeprocess-function.md | 1 + .../debugging/unregisterforruntimestartup-function.md | 1 + 22 files changed, 25 insertions(+), 3 deletions(-) diff --git a/docs/core/unmanaged-api/debugging/closeclrenumeration-function.md b/docs/core/unmanaged-api/debugging/closeclrenumeration-function.md index 13b420b0524b6..7a0c7939832d2 100644 --- a/docs/core/unmanaged-api/debugging/closeclrenumeration-function.md +++ b/docs/core/unmanaged-api/debugging/closeclrenumeration-function.md @@ -14,6 +14,7 @@ helpviewer_keywords: - "debugging API [.NET Core]" - ".NET Core, debugging" - "CloseCLR Enumeration function" +ms.assetid: 5e3c3958-80bb-43b1-a96b-dd3e6dbd9cd7 topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/closeresumehandle-function.md b/docs/core/unmanaged-api/debugging/closeresumehandle-function.md index 9d2e803c53177..ae8d08606cd69 100644 --- a/docs/core/unmanaged-api/debugging/closeresumehandle-function.md +++ b/docs/core/unmanaged-api/debugging/closeresumehandle-function.md @@ -14,6 +14,7 @@ helpviewer_keywords: - "debugging API [.NET Core]" - ".NET Core, debugging" - "CloseResumeHandle function" +ms.assetid: 5e3c3958-80bb-43b1-a96b-dd3e6dbd9cd7 topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/clrcreateinstance-function.md b/docs/core/unmanaged-api/debugging/clrcreateinstance-function.md index d2dfc8c37d04a..cd8447d9fa0ed 100644 --- a/docs/core/unmanaged-api/debugging/clrcreateinstance-function.md +++ b/docs/core/unmanaged-api/debugging/clrcreateinstance-function.md @@ -1,6 +1,6 @@ --- -description: "Learn more about: CLRCreateInstance Function for debugging" -title: "CLRCreateInstance Function (debugging)" +description: "Learn more about: CLRCreateInstance Function" +title: "CLRCreateInstance Function" ms.date: "03/25/2022" api_name: - "CLRCreateInstance" @@ -16,10 +16,11 @@ f1_keywords: helpviewer_keywords: - "CLRCreateInstance function [.NET Core Debugging]" - "CreateInterface function" +ms.assetid: 5de13327-96c6-4697-a89e-b8bf40717855 topic_type: - "apiref" --- -# CLRCreateInstance function (debugging) +# CLRCreateInstance function Provides the [ICLRDebugging](../../../framework/unmanaged-api/debugging/iclrdebugging-interface.md) interface. diff --git a/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion-function.md b/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion-function.md index acc031d4e7336..f9fad1da56fb9 100644 --- a/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion-function.md +++ b/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion-function.md @@ -12,6 +12,7 @@ helpviewer_keywords: - "CreateDebuggingInterfaceFromVersion function" - "debugging API [.NET Core]" - ".NET Core, debugging" +ms.assetid: 35c7a18f-133a-4584-bd25-bb338568b0c6 --- # CreateDebuggingInterfaceFromVersion function diff --git a/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion2-function.md b/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion2-function.md index 5ad013ca3c3ba..658827175ee3a 100644 --- a/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion2-function.md +++ b/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion2-function.md @@ -12,6 +12,7 @@ helpviewer_keywords: - "CreateDebuggingInterfaceFromVersion2 function" - "debugging API [.NET Core]" - ".NET Core, debugging" +ms.assetid: 35c7a18f-133a-4584-bd25-bb338568b0c6 --- # CreateDebuggingInterfaceFromVersion2 function diff --git a/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion3-function.md b/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion3-function.md index 267bac3d6016b..9edd7b960b39e 100644 --- a/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion3-function.md +++ b/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversion3-function.md @@ -12,6 +12,7 @@ helpviewer_keywords: - "CreateDebuggingInterfaceFromVersion3 function" - "debugging API [.NET Core]" - ".NET Core, debugging" +ms.assetid: 35c7a18f-133a-4584-bd25-bb338568b0c6 --- # CreateDebuggingInterfaceFromVersion3 function diff --git a/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversionex-function.md b/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversionex-function.md index 045c46fd099d0..02bfb878d8713 100644 --- a/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversionex-function.md +++ b/docs/core/unmanaged-api/debugging/createdebugginginterfacefromversionex-function.md @@ -12,6 +12,7 @@ helpviewer_keywords: - "CreateDebuggingInterfaceFromVersionEx function" - "debugging API [.NET Core]" - ".NET Core, debugging" +ms.assetid: 35c7a18f-133a-4584-bd25-bb338568b0c6 --- # CreateDebuggingInterfaceFromVersionEx function diff --git a/docs/core/unmanaged-api/debugging/createprocessforlaunch-function.md b/docs/core/unmanaged-api/debugging/createprocessforlaunch-function.md index 032e826535ac8..8ef7ad3073c8f 100644 --- a/docs/core/unmanaged-api/debugging/createprocessforlaunch-function.md +++ b/docs/core/unmanaged-api/debugging/createprocessforlaunch-function.md @@ -14,6 +14,7 @@ helpviewer_keywords: - "debugging API [.NET Core]" - ".NET Core, debugging" - "CreateProcessForLaunch function" +ms.assetid: 3d2fe9bd-75ef-4364-84a6-da1e1994ac1a topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/createversionstringfrommodule-function.md b/docs/core/unmanaged-api/debugging/createversionstringfrommodule-function.md index d98510033d2a4..601e31e08df1b 100644 --- a/docs/core/unmanaged-api/debugging/createversionstringfrommodule-function.md +++ b/docs/core/unmanaged-api/debugging/createversionstringfrommodule-function.md @@ -14,6 +14,7 @@ helpviewer_keywords: - "debugging API [.NET Core]" - ".NET Core, debugging" - "CreateVersionStringFromModule function" +ms.assetid: 3d2fe9bd-75ef-4364-84a6-da1e1994ac1a topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/enumerateclrs-function.md b/docs/core/unmanaged-api/debugging/enumerateclrs-function.md index 5f2b3e0188ca6..ee75921ba3397 100644 --- a/docs/core/unmanaged-api/debugging/enumerateclrs-function.md +++ b/docs/core/unmanaged-api/debugging/enumerateclrs-function.md @@ -14,6 +14,7 @@ helpviewer_keywords: - "debugging API [.NET Core]" - ".NET Core, debugging" - "EnumerateCLRs function" +ms.assetid: f8d50cb3-ec4f-4529-8fe3-bd61fd28e13c topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/getstartupnotificationevent-function.md b/docs/core/unmanaged-api/debugging/getstartupnotificationevent-function.md index 61d2e58e1663f..94da414126f05 100644 --- a/docs/core/unmanaged-api/debugging/getstartupnotificationevent-function.md +++ b/docs/core/unmanaged-api/debugging/getstartupnotificationevent-function.md @@ -12,6 +12,7 @@ helpviewer_keywords: - "GetStartupNotificationEvent function" - "debugging API [.NET Core]" - ".NET Core, debugging" +ms.assetid: c94b1b61-045a-4695-bacd-0f18c5acc246 topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider2-interface.md b/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider2-interface.md index 0bd13c69431de..4b291250f2cda 100644 --- a/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider2-interface.md +++ b/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider2-interface.md @@ -14,6 +14,7 @@ f1_keywords: - "ICLRDebuggingLibraryProvider2" helpviewer_keywords: - "ICLRDebuggingLibraryProvider2 interface [.NET Core debugging]" +ms.assetid: 67739617-6add-41a9-9de5-a3200c3109ce topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider2-providelibrary2-method.md b/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider2-providelibrary2-method.md index efac13be00166..e4187f9087acb 100644 --- a/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider2-providelibrary2-method.md +++ b/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider2-providelibrary2-method.md @@ -15,6 +15,7 @@ f1_keywords: helpviewer_keywords: - "ProvideLibrary method [.NET Core debugging]" - "ICLRDebuggingLibraryProvider2::ProvideLibrary2 method [.NET Core debugging]" +ms.assetid: 86f06245-9517-49be-8d8c-ca5deaf34c02 topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-interface.md b/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-interface.md index 9491f155737ed..4e364341fb3ee 100644 --- a/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-interface.md +++ b/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-interface.md @@ -14,6 +14,7 @@ f1_keywords: - "ICLRDebuggingLibraryProvider3" helpviewer_keywords: - "ICLRDebuggingLibraryProvider3 interface [.NET Core debugging]" +ms.assetid: 67739617-6add-41a9-9de5-a3200c3109ce topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-provideunixlibrary-method.md b/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-provideunixlibrary-method.md index c6ff67be7d0dc..fbc1987fb5d7c 100644 --- a/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-provideunixlibrary-method.md +++ b/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-provideunixlibrary-method.md @@ -15,6 +15,7 @@ f1_keywords: helpviewer_keywords: - "ProvideUnixLibrary method [.NET Core debugging]" - "ICLRDebuggingLibraryProvider3::ProvideUnixLibrary method [.NET Core debugging]" +ms.assetid: 86f06245-9517-49be-8d8c-ca5deaf34c02 topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-providewindowslibrary-method.md b/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-providewindowslibrary-method.md index 8e1ce7652f2b8..0577ba35a7973 100644 --- a/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-providewindowslibrary-method.md +++ b/docs/core/unmanaged-api/debugging/iclrdebugginglibraryprovider3-providewindowslibrary-method.md @@ -15,6 +15,7 @@ f1_keywords: helpviewer_keywords: - "ProvideWindowsLibrary method [.NET Core debugging]" - "ICLRDebuggingLibraryProvider3::ProvideWindowsLibrary method [.NET Core debugging]" +ms.assetid: 86f06245-9517-49be-8d8c-ca5deaf34c02 topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/libraryproviderindextype-enumeration.md b/docs/core/unmanaged-api/debugging/libraryproviderindextype-enumeration.md index b388cb396fcd2..e0e69221de8d9 100644 --- a/docs/core/unmanaged-api/debugging/libraryproviderindextype-enumeration.md +++ b/docs/core/unmanaged-api/debugging/libraryproviderindextype-enumeration.md @@ -14,6 +14,7 @@ f1_keywords: - "LIBRARY_PROVIDER_INDEX_TYPE" helpviewer_keywords: - "LIBRARY_PROVIDER_INDEX_TYPE enumeration [.NET Core debugging]" +ms.assetid: a6ac2531-ddfe-46fd-88fe-8b1eabe0b255 topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/registerforruntimestartup-function.md b/docs/core/unmanaged-api/debugging/registerforruntimestartup-function.md index 40cc1eea4a040..12742bef6bb37 100644 --- a/docs/core/unmanaged-api/debugging/registerforruntimestartup-function.md +++ b/docs/core/unmanaged-api/debugging/registerforruntimestartup-function.md @@ -12,6 +12,7 @@ helpviewer_keywords: - "RegisterForRuntimeStartup function" - "debugging API [.NET Core]" - ".NET Core, debugging" +ms.assetid: 35c7a18f-133a-4584-bd25-bb338568b0c6 --- # RegisterForRuntimeStartup function diff --git a/docs/core/unmanaged-api/debugging/registerforruntimestartup3-function.md b/docs/core/unmanaged-api/debugging/registerforruntimestartup3-function.md index 6af963d7af686..73e3be97716d5 100644 --- a/docs/core/unmanaged-api/debugging/registerforruntimestartup3-function.md +++ b/docs/core/unmanaged-api/debugging/registerforruntimestartup3-function.md @@ -12,6 +12,7 @@ helpviewer_keywords: - "RegisterForRuntimeStartup3 function" - "debugging API [.NET Core]" - ".NET Core, debugging" +ms.assetid: 35c7a18f-133a-4584-bd25-bb338568b0c6 --- # RegisterForRuntimeStartup3 function diff --git a/docs/core/unmanaged-api/debugging/registerforruntimestartupex-function.md b/docs/core/unmanaged-api/debugging/registerforruntimestartupex-function.md index 5ea49f0ec2843..444c41ddff3fb 100644 --- a/docs/core/unmanaged-api/debugging/registerforruntimestartupex-function.md +++ b/docs/core/unmanaged-api/debugging/registerforruntimestartupex-function.md @@ -12,6 +12,7 @@ helpviewer_keywords: - "RegisterForRuntimeStartupEx function" - "debugging API [.NET Core]" - ".NET Core, debugging" +ms.assetid: 35c7a18f-133a-4584-bd25-bb338568b0c6 --- # RegisterForRuntimeStartupEx function diff --git a/docs/core/unmanaged-api/debugging/resumeprocess-function.md b/docs/core/unmanaged-api/debugging/resumeprocess-function.md index 0707c4663e975..d803b3fa6503b 100644 --- a/docs/core/unmanaged-api/debugging/resumeprocess-function.md +++ b/docs/core/unmanaged-api/debugging/resumeprocess-function.md @@ -14,6 +14,7 @@ helpviewer_keywords: - "debugging API [.NET Core]" - ".NET Core, debugging" - "ResumeProcess function" +ms.assetid: 5e3c3958-80bb-43b1-a96b-dd3e6dbd9cd7 topic_type: - "apiref" --- diff --git a/docs/core/unmanaged-api/debugging/unregisterforruntimestartup-function.md b/docs/core/unmanaged-api/debugging/unregisterforruntimestartup-function.md index c7922ee469a84..5a8267a0354ff 100644 --- a/docs/core/unmanaged-api/debugging/unregisterforruntimestartup-function.md +++ b/docs/core/unmanaged-api/debugging/unregisterforruntimestartup-function.md @@ -12,6 +12,7 @@ helpviewer_keywords: - "UnregisterForRuntimeStartup function" - "debugging API [.NET Core]" - ".NET Core, debugging" +ms.assetid: 35c7a18f-133a-4584-bd25-bb338568b0c6 --- # UnregisterForRuntimeStartup function From 6bc9ea25d415b7f8180147af300422becdee59d1 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Thu, 26 Jun 2025 19:52:15 +0200 Subject: [PATCH 13/20] undo strong naming changes --- .../gethashfromassemblyfile-function.md | 104 +++++----- .../gethashfromassemblyfilew-function.md | 104 +++++----- .../strong-naming/gethashfromblob-function.md | 6 +- .../strong-naming/gethashfromfile-function.md | 106 +++++----- .../gethashfromfilew-function.md | 108 +++++------ .../gethashfromhandle-function.md | 102 +++++----- .../unmanaged-api/strong-naming/index.md | 182 +++++++++--------- .../strongnamecompareassemblies-function.md | 116 +++++------ .../strongnamefreebuffer-function.md | 68 +++---- .../strongnamegetblob-function.md | 104 +++++----- .../strongnamegetblobfromimage-function.md | 112 +++++------ .../strongnamegetpublickey-function.md | 130 ++++++------- .../strongnamehashsize-function.md | 94 ++++----- .../strongnamekeydelete-function.md | 8 +- .../strongnamekeygen-function.md | 124 ++++++------ .../strongnamekeygenex-function.md | 136 ++++++------- .../strongnamekeyinstall-function.md | 8 +- .../strongnamesignaturegeneration-function.md | 148 +++++++------- ...trongnamesignaturegenerationex-function.md | 172 ++++++++--------- .../strongnamesignaturesize-function.md | 96 ++++----- ...trongnamesignatureverification-function.md | 124 ++++++------ ...ongnamesignatureverificationex-function.md | 104 +++++----- ...signatureverificationfromimage-function.md | 138 ++++++------- .../strongnametokenfromassembly-function.md | 112 +++++------ .../strongnametokenfromassemblyex-function.md | 128 ++++++------ .../strongnametokenfrompublickey-function.md | 112 +++++------ 26 files changed, 1374 insertions(+), 1372 deletions(-) diff --git a/docs/framework/unmanaged-api/strong-naming/gethashfromassemblyfile-function.md b/docs/framework/unmanaged-api/strong-naming/gethashfromassemblyfile-function.md index f2233406a4f67..b42e77a1591e6 100644 --- a/docs/framework/unmanaged-api/strong-naming/gethashfromassemblyfile-function.md +++ b/docs/framework/unmanaged-api/strong-naming/gethashfromassemblyfile-function.md @@ -2,67 +2,67 @@ description: "Learn more about: GetHashFromAssemblyFile Function" title: "GetHashFromAssemblyFile Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetHashFromAssemblyFile" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "GetHashFromAssemblyFile" -helpviewer_keywords: +helpviewer_keywords: - "GetHashFromAssemblyFile function [.NET Framework strong naming]" ms.assetid: 751ed69f-b7ab-4e07-80de-e17ca9319b0c -topic_type: +topic_type: - "apiref" --- # GetHashFromAssemblyFile Function -Gets a hash of the specified assembly file, using the specified hash algorithm. - - This function has been deprecated. Use the [ICLRStrongName::GetHashFromAssemblyFile](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md) method instead. - -## Syntax - -```cpp -HRESULT GetHashFromAssemblyFile ( - [in] LPCSTR szFilePath, - [in, out] unsigned int *piHashAlg, - [out] BYTE *pbHash, - [in] DWORD cchHash, - [out] DWORD *pchHash -); -``` - -## Parameters - - `szFilePath` - [in] The path to the file to be hashed. - - `piHashAlg` - [in, out] A constant that specifies the hash algorithm. Use zero for the default hash algorithm. - - `pbHash` - [out] The returned hash buffer. - - `cchHash` - [in] The requested maximum size of `pbHash`. - - `pchHash` - [out] The returned size, in bytes, of `pbHash`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets a hash of the specified assembly file, using the specified hash algorithm. + + This function has been deprecated. Use the [ICLRStrongName::GetHashFromAssemblyFile](../hosting/iclrstrongname-gethashfromassemblyfile-method.md) method instead. + +## Syntax + +```cpp +HRESULT GetHashFromAssemblyFile ( + [in] LPCSTR szFilePath, + [in, out] unsigned int *piHashAlg, + [out] BYTE *pbHash, + [in] DWORD cchHash, + [out] DWORD *pchHash +); +``` + +## Parameters + + `szFilePath` + [in] The path to the file to be hashed. + + `piHashAlg` + [in, out] A constant that specifies the hash algorithm. Use zero for the default hash algorithm. + + `pbHash` + [out] The returned hash buffer. + + `cchHash` + [in] The requested maximum size of `pbHash`. + + `pchHash` + [out] The returned size, in bytes, of `pbHash`. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [GetHashFromAssemblyFile Method](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md) -- [GetHashFromAssemblyFileW Method](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [GetHashFromAssemblyFile Method](../hosting/iclrstrongname-gethashfromassemblyfile-method.md) +- [GetHashFromAssemblyFileW Method](../hosting/iclrstrongname-gethashfromassemblyfilew-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/gethashfromassemblyfilew-function.md b/docs/framework/unmanaged-api/strong-naming/gethashfromassemblyfilew-function.md index e65b128ef38d3..15c082ff30ae1 100644 --- a/docs/framework/unmanaged-api/strong-naming/gethashfromassemblyfilew-function.md +++ b/docs/framework/unmanaged-api/strong-naming/gethashfromassemblyfilew-function.md @@ -2,67 +2,67 @@ description: "Learn more about: GetHashFromAssemblyFileW Function" title: "GetHashFromAssemblyFileW Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetHashFromAssemblyFileW" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "GetHashFromAssemblyFileW" -helpviewer_keywords: +helpviewer_keywords: - "GetHashFromAssemblyFileW function [.NET Framework strong naming]" ms.assetid: d1b2b172-5353-42af-a877-cf653c68ece0 -topic_type: +topic_type: - "apiref" --- # GetHashFromAssemblyFileW Function -Gets a hash of the specified assembly file, using the specified hash algorithm. The path to the assembly file must be specified as a Unicode string. - - This function has been deprecated. Use the [ICLRStrongName::GetHashFromAssemblyFileW](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md) method instead. - -## Syntax - -```cpp -HRESULT GetHashFromAssemblyFileW ( - [in] LPCWSTR wszFilePath, - [in, out] unsigned int *piHashAlg, - [out] BYTE *pbHash, - [in] DWORD cchHash, - [out] DWORD *pchHash -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the file to be hashed. This parameter must be a Unicode string. - - `piHashAlg` - [in, out] A constant that specifies the hash algorithm. Use zero for the default hash algorithm. - - `pbHash` - [out] The returned hash buffer. - - `cchHash` - [in] The requested maximum size of `pbHash`. - - `pchHash` - [out] The returned size, in bytes, of `pbHash`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets a hash of the specified assembly file, using the specified hash algorithm. The path to the assembly file must be specified as a Unicode string. + + This function has been deprecated. Use the [ICLRStrongName::GetHashFromAssemblyFileW](../hosting/iclrstrongname-gethashfromassemblyfilew-method.md) method instead. + +## Syntax + +```cpp +HRESULT GetHashFromAssemblyFileW ( + [in] LPCWSTR wszFilePath, + [in, out] unsigned int *piHashAlg, + [out] BYTE *pbHash, + [in] DWORD cchHash, + [out] DWORD *pchHash +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the file to be hashed. This parameter must be a Unicode string. + + `piHashAlg` + [in, out] A constant that specifies the hash algorithm. Use zero for the default hash algorithm. + + `pbHash` + [out] The returned hash buffer. + + `cchHash` + [in] The requested maximum size of `pbHash`. + + `pchHash` + [out] The returned size, in bytes, of `pbHash`. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [GetHashFromAssemblyFileW Method](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md) -- [GetHashFromAssemblyFile Method](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [GetHashFromAssemblyFileW Method](../hosting/iclrstrongname-gethashfromassemblyfilew-method.md) +- [GetHashFromAssemblyFile Method](../hosting/iclrstrongname-gethashfromassemblyfile-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/gethashfromblob-function.md b/docs/framework/unmanaged-api/strong-naming/gethashfromblob-function.md index 9e823b5ebd670..81da83646e2f3 100644 --- a/docs/framework/unmanaged-api/strong-naming/gethashfromblob-function.md +++ b/docs/framework/unmanaged-api/strong-naming/gethashfromblob-function.md @@ -21,7 +21,7 @@ topic_type: Gets a hash of the assembly at the specified memory address, using the specified hash algorithm. -This function has been deprecated. Use the [ICLRStrongName::GetHashFromBlob](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md) method instead. +This function has been deprecated. Use the [ICLRStrongName::GetHashFromBlob](../hosting/iclrstrongname-gethashfromblob-method.md) method instead. ## Syntax @@ -68,5 +68,5 @@ HRESULT GetHashFromBlob ( ## See also -- [GetHashFromBlob Method](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [GetHashFromBlob Method](../hosting/iclrstrongname-gethashfromblob-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/gethashfromfile-function.md b/docs/framework/unmanaged-api/strong-naming/gethashfromfile-function.md index 8babe191b7282..dc6ad7b78d834 100644 --- a/docs/framework/unmanaged-api/strong-naming/gethashfromfile-function.md +++ b/docs/framework/unmanaged-api/strong-naming/gethashfromfile-function.md @@ -2,71 +2,71 @@ description: "Learn more about: GetHashFromFile Function" title: "GetHashFromFile Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetHashFromFile" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "GetHashFromFile" -helpviewer_keywords: +helpviewer_keywords: - "GetHashFromFile function [.NET Framework strong naming]" ms.assetid: b3c526a4-8fb4-4ad6-b6af-42ce9c06492e -topic_type: +topic_type: - "apiref" --- # GetHashFromFile Function -Generates a hash over the contents of the specified file. - - This function has been deprecated. Use the [ICLRStrongName::GetHashFromFile](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md) method instead. - -## Syntax - -```cpp -HRESULT GetHashFromFile ( - [in] LPCSTR szFilePath, +Generates a hash over the contents of the specified file. + + This function has been deprecated. Use the [ICLRStrongName::GetHashFromFile](../hosting/iclrstrongname-gethashfromfile-method.md) method instead. + +## Syntax + +```cpp +HRESULT GetHashFromFile ( + [in] LPCSTR szFilePath, [in, out] unsigned int *piHashAlg, [out] BYTE *pbHash, [in] DWORD cchHash, - [out] DWORD *pchHash -); -``` - -## Parameters - - `szFilePath` - [in] The name of the file to hash. - - `piHashAlg` - [in, out] The algorithm to use when generating the hash. Valid algorithms are those defined by the Win32 CryptoAPI. If `piHashAlg` is set to 0, the default algorithm CALG_SHA-1 is used. - - `pbHash` - [out] A byte array containing the generated hash. - - `cchHash` - [in] The maximum size of the buffer that `pbHash` points to. - - `pchHash` - [out] The size, in bytes, of the returned `pbHash`. - -## Remarks - - This function is the same as [GetHashFromFileW](gethashfromfilew-function.md), except that the file name specification is ANSI instead of Unicode. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - + [out] DWORD *pchHash +); +``` + +## Parameters + + `szFilePath` + [in] The name of the file to hash. + + `piHashAlg` + [in, out] The algorithm to use when generating the hash. Valid algorithms are those defined by the Win32 CryptoAPI. If `piHashAlg` is set to 0, the default algorithm CALG_SHA-1 is used. + + `pbHash` + [out] A byte array containing the generated hash. + + `cchHash` + [in] The maximum size of the buffer that `pbHash` points to. + + `pchHash` + [out] The size, in bytes, of the returned `pbHash`. + +## Remarks + + This function is the same as [GetHashFromFileW](gethashfromfilew-function.md), except that the file name specification is ANSI instead of Unicode. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also -- [GetHashFromFile Method](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md) -- [GetHashFromFileW Method](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [GetHashFromFile Method](../hosting/iclrstrongname-gethashfromfile-method.md) +- [GetHashFromFileW Method](../hosting/iclrstrongname-gethashfromfilew-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/gethashfromfilew-function.md b/docs/framework/unmanaged-api/strong-naming/gethashfromfilew-function.md index b7c103db476ec..c0f01fc646c87 100644 --- a/docs/framework/unmanaged-api/strong-naming/gethashfromfilew-function.md +++ b/docs/framework/unmanaged-api/strong-naming/gethashfromfilew-function.md @@ -2,71 +2,71 @@ description: "Learn more about: GetHashFromFileW Function" title: "GetHashFromFileW Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetHashFromFileW" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "GetHashFromFileW" -helpviewer_keywords: +helpviewer_keywords: - "GetHashFromFileW function [.NET Framework strong naming]" ms.assetid: 97c2d7a6-5376-45a1-ba65-146a249147cc -topic_type: +topic_type: - "apiref" --- # GetHashFromFileW Function -Generates a hash over the contents of the file specified by a Unicode string. - - This function has been deprecated. Use the [ICLRStrongName::GetHashFromFileW](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md) method instead. - -## Syntax - -```cpp +Generates a hash over the contents of the file specified by a Unicode string. + + This function has been deprecated. Use the [ICLRStrongName::GetHashFromFileW](../hosting/iclrstrongname-gethashfromfilew-method.md) method instead. + +## Syntax + +```cpp HRESULT GetHashFromFileW ( - [in] LPCWSTR wszFilePath, - [in, out] unsigned int *piHashAlg, - [out] BYTE *pbHash, - [in] DWORD cchHash, - [out] DWORD *pchHash + [in] LPCWSTR wszFilePath, + [in, out] unsigned int *piHashAlg, + [out] BYTE *pbHash, + [in] DWORD cchHash, + [out] DWORD *pchHash ); -``` - -## Parameters - - `wszFilePath` - [in] The Unicode name of the file to hash. - - `piHashAlg` - [in, out] The algorithm to use when generating the hash. Valid algorithms are those defined by the Win32 CryptoAPI. If `piHashAlg` is set to 0, the default algorithm CALG_SHA-1 is used. - - `pbHash` - [out] A byte array containing the generated hash. - - `cchHash` - [in] The maximum size of the buffer pointed to by `pbHash`. - - `pchHash` - [out] The size, in bytes, of `pbHash`. - -## Remarks - - This function is the same as [GetHashFromFile](gethashfromfile-function.md), except that the file name specification is Unicode instead of ANSI. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +``` + +## Parameters + + `wszFilePath` + [in] The Unicode name of the file to hash. + + `piHashAlg` + [in, out] The algorithm to use when generating the hash. Valid algorithms are those defined by the Win32 CryptoAPI. If `piHashAlg` is set to 0, the default algorithm CALG_SHA-1 is used. + + `pbHash` + [out] A byte array containing the generated hash. + + `cchHash` + [in] The maximum size of the buffer pointed to by `pbHash`. + + `pchHash` + [out] The size, in bytes, of `pbHash`. + +## Remarks + + This function is the same as [GetHashFromFile](gethashfromfile-function.md), except that the file name specification is Unicode instead of ANSI. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [GetHashFromFileW Method](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md) -- [GetHashFromFile Method](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [GetHashFromFileW Method](../hosting/iclrstrongname-gethashfromfilew-method.md) +- [GetHashFromFile Method](../hosting/iclrstrongname-gethashfromfile-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/gethashfromhandle-function.md b/docs/framework/unmanaged-api/strong-naming/gethashfromhandle-function.md index 59cff51dca3ec..75b6921fda915 100644 --- a/docs/framework/unmanaged-api/strong-naming/gethashfromhandle-function.md +++ b/docs/framework/unmanaged-api/strong-naming/gethashfromhandle-function.md @@ -2,66 +2,66 @@ description: "Learn more about: GetHashFromHandle Function" title: "GetHashFromHandle Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetHashFromHandle" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "GetHashFromHandle" -helpviewer_keywords: +helpviewer_keywords: - "GetHashFromHandle function [.NET Framework strong naming]" ms.assetid: 9e00337f-b307-4602-9bc3-965a8dbf02cd -topic_type: +topic_type: - "apiref" --- # GetHashFromHandle Function -Generates a hash over the contents of the file with the specified file handle, using the specified hash algorithm. - - This function has been deprecated. Use the [ICLRStrongName::GetHashFromHandle](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md) method instead. - -## Syntax - -```cpp -HRESULT GetHashFromHandle ( - [in] HANDLE hFile, - [in, out] unsigned int *piHashAlg, - [out] BYTE *pbHash, - [in] DWORD cchHash, - [out] DWORD *pchHash -); -``` - -## Parameters - - `hFile` - [in] The handle of the file to be hashed. - - `piHashAlg` - [in, out] A constant that specifies the hash algorithm. Use zero for the default algorithm. - - `pbHash` - [out] The returned hash buffer. - - `cchHash` - [in] The requested maximum size of `pbHash`. - - `pchHash` - [out] The size, in bytes, of the returned `pbHash`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Generates a hash over the contents of the file with the specified file handle, using the specified hash algorithm. + + This function has been deprecated. Use the [ICLRStrongName::GetHashFromHandle](../hosting/iclrstrongname-gethashfromhandle-method.md) method instead. + +## Syntax + +```cpp +HRESULT GetHashFromHandle ( + [in] HANDLE hFile, + [in, out] unsigned int *piHashAlg, + [out] BYTE *pbHash, + [in] DWORD cchHash, + [out] DWORD *pchHash +); +``` + +## Parameters + + `hFile` + [in] The handle of the file to be hashed. + + `piHashAlg` + [in, out] A constant that specifies the hash algorithm. Use zero for the default algorithm. + + `pbHash` + [out] The returned hash buffer. + + `cchHash` + [in] The requested maximum size of `pbHash`. + + `pchHash` + [out] The size, in bytes, of the returned `pbHash`. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [GetHashFromHandle Method](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [GetHashFromHandle Method](../hosting/iclrstrongname-gethashfromhandle-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/index.md b/docs/framework/unmanaged-api/strong-naming/index.md index 66b4619deb633..1071c7f02c117 100644 --- a/docs/framework/unmanaged-api/strong-naming/index.md +++ b/docs/framework/unmanaged-api/strong-naming/index.md @@ -2,7 +2,7 @@ description: "Learn more about: Strong Naming (Unmanaged API Reference)" title: "Strong Naming (Unmanaged API Reference)" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - "strong naming [.NET Framework], using the unmanaged API" - "native API reference [.NET Framework], strong naming" - "unmanaged API reference [.NET Framework], strong naming" @@ -10,97 +10,97 @@ ms.assetid: 428c68b6-a7b4-44be-b280-75905f46612c --- # Strong Naming (Unmanaged API Reference) -The strong naming API enables a client to administer strong name signing for assemblies. - - Signing an assembly with a strong name adds a public key encryption to the file containing the assembly manifest. Strong name signing helps verify name uniqueness, prevents name spoofing, and provides callers with a unique identity when a reference is resolved. However, no level of trust is associated with a strong name. - -## In This Section - +The strong naming API enables a client to administer strong name signing for assemblies. + + Signing an assembly with a strong name adds a public key encryption to the file containing the assembly manifest. Strong name signing helps verify name uniqueness, prevents name spoofing, and provides callers with a unique identity when a reference is resolved. However, no level of trust is associated with a strong name. + +## In This Section + > [!NOTE] -> All of these functions have been deprecated starting with the .NET Framework 4. For suggested alternatives, see the [ICLRStrongName](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) interface. - - [GetHashFromAssemblyFile Function](gethashfromassemblyfile-function.md) - Gets a hash of the specified assembly file, using the specified hash algorithm. Deprecated starting with the .NET Framework 4. - - [GetHashFromAssemblyFileW Function](gethashfromassemblyfilew-function.md) - Gets a hash of the assembly file specified as a Unicode string, using the specified hash algorithm. Deprecated starting with the .NET Framework 4. - - [GetHashFromBlob Function](gethashfromblob-function.md) - Gets a hash of the assembly at the specified memory address, using the specified hash algorithm. Deprecated starting with the .NET Framework 4. - - [GetHashFromFile Function](gethashfromfile-function.md) - Generates a hash over the contents of the specified file. Deprecated starting with the .NET Framework 4. - - [GetHashFromFileW Function](gethashfromfilew-function.md) - Generates a hash over the contents of the file specified by a Unicode string. Deprecated starting with the .NET Framework 4. - - [GetHashFromHandle Function](gethashfromhandle-function.md) - Generates a hash over the contents of the file with the specified file handle, using the specified hash algorithm. Deprecated starting with the .NET Framework 4. - - [StrongNameCompareAssemblies Function](strongnamecompareassemblies-function.md) - Determines whether two assemblies differ only by their strong name signatures. Deprecated starting with the .NET Framework 4. - - [StrongNameErrorInfo Function](strongnameerrorinfo-function.md) - Gets the last error code that was raised by one of the strong name functions. - - [StrongNameFreeBuffer Function](strongnamefreebuffer-function.md) - Frees memory that was allocated with a previous call to a strong name function such as [StrongNameGetPublicKey](strongnamegetpublickey-function.md), [StrongNameTokenFromPublicKey](strongnametokenfrompublickey-function.md), or [StrongNameSignatureGeneration](strongnamesignaturegeneration-function.md). Deprecated starting with the .NET Framework 4. - - [StrongNameGetBlob Function](strongnamegetblob-function.md) - Fills the specified buffer with the binary representation of the executable file at the specified address. Deprecated starting with the .NET Framework 4. - - [StrongNameGetBlobFromImage Function](strongnamegetblobfromimage-function.md) - Gets a binary representation of the assembly image at the specified memory address. Deprecated starting with the .NET Framework 4. - - [StrongNameGetPublicKey Function](strongnamegetpublickey-function.md) - Gets the public key from a private/public key pair. Deprecated starting with the .NET Framework 4. - - [StrongNameHashSize Function](strongnamehashsize-function.md) - Gets the buffer size required for a hash, using the specified hash algorithm. Deprecated starting with the .NET Framework 4. - - [StrongNameKeyDelete Function](strongnamekeydelete-function.md) - Deletes the specified key container. Deprecated starting with the .NET Framework 4. - - [StrongNameKeyGen Function](strongnamekeygen-function.md) - Creates a new public/private key pair for strong name use. Deprecated starting with the .NET Framework 4. - - [StrongNameKeyGenEx Function](strongnamekeygenex-function.md) - Generates a new public/private key pair with the specified key size for strong name use. Deprecated starting with the .NET Framework 4. - - [StrongNameKeyInstall Function](strongnamekeyinstall-function.md) - Imports a public/private key pair into a container. Deprecated starting with the .NET Framework 4. - - [StrongNameSignatureGeneration Function](strongnamesignaturegeneration-function.md) - Generates a strong name signature for the specified assembly. Deprecated starting with the .NET Framework 4. - - [StrongNameSignatureGenerationEx Function](strongnamesignaturegenerationex-function.md) - Generates a strong name signature for the specified assembly, based on the specified flags. Deprecated starting with the .NET Framework 4. - - [StrongNameSignatureSize Function](strongnamesignaturesize-function.md) - Returns the size of the strong name signature. Deprecated starting with the .NET Framework 4. - - [StrongNameSignatureVerification Function](strongnamesignatureverification-function.md) - Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature, which is verified according to the specified flags. Deprecated starting with the .NET Framework 4. - - [StrongNameSignatureVerificationEx Function](strongnamesignatureverificationex-function.md) - Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature. Deprecated starting with the .NET Framework 4. - - [StrongNameSignatureVerificationFromImage Function](strongnamesignatureverificationfromimage-function.md) - Verifies that an assembly that has already been mapped to memory is valid for the associated public key. Deprecated starting with the .NET Framework 4. - - [StrongNameTokenFromAssembly Function](strongnametokenfromassembly-function.md) - Creates a strong name token from the specified assembly file. Deprecated starting with the .NET Framework 4. - - [StrongNameTokenFromAssemblyEx Function](strongnametokenfromassemblyex-function.md) - Creates a strong name token from the specified assembly file, and returns the public key. Deprecated starting with the .NET Framework 4. - - [StrongNameTokenFromPublicKey Function](strongnametokenfrompublickey-function.md) - Gets a token representing a public key. Deprecated starting with the .NET Framework 4. - - [PublicKeyBlob Structure](publickeyblob-structure.md) - Represents the public key of a public/private key pair in binary format. - +> All of these functions have been deprecated starting with the .NET Framework 4. For suggested alternatives, see the [ICLRStrongName](../hosting/iclrstrongname-interface.md) interface. + + [GetHashFromAssemblyFile Function](gethashfromassemblyfile-function.md) + Gets a hash of the specified assembly file, using the specified hash algorithm. Deprecated starting with the .NET Framework 4. + + [GetHashFromAssemblyFileW Function](gethashfromassemblyfilew-function.md) + Gets a hash of the assembly file specified as a Unicode string, using the specified hash algorithm. Deprecated starting with the .NET Framework 4. + + [GetHashFromBlob Function](gethashfromblob-function.md) + Gets a hash of the assembly at the specified memory address, using the specified hash algorithm. Deprecated starting with the .NET Framework 4. + + [GetHashFromFile Function](gethashfromfile-function.md) + Generates a hash over the contents of the specified file. Deprecated starting with the .NET Framework 4. + + [GetHashFromFileW Function](gethashfromfilew-function.md) + Generates a hash over the contents of the file specified by a Unicode string. Deprecated starting with the .NET Framework 4. + + [GetHashFromHandle Function](gethashfromhandle-function.md) + Generates a hash over the contents of the file with the specified file handle, using the specified hash algorithm. Deprecated starting with the .NET Framework 4. + + [StrongNameCompareAssemblies Function](strongnamecompareassemblies-function.md) + Determines whether two assemblies differ only by their strong name signatures. Deprecated starting with the .NET Framework 4. + + [StrongNameErrorInfo Function](strongnameerrorinfo-function.md) + Gets the last error code that was raised by one of the strong name functions. + + [StrongNameFreeBuffer Function](strongnamefreebuffer-function.md) + Frees memory that was allocated with a previous call to a strong name function such as [StrongNameGetPublicKey](strongnamegetpublickey-function.md), [StrongNameTokenFromPublicKey](strongnametokenfrompublickey-function.md), or [StrongNameSignatureGeneration](strongnamesignaturegeneration-function.md). Deprecated starting with the .NET Framework 4. + + [StrongNameGetBlob Function](strongnamegetblob-function.md) + Fills the specified buffer with the binary representation of the executable file at the specified address. Deprecated starting with the .NET Framework 4. + + [StrongNameGetBlobFromImage Function](strongnamegetblobfromimage-function.md) + Gets a binary representation of the assembly image at the specified memory address. Deprecated starting with the .NET Framework 4. + + [StrongNameGetPublicKey Function](strongnamegetpublickey-function.md) + Gets the public key from a private/public key pair. Deprecated starting with the .NET Framework 4. + + [StrongNameHashSize Function](strongnamehashsize-function.md) + Gets the buffer size required for a hash, using the specified hash algorithm. Deprecated starting with the .NET Framework 4. + + [StrongNameKeyDelete Function](strongnamekeydelete-function.md) + Deletes the specified key container. Deprecated starting with the .NET Framework 4. + + [StrongNameKeyGen Function](strongnamekeygen-function.md) + Creates a new public/private key pair for strong name use. Deprecated starting with the .NET Framework 4. + + [StrongNameKeyGenEx Function](strongnamekeygenex-function.md) + Generates a new public/private key pair with the specified key size for strong name use. Deprecated starting with the .NET Framework 4. + + [StrongNameKeyInstall Function](strongnamekeyinstall-function.md) + Imports a public/private key pair into a container. Deprecated starting with the .NET Framework 4. + + [StrongNameSignatureGeneration Function](strongnamesignaturegeneration-function.md) + Generates a strong name signature for the specified assembly. Deprecated starting with the .NET Framework 4. + + [StrongNameSignatureGenerationEx Function](strongnamesignaturegenerationex-function.md) + Generates a strong name signature for the specified assembly, based on the specified flags. Deprecated starting with the .NET Framework 4. + + [StrongNameSignatureSize Function](strongnamesignaturesize-function.md) + Returns the size of the strong name signature. Deprecated starting with the .NET Framework 4. + + [StrongNameSignatureVerification Function](strongnamesignatureverification-function.md) + Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature, which is verified according to the specified flags. Deprecated starting with the .NET Framework 4. + + [StrongNameSignatureVerificationEx Function](strongnamesignatureverificationex-function.md) + Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature. Deprecated starting with the .NET Framework 4. + + [StrongNameSignatureVerificationFromImage Function](strongnamesignatureverificationfromimage-function.md) + Verifies that an assembly that has already been mapped to memory is valid for the associated public key. Deprecated starting with the .NET Framework 4. + + [StrongNameTokenFromAssembly Function](strongnametokenfromassembly-function.md) + Creates a strong name token from the specified assembly file. Deprecated starting with the .NET Framework 4. + + [StrongNameTokenFromAssemblyEx Function](strongnametokenfromassemblyex-function.md) + Creates a strong name token from the specified assembly file, and returns the public key. Deprecated starting with the .NET Framework 4. + + [StrongNameTokenFromPublicKey Function](strongnametokenfrompublickey-function.md) + Gets a token representing a public key. Deprecated starting with the .NET Framework 4. + + [PublicKeyBlob Structure](publickeyblob-structure.md) + Represents the public key of a public/private key pair in binary format. + ## See also -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) - [Unmanaged API Reference](../index.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamecompareassemblies-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamecompareassemblies-function.md index 01905b2e4515d..455267b1b84bf 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamecompareassemblies-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamecompareassemblies-function.md @@ -2,72 +2,74 @@ description: "Learn more about: StrongNameCompareAssemblies Function" title: "StrongNameCompareAssemblies Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameCompareAssemblies" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameCompareAssemblies" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameCompareAssemblies function [.NET Framework strong naming]" ms.assetid: 763f2375-efc6-4219-8806-a3b0567ef72b -topic_type: +topic_type: - "apiref" --- # StrongNameCompareAssemblies Function -Determines whether two assemblies differ only by their strong name signatures. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameCompareAssemblies](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameCompareAssemblies ( - [in] LPCWSTR wszAssembly1, - [in] LPCWSTR wszAssembly2, - [out] DWORD *pdwResult -); -``` - -## Parameters - - `wszAssembly1` - [in] The path to the first assembly. - - `wszAssembly2` - [in] The path to the second assembly. - - `pdwResult` - [out] One of the following values: - -- `SN_CMP_DIFFERENT` (0) - Specifies that the assemblies contain different data. -- `SN_CMP_IDENTICAL` (1) - Specifies that the assemblies are exactly the same, including their signatures and checksum. -- `SN_CMP_SIGONLY` (2) - Specifies that the assemblies differ only by signature and checksum. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - -## Remarks - - The strong name signature of an assembly consists of the assembly's text name, version, culture, and public key token. - - If the `StrongNameCompareAssemblies` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - +Determines whether two assemblies differ only by their strong name signatures. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameCompareAssemblies](../hosting/iclrstrongname-strongnamecompareassemblies-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameCompareAssemblies ( + [in] LPCWSTR wszAssembly1, + [in] LPCWSTR wszAssembly2, + [out] DWORD *pdwResult +); +``` + +## Parameters + + `wszAssembly1` + [in] The path to the first assembly. + + `wszAssembly2` + [in] The path to the second assembly. + + `pdwResult` + [out] One of the following values: + +- `SN_CMP_DIFFERENT` (0) - Specifies that the assemblies contain different data. + +- `SN_CMP_IDENTICAL` (1) - Specifies that the assemblies are exactly the same, including their signatures and checksum. + +- `SN_CMP_SIGONLY` (2) - Specifies that the assemblies differ only by signature and checksum. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + +## Remarks + + The strong name signature of an assembly consists of the assembly's text name, version, culture, and public key token. + + If the `StrongNameCompareAssemblies` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + ## See also -- [StrongNameCompareAssemblies Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [StrongNameCompareAssemblies Method](../hosting/iclrstrongname-strongnamecompareassemblies-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamefreebuffer-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamefreebuffer-function.md index 3f9147945f866..47ac1026c963a 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamefreebuffer-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamefreebuffer-function.md @@ -2,54 +2,54 @@ description: "Learn more about: StrongNameFreeBuffer Function" title: "StrongNameFreeBuffer Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameFreeBuffer" -api_location: +api_location: - "mscoree.dll" - "mscorsn.dll" - "clr.dll" - "mscorwks.dll" - "mscoreei.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameFreeBuffer" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameFreeBuffer function [.NET Framework strong naming]" ms.assetid: eda21ecf-4734-4f92-aaba-9f34884385db -topic_type: +topic_type: - "apiref" --- # StrongNameFreeBuffer Function -Frees memory that was allocated with a previous call to a strong name function such as [StrongNameGetPublicKey](strongnamegetpublickey-function.md), [StrongNameTokenFromPublicKey](strongnametokenfrompublickey-function.md), or [StrongNameSignatureGeneration](strongnamesignaturegeneration-function.md). - - This function has been deprecated. Use the [ICLRStrongName::StrongNameFreeBuffer](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md) method instead. - -## Syntax - -```cpp +Frees memory that was allocated with a previous call to a strong name function such as [StrongNameGetPublicKey](strongnamegetpublickey-function.md), [StrongNameTokenFromPublicKey](strongnametokenfrompublickey-function.md), or [StrongNameSignatureGeneration](strongnamesignaturegeneration-function.md). + + This function has been deprecated. Use the [ICLRStrongName::StrongNameFreeBuffer](../hosting/iclrstrongname-strongnamefreebuffer-method.md) method instead. + +## Syntax + +```cpp VOID StrongNameFreeBuffer ( - [in] BYTE *pbMemory -); -``` - -## Parameters - - `pbMemory` - [in] A pointer to the memory to free. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [in] BYTE *pbMemory +); +``` + +## Parameters + + `pbMemory` + [in] A pointer to the memory to free. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameFreeBuffer Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [StrongNameFreeBuffer Method](../hosting/iclrstrongname-strongnamefreebuffer-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamegetblob-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamegetblob-function.md index fd068b5cfc287..f9abbac4d3e5d 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamegetblob-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamegetblob-function.md @@ -2,67 +2,67 @@ description: "Learn more about: StrongNameGetBlob Function" title: "StrongNameGetBlob Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameGetBlob" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameGetBlob" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameGetBlob function [.NET Framework strong naming]" ms.assetid: 15d09166-be00-4696-913f-2c1fbc7ac2e1 -topic_type: +topic_type: - "apiref" --- # StrongNameGetBlob Function -Fills the specified buffer with the binary representation of the executable file at the specified address. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameGetBLob](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameGetBlob ( - [in] LPCWSTR wszFilePath, - [in] BYTE *pbBlob, - [in, out] DWORD *pcbBlob -); -``` - -## Parameters - - `wszFilePath` - [in] A valid path to the executable file to be loaded. - - `pbBlob` - [in] The buffer into which to load the executable file. - - `pcbBlob` - [in, out] The requested maximum size, in bytes, of `pbBlob`. Upon return, the actual size, in bytes, of `pbBlob`. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - If the `StrongNameGetBlob` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] - +Fills the specified buffer with the binary representation of the executable file at the specified address. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameGetBLob](../hosting/iclrstrongname-strongnamegetblob-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameGetBlob ( + [in] LPCWSTR wszFilePath, + [in] BYTE *pbBlob, + [in, out] DWORD *pcbBlob +); +``` + +## Parameters + + `wszFilePath` + [in] A valid path to the executable file to be loaded. + + `pbBlob` + [in] The buffer into which to load the executable file. + + `pcbBlob` + [in, out] The requested maximum size, in bytes, of `pbBlob`. Upon return, the actual size, in bytes, of `pbBlob`. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + If the `StrongNameGetBlob` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also -- [StrongNameGetBlob Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md) -- [StrongNameGetBlobFromImage Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [StrongNameGetBlob Method](../hosting/iclrstrongname-strongnamegetblob-method.md) +- [StrongNameGetBlobFromImage Method](../hosting/iclrstrongname-strongnamegetblobfromimage-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamegetblobfromimage-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamegetblobfromimage-function.md index 8d2b67559268f..85ef10483d3c6 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamegetblobfromimage-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamegetblobfromimage-function.md @@ -2,71 +2,71 @@ description: "Learn more about: StrongNameGetBlobFromImage Function" title: "StrongNameGetBlobFromImage Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameGetBlobFromImage" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameGetBlobFromImage" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameGetBlobFromImage function [.NET Framework strong naming]" ms.assetid: 1de658e6-da32-4d01-9097-6f43c92222e1 -topic_type: +topic_type: - "apiref" --- # StrongNameGetBlobFromImage Function -Gets a binary representation of the assembly image at the specified memory address. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameGetBlobFromImage](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameGetBlobFromImage ( - [in] BYTE *pbBase, - [in] DWORD dwLength, - [in] BYTE *pbBlob, - [in, out] DWORD *pcbBlob -); -``` - -## Parameters - - `pbBase` - [in] The memory address of the mapped assembly manifest. - - `dwLength` - [in] The size, in bytes, of the image at `pbBase`. - - `pbBlob` - [in] A buffer to contain the binary representation of the image. - - `pcbBlob` - [in, out] The requested maximum size, in bytes, of `pbBlob`. Upon return, the actual size, in bytes, of `pbBlob`. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - If the `StrongNameGetBlobFromImage` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets a binary representation of the assembly image at the specified memory address. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameGetBlobFromImage](../hosting/iclrstrongname-strongnamegetblobfromimage-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameGetBlobFromImage ( + [in] BYTE *pbBase, + [in] DWORD dwLength, + [in] BYTE *pbBlob, + [in, out] DWORD *pcbBlob +); +``` + +## Parameters + + `pbBase` + [in] The memory address of the mapped assembly manifest. + + `dwLength` + [in] The size, in bytes, of the image at `pbBase`. + + `pbBlob` + [in] A buffer to contain the binary representation of the image. + + `pcbBlob` + [in, out] The requested maximum size, in bytes, of `pbBlob`. Upon return, the actual size, in bytes, of `pbBlob`. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + If the `StrongNameGetBlobFromImage` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameGetBlobFromImage Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md) -- [StrongNameGetBlob Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [StrongNameGetBlobFromImage Method](../hosting/iclrstrongname-strongnamegetblobfromimage-method.md) +- [StrongNameGetBlob Method](../hosting/iclrstrongname-strongnamegetblob-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamegetpublickey-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamegetpublickey-function.md index 98d11b89d68fe..1b746b7a8f41c 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamegetpublickey-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamegetpublickey-function.md @@ -2,83 +2,83 @@ description: "Learn more about: StrongNameGetPublicKey Function" title: "StrongNameGetPublicKey Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameGetPublicKey" -api_location: +api_location: - "mscoree.dll" - "mscorsn.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameGetPublicKey" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameGetPublicKey function [.NET Framework strong naming]" ms.assetid: 5b58c87f-3f72-40df-9b9a-291076931cc3 -topic_type: +topic_type: - "apiref" --- # StrongNameGetPublicKey Function -Gets the public key from a private/public key pair. The key pair can be supplied either as a key container name within a cryptographic service provider (CSP) or as a raw collection of bytes. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameGetPublicKey](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md) method instead. - -## Syntax - -```cpp +Gets the public key from a private/public key pair. The key pair can be supplied either as a key container name within a cryptographic service provider (CSP) or as a raw collection of bytes. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameGetPublicKey](../hosting/iclrstrongname-strongnamegetpublickey-method.md) method instead. + +## Syntax + +```cpp BOOLEAN StrongNameGetPublicKey ( - [in] LPCWSTR szKeyContainer, - [in] BYTE *pbKeyBlob, - [in] ULONG cbKeyBlob, - [out] BYTE **ppbPublicKeyBlob, - [out] ULONG *pcbPublicKeyBlob -); -``` - -## Parameters - - `szKeyContainer` - [in] The name of the key container that contains the public/private key pair. If `pbKeyBlob` is null, `szKeyContainer` must specify a valid container within the CSP. In this case, `StrongNameGetPublicKey` extracts the public key from the key pair stored in the container. - - If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). - - The keys must be 1024-bit Rivest-Shamir-Adleman (RSA) signing keys. No other types of keys are supported at this time. - - `pbKeyBlob` - [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `szKeyContainer` is assumed to contain the key pair. - - `cbKeyBlob` - [in] The size, in bytes, of `pbKeyBlob`. - - `ppbPublicKeyBlob` - [out] The returned public key BLOB. The `ppbPublicKeyBlob` parameter is allocated by the common language runtime and returned to the caller. The caller must free the memory by using the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function. - - `pcbPublicKeyBlob` - [out] The size of the returned public key BLOB. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - The public key is contained in a [PublicKeyBlob](publickeyblob-structure.md) structure. - - If the `StrongNameGetPublicKey` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [in] LPCWSTR szKeyContainer, + [in] BYTE *pbKeyBlob, + [in] ULONG cbKeyBlob, + [out] BYTE **ppbPublicKeyBlob, + [out] ULONG *pcbPublicKeyBlob +); +``` + +## Parameters + + `szKeyContainer` + [in] The name of the key container that contains the public/private key pair. If `pbKeyBlob` is null, `szKeyContainer` must specify a valid container within the CSP. In this case, `StrongNameGetPublicKey` extracts the public key from the key pair stored in the container. + + If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). + + The keys must be 1024-bit Rivest-Shamir-Adleman (RSA) signing keys. No other types of keys are supported at this time. + + `pbKeyBlob` + [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `szKeyContainer` is assumed to contain the key pair. + + `cbKeyBlob` + [in] The size, in bytes, of `pbKeyBlob`. + + `ppbPublicKeyBlob` + [out] The returned public key BLOB. The `ppbPublicKeyBlob` parameter is allocated by the common language runtime and returned to the caller. The caller must free the memory by using the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function. + + `pcbPublicKeyBlob` + [out] The size of the returned public key BLOB. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + The public key is contained in a [PublicKeyBlob](publickeyblob-structure.md) structure. + + If the `StrongNameGetPublicKey` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameGetPublicKey Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md) -- [StrongNameTokenFromPublicKey Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [StrongNameGetPublicKey Method](../hosting/iclrstrongname-strongnamegetpublickey-method.md) +- [StrongNameTokenFromPublicKey Method](../hosting/iclrstrongname-strongnametokenfrompublickey-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) - [PublicKeyBlob Structure](publickeyblob-structure.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamehashsize-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamehashsize-function.md index 112ce83878514..60627bafc4c1e 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamehashsize-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamehashsize-function.md @@ -2,62 +2,62 @@ description: "Learn more about: StrongNameHashSize Function" title: "StrongNameHashSize Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameHashSize" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameHashSize" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameHashSize function [.NET Framework strong naming]" ms.assetid: 738c98d7-a60c-45fe-a296-220af05e6991 -topic_type: +topic_type: - "apiref" --- # StrongNameHashSize Function -Gets the buffer size required for a hash, using the specified hash algorithm. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameHashSize](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameHashSize ( - [in] ULONG ulHashAlg, - [out] DWORD *pcbSize -); -``` - -## Parameters - - `ulHashAlg` - [in] The hash algorithm used to compute the buffer size. - - `pcbSize` - [out] The returned buffer size, in bytes. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - If the `StrongNameHashSize` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets the buffer size required for a hash, using the specified hash algorithm. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameHashSize](../hosting/iclrstrongname-strongnamehashsize-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameHashSize ( + [in] ULONG ulHashAlg, + [out] DWORD *pcbSize +); +``` + +## Parameters + + `ulHashAlg` + [in] The hash algorithm used to compute the buffer size. + + `pcbSize` + [out] The returned buffer size, in bytes. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + If the `StrongNameHashSize` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameHashSize Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [StrongNameHashSize Method](../hosting/iclrstrongname-strongnamehashsize-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamekeydelete-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamekeydelete-function.md index 71fbe95d45111..360583928e657 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamekeydelete-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamekeydelete-function.md @@ -21,7 +21,7 @@ topic_type: Deletes the specified key container. -This function has been deprecated. Use the [ICLRStrongName::StrongNameKeyDelete](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md) method instead. +This function has been deprecated. Use the [ICLRStrongName::StrongNameKeyDelete](../hosting/iclrstrongname-strongnamekeydelete-method.md) method instead. ## Syntax @@ -58,6 +58,6 @@ If the `StrongNameKeyDelete` function does not complete successfully, call the [ ## See also -- [StrongNameKeyDelete Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md) -- [StrongNameKeyInstall Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [StrongNameKeyDelete Method](../hosting/iclrstrongname-strongnamekeydelete-method.md) +- [StrongNameKeyInstall Method](../hosting/iclrstrongname-strongnamekeyinstall-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamekeygen-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamekeygen-function.md index 0ab47575bcdfb..98e16f366066f 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamekeygen-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamekeygen-function.md @@ -2,77 +2,77 @@ description: "Learn more about: StrongNameKeyGen Function" title: "StrongNameKeyGen Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameKeyGen" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameKeyGen" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameKeyGen function [.NET Framework strong naming]" ms.assetid: 883e413a-ad2f-4f7f-b1b9-aeb8fe5b65f8 -topic_type: +topic_type: - "apiref" --- # StrongNameKeyGen Function -Creates a new public/private key pair for strong name use. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameKeyGen](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameKeyGen ( - [in] LPCWSTR wszKeyContainer, - [in] DWORD dwFlags, - [out] BYTE **ppbKeyBlob, - [out] ULONG *pcbKeyBlob -); -``` - -## Parameters - - `wszKeyContainer` - [in] The requested key container name. `wszKeyContainer` must be a non-empty string, or null to generate a temporary name. - - `dwFlags` - [in] Specifies whether to leave the key registered. The following values are supported: - -- 0x00000000 - Used when `wszKeyContainer` is null to generate a temporary key container name. - -- 0x00000001 (`SN_LEAVE_KEY`) - Specifies that the key should be left registered. - - `ppbKeyBlob` - [out] The returned public/private key pair. - - `pcbKeyBlob` - [out] The size, in bytes, of `ppbKeyBlob`. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - The `StrongNameKeyGen` function creates a 1024-bit key. After the key is retrieved, you should call the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function to release the allocated memory. - - If the `StrongNameKeyGen` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Creates a new public/private key pair for strong name use. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameKeyGen](../hosting/iclrstrongname-strongnamekeygen-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameKeyGen ( + [in] LPCWSTR wszKeyContainer, + [in] DWORD dwFlags, + [out] BYTE **ppbKeyBlob, + [out] ULONG *pcbKeyBlob +); +``` + +## Parameters + + `wszKeyContainer` + [in] The requested key container name. `wszKeyContainer` must be a non-empty string, or null to generate a temporary name. + + `dwFlags` + [in] Specifies whether to leave the key registered. The following values are supported: + +- 0x00000000 - Used when `wszKeyContainer` is null to generate a temporary key container name. + +- 0x00000001 (`SN_LEAVE_KEY`) - Specifies that the key should be left registered. + + `ppbKeyBlob` + [out] The returned public/private key pair. + + `pcbKeyBlob` + [out] The size, in bytes, of `ppbKeyBlob`. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + The `StrongNameKeyGen` function creates a 1024-bit key. After the key is retrieved, you should call the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function to release the allocated memory. + + If the `StrongNameKeyGen` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameKeyGen Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md) -- [StrongNameKeyGenEx Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [StrongNameKeyGen Method](../hosting/iclrstrongname-strongnamekeygen-method.md) +- [StrongNameKeyGenEx Method](../hosting/iclrstrongname-strongnamekeygenex-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamekeygenex-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamekeygenex-function.md index 400e373c8303c..5d1cbdbbd5e99 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamekeygenex-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamekeygenex-function.md @@ -2,83 +2,83 @@ description: "Learn more about: StrongNameKeyGenEx Function" title: "StrongNameKeyGenEx Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameKeyGenEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameKeyGenEx" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameKeyGenEx function [.NET Framework strong naming]" ms.assetid: 36bd10b9-9857-45f3-8d3b-0da091d6169e -topic_type: +topic_type: - "apiref" --- # StrongNameKeyGenEx Function -Generates a new public/private key pair with the specified key size, for strong name use. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameKeyGenEx](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameKeyGenEx ( - [in] LPCWSTR wszKeyContainer, - [in] DWORD dwFlags, - [in] DWORD dwKeySize, - [out] BYTE **ppbKeyBlob, - [out] ULONG *pcbKeyBlob -); -``` - -## Parameters - - `wszKeyContainer` - [in] The requested key container name. `wszKeyContainer` must be a non-empty string, or null to generate a temporary name. - - `dwFlags` - [in] Specifies whether to leave the key registered. The following values are supported: - -- 0x00000000 - Used when `wszKeyContainer` is null to generate a temporary key container name. - -- 0x00000001 (`SN_LEAVE_KEY`) - Specifies that the key should be left registered. - - `dwKeySize` - [in] The requested size of the key, in bits. - - `ppbKeyBlob` - [out] The returned public/private key pair. - - `pcbKeyBlob` - [out] The size, in bytes, of `ppbKeyBlob`. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - The .NET Framework versions 1.0 and 1.1 require a `dwKeySize` of 1024 bits to sign an assembly with a strong name; version 2.0 adds supports for 2048-bit keys. - - After the key is retrieved, you should call the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function to release the allocated memory. - - If the `StrongNameKeyGenEx` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Generates a new public/private key pair with the specified key size, for strong name use. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameKeyGenEx](../hosting/iclrstrongname-strongnamekeygenex-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameKeyGenEx ( + [in] LPCWSTR wszKeyContainer, + [in] DWORD dwFlags, + [in] DWORD dwKeySize, + [out] BYTE **ppbKeyBlob, + [out] ULONG *pcbKeyBlob +); +``` + +## Parameters + + `wszKeyContainer` + [in] The requested key container name. `wszKeyContainer` must be a non-empty string, or null to generate a temporary name. + + `dwFlags` + [in] Specifies whether to leave the key registered. The following values are supported: + +- 0x00000000 - Used when `wszKeyContainer` is null to generate a temporary key container name. + +- 0x00000001 (`SN_LEAVE_KEY`) - Specifies that the key should be left registered. + + `dwKeySize` + [in] The requested size of the key, in bits. + + `ppbKeyBlob` + [out] The returned public/private key pair. + + `pcbKeyBlob` + [out] The size, in bytes, of `ppbKeyBlob`. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + The .NET Framework versions 1.0 and 1.1 require a `dwKeySize` of 1024 bits to sign an assembly with a strong name; version 2.0 adds supports for 2048-bit keys. + + After the key is retrieved, you should call the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function to release the allocated memory. + + If the `StrongNameKeyGenEx` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameKeyGenEx Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md) -- [StrongNameKeyGen Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [StrongNameKeyGenEx Method](../hosting/iclrstrongname-strongnamekeygenex-method.md) +- [StrongNameKeyGen Method](../hosting/iclrstrongname-strongnamekeygen-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamekeyinstall-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamekeyinstall-function.md index 51491b2b2567a..ca205e86cab79 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamekeyinstall-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamekeyinstall-function.md @@ -21,7 +21,7 @@ topic_type: Imports a public/private key pair into a container. -This function has been deprecated. Use the [ICLRStrongName::StrongNameKeyInstall](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md) method instead. +This function has been deprecated. Use the [ICLRStrongName::StrongNameKeyInstall](../hosting/iclrstrongname-strongnamekeyinstall-method.md) method instead. ## Syntax @@ -66,6 +66,6 @@ If the `StrongNameKeyInstall` function does not complete successfully, call the ## See also -- [StrongNameKeyInstall Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md) -- [StrongNameKeyDelete Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [StrongNameKeyInstall Method](../hosting/iclrstrongname-strongnamekeyinstall-method.md) +- [StrongNameKeyDelete Method](../hosting/iclrstrongname-strongnamekeydelete-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamesignaturegeneration-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamesignaturegeneration-function.md index 39e7c9dbf87d3..e7a579a9fa2c9 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamesignaturegeneration-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamesignaturegeneration-function.md @@ -2,90 +2,90 @@ description: "Learn more about: StrongNameSignatureGeneration Function" title: "StrongNameSignatureGeneration Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameSignatureGeneration" -api_location: +api_location: - "mscoree.dll" - "mscorsn.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameSignatureGeneration" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameSignatureGeneration function [.NET Framework strong naming]" ms.assetid: 839b765c-3e41-44ce-bf1b-dc10453db18e --- # StrongNameSignatureGeneration Function -Generates a strong name signature for the specified assembly. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameSignatureGeneration](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md) method instead. - -## Syntax - -```cpp +Generates a strong name signature for the specified assembly. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameSignatureGeneration](../hosting/iclrstrongname-strongnamesignaturegeneration-method.md) method instead. + +## Syntax + +```cpp BOOLEAN StrongNameSignatureGeneration ( - [in] LPCWSTR wszFilePath, - [in] LPCWSTR wszKeyContainer, - [in] BYTE *pbKeyBlob, - [in] ULONG cbKeyBlob, - [out] BYTE **ppbSignatureBlob, - [out] ULONG *pcbSignatureBlob -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the file that contains the manifest of the assembly for which the strong name signature will be generated. - - `wszKeyContainer` - [in] The name of the key container that contains the public/private key pair. - - If `pbKeyBlob` is null, `wszKeyContainer` must specify a valid container within the cryptographic service provider (CSP). In this case, the key pair stored in the container is used to sign the file. - - If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). - - The keys must be 1024-bit Rivest-Shamir-Adleman (RSA) signing keys. No other types of keys are supported at this time. - - `pbKeyBlob` - [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `wszKeyContainer` is assumed to contain the key pair. - - `cbKeyBlob` - [in] The size, in bytes, of `pbKeyBlob`. - - `ppbSignatureBlob` - [out] A pointer to the location to which the common language runtime returns the signature. If `ppbSignatureBlob` is null, the runtime stores the signature in the file specified by `wszFilePath`. - - If `ppbSignatureBlob` is not null, the common language runtime allocates space in which to return the signature. The caller must free this space using the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function. - - `pcbSignatureBlob` - [out] The size, in bytes, of the returned signature. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - Specify null for `wszFilePath` to calculate the size of the signature without creating the signature. - - The signature can be stored either directly in the file, or returned to the caller. - - If the `StrongNameSignatureGeneration` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [in] LPCWSTR wszFilePath, + [in] LPCWSTR wszKeyContainer, + [in] BYTE *pbKeyBlob, + [in] ULONG cbKeyBlob, + [out] BYTE **ppbSignatureBlob, + [out] ULONG *pcbSignatureBlob +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the file that contains the manifest of the assembly for which the strong name signature will be generated. + + `wszKeyContainer` + [in] The name of the key container that contains the public/private key pair. + + If `pbKeyBlob` is null, `wszKeyContainer` must specify a valid container within the cryptographic service provider (CSP). In this case, the key pair stored in the container is used to sign the file. + + If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). + + The keys must be 1024-bit Rivest-Shamir-Adleman (RSA) signing keys. No other types of keys are supported at this time. + + `pbKeyBlob` + [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `wszKeyContainer` is assumed to contain the key pair. + + `cbKeyBlob` + [in] The size, in bytes, of `pbKeyBlob`. + + `ppbSignatureBlob` + [out] A pointer to the location to which the common language runtime returns the signature. If `ppbSignatureBlob` is null, the runtime stores the signature in the file specified by `wszFilePath`. + + If `ppbSignatureBlob` is not null, the common language runtime allocates space in which to return the signature. The caller must free this space using the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function. + + `pcbSignatureBlob` + [out] The size, in bytes, of the returned signature. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + Specify null for `wszFilePath` to calculate the size of the signature without creating the signature. + + The signature can be stored either directly in the file, or returned to the caller. + + If the `StrongNameSignatureGeneration` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameSignatureGeneration Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md) -- [StrongNameSignatureGenerationEx Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [StrongNameSignatureGeneration Method](../hosting/iclrstrongname-strongnamesignaturegeneration-method.md) +- [StrongNameSignatureGenerationEx Method](../hosting/iclrstrongname-strongnamesignaturegenerationex-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamesignaturegenerationex-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamesignaturegenerationex-function.md index e21e63dd3a55f..fb7f01f117337 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamesignaturegenerationex-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamesignaturegenerationex-function.md @@ -2,101 +2,101 @@ description: "Learn more about: StrongNameSignatureGenerationEx Function" title: "StrongNameSignatureGenerationEx Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameSignatureGenerationEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameSignatureGenerationEx" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameSignatureGenerationEx function [.NET Framework strong naming]" ms.assetid: 9a75469e-aa49-4e32-ad48-3bafd5202f09 -topic_type: +topic_type: - "apiref" --- # StrongNameSignatureGenerationEx Function -Generates a strong name signature for the specified assembly, according to the specified flags. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameSignatureGenerationEx](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameSignatureGenerationEx ( - [in] LPCWSTR wszFilePath, - [in] LPCWSTR wszKeyContainer, - [in] BYTE *pbKeyBlob, - [in] ULONG cbKeyBlob, - [out] BYTE **ppbSignatureBlob, - [out] ULONG *pcbSignatureBlob, - [in] DWORD dwFlags -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the file that contains the manifest of the assembly for which the strong name signature will be generated. - - `wszKeyContainer` - [in] The name of the key container that contains the public/private key pair. - - If `pbKeyBlob` is null, `wszKeyContainer` must specify a valid container within the cryptographic service provider (CSP). In this case, the key pair stored in the container is used to sign the file. - - If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). - - `pbKeyBlob` - [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `wszKeyContainer` is assumed to contain the key pair. - - `cbKeyBlob` - [in] The size, in bytes, of `pbKeyBlob`. - - `ppbSignatureBlob` - [out] A pointer to the location to which the common language runtime returns the signature. If `ppbSignatureBlob` is null, the runtime stores the signature in the file specified by `wszFilePath`. - - If `ppbSignatureBlob` is not null, the common language runtime allocates space in which to return the signature. The caller must free this space using the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function. - - `pcbSignatureBlob` - [out] The size, in bytes, of the returned signature. - - `dwFlags` - [in] One or more of the following values: - -- `SN_SIGN_ALL_FILES` (0x00000001) - Recompute all hashes for linked modules. - -- `SN_TEST_SIGN` (0x00000002) - Test-sign the assembly. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - Specify null for `wszFilePath` to calculate the size of the signature without creating the signature. - - The signature can be either stored directly in the file, or returned to the caller. - - If `SN_SIGN_ALL_FILES` is specified but a public key is not included (both `pbKeyBlob` and `wszFilePath` are null), hashes for linked modules are recomputed, but the assembly is not re-signed. - - If `SN_TEST_SIGN` is specified, the common language runtime header is not modified to indicate that the assembly is signed with a strong name. - - If the `StrongNameSignatureGenerationEx` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Generates a strong name signature for the specified assembly, according to the specified flags. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameSignatureGenerationEx](../hosting/iclrstrongname-strongnamesignaturegenerationex-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameSignatureGenerationEx ( + [in] LPCWSTR wszFilePath, + [in] LPCWSTR wszKeyContainer, + [in] BYTE *pbKeyBlob, + [in] ULONG cbKeyBlob, + [out] BYTE **ppbSignatureBlob, + [out] ULONG *pcbSignatureBlob, + [in] DWORD dwFlags +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the file that contains the manifest of the assembly for which the strong name signature will be generated. + + `wszKeyContainer` + [in] The name of the key container that contains the public/private key pair. + + If `pbKeyBlob` is null, `wszKeyContainer` must specify a valid container within the cryptographic service provider (CSP). In this case, the key pair stored in the container is used to sign the file. + + If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). + + `pbKeyBlob` + [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `wszKeyContainer` is assumed to contain the key pair. + + `cbKeyBlob` + [in] The size, in bytes, of `pbKeyBlob`. + + `ppbSignatureBlob` + [out] A pointer to the location to which the common language runtime returns the signature. If `ppbSignatureBlob` is null, the runtime stores the signature in the file specified by `wszFilePath`. + + If `ppbSignatureBlob` is not null, the common language runtime allocates space in which to return the signature. The caller must free this space using the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function. + + `pcbSignatureBlob` + [out] The size, in bytes, of the returned signature. + + `dwFlags` + [in] One or more of the following values: + +- `SN_SIGN_ALL_FILES` (0x00000001) - Recompute all hashes for linked modules. + +- `SN_TEST_SIGN` (0x00000002) - Test-sign the assembly. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + Specify null for `wszFilePath` to calculate the size of the signature without creating the signature. + + The signature can be either stored directly in the file, or returned to the caller. + + If `SN_SIGN_ALL_FILES` is specified but a public key is not included (both `pbKeyBlob` and `wszFilePath` are null), hashes for linked modules are recomputed, but the assembly is not re-signed. + + If `SN_TEST_SIGN` is specified, the common language runtime header is not modified to indicate that the assembly is signed with a strong name. + + If the `StrongNameSignatureGenerationEx` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameSignatureGenerationEx Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md) -- [StrongNameSignatureGeneration Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [StrongNameSignatureGenerationEx Method](../hosting/iclrstrongname-strongnamesignaturegenerationex-method.md) +- [StrongNameSignatureGeneration Method](../hosting/iclrstrongname-strongnamesignaturegeneration-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamesignaturesize-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamesignaturesize-function.md index 7d940f24a1d75..e90f48d6778fa 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamesignaturesize-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamesignaturesize-function.md @@ -2,66 +2,66 @@ description: "Learn more about: StrongNameSignatureSize Function" title: "StrongNameSignatureSize Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameSignatureSize" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameSignatureSize" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameSignatureSize function [.NET Framework strong naming]" ms.assetid: 4fde4cd0-f53e-4411-a2fe-fc5c54472f95 -topic_type: +topic_type: - "apiref" --- # StrongNameSignatureSize Function -Returns the size of the strong name signature. `StrongNameSignatureSize` is typically used by compilers to determine how much space to reserve in the file when creating a delay-signed assembly. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameSignatureSize](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md) method instead. - -## Syntax - -```cpp +Returns the size of the strong name signature. `StrongNameSignatureSize` is typically used by compilers to determine how much space to reserve in the file when creating a delay-signed assembly. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameSignatureSize](../hosting/iclrstrongname-strongnamesignaturesize-method.md) method instead. + +## Syntax + +```cpp BOOLEAN StrongNameSignatureSize ( - [in] BYTE *pbPublicKeyBlob, + [in] BYTE *pbPublicKeyBlob, [in] ULONG cbPublicKeyBlob, - [in] DWORD *pcbSize + [in] DWORD *pcbSize ); -``` - -## Parameters - - `pbPublicKeyBlob` - [in] A structure of type [PublicKeyBlob](publickeyblob-structure.md) that contains the public portion of the key pair used to generate the strong name signature. - - `cbPublicKeyBlob` - [in] The size, in bytes, of `pbPublicKeyBlob`. - - `pcbSize` - [in] The number of bytes required to store the strong name signature. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - If the `StrongNameSignatureSize` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +``` + +## Parameters + + `pbPublicKeyBlob` + [in] A structure of type [PublicKeyBlob](publickeyblob-structure.md) that contains the public portion of the key pair used to generate the strong name signature. + + `cbPublicKeyBlob` + [in] The size, in bytes, of `pbPublicKeyBlob`. + + `pcbSize` + [in] The number of bytes required to store the strong name signature. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + If the `StrongNameSignatureSize` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameSignatureSize Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [StrongNameSignatureSize Method](../hosting/iclrstrongname-strongnamesignaturesize-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverification-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverification-function.md index 0ddc7d6d4ae39..1d556e1553f79 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverification-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverification-function.md @@ -2,77 +2,77 @@ description: "Learn more about: StrongNameSignatureVerification Function" title: "StrongNameSignatureVerification Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameSignatureVerification" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameSignatureVerification" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameSignatureVerification function [.NET Framework strong naming]" ms.assetid: 933758dd-231e-4382-8819-242c0a13a4b7 -topic_type: +topic_type: - "apiref" --- # StrongNameSignatureVerification Function -Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature, which is verified according to the specified flags. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameSignatureVerification](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameSignatureVerification ( - [in] LPCWSTR wszFilePath, - [in] DWORD dwInFlags, - [out] DWORD *pdwOutFlags -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the portable executable (.dll or .exe) file for the assembly to verify. - - `dwInFlags` - [in] Flags to modify the verification behavior. The following values are supported: - -- `SN_INFLAG_FORCE_VER` (0x00000001) - Forces verification even if it is necessary to override registry settings. - -- `SN_INFLAG_INSTALL` (0x00000002) - Specifies that this is the first time the manifest is verified. - -- `SN_INFLAG_ADMIN_ACCESS` (0x00000004) - Specifies that the cache will allow access only to users who have administrative privileges. - -- `SN_INFLAG_USER_ACCESS` (0x00000008) - Specifies that the assembly will be accessible only to the current user. - -- `SN_INFLAG_ALL_ACCESS` (0x00000010) - Specifies that the cache will provide no guarantees of access restriction. - -- `SN_INFLAG_RUNTIME` (0x80000000) - Reserved for internal debugging. - - `pdwOutFlags` - [out] Flags indicating whether the strong name signature was verified. The following value is supported: - -- `SN_OUTFLAG_WAS_VERIFIED` (0x00000001) - This value is set to `false` to specify that the verification succeeded due to registry settings. - -## Return Value - - `true` if the verification was successful; otherwise, `false`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in MsCorEE.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature, which is verified according to the specified flags. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameSignatureVerification](../hosting/iclrstrongname-strongnamesignatureverification-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameSignatureVerification ( + [in] LPCWSTR wszFilePath, + [in] DWORD dwInFlags, + [out] DWORD *pdwOutFlags +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the portable executable (.dll or .exe) file for the assembly to verify. + + `dwInFlags` + [in] Flags to modify the verification behavior. The following values are supported: + +- `SN_INFLAG_FORCE_VER` (0x00000001) - Forces verification even if it is necessary to override registry settings. + +- `SN_INFLAG_INSTALL` (0x00000002) - Specifies that this is the first time the manifest is verified. + +- `SN_INFLAG_ADMIN_ACCESS` (0x00000004) - Specifies that the cache will allow access only to users who have administrative privileges. + +- `SN_INFLAG_USER_ACCESS` (0x00000008) - Specifies that the assembly will be accessible only to the current user. + +- `SN_INFLAG_ALL_ACCESS` (0x00000010) - Specifies that the cache will provide no guarantees of access restriction. + +- `SN_INFLAG_RUNTIME` (0x80000000) - Reserved for internal debugging. + + `pdwOutFlags` + [out] Flags indicating whether the strong name signature was verified. The following value is supported: + +- `SN_OUTFLAG_WAS_VERIFIED` (0x00000001) - This value is set to `false` to specify that the verification succeeded due to registry settings. + +## Return Value + + `true` if the verification was successful; otherwise, `false`. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in MsCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameSignatureVerification Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md) -- [StrongNameSignatureVerificationEx Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [StrongNameSignatureVerification Method](../hosting/iclrstrongname-strongnamesignatureverification-method.md) +- [StrongNameSignatureVerificationEx Method](../hosting/iclrstrongname-strongnamesignatureverificationex-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverificationex-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverificationex-function.md index bca1fe54d19f1..3b793d1f8c696 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverificationex-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverificationex-function.md @@ -2,68 +2,68 @@ description: "Learn more about: StrongNameSignatureVerificationEx Function" title: "StrongNameSignatureVerificationEx Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameSignatureVerificationEx" -api_location: +api_location: - "mscoree.dll" - "mscorwks.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameSignatureVerificationEx" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameSignatureVerificationEx function [.NET Framework strong naming]" ms.assetid: cfe4b634-18bf-44b8-9773-d94fb7e8a480 -topic_type: +topic_type: - "apiref" --- # StrongNameSignatureVerificationEx Function -Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameSignatureVerificationEx](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameSignatureVerificationEx ( - [in] LPCWSTR wszFilePath, - [in] BOOLEAN fForceVerification, - [out] BOOLEAN *pfWasVerified -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the portable executable (.exe or .dll) file for the assembly to be verified. - - `fForceVerification` - [in] `true` to perform verification, even if it is necessary to override registry settings; otherwise, `false`. - - `pfWasVerified` - [out] `true` if the strong name signature was verified; otherwise, `false`. `pfWasVerified` is also set to `false` if the verification was successful due to registry settings. - -## Return Value - - `true` if the verification was successful; otherwise, `false`. - -## Remarks - - `StrongNameSignatureVerificationEx` provides a capability similar to the [StrongNameSignatureVerification](strongnamesignatureverification-function.md) function. However, the second input parameter and the output parameter for `StrongNameSignatureVerificationEx` are of type `BOOLEAN` instead of `DWORD`. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in mscoree.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameSignatureVerificationEx](../hosting/iclrstrongname-strongnamesignatureverificationex-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameSignatureVerificationEx ( + [in] LPCWSTR wszFilePath, + [in] BOOLEAN fForceVerification, + [out] BOOLEAN *pfWasVerified +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the portable executable (.exe or .dll) file for the assembly to be verified. + + `fForceVerification` + [in] `true` to perform verification, even if it is necessary to override registry settings; otherwise, `false`. + + `pfWasVerified` + [out] `true` if the strong name signature was verified; otherwise, `false`. `pfWasVerified` is also set to `false` if the verification was successful due to registry settings. + +## Return Value + + `true` if the verification was successful; otherwise, `false`. + +## Remarks + + `StrongNameSignatureVerificationEx` provides a capability similar to the [StrongNameSignatureVerification](strongnamesignatureverification-function.md) function. However, the second input parameter and the output parameter for `StrongNameSignatureVerificationEx` are of type `BOOLEAN` instead of `DWORD`. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in mscoree.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameSignatureVerificationEx Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md) -- [StrongNameSignatureVerification Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [StrongNameSignatureVerificationEx Method](../hosting/iclrstrongname-strongnamesignatureverificationex-method.md) +- [StrongNameSignatureVerification Method](../hosting/iclrstrongname-strongnamesignatureverification-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverificationfromimage-function.md b/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverificationfromimage-function.md index 5e9ed0ab92097..63e49d3c65244 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverificationfromimage-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnamesignatureverificationfromimage-function.md @@ -2,84 +2,84 @@ description: "Learn more about: StrongNameSignatureVerificationFromImage Function" title: "StrongNameSignatureVerificationFromImage Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameSignatureVerificationFromImage" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameSignatureVerificationFromImage" -helpviewer_keywords: +helpviewer_keywords: - "StrongnameSignatureVerificationFromImage function [.NET Framework strong naming]" ms.assetid: 9fb144d2-07e0-4a0e-8e05-907bbb6c9e03 -topic_type: +topic_type: - "apiref" --- # StrongNameSignatureVerificationFromImage Function -Verifies that an assembly that has already been mapped to memory is valid for the associated public key. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameVerificationFromImage](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameSignatureVerificationFromImage ( - [in] BYTE *pbBase, - [in] DWORD dwLength, - [in] DWORD dwInFlags, - [out] DWORD *pdwOutFlags -); -``` - -## Parameters - - `pbBase` - [in] The relative virtual address of the mapped assembly manifest. - - `dwLength` - [in] The size, in bytes, of the mapped image. - - `dwInFlags` - [in] Flags that influence verification behavior. The following values are supported: - -- `SN_INFLAG_FORCE_VER` (0x00000001) - Forces verification even if it is necessary to override registry settings. - -- `SN_INFLAG_INSTALL` (0x00000002) - Specifies that this is the first verification performed on this image. - -- `SN_INFLAG_ADMIN_ACCESS` (0x00000004) - Specifies that the cache will allow access only to users who have administrative privileges. - -- `SN_INFLAG_USER_ACCESS` (0x00000008) - Specifies that the assembly will be accessible only to the current user. - -- `SN_INFLAG_ALL_ACCESS` (0x00000010) - Specifies that the cache will provide no guarantees of access restriction. - -- `SN_INFLAG_RUNTIME` (0x80000000) - Reserved for internal debugging. - - `pdwOutFlags` - [out] A flag for additional output information. The following value is supported: - -- `SN_OUTFLAG_WAS_VERIFIED` (0x00000001) - This value is set to `false` to specify that the verification succeeded due to registry settings. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - If the `StrongNameSignatureVerificationFromImage` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in mscoree.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Verifies that an assembly that has already been mapped to memory is valid for the associated public key. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameVerificationFromImage](../hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameSignatureVerificationFromImage ( + [in] BYTE *pbBase, + [in] DWORD dwLength, + [in] DWORD dwInFlags, + [out] DWORD *pdwOutFlags +); +``` + +## Parameters + + `pbBase` + [in] The relative virtual address of the mapped assembly manifest. + + `dwLength` + [in] The size, in bytes, of the mapped image. + + `dwInFlags` + [in] Flags that influence verification behavior. The following values are supported: + +- `SN_INFLAG_FORCE_VER` (0x00000001) - Forces verification even if it is necessary to override registry settings. + +- `SN_INFLAG_INSTALL` (0x00000002) - Specifies that this is the first verification performed on this image. + +- `SN_INFLAG_ADMIN_ACCESS` (0x00000004) - Specifies that the cache will allow access only to users who have administrative privileges. + +- `SN_INFLAG_USER_ACCESS` (0x00000008) - Specifies that the assembly will be accessible only to the current user. + +- `SN_INFLAG_ALL_ACCESS` (0x00000010) - Specifies that the cache will provide no guarantees of access restriction. + +- `SN_INFLAG_RUNTIME` (0x80000000) - Reserved for internal debugging. + + `pdwOutFlags` + [out] A flag for additional output information. The following value is supported: + +- `SN_OUTFLAG_WAS_VERIFIED` (0x00000001) - This value is set to `false` to specify that the verification succeeded due to registry settings. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + If the `StrongNameSignatureVerificationFromImage` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in mscoree.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameSignatureVerificationFromImage Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [StrongNameSignatureVerificationFromImage Method](../hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnametokenfromassembly-function.md b/docs/framework/unmanaged-api/strong-naming/strongnametokenfromassembly-function.md index 9ac20e98fa5f1..444bc965e67bc 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnametokenfromassembly-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnametokenfromassembly-function.md @@ -2,71 +2,71 @@ description: "Learn more about: StrongNameTokenFromAssembly Function" title: "StrongNameTokenFromAssembly Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameTokenFromAssembly" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameTokenFromAssembly" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameTokenFromAssembly function [.NET Framework strong naming]" ms.assetid: 0a4b47ee-02f6-4a98-864e-a6f11ca3f2d9 -topic_type: +topic_type: - "apiref" --- # StrongNameTokenFromAssembly Function -Creates a strong name token from the specified assembly file. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameTokenFromAssembly](../../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameTokenFromAssembly ( - [in] LPCWSTR wszFilePath, - [out] BYTE **ppbStrongNameToken, - [out] ULONG *pcbStrongNameToken -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the portable executable (PE) file for the assembly. - - `ppbStrongNameToken` - [out] The returned strong name token. - - `pcbStrongNameToken` - [out] The size, in bytes, of the strong name token. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - A strong name token is the shortened form of a public key. The token is a 64-bit hash that is created from the public key used to sign the assembly. The token is a part of the strong name for the assembly, and can be read from the assembly metadata. - - After the token is created, you should call the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function to release the allocated memory. - - If the `StrongNameTokenFromAssembly` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in mscoree.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Creates a strong name token from the specified assembly file. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameTokenFromAssembly](../hosting/iclrstrongname-strongnametokenfromassembly-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameTokenFromAssembly ( + [in] LPCWSTR wszFilePath, + [out] BYTE **ppbStrongNameToken, + [out] ULONG *pcbStrongNameToken +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the portable executable (PE) file for the assembly. + + `ppbStrongNameToken` + [out] The returned strong name token. + + `pcbStrongNameToken` + [out] The size, in bytes, of the strong name token. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + A strong name token is the shortened form of a public key. The token is a 64-bit hash that is created from the public key used to sign the assembly. The token is a part of the strong name for the assembly, and can be read from the assembly metadata. + + After the token is created, you should call the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function to release the allocated memory. + + If the `StrongNameTokenFromAssembly` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in mscoree.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameTokenFromAssembly Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md) -- [StrongNameTokenFromAssemblyEx Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [StrongNameTokenFromAssembly Method](../hosting/iclrstrongname-strongnametokenfromassembly-method.md) +- [StrongNameTokenFromAssemblyEx Method](../hosting/iclrstrongname-strongnametokenfromassemblyex-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnametokenfromassemblyex-function.md b/docs/framework/unmanaged-api/strong-naming/strongnametokenfromassemblyex-function.md index e286fb9071f89..85852b0858807 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnametokenfromassemblyex-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnametokenfromassemblyex-function.md @@ -2,79 +2,79 @@ description: "Learn more about: StrongNameTokenFromAssemblyEx Function" title: "StrongNameTokenFromAssemblyEx Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameTokenFromAssemblyEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "StrongNameTokenFromAssemblyEx" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameTokenFromAssemblyEx function [.NET Framework strong naming]" ms.assetid: 67a8a9f2-dee3-44b2-a1c0-f307a3bdf90f -topic_type: +topic_type: - "apiref" --- # StrongNameTokenFromAssemblyEx Function -Creates a strong name token from the specified assembly file, and returns the public key that the token represents. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameTokenFromAssemblyEx](../../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md) method instead. - -## Syntax - -```cpp -BOOLEAN StrongNameTokenFromAssemblyEx ( - [in] LPCWSTR wszFilePath, - [out] BYTE **ppbStrongNameToken, - [out] ULONG *pcbStrongNameToken, - [out] BYTE **ppbPublicKeyBlob, - [out] ULONG *pcbPublicKeyBlob -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the portable executable (PE) file for the assembly. - - `ppbStrongNameToken` - [out] The returned strong name token. - - `pcbStrongNameToken` - [out] The size, in bytes, of the strong name token. - - `ppbPublicKeyBlob` - [out] The returned public key. - - `pcbPublicKeyBlob` - [out] The size, in bytes, of the public key. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - A strong name token is the shortened form of a public key. The token is a 64-bit hash that is created from the public key used to sign the assembly. The token is a part of the strong name for the assembly, and can be read from the assembly metadata. - - After the key is retrieved and the token is created, you should call the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function to release the allocated memory. - - If the `StrongNameTokenFromAssemblyEx` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in mscoree.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - +Creates a strong name token from the specified assembly file, and returns the public key that the token represents. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameTokenFromAssemblyEx](../hosting/iclrstrongname-strongnametokenfromassemblyex-method.md) method instead. + +## Syntax + +```cpp +BOOLEAN StrongNameTokenFromAssemblyEx ( + [in] LPCWSTR wszFilePath, + [out] BYTE **ppbStrongNameToken, + [out] ULONG *pcbStrongNameToken, + [out] BYTE **ppbPublicKeyBlob, + [out] ULONG *pcbPublicKeyBlob +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the portable executable (PE) file for the assembly. + + `ppbStrongNameToken` + [out] The returned strong name token. + + `pcbStrongNameToken` + [out] The size, in bytes, of the strong name token. + + `ppbPublicKeyBlob` + [out] The returned public key. + + `pcbPublicKeyBlob` + [out] The size, in bytes, of the public key. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + A strong name token is the shortened form of a public key. The token is a 64-bit hash that is created from the public key used to sign the assembly. The token is a part of the strong name for the assembly, and can be read from the assembly metadata. + + After the key is retrieved and the token is created, you should call the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function to release the allocated memory. + + If the `StrongNameTokenFromAssemblyEx` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in mscoree.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameTokenFromAssemblyEx Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md) -- [StrongNameTokenFromAssembly Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [StrongNameTokenFromAssemblyEx Method](../hosting/iclrstrongname-strongnametokenfromassemblyex-method.md) +- [StrongNameTokenFromAssembly Method](../hosting/iclrstrongname-strongnametokenfromassembly-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/strong-naming/strongnametokenfrompublickey-function.md b/docs/framework/unmanaged-api/strong-naming/strongnametokenfrompublickey-function.md index f8950de3a38ea..c53be651407e6 100644 --- a/docs/framework/unmanaged-api/strong-naming/strongnametokenfrompublickey-function.md +++ b/docs/framework/unmanaged-api/strong-naming/strongnametokenfrompublickey-function.md @@ -2,77 +2,77 @@ description: "Learn more about: StrongNameTokenFromPublicKey Function" title: "StrongNameTokenFromPublicKey Function" ms.date: "03/30/2017" -api_name: +api_name: - "StrongNameTokenFromPublicKey" -api_location: +api_location: - "mscoree.dll" - "mscorsn.dll" - "clr.dll" - "mscorwks.dll" - "mscoreei.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "StrongNameTokenFromPublicKey" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameTokenFromPublicKey function [.NET Framework strong naming]" ms.assetid: 997e9e57-abb2-4217-bf20-1df621a75add -topic_type: +topic_type: - "apiref" --- # StrongNameTokenFromPublicKey Function -Gets a token representing a public key. A strong name token is the shortened form of a public key. - - This function has been deprecated. Use the [ICLRStrongName::StrongNameTokenFromPublicKey](../../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md) method instead. - -## Syntax - -```cpp +Gets a token representing a public key. A strong name token is the shortened form of a public key. + + This function has been deprecated. Use the [ICLRStrongName::StrongNameTokenFromPublicKey](../hosting/iclrstrongname-strongnametokenfrompublickey-method.md) method instead. + +## Syntax + +```cpp BOOLEAN StrongNameTokenFromPublicKey ( - [in] BYTE *pbPublicKeyBlob, - [in] ULONG cbPublicKeyBlob, - [out] BYTE **ppbStrongNameToken, - [out] ULONG *pcbStrongNameToken -); -``` - -## Parameters - - `pbPublicKeyBlob` - [in] A structure of type [PublicKeyBlob](publickeyblob-structure.md) that contains the public portion of the key pair used to generate the strong name signature. - - `cbPublicKeyBlob` - [in] The size, in bytes, of `pbPublicKeyBlob`. - - `ppbStrongNameToken` - [out] The strong name token corresponding to the key passed in `pbPublicKeyBlob`. The common language runtime allocates the memory in which to return the token. The caller must free this memory by using the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function. - - `pcbStrongNameToken` - [out] The size, in bytes, of the returned strong name token. - -## Return Value - - `true` on successful completion; otherwise, `false`. - -## Remarks - - A strong name token is the shortened form of a public key used to save space when storing key information in metadata. Specifically, strong name tokens are used in assembly references to refer to the dependent assembly. - - If the `StrongNameTokenFromPublicKey` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. - -## Requirements - - **Platforms:** See [System Requirements](../../get-started/system-requirements.md). - - **Header:** StrongName.h - - **Library:** Included as a resource in mscoree.dll - - **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] - + [in] BYTE *pbPublicKeyBlob, + [in] ULONG cbPublicKeyBlob, + [out] BYTE **ppbStrongNameToken, + [out] ULONG *pcbStrongNameToken +); +``` + +## Parameters + + `pbPublicKeyBlob` + [in] A structure of type [PublicKeyBlob](publickeyblob-structure.md) that contains the public portion of the key pair used to generate the strong name signature. + + `cbPublicKeyBlob` + [in] The size, in bytes, of `pbPublicKeyBlob`. + + `ppbStrongNameToken` + [out] The strong name token corresponding to the key passed in `pbPublicKeyBlob`. The common language runtime allocates the memory in which to return the token. The caller must free this memory by using the [StrongNameFreeBuffer](strongnamefreebuffer-function.md) function. + + `pcbStrongNameToken` + [out] The size, in bytes, of the returned strong name token. + +## Return Value + + `true` on successful completion; otherwise, `false`. + +## Remarks + + A strong name token is the shortened form of a public key used to save space when storing key information in metadata. Specifically, strong name tokens are used in assembly references to refer to the dependent assembly. + + If the `StrongNameTokenFromPublicKey` function does not complete successfully, call the [StrongNameErrorInfo](strongnameerrorinfo-function.md) function to retrieve the last generated error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** StrongName.h + + **Library:** Included as a resource in mscoree.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also -- [StrongNameTokenFromPublicKey Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md) -- [StrongNameGetPublicKey Method](../../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md) +- [StrongNameTokenFromPublicKey Method](../hosting/iclrstrongname-strongnametokenfrompublickey-method.md) +- [StrongNameGetPublicKey Method](../hosting/iclrstrongname-strongnamegetpublickey-method.md) - [PublicKeyBlob Structure](publickeyblob-structure.md) From b9f0e6f5bbb61bfb2af43bd2ae67de51dfc612df Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Thu, 26 Jun 2025 20:39:27 +0200 Subject: [PATCH 14/20] resets for hosting --- docs/core/unmanaged-api/index.md | 10 +- docs/framework/unmanaged-api/index.md | 33 +- docs/framework/unmanaged-api/toc.yml | 3 +- .../wcf/migrating-from-net-remoting-to-wcf.md | 1228 ++++++++--------- .../system-threading-thread.md | 2 +- docs/navigate/tools-diagnostics/toc.yml | 2 + .../app-domain-resource-monitoring.md | 14 +- .../garbage-collection/performance.md | 2 +- .../exceptions-in-managed-threads.md | 2 +- .../threading/the-managed-thread-pool.md | 4 +- 10 files changed, 650 insertions(+), 650 deletions(-) diff --git a/docs/core/unmanaged-api/index.md b/docs/core/unmanaged-api/index.md index 5c98323766f21..90f591625b53e 100644 --- a/docs/core/unmanaged-api/index.md +++ b/docs/core/unmanaged-api/index.md @@ -9,16 +9,16 @@ This section includes information on unmanaged APIs that can be used by managed- 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 +## In this section -[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. -[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) +[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. diff --git a/docs/framework/unmanaged-api/index.md b/docs/framework/unmanaged-api/index.md index 907b35d084cf5..67a91602fc7f9 100644 --- a/docs/framework/unmanaged-api/index.md +++ b/docs/framework/unmanaged-api/index.md @@ -15,46 +15,43 @@ This section includes information on unmanaged APIs that can be used by managed- For unmanaged APIs that can be used with both .NET Framework and .NET, see [.NET unmanaged API reference](../../core/unmanaged-api/index.md). -## In This Section +## In this section - [Common Data Types](common-data-types-unmanaged-api-reference.md) + [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)) + [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](../../core/unmanaged-api/hosting/index.md) - For hosting APIs that can be used with both .NET Framework and .NET, see the .NET unmanaged API reference. + [Hosting](./hosting/index.md)\ + Describes the hosting API, which enables unmanaged hosts to integrate the CLR into their applications. - [Metadata](../../core/unmanaged-api/metadata/index.md) - For metadata APIs that can be used with both .NET Framework and .NET, see the .NET unmanaged API reference. - - [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/toc.yml b/docs/framework/unmanaged-api/toc.yml index 6336be1765b22..e0922db3284b9 100644 --- a/docs/framework/unmanaged-api/toc.yml +++ b/docs/framework/unmanaged-api/toc.yml @@ -1,5 +1,4 @@ items: - - name: .NET Framework unmanaged API reference href: index.md - name: Common data types @@ -37,6 +36,8 @@ items: href: diagnostics/ - name: Fusion href: fusion/ +- name: Hosting + href: hosting/ - name: Profiling href: profiling/ - name: Strong naming diff --git a/docs/framework/wcf/migrating-from-net-remoting-to-wcf.md b/docs/framework/wcf/migrating-from-net-remoting-to-wcf.md index c2ed3361d886f..e129a0ac1546b 100644 --- a/docs/framework/wcf/migrating-from-net-remoting-to-wcf.md +++ b/docs/framework/wcf/migrating-from-net-remoting-to-wcf.md @@ -4,673 +4,673 @@ description: Learn how to migrate an application that uses .NET Remoting to use ms.date: "03/30/2017" ms.assetid: 16902a42-ef80-40e9-8c4c-90e61ddfdfe5 --- -# Migrate from .NET Remoting to WCF - -This article describes how to migrate an application that uses .NET Remoting to use Windows Communication Foundation (WCF). It compares similar concepts between these products and then describes how to accomplish several common Remoting scenarios in WCF. - - .NET Remoting is a legacy product that is supported only for backward compatibility. It is not secure across mixed-trust environments because it cannot maintain the separate trust levels between client and server. For example, you should never expose a .NET Remoting endpoint to the Internet or to untrusted clients. We recommend existing Remoting applications be migrated to newer and more secure technologies. If the application's design uses only HTTP and is RESTful, we recommend ASP.NET Web API. For more information, see ASP.NET Web API. If the application is based on SOAP or requires non-Http protocols such as TCP, we recommend WCF. - -## Comparing .NET Remoting to WCF - - This section compares the basic building blocks of .NET Remoting with their WCF equivalents. We will use these building blocks later to create some common client-server scenarios in WCF. The following chart summarizes the main similarities and differences between .NET Remoting and WCF. - -| | .NET Remoting | WCF | -|------------------------|-------------------------------------|-------------------------------------------------| -| **Server type** | Subclass `MarshalByRefObject` | Mark with `[ServiceContract]` attribute | -| **Service operations** | Public methods on server type | Mark with `[OperationContract]` attribute | -| **Serialization** | `ISerializable` or `[Serializable]` | `DataContractSerializer` or `XmlSerializer` | -| **Objects passed** | By-value or by-reference | By-value only | -| **Errors/exceptions** | Any serializable exception | `FaultContract` | -| **Client proxy objects** | Strongly typed transparent proxies are created automatically from MarshalByRefObjects | Strongly typed proxies are generated on-demand using ChannelFactory\ | -| **Platform required** | Both client and server must use Microsoft OS and .NET | Cross-platform | -| **Message format** | Private | Industry standards (for example, SOAP and WS-*) | - -### Server Implementation Comparison - -#### Creating a Server in .NET Remoting - - .NET Remoting server types must derive from MarshalByRefObject and define methods the client can call, like the following: - +# Migrating from .NET Remoting to WCF + +This article describes how to migrate an application that uses .NET Remoting to use Windows Communication Foundation (WCF). It compares similar concepts between these products and then describes how to accomplish several common Remoting scenarios in WCF. + + .NET Remoting is a legacy product that is supported only for backward compatibility. It is not secure across mixed-trust environments because it cannot maintain the separate trust levels between client and server. For example, you should never expose a .NET Remoting endpoint to the Internet or to untrusted clients. We recommend existing Remoting applications be migrated to newer and more secure technologies. If the application’s design uses only HTTP and is RESTful, we recommend ASP.NET Web API. For more information, see ASP.NET Web API. If the application is based on SOAP or requires non-Http protocols such as TCP, we recommend WCF. + +## Comparing .NET Remoting to WCF + + This section compares the basic building blocks of .NET Remoting with their WCF equivalents. We will use these building blocks later to create some common client-server scenarios in WCF. The following chart summarizes the main similarities and differences between .NET Remoting and WCF. + +| | .NET Remoting | WCF | +|--------------------------|---------------------------------------------------------------------------------------|--------------------------------------------------------------------------------| +| **Server type** | Subclass `MarshalByRefObject` | Mark with `[ServiceContract]` attribute | +| **Service operations** | Public methods on server type | Mark with `[OperationContract]` attribute | +| **Serialization** | `ISerializable` or `[Serializable]` | `DataContractSerializer` or `XmlSerializer` | +| **Objects passed** | By-value or by-reference | By-value only | +| **Errors/exceptions** | Any serializable exception | `FaultContract` | +| **Client proxy objects** | Strongly typed transparent proxies are created automatically from MarshalByRefObjects | Strongly typed proxies are generated on-demand using ChannelFactory\ | +| **Platform required** | Both client and server must use Microsoft OS and .NET | Cross-platform | +| **Message format** | Private | Industry standards (for example, SOAP and WS-*) | + +### Server Implementation Comparison + +#### Creating a Server in .NET Remoting + + .NET Remoting server types must derive from MarshalByRefObject and define methods the client can call, like the following: + ```csharp -public class RemotingServer : MarshalByRefObject -{ - public Customer GetCustomer(int customerId) { … } -} -``` - - The public methods of this server type become the public contract available to clients. There is no separation between the server's public interface and its implementation - one type handles both. - - Once the server type has been defined, it can be made available to clients, like in the following example: - +public class RemotingServer : MarshalByRefObject +{ + public Customer GetCustomer(int customerId) { … } +} +``` + + The public methods of this server type become the public contract available to clients. There is no separation between the server's public interface and its implementation - one type handles both. + + Once the server type has been defined, it can be made available to clients, like in the following example: + ```csharp -TcpChannel channel = new TcpChannel(8080); -ChannelServices.RegisterChannel(channel, ensureSecurity : true); -RemotingConfiguration.RegisterWellKnownServiceType( +TcpChannel channel = new TcpChannel(8080); +ChannelServices.RegisterChannel(channel, ensureSecurity : true); +RemotingConfiguration.RegisterWellKnownServiceType( typeof(RemotingServer), "RemotingServer", - WellKnownObjectMode.Singleton); -Console.WriteLine("RemotingServer is running. Press ENTER to terminate..."); -Console.ReadLine(); -``` - - There are many ways to make the Remoting type available as a server, including using configuration files. This is just one example. - -#### Creating a Server in WCF - - The equivalent step in WCF involves creating two types -- the public "service contract" and the concrete implementation. The first is declared as an interface marked with [ServiceContract]. Methods available to clients are marked with [OperationContract]: - + WellKnownObjectMode.Singleton); +Console.WriteLine("RemotingServer is running. Press ENTER to terminate..."); +Console.ReadLine(); +``` + + There are many ways to make the Remoting type available as a server, including using configuration files. This is just one example. + +#### Creating a Server in WCF + + The equivalent step in WCF involves creating two types -- the public "service contract" and the concrete implementation. The first is declared as an interface marked with [ServiceContract]. Methods available to clients are marked with [OperationContract]: + ```csharp -[ServiceContract] -public interface IWCFServer -{ - [OperationContract] - Customer GetCustomer(int customerId); -} -``` - - The server's implementation is defined in a separate concrete class, like in the following example: - +[ServiceContract] +public interface IWCFServer +{ + [OperationContract] + Customer GetCustomer(int customerId); +} +``` + + The server’s implementation is defined in a separate concrete class, like in the following example: + ```csharp -public class WCFServer : IWCFServer -{ - public Customer GetCustomer(int customerId) { … } -} -``` - - Once these types have been defined, the WCF server can be made available to clients, like in the following example: - +public class WCFServer : IWCFServer +{ + public Customer GetCustomer(int customerId) { … } +} +``` + + Once these types have been defined, the WCF server can be made available to clients, like in the following example: + ```csharp -NetTcpBinding binding = new NetTcpBinding(); -Uri baseAddress = new Uri("net.tcp://localhost:8000/wcfserver"); - -using (ServiceHost serviceHost = new ServiceHost(typeof(WCFServer), baseAddress)) -{ - serviceHost.AddServiceEndpoint(typeof(IWCFServer), binding, baseAddress); - serviceHost.Open(); - +NetTcpBinding binding = new NetTcpBinding(); +Uri baseAddress = new Uri("net.tcp://localhost:8000/wcfserver"); + +using (ServiceHost serviceHost = new ServiceHost(typeof(WCFServer), baseAddress)) +{ + serviceHost.AddServiceEndpoint(typeof(IWCFServer), binding, baseAddress); + serviceHost.Open(); + Console.WriteLine($"The WCF server is ready at {baseAddress}."); - Console.WriteLine("Press to terminate service..."); - Console.WriteLine(); - Console.ReadLine(); -} -``` - + Console.WriteLine("Press to terminate service..."); + Console.WriteLine(); + Console.ReadLine(); +} +``` + > [!NOTE] -> TCP is used in both examples to keep them as similar as possible. Refer to the scenario walk-throughs later in this topic for examples using HTTP. - - There are many ways to configure and to host WCF services. This is just one example, known as "self-hosted". For more information, see the following topics: - -- [How to: Define a Service Contract](how-to-define-a-wcf-service-contract.md) - -- [Configuring Services Using Configuration Files](configuring-services-using-configuration-files.md) - -- [Hosting Services](hosting-services.md) - -### Client Implementation Comparison - -#### Creating a Client in .NET Remoting - - Once a .NET Remoting server object has been made available, it can be consumed by clients, like in the following example: - +> TCP is used in both examples to keep them as similar as possible. Refer to the scenario walk-throughs later in this topic for examples using HTTP. + + There are many ways to configure and to host WCF services. This is just one example, known as "self-hosted". For more information, see the following topics: + +- [How to: Define a Service Contract](how-to-define-a-wcf-service-contract.md) + +- [Configuring Services Using Configuration Files](configuring-services-using-configuration-files.md) + +- [Hosting Services](hosting-services.md) + +### Client Implementation Comparison + +#### Creating a Client in .NET Remoting + + Once a .NET Remoting server object has been made available, it can be consumed by clients, like in the following example: + ```csharp -TcpChannel channel = new TcpChannel(); -ChannelServices.RegisterChannel(channel, ensureSecurity : true); -RemotingServer server = (RemotingServer)Activator.GetObject( +TcpChannel channel = new TcpChannel(); +ChannelServices.RegisterChannel(channel, ensureSecurity : true); +RemotingServer server = (RemotingServer)Activator.GetObject( typeof(RemotingServer), - "tcp://localhost:8080/RemotingServer"); - -RemotingCustomer customer = server.GetCustomer(42); + "tcp://localhost:8080/RemotingServer"); + +RemotingCustomer customer = server.GetCustomer(42); Console.WriteLine($"Customer {customer.FirstName} {customer.LastName} received."); -``` - - The RemotingServer instance returned from Activator.GetObject() is known as a "transparent proxy." It implements the public API for the RemotingServer type on the client, but all the methods call the server object running in a different process or machine. - -#### Creating a Client in WCF - - The equivalent step in WCF involves using a channel factory to create the proxy explicitly. Like Remoting, the proxy object can be used to invoke operations on the server, like in the following example: - +``` + + The RemotingServer instance returned from Activator.GetObject() is known as a "transparent proxy." It implements the public API for the RemotingServer type on the client, but all the methods call the server object running in a different process or machine. + +#### Creating a Client in WCF + + The equivalent step in WCF involves using a channel factory to create the proxy explicitly. Like Remoting, the proxy object can be used to invoke operations on the server, like in the following example: + ```csharp -NetTcpBinding binding = new NetTcpBinding(); -String url = "net.tcp://localhost:8000/wcfserver"; -EndpointAddress address = new EndpointAddress(url); +NetTcpBinding binding = new NetTcpBinding(); +String url = "net.tcp://localhost:8000/wcfserver"; +EndpointAddress address = new EndpointAddress(url); ChannelFactory channelFactory = - new ChannelFactory(binding, address); -IWCFServer server = channelFactory.CreateChannel(); - -Customer customer = server.GetCustomer(42); + new ChannelFactory(binding, address); +IWCFServer server = channelFactory.CreateChannel(); + +Customer customer = server.GetCustomer(42); Console.WriteLine($" Customer {customer.FirstName} {customer.LastName} received."); -``` - - This example shows programming at the channel level because it is most similar to the Remoting example. Also available is the **Add Service Reference** approach in Visual Studio that generates code to simplify client programming. For more information, see the following topics: - -- [Client Channel-Level Programming](./extending/client-channel-level-programming.md) - -- [How to: Add, Update, or Remove a Service Reference](/visualstudio/data-tools/how-to-add-update-or-remove-a-wcf-data-service-reference) - -### Serialization Usage - - Both .NET Remoting and WCF use serialization to send objects between client and server, but they differ in these important ways: - -1. They use different serializers and conventions to indicate what to serialize. - -2. .NET Remoting supports "by reference" serialization that allows method or property access on one tier to execute code on the other tier, which is across security boundaries. This capability exposes security vulnerabilities and is one of the main reasons why Remoting endpoints should never be exposed to untrusted clients. - -3. Serialization used by Remoting is opt-out (explicitly exclude what not to serialize) and WCF serialization is opt-in (explicitly mark which members to serialize). - -#### Serialization in .NET Remoting - - .NET Remoting supports two ways to serialize and deserialize objects between the client and server: - -- *By value* – the values of the object are serialized across tier boundaries, and a new instance of that object is created on the other tier. Any calls to methods or properties of that new instance execute only locally and do not affect the original object or tier. - -- *By reference* – a special "object reference" is serialized across tier boundaries. When one tier interacts with methods or properties of that object, it communicates back to the original object on the original tier. By-reference objects can flow in either direction – server to client, or client to server. - - By-value types in Remoting are marked with the [Serializable] attribute or implement ISerializable, like in the following example: - +``` + + This example shows programming at the channel level because it is most similar to the Remoting example. Also available is the **Add Service Reference** approach in Visual Studio that generates code to simplify client programming. For more information, see the following topics: + +- [Client Channel-Level Programming](./extending/client-channel-level-programming.md) + +- [How to: Add, Update, or Remove a Service Reference](/visualstudio/data-tools/how-to-add-update-or-remove-a-wcf-data-service-reference) + +### Serialization Usage + + Both .NET Remoting and WCF use serialization to send objects between client and server, but they differ in these important ways: + +1. They use different serializers and conventions to indicate what to serialize. + +2. .NET Remoting supports "by reference" serialization that allows method or property access on one tier to execute code on the other tier, which is across security boundaries. This capability exposes security vulnerabilities and is one of the main reasons why Remoting endpoints should never be exposed to untrusted clients. + +3. Serialization used by Remoting is opt-out (explicitly exclude what not to serialize) and WCF serialization is opt-in (explicitly mark which members to serialize). + +#### Serialization in .NET Remoting + + .NET Remoting supports two ways to serialize and deserialize objects between the client and server: + +- *By value* – the values of the object are serialized across tier boundaries, and a new instance of that object is created on the other tier. Any calls to methods or properties of that new instance execute only locally and do not affect the original object or tier. + +- *By reference* – a special "object reference" is serialized across tier boundaries. When one tier interacts with methods or properties of that object, it communicates back to the original object on the original tier. By-reference objects can flow in either direction – server to client, or client to server. + + By-value types in Remoting are marked with the [Serializable] attribute or implement ISerializable, like in the following example: + ```csharp -[Serializable] -public class RemotingCustomer -{ - public string FirstName { get; set; } - public string LastName { get; set; } - public int CustomerId { get; set; } -} -``` - - By-reference types derive from the MarshalByRefObject class, like in the following example: - +[Serializable] +public class RemotingCustomer +{ + public string FirstName { get; set; } + public string LastName { get; set; } + public int CustomerId { get; set; } +} +``` + + By-reference types derive from the MarshalByRefObject class, like in the following example: + ```csharp -public class RemotingCustomerReference : MarshalByRefObject -{ - public string FirstName { get; set; } - public string LastName { get; set; } - public int CustomerId { get; set; } -} -``` - - It is extremely important to understand the implications of Remoting's by-reference objects. If either tier (client or server) sends a by-reference object to the other tier, all method calls execute back on the tier owning the object. For example, a client calling methods on a by-reference object returned by the server will execute code on the server. Similarly, a server calling methods on a by-reference object provided by the client will execute code back on the client. For this reason, the use of .NET Remoting is recommended only within fully-trusted environments. Exposing a public .NET Remoting endpoint to untrusted clients will make a Remoting server vulnerable to attack. - -#### Serialization in WCF - - WCF supports only by-value serialization. The most common way to define a type to exchange between client and server is like in the following example: - +public class RemotingCustomerReference : MarshalByRefObject +{ + public string FirstName { get; set; } + public string LastName { get; set; } + public int CustomerId { get; set; } +} +``` + + It is extremely important to understand the implications of Remoting’s by-reference objects. If either tier (client or server) sends a by-reference object to the other tier, all method calls execute back on the tier owning the object. For example, a client calling methods on a by-reference object returned by the server will execute code on the server. Similarly, a server calling methods on a by-reference object provided by the client will execute code back on the client. For this reason, the use of .NET Remoting is recommended only within fully-trusted environments. Exposing a public .NET Remoting endpoint to untrusted clients will make a Remoting server vulnerable to attack. + +#### Serialization in WCF + + WCF supports only by-value serialization. The most common way to define a type to exchange between client and server is like in the following example: + ```csharp -[DataContract] -public class WCFCustomer -{ - [DataMember] - public string FirstName { get; set; } - - [DataMember] - public string LastName { get; set; } - - [DataMember] - public int CustomerId { get; set; } -} -``` - - The [DataContract] attribute identifies this type as one that can be serialized and deserialized between client and server. The [DataMember] attribute identifies the individual properties or fields to serialize. - - When WCF sends an object across tiers, it serializes only the values and creates a new instance of the object on the other tier. Any interactions with the values of the object occur only locally – they do not communicate with the other tier the way .NET Remoting by-reference objects do. For more information, see [Serialization and Deserialization](./feature-details/serialization-and-deserialization.md). - -### Exception Handling Capabilities - -#### Exceptions in .NET Remoting - - Exceptions thrown by a Remoting server are serialized, sent to the client, and thrown locally on the client like any other exception. Custom exceptions can be created by sub-classing the Exception type and marking it with [Serializable]. Most framework exceptions are already marked in this way, allowing most to be thrown by the server, serialized, and re-thrown on the client. Though this design is convenient during development, server-side information can inadvertently be disclosed to the client. This is one of many reasons Remoting should be used only in fully-trusted environments. - -#### Exceptions and Faults in WCF - - WCF does not allow arbitrary exception types to be returned from the server to the client because it could lead to inadvertent information disclosure. If a service operation throws an unexpected exception, it causes a general purpose FaultException to be thrown on the client. This exception does not carry any information why or where the problem occurred, and for some applications this is sufficient. Applications that need to communicate richer error information to the client do this by defining a fault contract. - - To do this, first create a [DataContract] type to carry the fault information. - +[DataContract] +public class WCFCustomer +{ + [DataMember] + public string FirstName { get; set; } + + [DataMember] + public string LastName { get; set; } + + [DataMember] + public int CustomerId { get; set; } +} +``` + + The [DataContract] attribute identifies this type as one that can be serialized and deserialized between client and server. The [DataMember] attribute identifies the individual properties or fields to serialize. + + When WCF sends an object across tiers, it serializes only the values and creates a new instance of the object on the other tier. Any interactions with the values of the object occur only locally – they do not communicate with the other tier the way .NET Remoting by-reference objects do. For more information, see [Serialization and Deserialization](./feature-details/serialization-and-deserialization.md). + +### Exception Handling Capabilities + +#### Exceptions in .NET Remoting + + Exceptions thrown by a Remoting server are serialized, sent to the client, and thrown locally on the client like any other exception. Custom exceptions can be created by sub-classing the Exception type and marking it with [Serializable]. Most framework exceptions are already marked in this way, allowing most to be thrown by the server, serialized, and re-thrown on the client. Though this design is convenient during development, server-side information can inadvertently be disclosed to the client. This is one of many reasons Remoting should be used only in fully-trusted environments. + +#### Exceptions and Faults in WCF + + WCF does not allow arbitrary exception types to be returned from the server to the client because it could lead to inadvertent information disclosure. If a service operation throws an unexpected exception, it causes a general purpose FaultException to be thrown on the client. This exception does not carry any information why or where the problem occurred, and for some applications this is sufficient. Applications that need to communicate richer error information to the client do this by defining a fault contract. + + To do this, first create a [DataContract] type to carry the fault information. + ```csharp -[DataContract] -public class CustomerServiceFault -{ - [DataMember] - public string ErrorMessage { get; set; } - - [DataMember] - public int CustomerId {get;set;} -} -``` - - Specify the fault contract to use for each service operation. - +[DataContract] +public class CustomerServiceFault +{ + [DataMember] + public string ErrorMessage { get; set; } + + [DataMember] + public int CustomerId {get;set;} +} +``` + + Specify the fault contract to use for each service operation. + ```csharp -[ServiceContract] -public interface IWCFServer -{ - [OperationContract] - [FaultContract(typeof(CustomerServiceFault))] - Customer GetCustomer(int customerId); -} -``` - - The server reports error conditions by throwing a FaultException. - +[ServiceContract] +public interface IWCFServer +{ + [OperationContract] + [FaultContract(typeof(CustomerServiceFault))] + Customer GetCustomer(int customerId); +} +``` + + The server reports error conditions by throwing a FaultException. + ```csharp -throw new FaultException( +throw new FaultException( new CustomerServiceFault() { CustomerId = customerId, ErrorMessage = "Illegal customer Id" - }); -``` - - And whenever the client makes a request to the server, it can catch faults as normal exceptions. - + }); +``` + + And whenever the client makes a request to the server, it can catch faults as normal exceptions. + ```csharp -try -{ - Customer customer = server.GetCustomer(-1); -} -catch (FaultException fault) -{ +try +{ + Customer customer = server.GetCustomer(-1); +} +catch (FaultException fault) +{ Console.WriteLine($"Fault received: {fault.Detail.ErrorMessage}"); -} -``` - - For more information about fault contracts, see . - -### Security Considerations - -#### Security in .NET Remoting - - Some .NET Remoting channels support security features such as authentication and encryption at the channel layer (IPC and TCP). The HTTP channel relies on Internet Information Services (IIS) for both authentication and encryption. Despite this support, you should consider .NET Remoting an unsecure communication protocol and use it only within fully-trusted environments. Never expose a public Remoting endpoint to the Internet or untrusted clients. - -#### Security in WCF - - WCF was designed with security in mind, in part to address the kinds of vulnerabilities found in .NET Remoting. WCF offers security at both the transport and message level, and offers many options for authentication, authorization, encryption, and so on. For more information, see the following topics: - -- [Security](./feature-details/security.md) - -- [WCF Security Guidance](./feature-details/security-guidance-and-best-practices.md) - -## Migrating to WCF - -### Why Migrate from Remoting to WCF? - -- **.NET Remoting is a legacy product.** As described in [.NET Remoting](/previous-versions/dotnet/netframework-4.0/72x4h507(v=vs.100)), it is considered a legacy product and is not recommended for new development. WCF or ASP.NET Web API are recommended for new and existing applications. - +} +``` + + For more information about fault contracts, see . + +### Security Considerations + +#### Security in .NET Remoting + + Some .NET Remoting channels support security features such as authentication and encryption at the channel layer (IPC and TCP). The HTTP channel relies on Internet Information Services (IIS) for both authentication and encryption. Despite this support, you should consider .NET Remoting an unsecure communication protocol and use it only within fully-trusted environments. Never expose a public Remoting endpoint to the Internet or untrusted clients. + +#### Security in WCF + + WCF was designed with security in mind, in part to address the kinds of vulnerabilities found in .NET Remoting. WCF offers security at both the transport and message level, and offers many options for authentication, authorization, encryption, and so on. For more information, see the following topics: + +- [Security](./feature-details/security.md) + +- [WCF Security Guidance](./feature-details/security-guidance-and-best-practices.md) + +## Migrating to WCF + +### Why Migrate from Remoting to WCF? + +- **.NET Remoting is a legacy product.** As described in [.NET Remoting](/previous-versions/dotnet/netframework-4.0/72x4h507(v=vs.100)), it is considered a legacy product and is not recommended for new development. WCF or ASP.NET Web API are recommended for new and existing applications. + - **WCF uses cross-platform standards.** WCF was designed with cross-platform interoperability in mind and supports many industry standards (SOAP, WS-Security, WS-Trust, etc.). A WCF service can interoperate with clients running on operating systems other than Windows. Remoting was designed primarily for environments where both the server and client applications run using .NET Framework on a Windows operating system. - -- **WCF has built-in security.** WCF was designed with security in mind and offers many options for authentication, transport level security, message level security, etc. Remoting was designed to make it easy for applications to interoperate but was not designed to be secure in non-trusted environments. WCF was designed to work in both trusted and non-trusted environments. - -### Migration Recommendations - - The following are the recommended steps to migrate from .NET Remoting to WCF: - -- **Create the service contract.** Define your service interface types, and mark them with the [ServiceContract] attribute.Mark all the methods the clients will be allowed to call with [OperationContract]. - -- **Create the data contract.** Define the data types that will be exchanged between server and client, and mark them with the [DataContract] attribute. Mark all the fields and properties the client will be allowed to use with [DataMember]. - -- **Create the fault contract (optional).** Create the types that will be exchanged between server and client when errors are encountered. Mark these types with [DataContract] and [DataMember] to make them serializable. For all service operations you marked with [OperationContract], also mark them with [FaultContract] to indicate which errors they may return. - -- **Configure and host the service.** Once the service contract has been created, the next step is to configure a binding to expose the service at an endpoint. For more information, see [Endpoints: Addresses, Bindings, and Contracts](./feature-details/endpoints-addresses-bindings-and-contracts.md). - - Once a Remoting application has been migrated to WCF, it is still important to remove dependencies on .NET Remoting. This ensures that any Remoting vulnerabilities are removed from the application. These steps include the following: - -- **Discontinue use of MarshalByRefObject.** The MarshalByRefObject type exists only for Remoting and is not used by WCF. Any application types that sub-class MarshalByRefObject should be removed or changed. - -- **Discontinue use of [Serializable] and ISerializable.** The [Serializable] attribute and ISerializable interface were originally designed to serialize types within trusted environments, and they are used by Remoting. WCF serialization relies on types being marked with [DataContract] and [DataMember]. Data types used by an application should be modified to use [DataContract] and not to use ISerializable or [Serializable]. - -### Migration Scenarios - - Now let's see how to accomplish the following common Remoting scenarios in WCF: - -1. Server returns an object by-value to the client - -2. Server returns an object by-reference to the client - -3. Client sends an object by-value to the server - + +- **WCF has built-in security.** WCF was designed with security in mind and offers many options for authentication, transport level security, message level security, etc. Remoting was designed to make it easy for applications to interoperate but was not designed to be secure in non-trusted environments. WCF was designed to work in both trusted and non-trusted environments. + +### Migration Recommendations + + The following are the recommended steps to migrate from .NET Remoting to WCF: + +- **Create the service contract.** Define your service interface types, and mark them with the [ServiceContract] attribute.Mark all the methods the clients will be allowed to call with [OperationContract]. + +- **Create the data contract.** Define the data types that will be exchanged between server and client, and mark them with the [DataContract] attribute. Mark all the fields and properties the client will be allowed to use with [DataMember]. + +- **Create the fault contract (optional).** Create the types that will be exchanged between server and client when errors are encountered. Mark these types with [DataContract] and [DataMember] to make them serializable. For all service operations you marked with [OperationContract], also mark them with [FaultContract] to indicate which errors they may return. + +- **Configure and host the service.** Once the service contract has been created, the next step is to configure a binding to expose the service at an endpoint. For more information, see [Endpoints: Addresses, Bindings, and Contracts](./feature-details/endpoints-addresses-bindings-and-contracts.md). + + Once a Remoting application has been migrated to WCF, it is still important to remove dependencies on .NET Remoting. This ensures that any Remoting vulnerabilities are removed from the application. These steps include the following: + +- **Discontinue use of MarshalByRefObject.** The MarshalByRefObject type exists only for Remoting and is not used by WCF. Any application types that sub-class MarshalByRefObject should be removed or changed. + +- **Discontinue use of [Serializable] and ISerializable.** The [Serializable] attribute and ISerializable interface were originally designed to serialize types within trusted environments, and they are used by Remoting. WCF serialization relies on types being marked with [DataContract] and [DataMember]. Data types used by an application should be modified to use [DataContract] and not to use ISerializable or [Serializable]. + +### Migration Scenarios + + Now let’s see how to accomplish the following common Remoting scenarios in WCF: + +1. Server returns an object by-value to the client + +2. Server returns an object by-reference to the client + +3. Client sends an object by-value to the server + > [!NOTE] -> Sending an object by-reference from the client to the server is not allowed in WCF. - - When reading through these scenarios, assume our baseline interfaces for .NET Remoting look like the following example. The .NET Remoting implementation is not important here because we want to illustrate only how to use WCF to implement equivalent functionality. - +> Sending an object by-reference from the client to the server is not allowed in WCF. + + When reading through these scenarios, assume our baseline interfaces for .NET Remoting look like the following example. The .NET Remoting implementation is not important here because we want to illustrate only how to use WCF to implement equivalent functionality. + ```csharp -public class RemotingServer : MarshalByRefObject -{ - // Demonstrates server returning object by-value - public Customer GetCustomer(int customerId) {…} - - // Demonstrates server returning object by-reference - public CustomerReference GetCustomerReference(int customerId) {…} - - // Demonstrates client passing object to server by-value - public bool UpdateCustomer(Customer customer) {…} -} -``` - -#### Scenario 1: Service Returns an Object by Value - - This scenario demonstrates a server returning an object to the client by value. WCF always returns objects from the server by value, so the following steps simply describe how to build a normal WCF service. - -1. Start by defining a public interface for the WCF service and mark it with the [ServiceContract] attribute. We use [OperationContract] to identify the server-side methods our client will call. - +public class RemotingServer : MarshalByRefObject +{ + // Demonstrates server returning object by-value + public Customer GetCustomer(int customerId) {…} + + // Demonstrates server returning object by-reference + public CustomerReference GetCustomerReference(int customerId) {…} + + // Demonstrates client passing object to server by-value + public bool UpdateCustomer(Customer customer) {…} +} +``` + +#### Scenario 1: Service Returns an Object by Value + + This scenario demonstrates a server returning an object to the client by value. WCF always returns objects from the server by value, so the following steps simply describe how to build a normal WCF service. + +1. Start by defining a public interface for the WCF service and mark it with the [ServiceContract] attribute. We use [OperationContract] to identify the server-side methods our client will call. + ```csharp - [ServiceContract] - public interface ICustomerService - { - [OperationContract] - Customer GetCustomer(int customerId); - - [OperationContract] - bool UpdateCustomer(Customer customer); - } - ``` - -2. The next step is to create the data contract for this service. We do this by creating classes (not interfaces) marked with the [DataContract] attribute. The individual properties or fields we want visible to both client and server are marked with [DataMember]. If we want derived types to be allowed, we must use the [KnownType] attribute to identify them. The only types WCF will allow to be serialized or deserialized for this service are those in the service interface and these "known types". Attempting to exchange any other type not in this list will be rejected. - + [ServiceContract] + public interface ICustomerService + { + [OperationContract] + Customer GetCustomer(int customerId); + + [OperationContract] + bool UpdateCustomer(Customer customer); + } + ``` + +2. The next step is to create the data contract for this service. We do this by creating classes (not interfaces) marked with the [DataContract] attribute. The individual properties or fields we want visible to both client and server are marked with [DataMember]. If we want derived types to be allowed, we must use the [KnownType] attribute to identify them. The only types WCF will allow to be serialized or deserialized for this service are those in the service interface and these "known types". Attempting to exchange any other type not in this list will be rejected. + ```csharp - [DataContract] - [KnownType(typeof(PremiumCustomer))] - public class Customer - { - [DataMember] - public string FirstName { get; set; } - - [DataMember] - public string LastName { get; set; } - - [DataMember] - public int CustomerId { get; set; } - } - - [DataContract] + [DataContract] + [KnownType(typeof(PremiumCustomer))] + public class Customer + { + [DataMember] + public string FirstName { get; set; } + + [DataMember] + public string LastName { get; set; } + + [DataMember] + public int CustomerId { get; set; } + } + + [DataContract] public class PremiumCustomer : Customer - { - [DataMember] - public int AccountId { get; set; } - } - ``` - -3. Next, we provide the implementation for the service interface. - - ```csharp - public class CustomerService : ICustomerService - { - public Customer GetCustomer(int customerId) - { - // read from database - } - - public bool UpdateCustomer(Customer customer) - { - // write to database - } - } - ``` - -4. To run the WCF service, we need to declare an endpoint that exposes that service interface at a specific URL using a specific WCF binding. This is typically done by adding the following sections to the server project's web.config file. - - ```xml - - - - - - - - - - ``` - -5. The WCF service can then be started with the following code: - + { + [DataMember] + public int AccountId { get; set; } + } + ``` + +3. Next, we provide the implementation for the service interface. + + ```csharp + public class CustomerService : ICustomerService + { + public Customer GetCustomer(int customerId) + { + // read from database + } + + public bool UpdateCustomer(Customer customer) + { + // write to database + } + } + ``` + +4. To run the WCF service, we need to declare an endpoint that exposes that service interface at a specific URL using a specific WCF binding. This is typically done by adding the following sections to the server project’s web.config file. + + ```xml + + + + + + + + + + ``` + +5. The WCF service can then be started with the following code: + ```csharp - ServiceHost customerServiceHost = new ServiceHost(typeof(CustomerService)); - customerServiceHost.Open(); - ``` - - When this ServiceHost is started, it uses the web.config file to establish the proper contract, binding and endpoint. For more information about configuration files, see [Configuring Services Using Configuration Files](./configuring-services-using-configuration-files.md). This style of starting the server is known as self-hosting. To learn more about other choices for hosting WCF services, see [Hosting Services](./hosting-services.md). - -6. The client project's app.config must declare matching binding information for the service's endpoint. The easiest way to do this in Visual Studio is to use **Add Service Reference**, which automatically updates the app.config file. Alternatively, these same changes can be added manually: - - ```xml - - - - - - - - ``` - - For more information about using **Add Service Reference**, see [How to: Add, Update, or Remove a Service Reference](/visualstudio/data-tools/how-to-add-update-or-remove-a-wcf-data-service-reference). - -7. Now you can call the WCF service from the client. We do this by creating a channel factory for that service, asking it for a channel, and directly calling the method we want on that channel. We can do this because the channel implements the service's interface and handles the underlying request/reply logic for us. The return value from that method call is the deserialized copy of the server's response. - + ServiceHost customerServiceHost = new ServiceHost(typeof(CustomerService)); + customerServiceHost.Open(); + ``` + + When this ServiceHost is started, it uses the web.config file to establish the proper contract, binding and endpoint. For more information about configuration files, see [Configuring Services Using Configuration Files](./configuring-services-using-configuration-files.md). This style of starting the server is known as self-hosting. To learn more about other choices for hosting WCF services, see [Hosting Services](./hosting-services.md). + +6. The client project’s app.config must declare matching binding information for the service’s endpoint. The easiest way to do this in Visual Studio is to use **Add Service Reference**, which will automatically update the app.config file. Alternatively, these same changes can be added manually. + + ```xml + + + + + + + + ``` + + For more information about using **Add Service Reference**, see [How to: Add, Update, or Remove a Service Reference](/visualstudio/data-tools/how-to-add-update-or-remove-a-wcf-data-service-reference). + +7. Now we can call the WCF service from the client. We do this by creating a channel factory for that service, asking it for a channel, and directly calling the method we want on that channel. We can do this because the channel implements the service’s interface and handles the underlying request/reply logic for us. The return value from that method call is the deserialized copy of the server’s response. + ```csharp - ChannelFactory factory = - new ChannelFactory("customerservice"); - ICustomerService service = factory.CreateChannel(); - Customer customer = service.GetCustomer(42); + ChannelFactory factory = + new ChannelFactory("customerservice"); + ICustomerService service = factory.CreateChannel(); + Customer customer = service.GetCustomer(42); Console.WriteLine($" Customer {customer.FirstName} {customer.LastName} received."); - ``` - - Objects returned by WCF from the server to the client are always by value. The objects are deserialized copies of the data sent by the server. The client can call methods on these local copies without any danger of invoking server code through callbacks. - -#### Scenario 2: Server Returns an Object By Reference - - This scenario demonstrates the server providing an object to the client by reference. In .NET Remoting, this is handled automatically for any type derived from MarshalByRefObject, which is serialized by-reference. An example of this scenario is allowing multiple clients to have independent sessionful server-side objects. As previously mentioned, objects returned by a WCF service are always by value, so there is no direct equivalent of a by-reference object, but it is possible to achieve something similar to by-reference semantics using an object. This is a serializable by-value object that can be used by the client to obtain a sessionful by-reference object on the server. This enables the scenario of having multiple clients with independent sessionful server-side objects. - -1. First, we need to define a WCF service contract that corresponds to the sessionful object itself. - + ``` + + Objects returned by WCF from the server to the client are always by value. The objects are deserialized copies of the data sent by the server. The client can call methods on these local copies without any danger of invoking server code through callbacks. + +#### Scenario 2: Server Returns an Object By Reference + + This scenario demonstrates the server providing an object to the client by reference. In .NET Remoting, this is handled automatically for any type derived from MarshalByRefObject, which is serialized by-reference. An example of this scenario is allowing multiple clients to have independent sessionful server-side objects. As previously mentioned, objects returned by a WCF service are always by value, so there is no direct equivalent of a by-reference object, but it is possible to achieve something similar to by-reference semantics using an object. This is a serializable by-value object that can be used by the client to obtain a sessionful by-reference object on the server. This enables the scenario of having multiple clients with independent sessionful server-side objects. + +1. First, we need to define a WCF service contract that corresponds to the sessionful object itself. + ```csharp - [ServiceContract(SessionMode = SessionMode.Allowed)] - public interface ISessionBoundObject - { - [OperationContract] - string GetCurrentValue(); - - [OperationContract] - void SetCurrentValue(string value); - } - ``` - + [ServiceContract(SessionMode = SessionMode.Allowed)] + public interface ISessionBoundObject + { + [OperationContract] + string GetCurrentValue(); + + [OperationContract] + void SetCurrentValue(string value); + } + ``` + > [!TIP] - > Notice that the sessionful object is marked with [ServiceContract], making it a normal WCF service interface. Setting the SessionMode property indicates it will be a sessionful service. In WCF, a session is a way of correlating multiple messages sent between two endpoints. This means that once a client obtains a connection to this service, a session will be established between the client and the server. The client will use a single unique instance of the server-side object for all its interactions within this single session. - -2. Next, we need to provide the implementation of this service interface. By denoting it with [ServiceBehavior] and setting the InstanceContextMode, we tell WCF we want to use a unique instance of this type for an each session. - + > Notice that the sessionful object is marked with [ServiceContract], making it a normal WCF service interface. Setting the SessionMode property indicates it will be a sessionful service. In WCF, a session is a way of correlating multiple messages sent between two endpoints. This means that once a client obtains a connection to this service, a session will be established between the client and the server. The client will use a single unique instance of the server-side object for all its interactions within this single session. + +2. Next, we need to provide the implementation of this service interface. By denoting it with [ServiceBehavior] and setting the InstanceContextMode, we tell WCF we want to use a unique instance of this type for an each session. + ```csharp - [ServiceBehavior(InstanceContextMode = InstanceContextMode.PerSession)] - public class MySessionBoundObject : ISessionBoundObject - { - private string _value; - - public string GetCurrentValue() - { - return _value; - } - - public void SetCurrentValue(string val) - { - _value = val; - } - - } - ``` - -3. Now we need a way to obtain an instance of this sessionful object. We do this by creating another WCF service interface that returns an EndpointAddress10 object. This is a serializable form of an endpoint that the client can use to create the sessionful object. - + [ServiceBehavior(InstanceContextMode = InstanceContextMode.PerSession)] + public class MySessionBoundObject : ISessionBoundObject + { + private string _value; + + public string GetCurrentValue() + { + return _value; + } + + public void SetCurrentValue(string val) + { + _value = val; + } + + } + ``` + +3. Now we need a way to obtain an instance of this sessionful object. We do this by creating another WCF service interface that returns an EndpointAddress10 object. This is a serializable form of an endpoint that the client can use to create the sessionful object. + ```csharp - [ServiceContract] - public interface ISessionBoundFactory - { - [OperationContract] - EndpointAddress10 GetInstanceAddress(); - } - ``` - - And we implement this WCF service: - + [ServiceContract] + public interface ISessionBoundFactory + { + [OperationContract] + EndpointAddress10 GetInstanceAddress(); + } + ``` + + And we implement this WCF service: + ```csharp - public class SessionBoundFactory : ISessionBoundFactory - { + public class SessionBoundFactory : ISessionBoundFactory + { public static ChannelFactory _factory = - new ChannelFactory("sessionbound"); - - public SessionBoundFactory() - { - } - - public EndpointAddress10 GetInstanceAddress() - { - IClientChannel channel = (IClientChannel)_factory.CreateChannel(); - return EndpointAddress10.FromEndpointAddress(channel.RemoteAddress); - } - } - ``` - - This implementation maintains a singleton channel factory to create sessionful objects. When GetInstanceAddress() is called, it creates a channel and creates an EndpointAddress10 object that effectively points to the remote address associated with this channel. EndpointAddress10 is simply a data type that can be returned to the client by-value. - -4. We need to modify the server's configuration file by doing the following two things as shown in the example below: - - 1. Declare a \ section that describes the endpoint for the sessionful object. This is necessary because the server also acts as a client in this situation. - - 2. Declare endpoints for the factory and sessionful object. This is necessary to allow the client to communicate with the service endpoints to acquire the EndpointAddress10 and to create the sessionful channel. - - ```xml - - - - - - - - - - - - - - - - - - - ``` - - And then we can start these services: - + new ChannelFactory("sessionbound"); + + public SessionBoundFactory() + { + } + + public EndpointAddress10 GetInstanceAddress() + { + IClientChannel channel = (IClientChannel)_factory.CreateChannel(); + return EndpointAddress10.FromEndpointAddress(channel.RemoteAddress); + } + } + ``` + + This implementation maintains a singleton channel factory to create sessionful objects. When GetInstanceAddress() is called, it creates a channel and creates an EndpointAddress10 object that effectively points to the remote address associated with this channel. EndpointAddress10 is simply a data type that can be returned to the client by-value. + +4. We need to modify the server’s configuration file by doing the following two things as shown in the example below: + + 1. Declare a \ section that describes the endpoint for the sessionful object. This is necessary because the server also acts as a client in this situation. + + 2. Declare endpoints for the factory and sessionful object. This is necessary to allow the client to communicate with the service endpoints to acquire the EndpointAddress10 and to create the sessionful channel. + + ```xml + + + + + + + + + + + + + + + + + + + ``` + + And then we can start these services: + ```csharp - ServiceHost factoryHost = new ServiceHost(typeof(SessionBoundFactory)); - factoryHost.Open(); - - ServiceHost sessionHost = new ServiceHost(typeof(MySessionBoundObject)); - sessionHost.Open(); - ``` - -5. We configure the client by declaring these same endpoints in its project's app.config file. - - ```xml - - - - - - - - - - ``` - -6. In order to create and use this sessionful object, the client must do the following steps: - - 1. Create a channel to the ISessionBoundFactory service. - - 2. Use that channel to invoke that service to obtain an EndpointAddress10. - - 3. Use the EndpointAddress10 to create a channel to obtain a sessionful object. - - 4. Interact with the sessionful object to demonstrate it remains the same instance across multiple calls. - + ServiceHost factoryHost = new ServiceHost(typeof(SessionBoundFactory)); + factoryHost.Open(); + + ServiceHost sessionHost = new ServiceHost(typeof(MySessionBoundObject)); + sessionHost.Open(); + ``` + +5. We configure the client by declaring these same endpoints in its project’s app.config file. + + ```xml + + + + + + + + + + ``` + +6. In order to create and use this sessionful object, the client must do the following steps: + + 1. Create a channel to the ISessionBoundFactory service. + + 2. Use that channel to invoke that service to obtain an EndpointAddress10. + + 3. Use the EndpointAddress10 to create a channel to obtain a sessionful object. + + 4. Interact with the sessionful object to demonstrate it remains the same instance across multiple calls. + ```csharp ChannelFactory channelFactory = - new ChannelFactory("factory"); - ISessionBoundFactory sessionFactory = channelFactory.CreateChannel(); - - EndpointAddress10 address1 = sessionFactory.GetInstanceAddress(); - EndpointAddress10 address2 = sessionFactory.GetInstanceAddress(); - + new ChannelFactory("factory"); + ISessionBoundFactory sessionFactory = channelFactory.CreateChannel(); + + EndpointAddress10 address1 = sessionFactory.GetInstanceAddress(); + EndpointAddress10 address2 = sessionFactory.GetInstanceAddress(); + ChannelFactory sessionObjectFactory1 = new ChannelFactory(new NetTcpBinding(), - address1.ToEndpointAddress()); + address1.ToEndpointAddress()); ChannelFactory sessionObjectFactory2 = new ChannelFactory(new NetTcpBinding(), - address2.ToEndpointAddress()); - - ISessionBoundObject sessionInstance1 = sessionObjectFactory1.CreateChannel(); - ISessionBoundObject sessionInstance2 = sessionObjectFactory2.CreateChannel(); - - sessionInstance1.SetCurrentValue("Hello"); - sessionInstance2.SetCurrentValue("World"); - - if (sessionInstance1.GetCurrentValue() == "Hello" && - sessionInstance2.GetCurrentValue() == "World") - { - Console.WriteLine("sessionful server object works as expected"); - } - ``` - - WCF always returns objects by value, but it is possible to support the equivalent of by-reference semantics through the use of EndpointAddress10. This permits the client to request a sessionful WCF service instance, after which it can interact with it like any other WCF service. - -#### Scenario 3: Client Sends Server a By-Value Instance - - This scenario demonstrates the client sending a non-primitive object instance to the server by value. Because WCF only sends objects by value, this scenario demonstrates normal WCF usage. - -1. Use the same WCF Service from Scenario 1. - -2. Use the client to create a new by-value object (Customer), create a channel to communicate with the ICustomerService service, and send the object to it. - + address2.ToEndpointAddress()); + + ISessionBoundObject sessionInstance1 = sessionObjectFactory1.CreateChannel(); + ISessionBoundObject sessionInstance2 = sessionObjectFactory2.CreateChannel(); + + sessionInstance1.SetCurrentValue("Hello"); + sessionInstance2.SetCurrentValue("World"); + + if (sessionInstance1.GetCurrentValue() == "Hello" && + sessionInstance2.GetCurrentValue() == "World") + { + Console.WriteLine("sessionful server object works as expected"); + } + ``` + + WCF always returns objects by value, but it is possible to support the equivalent of by-reference semantics through the use of EndpointAddress10. This permits the client to request a sessionful WCF service instance, after which it can interact with it like any other WCF service. + +#### Scenario 3: Client Sends Server a By-Value Instance + + This scenario demonstrates the client sending a non-primitive object instance to the server by value. Because WCF only sends objects by value, this scenario demonstrates normal WCF usage. + +1. Use the same WCF Service from Scenario 1. + +2. Use the client to create a new by-value object (Customer), create a channel to communicate with the ICustomerService service, and send the object to it. + ```csharp - ChannelFactory factory = - new ChannelFactory("customerservice"); - ICustomerService service = factory.CreateChannel(); + ChannelFactory factory = + new ChannelFactory("customerservice"); + ICustomerService service = factory.CreateChannel(); PremiumCustomer customer = new PremiumCustomer { FirstName = "Bob", LastName = "Jones", CustomerId = 43, - AccountId = 99}; - bool success = service.UpdateCustomer(customer); + AccountId = 99}; + bool success = service.UpdateCustomer(customer); Console.WriteLine($" Server returned {success}."); - ``` - - The customer object will be serialized, and sent to the server, where it is deserialized into a new copy of that object. - + ``` + + The customer object will be serialized, and sent to the server, where it is deserialized into a new copy of that object. + > [!NOTE] - > This code also illustrates sending a derived type (PremiumCustomer). The service interface expects a Customer object, but the [KnownType] attribute on the Customer class indicated PremiumCustomer was also allowed. WCF will fail any attempt to serialize or deserialize any other type through this service interface. - - Normal WCF exchanges of data are by value. This guarantees that invoking methods on one of these data objects executes only locally – it will not invoke code on the other tier. While it is possible to achieve something like by-reference objects returned *from* the server, it is not possible for a client to pass a by-reference object *to* the server. A scenario that requires a conversation back and forth between client and server can be achieved in WCF using a duplex service. For more information, see [Duplex Services](./feature-details/duplex-services.md). - -## Summary + > This code also illustrates sending a derived type (PremiumCustomer). The service interface expects a Customer object, but the [KnownType] attribute on the Customer class indicated PremiumCustomer was also allowed. WCF will fail any attempt to serialize or deserialize any other type through this service interface. + + Normal WCF exchanges of data are by value. This guarantees that invoking methods on one of these data objects executes only locally – it will not invoke code on the other tier. While it is possible to achieve something like by-reference objects returned *from* the server, it is not possible for a client to pass a by-reference object *to* the server. A scenario that requires a conversation back and forth between client and server can be achieved in WCF using a duplex service. For more information, see [Duplex Services](./feature-details/duplex-services.md). + +## Summary -.NET Remoting is a communication framework intended to be used only within fully-trusted environments. It is a legacy product and supported only for backward compatibility. It should not be used to build new applications. Conversely, WCF was designed with security in mind and is recommended for new and existing applications. Microsoft recommends that existing Remoting applications be migrated to use WCF or ASP.NET Web API instead. + .NET Remoting is a communication framework intended to be used only within fully-trusted environments. It is a legacy product and supported only for backward compatibility. It should not be used to build new applications. Conversely, WCF was designed with security in mind and is recommended for new and existing applications. Microsoft recommends that existing Remoting applications be migrated to use WCF or ASP.NET Web API instead. diff --git a/docs/fundamentals/runtime-libraries/system-threading-thread.md b/docs/fundamentals/runtime-libraries/system-threading-thread.md index c731052e02488..ea4362c976b6b 100644 --- a/docs/fundamentals/runtime-libraries/system-threading-thread.md +++ b/docs/fundamentals/runtime-libraries/system-threading-thread.md @@ -124,7 +124,7 @@ You can retrieve a number of property values that provide information about a th - A thread ID. The value of the read-only property is assigned by the runtime and uniquely identifies a thread within its process. > [!NOTE] - > An operating-system [ThreadId](/windows/win32/api/processthreadsapi/nf-processthreadsapi-getthreadid) has no fixed relationship to a managed thread, because an unmanaged host can control the relationship between managed and unmanaged threads. Specifically, a sophisticated host can use the [CLR Hosting API](../../core/unmanaged-api/hosting/index.md) to schedule many managed threads against the same operating system thread, or to move a managed thread between different operating system threads. + > An operating-system [ThreadId](/windows/win32/api/processthreadsapi/nf-processthreadsapi-getthreadid) has no fixed relationship to a managed thread, because an unmanaged host can control the relationship between managed and unmanaged threads. Specifically, a sophisticated host can use the [CLR Hosting API](../../framework/unmanaged-api/hosting/index.md) to schedule many managed threads against the same operating system thread, or to move a managed thread between different operating system threads. - The thread's current state. For the duration of its existence, a thread is always in one or more of the states defined by the property. diff --git a/docs/navigate/tools-diagnostics/toc.yml b/docs/navigate/tools-diagnostics/toc.yml index a814ff794c53b..bc08b44e9c8d9 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 diff --git a/docs/standard/garbage-collection/app-domain-resource-monitoring.md b/docs/standard/garbage-collection/app-domain-resource-monitoring.md index d220d7fe8a6e5..96155cd900fdf 100644 --- a/docs/standard/garbage-collection/app-domain-resource-monitoring.md +++ b/docs/standard/garbage-collection/app-domain-resource-monitoring.md @@ -25,7 +25,7 @@ As soon as ARM is enabled, it begins collecting data on all application domains - You can enable ARM at CLR startup by adding the [\](../../framework/configure-apps/file-schema/runtime/appdomainresourcemonitoring-element.md) element to the configuration file, and setting the `enabled` attribute to `true`. A value of `false` (the default) means only that ARM is not enabled at startup; you can activate it later by using one of the other activation mechanisms. -- The host can enable ARM by requesting the [ICLRAppDomainResourceMonitor](../../core/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md) hosting interface. Once this interface is successfully obtained, ARM is enabled. +- The host can enable ARM by requesting the [ICLRAppDomainResourceMonitor](../../framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md) hosting interface. Once this interface is successfully obtained, ARM is enabled. - Managed code can enable ARM by setting the static (`Shared` in Visual Basic) property to `true`. As soon as the property is set, ARM is enabled. @@ -39,7 +39,7 @@ ARM provides the total processor time that is used by an application domain and - Managed API: property. - - Hosting API: [ICLRAppDomainResourceMonitor::GetCurrentCpuTime](../../core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentcputime-method.md) method. + - Hosting API: [ICLRAppDomainResourceMonitor::GetCurrentCpuTime](../../framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentcputime-method.md) method. - ETW events: `ThreadCreated`, `ThreadAppDomainEnter`, and `ThreadTerminated` events. For information about providers and keywords, see "AppDomain Resource Monitoring Events" in [CLR ETW Events](../../framework/performance/clr-etw-events.md). @@ -47,7 +47,7 @@ ARM provides the total processor time that is used by an application domain and - Managed API: property. - - Hosting API: [ICLRAppDomainResourceMonitor::GetCurrentAllocated](../../core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentallocated-method.md) method. + - Hosting API: [ICLRAppDomainResourceMonitor::GetCurrentAllocated](../../framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentallocated-method.md) method. - ETW events: `AppDomainMemAllocated` event, `Allocated` field. @@ -55,7 +55,7 @@ ARM provides the total processor time that is used by an application domain and - Managed API: property. - - Hosting API: [ICLRAppDomainResourceMonitor::GetCurrentSurvived](../../core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md) method, `pAppDomainBytesSurvived` parameter. + - Hosting API: [ICLRAppDomainResourceMonitor::GetCurrentSurvived](../../framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md) method, `pAppDomainBytesSurvived` parameter. - ETW events: `AppDomainMemSurvived` event, `Survived` field. @@ -63,7 +63,7 @@ ARM provides the total processor time that is used by an application domain and - Managed API: property. - - Hosting API: [ICLRAppDomainResourceMonitor::GetCurrentSurvived](../../core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md) method, `pTotalBytesSurvived` parameter. + - Hosting API: [ICLRAppDomainResourceMonitor::GetCurrentSurvived](../../framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md) method, `pTotalBytesSurvived` parameter. - ETW events: `AppDomainMemSurvived` event, `ProcessSurvived` field. @@ -79,11 +79,11 @@ Alternatively, you can call the -- [ICLRAppDomainResourceMonitor Interface](../../core/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md) +- [ICLRAppDomainResourceMonitor Interface](../../framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md) - [\](../../framework/configure-apps/file-schema/runtime/appdomainresourcemonitoring-element.md) - [CLR ETW Events](../../framework/performance/clr-etw-events.md) diff --git a/docs/standard/garbage-collection/performance.md b/docs/standard/garbage-collection/performance.md index 655a63b489f5b..49aad1f58ec9d 100644 --- a/docs/standard/garbage-collection/performance.md +++ b/docs/standard/garbage-collection/performance.md @@ -117,7 +117,7 @@ If fragmentation of virtual memory is preventing the garbage collector from addi - Holding too many references to COM objects when interoperating with unmanaged code. - Creation of large transient objects, which causes the large object heap to allocate and free heap segments frequently. - When hosting the CLR, an application can request that the garbage collector retain its segments. This reduces the frequency of segment allocations. This is accomplished by using the STARTUP_HOARD_GC_VM flag in the [STARTUP_FLAGS Enumeration](../../core/unmanaged-api/hosting/startup-flags-enumeration.md). + When hosting the CLR, an application can request that the garbage collector retain its segments. This reduces the frequency of segment allocations. This is accomplished by using the STARTUP_HOARD_GC_VM flag in the [STARTUP_FLAGS Enumeration](../../framework/unmanaged-api/hosting/startup-flags-enumeration.md). |Performance checks| |------------------------| diff --git a/docs/standard/threading/exceptions-in-managed-threads.md b/docs/standard/threading/exceptions-in-managed-threads.md index 8e08fe0d44f53..c659812979970 100644 --- a/docs/standard/threading/exceptions-in-managed-threads.md +++ b/docs/standard/threading/exceptions-in-managed-threads.md @@ -34,7 +34,7 @@ If these exceptions are unhandled in the main thread, or in threads that entered ## Host override -An unmanaged host can use the [ICLRPolicyManager](../../core/unmanaged-api/hosting/iclrpolicymanager-interface.md) interface in the Hosting API to override the default unhandled exception policy of the common language runtime. The [ICLRPolicyManager::SetUnhandledExceptionPolicy](../../core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md) function is used to set the policy for unhandled exceptions. +An unmanaged host can use the [ICLRPolicyManager](../../framework/unmanaged-api/hosting/iclrpolicymanager-interface.md) interface in the Hosting API to override the default unhandled exception policy of the common language runtime. The [ICLRPolicyManager::SetUnhandledExceptionPolicy](../../framework/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md) function is used to set the policy for unhandled exceptions. ## See also diff --git a/docs/standard/threading/the-managed-thread-pool.md b/docs/standard/threading/the-managed-thread-pool.md index 316b19ef54807..47c2c80e23525 100644 --- a/docs/standard/threading/the-managed-thread-pool.md +++ b/docs/standard/threading/the-managed-thread-pool.md @@ -38,7 +38,7 @@ The number of operations that can be queued to the thread pool is limited only b You can control the maximum number of threads by using the and methods. > [!NOTE] -> Code that hosts the common language runtime can set the size using the [`ICorThreadpool::CorSetMaxThreads`](../../core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md) method. +> Code that hosts the common language runtime can set the size using the [`ICorThreadpool::CorSetMaxThreads`](../../framework/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md) method. ### Thread pool minimums @@ -56,7 +56,7 @@ When a minimum is reached, the thread pool can create additional threads or wait The easiest way to use the thread pool is to use the [Task Parallel Library (TPL)](../parallel-programming/task-parallel-library-tpl.md). By default, TPL types like and use thread pool threads to run tasks. -You can also use the thread pool by calling from managed code (or [`ICorThreadpool::CorQueueUserWorkItem`](../../core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md) from unmanaged code) and passing a delegate representing the method that performs the task. +You can also use the thread pool by calling from managed code (or [`ICorThreadpool::CorQueueUserWorkItem`](../../framework/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md) from unmanaged code) and passing a delegate representing the method that performs the task. Another way to use the thread pool is to queue work items that are related to a wait operation by using the method and passing a that, when signaled or when timed out, calls the method represented by the delegate. Thread pool threads are used to invoke callback methods. From 80b88fa2bbe70c2609acc5a45b386bc6e96f2c5f Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Thu, 26 Jun 2025 20:42:17 +0200 Subject: [PATCH 15/20] reset index and toc for hosting --- docs/core/unmanaged-api/index.md | 3 - docs/navigate/tools-diagnostics/toc.yml | 1001 ----------------------- 2 files changed, 1004 deletions(-) diff --git a/docs/core/unmanaged-api/index.md b/docs/core/unmanaged-api/index.md index 90f591625b53e..ed4d0435d5f0d 100644 --- a/docs/core/unmanaged-api/index.md +++ b/docs/core/unmanaged-api/index.md @@ -14,9 +14,6 @@ These articles describe APIs that were introduced in .NET Core 2.0 and later ver [Debugging](./debugging/index.md)\ Describes the debugging API, which enables a debugger to debug code that runs in the common language runtime (CLR) environment. -[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. diff --git a/docs/navigate/tools-diagnostics/toc.yml b/docs/navigate/tools-diagnostics/toc.yml index bc08b44e9c8d9..88a9691eba559 100644 --- a/docs/navigate/tools-diagnostics/toc.yml +++ b/docs/navigate/tools-diagnostics/toc.yml @@ -637,1007 +637,6 @@ items: items: - name: PSTARTUP_CALLBACK function pointer href: ../../core/unmanaged-api/debugging/pstartup_callback-function-pointer.md - - name: Hosting - items: - - name: Overview - href: ../../core/unmanaged-api/hosting/index.md - - name: Hosting Coclasses - href: ../../core/unmanaged-api/hosting/hosting-coclasses.md - items: - - name: CLRRuntimeHost Coclass - href: ../../core/unmanaged-api/hosting/clrruntimehost-coclass.md - - name: ComCallUnmarshal Coclass - href: ../../core/unmanaged-api/hosting/comcallunmarshal-coclass.md - - name: CorRuntimeHost Coclass - href: ../../core/unmanaged-api/hosting/corruntimehost-coclass.md - - name: TypeNameFactory Coclass - href: ../../core/unmanaged-api/hosting/typenamefactory-coclass.md - - name: Hosting Enumerations - href: ../../core/unmanaged-api/hosting/hosting-enumerations.md - items: - - name: CLSID_RESOLUTION_FLAGS Enumeration - href: ../../core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md - - name: COR_GC_STAT_TYPES Enumeration - href: ../../core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md - - name: COR_GC_THREAD_STATS_TYPES Enumeration - href: ../../core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md - - name: EApiCategories Enumeration - href: ../../core/unmanaged-api/hosting/eapicategories-enumeration.md - - name: EBindPolicyLevels Enumeration - href: ../../core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md - - name: ECLRAssemblyIdentityFlags Enumeration - href: ../../core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md - - name: EClrEvent Enumeration - href: ../../core/unmanaged-api/hosting/eclrevent-enumeration.md - - name: EClrFailure Enumeration - href: ../../core/unmanaged-api/hosting/eclrfailure-enumeration.md - - name: EClrOperation Enumeration - href: ../../core/unmanaged-api/hosting/eclroperation-enumeration.md - - name: EClrUnhandledException Enumeration - href: ../../core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md - - name: EContextType Enumeration - href: ../../core/unmanaged-api/hosting/econtexttype-enumeration.md - - name: ECustomDumpFlavor Enumeration - href: ../../core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md - - name: ECustomDumpItemKind Enumeration - href: ../../core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md - - name: EHostApplicationPolicy Enumeration - href: ../../core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md - - name: EHostBindingPolicyModifyFlags Enumeration - href: ../../core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md - - name: EInitializeNewDomainFlags Enumeration - href: ../../core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md - - name: EMemoryAvailable Enumeration - href: ../../core/unmanaged-api/hosting/ememoryavailable-enumeration.md - - name: EMemoryCriticalLevel Enumeration - href: ../../core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md - - name: EPolicyAction Enumeration - href: ../../core/unmanaged-api/hosting/epolicyaction-enumeration.md - - name: ESymbolReadingPolicy Enumeration - href: ../../core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md - - name: ETaskType Enumeration - href: ../../core/unmanaged-api/hosting/etasktype-enumeration.md - - name: HOST_TYPE Enumeration - href: ../../core/unmanaged-api/hosting/host-type-enumeration.md - - name: MALLOC_TYPE Enumeration - href: ../../core/unmanaged-api/hosting/malloc-type-enumeration.md - - name: METAHOST_CONFIG_FLAGS Enumeration - href: ../../core/unmanaged-api/hosting/metahost-config-flags-enumeration.md - - name: METAHOST_POLICY_FLAGS Enumeration - href: ../../core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md - - name: RUNTIME_INFO_FLAGS Enumeration - href: ../../core/unmanaged-api/hosting/runtime-info-flags-enumeration.md - - name: StackOverflowType Enumeration - href: ../../core/unmanaged-api/hosting/stackoverflowtype-enumeration.md - - name: STARTUP_FLAGS Enumeration - href: ../../core/unmanaged-api/hosting/startup-flags-enumeration.md - - name: ValidatorFlags Enumeration - href: ../../core/unmanaged-api/hosting/validatorflags-enumeration.md - - name: WAIT_OPTION Enumeration - href: ../../core/unmanaged-api/hosting/wait-option-enumeration.md - - name: Hosting Global Static Functions - href: ../../core/unmanaged-api/hosting/hosting-global-static-functions.md - items: - - name: .NET Framework 4 Hosting Global Static Functions - href: ../../core/unmanaged-api/hosting/net-framework-4-hosting-global-static-functions.md - items: - - name: CLRCreateInstance Function - href: ../../core/unmanaged-api/hosting/clrcreateinstance-function.md - - name: Deprecated CLR Hosting Functions - href: ../../core/unmanaged-api/hosting/deprecated-clr-hosting-functions.md - items: - - name: _CorDllMain Function - href: ../../core/unmanaged-api/hosting/cordllmain-function.md - - name: _CorExeMain Function - href: ../../core/unmanaged-api/hosting/corexemain-function.md - - name: _CorExeMain2 Function - href: ../../core/unmanaged-api/hosting/corexemain2-function.md - - name: _CorImageUnloading Function - href: ../../core/unmanaged-api/hosting/corimageunloading-function.md - - name: _CorValidateImage Function - href: ../../core/unmanaged-api/hosting/corvalidateimage-function.md - - name: CallFunctionShim Function - href: ../../core/unmanaged-api/hosting/callfunctionshim-function.md - - name: ClrCreateManagedInstance Function - href: ../../core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md - - name: CoEEShutDownCOM Function - href: ../../core/unmanaged-api/hosting/coeeshutdowncom-function.md - - name: CoInitializeCor Function - href: ../../core/unmanaged-api/hosting/coinitializecor-function.md - - name: CoInitializeEE Function - href: ../../core/unmanaged-api/hosting/coinitializeee-function.md - - name: CorBindToCurrentRuntime Function - href: ../../core/unmanaged-api/hosting/corbindtocurrentruntime-function.md - - name: CorBindToRuntime Function - href: ../../core/unmanaged-api/hosting/corbindtoruntime-function.md - - name: CorBindToRuntimeByCfg Function - href: ../../core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md - - name: CorBindToRuntimeEx Function - href: ../../core/unmanaged-api/hosting/corbindtoruntimeex-function.md - - name: CorBindToRuntimeHost Function - href: ../../core/unmanaged-api/hosting/corbindtoruntimehost-function.md - - name: CorExitProcess Function - href: ../../core/unmanaged-api/hosting/corexitprocess-function.md - - name: CorLaunchApplication Function - href: ../../core/unmanaged-api/hosting/corlaunchapplication-function.md - - name: CorMarkThreadInThreadPool Function - href: ../../core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md - - name: CoUninitializeCor Function - href: ../../core/unmanaged-api/hosting/couninitializecor-function.md - - name: CoUninitializeEE Function - href: ../../core/unmanaged-api/hosting/couninitializeee-function.md - - name: CreateDebuggingInterfaceFromVersion Function - href: ../../core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md - - name: CreateICeeFileGen Function - href: ../../core/unmanaged-api/hosting/createiceefilegen-function.md - - name: DestroyICeeFileGen Function - href: ../../core/unmanaged-api/hosting/destroyiceefilegen-function.md - - name: FExecuteInAppDomainCallback Function Pointer - href: ../../core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md - - name: FLockClrVersionCallback Function Pointer - href: ../../core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md - - name: GetCLRIdentityManager Function - href: ../../core/unmanaged-api/hosting/getclridentitymanager-function.md - - name: GetCORRequiredVersion Function - href: ../../core/unmanaged-api/hosting/getcorrequiredversion-function.md - - name: GetCORSystemDirectory Function - href: ../../core/unmanaged-api/hosting/getcorsystemdirectory-function.md - - name: GetCORVersion Function - href: ../../core/unmanaged-api/hosting/getcorversion-function.md - - name: GetFileVersion Function - href: ../../core/unmanaged-api/hosting/getfileversion-function.md - - name: GetRealProcAddress Function - href: ../../core/unmanaged-api/hosting/getrealprocaddress-function.md - - name: GetRequestedRuntimeInfo Function - href: ../../core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md - - name: GetRequestedRuntimeVersion Function - href: ../../core/unmanaged-api/hosting/getrequestedruntimeversion-function.md - - name: GetRequestedRuntimeVersionForCLSID Function - href: ../../core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md - - name: GetVersionFromProcess Function - href: ../../core/unmanaged-api/hosting/getversionfromprocess-function.md - - name: LoadLibraryShim Function - href: ../../core/unmanaged-api/hosting/loadlibraryshim-function.md - - name: LoadStringRC Function - href: ../../core/unmanaged-api/hosting/loadstringrc-function.md - - name: LoadStringRCEx Function - href: ../../core/unmanaged-api/hosting/loadstringrcex-function.md - - name: LockClrVersion Function - href: ../../core/unmanaged-api/hosting/lockclrversion-function.md - - name: LPOVERLAPPED_COMPLETION_ROUTINE Function Pointer - href: ../../core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md - - name: LPTHREAD_START_ROUTINE Function Pointer - href: ../../core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md - - name: RunDll32ShimW Function - href: ../../core/unmanaged-api/hosting/rundll32shimw-function.md - - name: WAITORTIMERCALLBACK Function Pointer - href: ../../core/unmanaged-api/hosting/waitortimercallback-function-pointer.md - - name: Hosting Interfaces - href: ../../core/unmanaged-api/hosting/hosting-interfaces.md - items: - - name: Deprecated CLR Hosting Interfaces and Coclasses - href: ../../core/unmanaged-api/hosting/deprecated-clr-hosting-interfaces-and-coclasses.md - items: - - name: IAppDomainSetup Interface - href: ../../core/unmanaged-api/hosting/iappdomainsetup-interface.md - - name: ICeeFileGen Class - href: ../../core/unmanaged-api/hosting/iceefilegen-class.md - - name: ICorRuntimeHost Interface - href: ../../core/unmanaged-api/hosting/icorruntimehost-interface.md - items: - - name: CloseEnum Method - href: ../../core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md - - name: CreateDomain Method - href: ../../core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md - - name: CreateDomainSetup Method - href: ../../core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md - - name: CreateDomainEx Method - href: ../../core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md - - name: CreateEvidence Method - href: ../../core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md - - name: CreateLogicalThreadState Method - href: ../../core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md - - name: CurrentDomain Method - href: ../../core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md - - name: DeleteLogicalThreadState Method - href: ../../core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md - - name: EnumDomains Method - href: ../../core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md - - name: GetConfiguration Method - href: ../../core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md - - name: GetDefaultDomain Method - href: ../../core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md - - name: LocksHeldByLogicalThread Method - href: ../../core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md - - name: MapFile Method - href: ../../core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md - - name: NextDomain Method - href: ../../core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md - - name: Start Method - href: ../../core/unmanaged-api/hosting/icorruntimehost-start-method.md - - name: Stop Method - href: ../../core/unmanaged-api/hosting/icorruntimehost-stop-method.md - - name: SwitchInLogicalThreadState Method - href: ../../core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md - - name: SwitchOutLogicalThreadState Method - href: ../../core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md - - name: UnloadDomain Method - href: ../../core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md - - name: CLR Hosting Interfaces - href: ../../core/unmanaged-api/hosting/clr-hosting-interfaces.md - items: - - name: IActionOnCLREvent Interface - href: ../../core/unmanaged-api/hosting/iactiononclrevent-interface.md - items: - - name: OnEvent Method - href: ../../core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md - - name: IApartmentCallback Interface - href: ../../core/unmanaged-api/hosting/iapartmentcallback-interface.md - items: - - name: DoCallback Method - href: ../../core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md - - name: IAppDomainBinding Interface - href: ../../core/unmanaged-api/hosting/iappdomainbinding-interface.md - items: - - name: OnAppDomain Method - href: ../../core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md - - name: ICatalogServices Interface - href: ../../core/unmanaged-api/hosting/icatalogservices-interface.md - items: - - name: Autodone Method - href: ../../core/unmanaged-api/hosting/icatalogservices-autodone-method.md - - name: NotAutodone Method - href: ../../core/unmanaged-api/hosting/icatalogservices-notautodone-method.md - - name: ICLRAssemblyIdentityManager Interface - href: ../../core/unmanaged-api/hosting/iclrassemblyidentitymanager-interface.md - items: - - name: GetBindingIdentityFromFile Method - href: ../../core/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromfile-method.md - - name: GetBindingIdentityFromStream Method - href: ../../core/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromstream-method.md - - name: GetCLRAssemblyReferenceList Method - href: ../../core/unmanaged-api/hosting/iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md - - name: GetProbingAssembliesFromReference Method - href: ../../core/unmanaged-api/hosting/iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md - - name: GetReferencedAssembliesFromFile Method - href: ../../core/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md - - name: GetReferencedAssembliesFromStream Method - href: ../../core/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md - - name: IsStronglyNamed Method - href: ../../core/unmanaged-api/hosting/iclrassemblyidentitymanager-isstronglynamed-method.md - - name: ICLRAssemblyReferenceList Interface - href: ../../core/unmanaged-api/hosting/iclrassemblyreferencelist-interface.md - items: - - name: IsAssemblyReferenceInList Method - href: ../../core/unmanaged-api/hosting/iclrassemblyreferencelist-isassemblyreferenceinlist-method.md - - name: IsStringAssemblyReferenceInList Method - href: ../../core/unmanaged-api/hosting/iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md - - name: ICLRControl Interface - href: ../../core/unmanaged-api/hosting/iclrcontrol-interface.md - items: - - name: GetCLRManager Method - href: ../../core/unmanaged-api/hosting/iclrcontrol-getclrmanager-method.md - - name: SetAppDomainManagerType Method - href: ../../core/unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.md - - name: ICLRDebugManager Interface - href: ../../core/unmanaged-api/hosting/iclrdebugmanager-interface.md - items: - - name: BeginConnection Method - href: ../../core/unmanaged-api/hosting/iclrdebugmanager-beginconnection-method.md - - name: EndConnection Method - href: ../../core/unmanaged-api/hosting/iclrdebugmanager-endconnection-method.md - - name: GetDacl Method - href: ../../core/unmanaged-api/hosting/iclrdebugmanager-getdacl-method.md - - name: IsDebuggerAttached Method - href: ../../core/unmanaged-api/hosting/iclrdebugmanager-isdebuggerattached-method.md - - name: SetConnectionTasks Method - href: ../../core/unmanaged-api/hosting/iclrdebugmanager-setconnectiontasks-method.md - - name: SetDacl Method - href: ../../core/unmanaged-api/hosting/iclrdebugmanager-setdacl-method.md - - name: SetSymbolReadingPolicy Method - href: ../../core/unmanaged-api/hosting/iclrdebugmanager-setsymbolreadingpolicy-method.md - - name: ICLRErrorReportingManager Interface - href: ../../core/unmanaged-api/hosting/iclrerrorreportingmanager-interface.md - items: - - name: BeginCustomDump Method - href: ../../core/unmanaged-api/hosting/iclrerrorreportingmanager-begincustomdump-method.md - - name: EndCustomDump Method - href: ../../core/unmanaged-api/hosting/iclrerrorreportingmanager-endcustomdump-method.md - - name: GetBucketParametersForCurrentException Method - href: ../../core/unmanaged-api/hosting/iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md - - name: ICLRGCManager Interface - href: ../../core/unmanaged-api/hosting/iclrgcmanager-interface.md - items: - - name: Collect Method - href: ../../core/unmanaged-api/hosting/iclrgcmanager-collect-method.md - - name: GetStats Method - href: ../../core/unmanaged-api/hosting/iclrgcmanager-getstats-method.md - - name: SetGCStartupLimits Method - href: ../../core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md - - name: ICLRHostBindingPolicyManager Interface - href: ../../core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md - items: - - name: EvaluatePolicy Method - href: ../../core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md - - name: ModifyApplicationPolicy Method - href: ../../core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md - - name: ICLRHostProtectionManager Interface - href: ../../core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md - items: - - name: SetEagerSerializeGrantSets - href: ../../core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md - - name: SetProtectedCategories Method - href: ../../core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md - - name: ICLRIoCompletionManager Interface - href: ../../core/unmanaged-api/hosting/iclriocompletionmanager-interface.md - items: - - name: OnComplete Method - href: ../../core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md - - name: ICLRMemoryNotificationCallback Interface - href: ../../core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md - items: - - name: OnMemoryNotification Method - href: ../../core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md - - name: ICLROnEventManager Interface - href: ../../core/unmanaged-api/hosting/iclroneventmanager-interface.md - items: - - name: RegisterActionOnEvent Method - href: ../../core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md - - name: UnregisterActionOnEvent Method - href: ../../core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md - - name: ICLRPolicyManager Interface - href: ../../core/unmanaged-api/hosting/iclrpolicymanager-interface.md - items: - - name: SetActionOnFailure Method - href: ../../core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md - - name: SetActionOnTimeout Method - href: ../../core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md - - name: SetDefaultAction Method - href: ../../core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md - - name: SetTimeout Method - href: ../../core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md - - name: SetTimeoutAndAction Method - href: ../../core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md - - name: SetUnhandledExceptionPolicy Method - href: ../../core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md - - name: ICLRProbingAssemblyEnum Interface - href: ../../core/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md - items: - - name: Get Method - href: ../../core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md - - name: ICLRReferenceAssemblyEnum Interface - href: ../../core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md - items: - - name: Get Method - href: ../../core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md - - name: ICLRRuntimeHost Interface - href: ../../core/unmanaged-api/hosting/iclrruntimehost-interface.md - items: - - name: ExecuteApplication Method - href: ../../core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md - - name: ExecuteInAppDomain Method - href: ../../core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md - - name: ExecuteInDefaultAppDomain Method - href: ../../core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md - - name: GetCLRControl Method - href: ../../core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md - - name: GetCurrentAppDomainId Method - href: ../../core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md - - name: SetHostControl Method - href: ../../core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md - - name: Start Method - href: ../../core/unmanaged-api/hosting/iclrruntimehost-start-method.md - - name: Stop Method - href: ../../core/unmanaged-api/hosting/iclrruntimehost-stop-method.md - - name: UnloadAppDomain Method - href: ../../core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md - - name: ICLRSyncManager Interface - href: ../../core/unmanaged-api/hosting/iclrsyncmanager-interface.md - items: - - name: CreateRWLockOwnerIterator Method - href: ../../core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md - - name: DeleteRWLockOwnerIterator Method - href: ../../core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md - - name: GetMonitorOwner Method - href: ../../core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md - - name: GetRWLockOwnerNext Method - href: ../../core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md - - name: ICLRTask Interface - href: ../../core/unmanaged-api/hosting/iclrtask-interface.md - items: - - name: Abort Method - href: ../../core/unmanaged-api/hosting/iclrtask-abort-method.md - - name: ExitTask Method - href: ../../core/unmanaged-api/hosting/iclrtask-exittask-method.md - - name: GetMemStats Method - href: ../../core/unmanaged-api/hosting/iclrtask-getmemstats-method.md - - name: LocksHeld Method - href: ../../core/unmanaged-api/hosting/iclrtask-locksheld-method.md - - name: NeedsPriorityScheduling Method - href: ../../core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md - - name: Reset Method - href: ../../core/unmanaged-api/hosting/iclrtask-reset-method.md - - name: RudeAbort Method - href: ../../core/unmanaged-api/hosting/iclrtask-rudeabort-method.md - - name: SetTaskIdentifier Method - href: ../../core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md - - name: SwitchIn Method - href: ../../core/unmanaged-api/hosting/iclrtask-switchin-method.md - - name: SwitchOut Method - href: ../../core/unmanaged-api/hosting/iclrtask-switchout-method.md - - name: YieldTask Method - href: ../../core/unmanaged-api/hosting/iclrtask-yieldtask-method.md - - name: ICLRTaskManager Interface - href: ../../core/unmanaged-api/hosting/iclrtaskmanager-interface.md - items: - - name: CreateTask Method - href: ../../core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md - - name: GetCurrentTask Method - href: ../../core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md - - name: GetCurrentTaskType Method - href: ../../core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md - - name: SetLocale Method - href: ../../core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md - - name: SetUILocale Method - href: ../../core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md - - name: ICLRValidator Interface - href: ../../core/unmanaged-api/hosting/iclrvalidator-interface.md - items: - - name: FormatEventInfo Method - href: ../../core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md - - name: Validate Method - href: ../../core/unmanaged-api/hosting/iclrvalidator-validate-method.md - - name: ICorConfiguration Interface - href: ../../core/unmanaged-api/hosting/icorconfiguration-interface.md - items: - - name: AddDebuggerSpecialThread Method - href: ../../core/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md - - name: SetDebuggerThreadControl Method - href: ../../core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md - - name: SetGCHostControl Method - href: ../../core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md - - name: SetGCThreadControl Method - href: ../../core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md - - name: ICorThreadpool Interface - href: ../../core/unmanaged-api/hosting/icorthreadpool-interface.md - items: - - name: CorBindIoCompletionCallback Method - href: ../../core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md - - name: CorCallOrQueueUserWorkItem Method - href: ../../core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md - - name: CorChangeTimer Method - href: ../../core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md - - name: CorCreateTimer Method - href: ../../core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md - - name: CorDeleteTimer Method - href: ../../core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md - - name: CorGetAvailableThreads Method - href: ../../core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md - - name: CorGetMaxThreads Method - href: ../../core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md - - name: CorQueueUserWorkItem Method - href: ../../core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md - - name: CorRegisterWaitForSingleObject Method - href: ../../core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md - - name: CorSetMaxThreads Method - href: ../../core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md - - name: CorUnregisterWait Method - href: ../../core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md - - name: IDebuggerInfo Interface - href: ../../core/unmanaged-api/hosting/idebuggerinfo-interface.md - items: - - name: IsDebuggerAttached Method - href: ../../core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md - - name: IDebuggerThreadControl Interface - href: ../../core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md - items: - - name: ReleaseAllRuntimeThreads Method - href: ../../core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md - - name: StartBlockingForDebugger Method - href: ../../core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md - - name: ThreadIsBlockingForDebugger Method - href: ../../core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md - - name: IGCHost Interface - href: ../../core/unmanaged-api/hosting/igchost-interface.md - items: - - name: Collect Method - href: ../../core/unmanaged-api/hosting/igchost-collect-method.md - - name: GetStats Method - href: ../../core/unmanaged-api/hosting/igchost-getstats-method.md - - name: GetThreadStats Method - href: ../../core/unmanaged-api/hosting/igchost-getthreadstats-method.md - - name: SetGCStartupLimits Method - href: ../../core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md - - name: SetVirtualMemLimit Method - href: ../../core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md - - name: IGCHost2 Interface - href: ../../core/unmanaged-api/hosting/igchost2-interface.md - items: - - name: SetGCStartupLimitsEx Method - href: ../../core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md - - name: IGCHostControl Interface - href: ../../core/unmanaged-api/hosting/igchostcontrol-interface.md - items: - - name: RequestVirtualMemLimit Method - href: ../../core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md - - name: IGCThreadControl Interface - href: ../../core/unmanaged-api/hosting/igcthreadcontrol-interface.md - items: - - name: SuspensionEnding Method - href: ../../core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md - - name: SuspensionStarting Method - href: ../../core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md - - name: ThreadIsBlockingForSuspension Method - href: ../../core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md - - name: IHostAssemblyManager Interface - href: ../../core/unmanaged-api/hosting/ihostassemblymanager-interface.md - items: - - name: GetAssemblyStore Method - href: ../../core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md - - name: GetNonHostStoreAssemblies Method - href: ../../core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md - - name: IHostAssemblyStore Interface - href: ../../core/unmanaged-api/hosting/ihostassemblystore-interface.md - items: - - name: ProvideAssembly Method - href: ../../core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md - - name: ProvideModule Method - href: ../../core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md - - name: IHostAutoEvent Interface - href: ../../core/unmanaged-api/hosting/ihostautoevent-interface.md - items: - - name: Set Method - href: ../../core/unmanaged-api/hosting/ihostautoevent-set-method.md - - name: Wait Method - href: ../../core/unmanaged-api/hosting/ihostautoevent-wait-method.md - - name: IHostControl Interface - href: ../../core/unmanaged-api/hosting/ihostcontrol-interface.md - items: - - name: GetHostManager Method - href: ../../core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md - - name: SetAppDomainManager Method - href: ../../core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md - - name: IHostCrst Interface - href: ../../core/unmanaged-api/hosting/ihostcrst-interface.md - items: - - name: Enter Method - href: ../../core/unmanaged-api/hosting/ihostcrst-enter-method.md - - name: Leave Method - href: ../../core/unmanaged-api/hosting/ihostcrst-leave-method.md - - name: SetSpinCount Method - href: ../../core/unmanaged-api/hosting/ihostcrst-setspincount-method.md - - name: TryEnter Method - href: ../../core/unmanaged-api/hosting/ihostcrst-tryenter-method.md - - name: IHostGCManager Interface - href: ../../core/unmanaged-api/hosting/ihostgcmanager-interface.md - items: - - name: SuspensionEnding Method - href: ../../core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md - - name: SuspensionStarting Method - href: ../../core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md - - name: ThreadIsBlockingForSuspension Method - href: ../../core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md - - name: IHostIoCompletionManager Interface - href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md - items: - - name: Bind Method - href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md - - name: CloseIoCompletionPort Method - href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md - - name: CreateIoCompletionPort Method - href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md - - name: GetAvailableThreads Method - href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md - - name: GetHostOverlappedSize Method - href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md - - name: GetMaxThreads Method - href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md - - name: GetMinThreads Method - href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md - - name: InitializeHostOverlapped Method - href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md - - name: SetCLRIoCompletionManager Method - href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md - - name: SetMaxThreads Method - href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md - - name: SetMinThreads Method - href: ../../core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md - - name: IHostMalloc Interface - href: ../../core/unmanaged-api/hosting/ihostmalloc-interface.md - items: - - name: Alloc Method - href: ../../core/unmanaged-api/hosting/ihostmalloc-alloc-method.md - - name: DebugAlloc Method - href: ../../core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md - - name: Free Method - href: ../../core/unmanaged-api/hosting/ihostmalloc-free-method.md - - name: IHostManualEvent Interface - href: ../../core/unmanaged-api/hosting/ihostmanualevent-interface.md - items: - - name: Reset Method - href: ../../core/unmanaged-api/hosting/ihostmanualevent-reset-method.md - - name: Set Method - href: ../../core/unmanaged-api/hosting/ihostmanualevent-set-method.md - - name: Wait Method - href: ../../core/unmanaged-api/hosting/ihostmanualevent-wait-method.md - - name: IHostMemoryManager Interface - href: ../../core/unmanaged-api/hosting/ihostmemorymanager-interface.md - items: - - name: AcquiredVirtualAddressSpace Method - href: ../../core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md - - name: CreateMAlloc Method - href: ../../core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md - - name: GetMemoryLoad Method - href: ../../core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md - - name: NeedsVirtualAddressSpace Method - href: ../../core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md - - name: RegisterMemoryNotificationCallback Method - href: ../../core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md - - name: ReleasedVirtualAddressSpace Method - href: ../../core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md - - name: VirtualAlloc Method - href: ../../core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md - - name: VirtualFree Method - href: ../../core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md - - name: VirtualProtect Method - href: ../../core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md - - name: VirtualQuery Method - href: ../../core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md - - name: IHostPolicyManager Interface - href: ../../core/unmanaged-api/hosting/ihostpolicymanager-interface.md - items: - - name: OnDefaultAction Method - href: ../../core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md - - name: OnFailure Method - href: ../../core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md - - name: OnTimeout Method - href: ../../core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md - - name: IHostSecurityContext Interface - href: ../../core/unmanaged-api/hosting/ihostsecuritycontext-interface.md - items: - - name: Capture Method - href: ../../core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md - - name: IHostSecurityManager Interface - href: ../../core/unmanaged-api/hosting/ihostsecuritymanager-interface.md - items: - - name: GetSecurityContext Method - href: ../../core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md - - name: ImpersonateLoggedOnUser Method - href: ../../core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md - - name: OpenThreadToken Method - href: ../../core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md - - name: RevertToSelf Method - href: ../../core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md - - name: SetSecurityContext Method - href: ../../core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md - - name: SetThreadToken Method - href: ../../core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md - - name: IHostSemaphore Interface - href: ../../core/unmanaged-api/hosting/ihostsemaphore-interface.md - items: - - name: ReleaseSemaphore Method - href: ../../core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md - - name: Wait Method - href: ../../core/unmanaged-api/hosting/ihostsemaphore-wait-method.md - - name: IHostSyncManager Interface - href: ../../core/unmanaged-api/hosting/ihostsyncmanager-interface.md - items: - - name: CreateAutoEvent Method - href: ../../core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md - - name: CreateCrst Method - href: ../../core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md - - name: CreateCrstWithSpinCount Method - href: ../../core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md - - name: CreateManualEvent Method - href: ../../core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md - - name: CreateMonitorEvent Method - href: ../../core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md - - name: CreateRWLockReaderEvent Method - href: ../../core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md - - name: CreateRWLockWriterEvent Method - href: ../../core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md - - name: CreateSemaphore Method - href: ../../core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md - - name: SetCLRSyncManager Method - href: ../../core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md - - name: IHostTask Interface - href: ../../core/unmanaged-api/hosting/ihosttask-interface.md - items: - - name: Alert Method - href: ../../core/unmanaged-api/hosting/ihosttask-alert-method.md - - name: GetPriority Method - href: ../../core/unmanaged-api/hosting/ihosttask-getpriority-method.md - - name: Join Method - href: ../../core/unmanaged-api/hosting/ihosttask-join-method.md - - name: SetCLRTask Method - href: ../../core/unmanaged-api/hosting/ihosttask-setclrtask-method.md - - name: SetPriority Method - href: ../../core/unmanaged-api/hosting/ihosttask-setpriority-method.md - - name: Start Method - href: ../../core/unmanaged-api/hosting/ihosttask-start-method.md - - name: IHostTaskManager Interface - href: ../../core/unmanaged-api/hosting/ihosttaskmanager-interface.md - items: - - name: BeginDelayAbort Method - href: ../../core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md - - name: BeginThreadAffinity Method - href: ../../core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md - - name: CallNeedsHostHook Method - href: ../../core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md - - name: CreateTask Method - href: ../../core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md - - name: EndDelayAbort Method - href: ../../core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md - - name: EndThreadAffinity Method - href: ../../core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md - - name: EnterRuntime Method - href: ../../core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md - - name: GetCurrentTask Method - href: ../../core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md - - name: GetStackGuarantee Method - href: ../../core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md - - name: LeaveRuntime Method - href: ../../core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md - - name: ReverseEnterRuntime Method - href: ../../core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md - - name: ReverseLeaveRuntime Method - href: ../../core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md - - name: SetCLRTaskManager Method - href: ../../core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md - - name: SetLocale Method - href: ../../core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md - - name: SetStackGuarantee Method - href: ../../core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md - - name: SetUILocale Method - href: ../../core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md - - name: Sleep Method - href: ../../core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md - - name: SwitchToTask Method - href: ../../core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md - - name: IHostThreadPoolManager Interface - href: ../../core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md - items: - - name: GetAvailableThreads Method - href: ../../core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md - - name: GetMaxThreads Method - href: ../../core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md - - name: GetMinThreads Method - href: ../../core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md - - name: QueueUserWorkItem Method - href: ../../core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md - - name: SetMaxThreads Method - href: ../../core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md - - name: SetMinThreads Method - href: ../../core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md - - name: IManagedObject Interface - href: ../../core/unmanaged-api/hosting/imanagedobject-interface.md - items: - - name: GetObjectIdentity Method - href: ../../core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md - - name: GetSerializedBuffer Method - href: ../../core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md - - name: IObjectHandle Interface - href: ../../core/unmanaged-api/hosting/iobjecthandle-interface.md - items: - - name: Unwrap Method - href: ../../core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md - - name: ITypeName Interface - href: ../../core/unmanaged-api/hosting/itypename-interface.md - items: - - name: GetAssemblyName Method - href: ../../core/unmanaged-api/hosting/itypename-getassemblyname-method.md - - name: GetModifierLength Method - href: ../../core/unmanaged-api/hosting/itypename-getmodifierlength-method.md - - name: GetModifiers Method - href: ../../core/unmanaged-api/hosting/itypename-getmodifiers-method.md - - name: GetNameCount Method - href: ../../core/unmanaged-api/hosting/itypename-getnamecount-method.md - - name: GetNames Method - href: ../../core/unmanaged-api/hosting/itypename-getnames-method.md - - name: GetTypeArgumentCount Method - href: ../../core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md - - name: GetTypeArguments Method - href: ../../core/unmanaged-api/hosting/itypename-gettypearguments-method.md - - name: ITypeNameBuilder Interface - href: ../../core/unmanaged-api/hosting/itypenamebuilder-interface.md - items: - - name: AddArray Method - href: ../../core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md - - name: AddAssemblySpec Method - href: ../../core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md - - name: AddByRef Method - href: ../../core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md - - name: AddName Method - href: ../../core/unmanaged-api/hosting/itypenamebuilder-addname-method.md - - name: AddPointer Method - href: ../../core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md - - name: AddSzArray Method - href: ../../core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md - - name: Clear Method - href: ../../core/unmanaged-api/hosting/itypenamebuilder-clear-method.md - - name: CloseGenericArgument Method - href: ../../core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md - - name: CloseGenericArguments Method - href: ../../core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md - - name: OpenGenericArgument Method - href: ../../core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md - - name: OpenGenericArguments Method - href: ../../core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md - - name: ToString Method - href: ../../core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md - - name: ITypeNameFactory Interface - href: ../../core/unmanaged-api/hosting/itypenamefactory-interface.md - items: - - name: GetTypeNameBuilder Method - href: ../../core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md - - name: ParseTypeName Method - href: ../../core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md - - name: IValidator Interface - href: ../../core/unmanaged-api/hosting/ivalidator-interface.md - items: - - name: FormatEventInfo Method - href: ../../core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md - - name: Validate Method - href: ../../core/unmanaged-api/hosting/ivalidator-validate-method.md - - name: CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5 - href: ../../core/unmanaged-api/hosting/clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md - items: - - name: ICLRAppDomainResourceMonitor Interface - href: ../../core/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md - items: - - name: GetCurrentAllocated Method - href: ../../core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentallocated-method.md - - name: GetCurrentSurvived Method - href: ../../core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md - - name: GetCurrentCpuTime Method - href: ../../core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentcputime-method.md - - name: ICLRDomainManager Interface - href: ../../core/unmanaged-api/hosting/iclrdomainmanager-interface.md - items: - - name: SetAppDomainManagerType Method - href: ../../core/unmanaged-api/hosting/iclrdomainmanager-setappdomainmanagertype-method.md - - name: SetPropertiesForDefaultAppDomain Method - href: ../../core/unmanaged-api/hosting/iclrdomainmanager-setpropertiesfordefaultappdomain-method.md - - name: ICLRGCManager2 Interface - href: ../../core/unmanaged-api/hosting/iclrgcmanager2-interface.md - items: - - name: SetGCStartupLimitsEx Method - href: ../../core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md - - name: ICLRMetaHost Interface - href: ../../core/unmanaged-api/hosting/iclrmetahost-interface.md - items: - - name: EnumerateInstalledRuntimes Method - href: ../../core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md - - name: EnumerateLoadedRuntimes Method - href: ../../core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md - - name: ExitProcess Method - href: ../../core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md - - name: GetRuntime Method - href: ../../core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md - - name: GetVersionFromFile Method - href: ../../core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md - - name: QueryLegacyV2RuntimeBinding Method - href: ../../core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md - - name: RequestRuntimeLoadedNotification Method - href: ../../core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md - - name: ICLRMetaHostPolicy Interface - href: ../../core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md - items: - - name: GetRequestedRuntime Method - href: ../../core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md - - name: ICLRRuntimeInfo Interface - href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-interface.md - items: - - name: BindAsLegacyV2Runtime Method - href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md - - name: GetDefaultStartupFlags Method - href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md - - name: GetInterface Method - href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md - - name: GetProcAddress Method - href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md - - name: GetRuntimeDirectory Method - href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md - - name: GetVersionString Method - href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md - - name: IsLoadable Method - href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md - - name: IsLoaded Method - href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md - - name: IsStarted Method - href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md - - name: LoadErrorString Method - href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md - - name: LoadLibrary Method - href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md - - name: SetDefaultStartupFlags Method - href: ../../core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md - - name: ICLRStrongName Interface - href: ../../core/unmanaged-api/hosting/iclrstrongname-interface.md - items: - - name: GetHashFromAssemblyFile Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md - - name: GetHashFromAssemblyFileW Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md - - name: GetHashFromBlob Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md - - name: GetHashFromFile Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md - - name: GetHashFromFileW Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md - - name: GetHashFromHandle Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md - - name: StrongNameCompareAssemblies Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md - - name: StrongNameFreeBuffer Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md - - name: StrongNameGetBlob Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md - - name: StrongNameGetBlobFromImage Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md - - name: StrongNameGetPublicKey Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md - - name: StrongNameHashSize Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md - - name: StrongNameKeyDelete Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md - - name: StrongNameKeyGen Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md - - name: StrongNameKeyGenEx Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md - - name: StrongNameKeyInstall Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md - - name: StrongNameSignatureGeneration Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md - - name: StrongNameSignatureGenerationEx Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md - - name: StrongNameSignatureSize Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md - - name: StrongNameSignatureVerification Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md - - name: StrongNameSignatureVerificationEx Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md - - name: StrongNameSignatureVerificationFromImage Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md - - name: StrongNameTokenFromAssembly Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md - - name: StrongNameTokenFromAssemblyEx Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md - - name: StrongNameTokenFromPublicKey Method - href: ../../core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md - - name: ICLRStrongName2 Interface - href: ../../core/unmanaged-api/hosting/iclrstrongname2-interface.md - items: - - name: StrongNameGetPublicKeyEx Method - href: ../../core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md - - name: StrongNameSignatureVerificationEx2 Method - href: ../../core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md - - name: ICLRTask2 Interface - href: ../../core/unmanaged-api/hosting/iclrtask2-interface.md - items: - - name: BeginPreventAsyncAbort Method - href: ../../core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md - - name: EndPreventAsyncAbort Method - href: ../../core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md - - name: Hosting Structures - href: ../../core/unmanaged-api/hosting/hosting-structures.md - items: - - name: AssemblyBindInfo Structure - href: ../../core/unmanaged-api/hosting/assemblybindinfo-structure.md - - name: BucketParameters Structure - href: ../../core/unmanaged-api/hosting/bucketparameters-structure.md - - name: COR_GC_STATS Structure - href: ../../core/unmanaged-api/hosting/cor-gc-stats-structure.md - - name: COR_GC_THREAD_STATS Structure - href: ../../core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md - - name: CustomDumpItem Structure - href: ../../core/unmanaged-api/hosting/customdumpitem-structure.md - - name: MDAInfo Structure - href: ../../core/unmanaged-api/hosting/mdainfo-structure.md - - name: ModuleBindInfo Structure - href: ../../core/unmanaged-api/hosting/modulebindinfo-structure.md - - name: StackOverflowInfo Structure - href: ../../core/unmanaged-api/hosting/stackoverflowinfo-structure.md - name: Metadata items: - name: Overview From 0c4dcc1b446bac509da6f512af5019ca5b8b56ec Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Thu, 26 Jun 2025 20:43:29 +0200 Subject: [PATCH 16/20] reset hosting files --- .../hosting/bucketparameters-structure.md | 50 - .../hosting/callfunctionshim-function.md | 69 -- .../hosting/clrruntimehost-coclass.md | 50 - .../clsid-resolution-flags-enumeration.md | 48 - .../hosting/coinitializeee-function.md | 62 - .../hosting/comcallunmarshal-coclass.md | 48 - .../hosting/cor-gc-stat-types-enumeration.md | 53 - .../cor-gc-thread-stats-types-enumeration.md | 46 - .../hosting/corexemain2-function.md | 63 -- .../hosting/corlaunchapplication-function.md | 74 -- .../hosting/createiceefilegen-function.md | 61 - .../hosting/customdumpitem-structure.md | 56 - .../hosting/destroyiceefilegen-function.md | 59 - .../hosting/ebindpolicylevels-enumeration.md | 67 -- .../eclrassemblyidentityflags-enumeration.md | 46 - .../hosting/eclrevent-enumeration.md | 64 -- .../ecustomdumpitemkind-enumeration.md | 49 - .../ehostapplicationpolicy-enumeration.md | 42 - .../hosting/etasktype-enumeration.md | 68 -- .../hosting/getcorrequiredversion-function.md | 57 - .../hosting/getfileversion-function.md | 59 - .../hosting/getrealprocaddress-function.md | 63 -- ...equestedruntimeversionforclsid-function.md | 77 -- .../hosting/host-type-enumeration.md | 52 - .../hosting/hosting-structures.md | 48 - .../iapartmentcallback-docallback-method.md | 52 - .../hosting/iapartmentcallback-interface.md | 40 - .../iappdomainbinding-onappdomain-method.md | 48 - .../hosting/iceefilegen-class.md | 242 ---- .../iclrdebugmanager-getdacl-method.md | 57 - .../iclrdebugmanager-setdacl-method.md | 57 - ...dingpolicymanager-evaluatepolicy-method.md | 85 -- ...ahost-enumerateinstalledruntimes-method.md | 57 - .../iclrmetahost-exitprocess-method.md | 54 - .../iclrpolicymanager-settimeout-method.md | 74 -- .../iclrreferenceassemblyenum-get-method.md | 74 -- ...mehost-executeindefaultappdomain-method.md | 85 -- ...untimeinfo-bindaslegacyv2runtime-method.md | 57 - .../iclrruntimeinfo-getinterface-method.md | 86 -- .../iclrruntimeinfo-getprocaddress-method.md | 69 -- .../iclrruntimeinfo-isstarted-method.md | 64 -- .../iclrruntimeinfo-loaderrorstring-method.md | 77 -- .../iclrruntimeinfo-loadlibrary-method.md | 69 -- ...rongname-gethashfromassemblyfile-method.md | 69 -- ...ongname-gethashfromassemblyfilew-method.md | 69 -- .../iclrstrongname-gethashfromblob-method.md | 72 -- .../iclrstrongname-gethashfromfile-method.md | 73 -- .../iclrstrongname-gethashfromfilew-method.md | 73 -- ...iclrstrongname-gethashfromhandle-method.md | 69 -- ...name-strongnamecompareassemblies-method.md | 70 -- ...iclrstrongname-strongnamegetblob-method.md | 62 - ...gname-strongnamegetblobfromimage-method.md | 65 -- ...clrstrongname-strongnamehashsize-method.md | 56 - ...rongname-strongnamesignaturesize-method.md | 60 - .../iclrvalidator-formateventinfo-method.md | 76 -- .../icorruntimehost-enumdomains-method.md | 57 - .../hosting/icorruntimehost-mapfile-method.md | 52 - ...pool-corbindiocompletioncallback-method.md | 44 - ...dpool-corcallorqueueuserworkitem-method.md | 45 - .../icorthreadpool-corchangetimer-method.md | 46 - .../icorthreadpool-corcreatetimer-method.md | 48 - .../icorthreadpool-cordeletetimer-method.md | 45 - ...hreadpool-corgetavailablethreads-method.md | 44 - .../icorthreadpool-corgetmaxthreads-method.md | 44 - ...rthreadpool-corqueueuserworkitem-method.md | 46 - ...l-corregisterwaitforsingleobject-method.md | 49 - .../icorthreadpool-corsetmaxthreads-method.md | 44 - ...icorthreadpool-corunregisterwait-method.md | 45 - .../hosting/igchost-collect-method.md | 48 - .../hosting/igchost-getthreadstats-method.md | 52 - .../igchost-setgcstartuplimits-method.md | 59 - .../igchost-setvirtualmemlimit-method.md | 52 - .../igchost2-setgcstartuplimitsex-method.md | 56 - .../hosting/igchostcontrol-interface.md | 40 - ...stcontrol-requestvirtualmemlimit-method.md | 52 - .../ihostcontrol-gethostmanager-method.md | 91 -- ...ager-acquiredvirtualaddressspace-method.md | 56 - ...imanagedobject-getobjectidentity-method.md | 60 - ...anagedobject-getserializedbuffer-method.md | 52 - .../hosting/imanagedobject-interface.md | 41 - docs/core/unmanaged-api/hosting/index.md | 36 - .../hosting/iobjecthandle-interface.md | 40 - .../hosting/iobjecthandle-unwrap-method.md | 44 - .../itypename-getassemblyname-method.md | 43 - .../itypename-getmodifierlength-method.md | 43 - .../hosting/itypename-getmodifiers-method.md | 45 - .../hosting/itypename-getnamecount-method.md | 43 - .../hosting/itypename-getnames-method.md | 45 - .../itypename-gettypeargumentcount-method.md | 43 - .../itypename-gettypearguments-method.md | 45 - .../hosting/itypename-interface.md | 36 - .../itypenamebuilder-addarray-method.md | 43 - ...itypenamebuilder-addassemblyspec-method.md | 43 - .../itypenamebuilder-addname-method.md | 43 - .../itypenamebuilder-addpointer-method.md | 41 - .../itypenamebuilder-addszarray-method.md | 41 - .../hosting/itypenamebuilder-clear-method.md | 41 - .../hosting/itypenamebuilder-interface.md | 36 - .../itypenamebuilder-tostring-method.md | 43 - ...penamefactory-gettypenamebuilder-method.md | 43 - .../hosting/itypenamefactory-interface.md | 37 - .../itypenamefactory-parsetypename-method.md | 45 - .../ivalidator-formateventinfo-method.md | 60 - .../hosting/loadstringrc-function.md | 75 -- .../hosting/loadstringrcex-function.md | 84 -- ...lpthread-start-routine-function-pointer.md | 53 - .../hosting/malloc-type-enumeration.md | 50 - .../hosting/rundll32shimw-function.md | 61 - .../hosting/runtime-info-flags-enumeration.md | 74 -- .../hosting/stackoverflowtype-enumeration.md | 56 - .../hosting/typenamefactory-coclass.md | 48 - .../hosting/assemblybindinfo-structure.md | 81 +- .../hosting/bucketparameters-structure.md | 51 + .../hosting/callfunctionshim-function.md | 70 ++ ...es-added-in-the-net-framework-4-and-4-5.md | 99 +- .../hosting/clr-hosting-interfaces.md | 357 +++--- .../hosting/clrcreateinstance-function.md | 33 +- .../clrcreatemanagedinstance-function.md | 87 +- .../hosting/clrruntimehost-coclass.md | 51 + .../clsid-resolution-flags-enumeration.md | 49 + .../hosting/coeeshutdowncom-function.md | 65 +- .../hosting/coinitializecor-function.md | 49 +- .../hosting/coinitializeee-function.md | 63 ++ .../hosting/comcallunmarshal-coclass.md | 49 + .../hosting/cor-gc-stat-types-enumeration.md | 54 + .../hosting/cor-gc-stats-structure.md | 137 +-- .../hosting/cor-gc-thread-stats-structure.md | 73 +- .../cor-gc-thread-stats-types-enumeration.md | 47 + .../corbindtocurrentruntime-function.md | 99 +- .../hosting/corbindtoruntime-function.md | 151 +-- .../hosting/corbindtoruntimebycfg-function.md | 113 +- .../hosting/corbindtoruntimeex-function.md | 233 ++-- .../hosting/corbindtoruntimehost-function.md | 116 +- .../hosting/cordllmain-function.md | 105 +- .../hosting/corexemain-function.md | 63 +- .../hosting/corexemain2-function.md | 64 ++ .../hosting/corexitprocess-function.md | 73 +- .../hosting/corimageunloading-function.md | 65 +- .../hosting/corlaunchapplication-function.md | 75 ++ .../cormarkthreadinthreadpool-function.md | 49 +- .../hosting/corruntimehost-coclass.md | 81 +- .../hosting/corvalidateimage-function.md | 135 +-- .../hosting/couninitializecor-function.md | 35 +- .../hosting/couninitializeee-function.md | 39 +- ...edebugginginterfacefromversion-function.md | 9 +- .../hosting/createiceefilegen-function.md | 62 + .../hosting/customdumpitem-structure.md | 57 + .../deprecated-clr-hosting-functions.md | 296 ++--- ...ed-clr-hosting-interfaces-and-coclasses.md | 31 +- .../hosting/destroyiceefilegen-function.md | 60 + .../hosting/eapicategories-enumeration.md | 113 +- .../hosting/ebindpolicylevels-enumeration.md | 68 ++ .../eclrassemblyidentityflags-enumeration.md | 47 + .../hosting/eclrevent-enumeration.md | 65 ++ .../hosting/eclrfailure-enumeration.md | 93 +- .../hosting/eclroperation-enumeration.md | 109 +- .../eclrunhandledexception-enumeration.md | 77 +- .../hosting/econtexttype-enumeration.md | 77 +- .../hosting/ecustomdumpflavor-enumeration.md | 77 +- .../ecustomdumpitemkind-enumeration.md | 50 + .../ehostapplicationpolicy-enumeration.md | 43 + ...ostbindingpolicymodifyflags-enumeration.md | 85 +- .../einitializenewdomainflags-enumeration.md | 75 +- .../hosting/ememoryavailable-enumeration.md | 79 +- .../ememorycriticallevel-enumeration.md | 81 +- .../hosting/epolicyaction-enumeration.md | 105 +- .../esymbolreadingpolicy-enumeration.md | 81 +- .../hosting/etasktype-enumeration.md | 69 ++ ...uteinappdomaincallback-function-pointer.md | 71 +- ...lockclrversioncallback-function-pointer.md | 61 +- .../hosting/getclridentitymanager-function.md | 83 +- .../hosting/getcorrequiredversion-function.md | 58 + .../hosting/getcorsystemdirectory-function.md | 83 +- .../hosting/getcorversion-function.md | 66 +- .../hosting/getfileversion-function.md | 60 + .../hosting/getrealprocaddress-function.md | 64 ++ .../getrequestedruntimeinfo-function.md | 197 ++-- .../getrequestedruntimeversion-function.md | 105 +- ...equestedruntimeversionforclsid-function.md | 78 ++ .../hosting/getversionfromprocess-function.md | 107 +- .../hosting/host-type-enumeration.md | 53 + .../hosting/hosting-coclasses.md | 51 +- .../hosting/hosting-enumerations.md | 207 ++-- .../hosting-global-static-functions.md | 35 +- .../hosting/hosting-interfaces.md | 63 +- .../hosting/hosting-structures.md | 49 + .../hosting/iactiononclrevent-interface.md | 49 +- .../iactiononclrevent-onevent-method.md | 107 +- .../iapartmentcallback-docallback-method.md | 53 + .../hosting/iapartmentcallback-interface.md | 41 + .../hosting/iappdomainbinding-interface.md | 49 +- .../iappdomainbinding-onappdomain-method.md | 49 + .../hosting/iappdomainsetup-interface.md | 79 +- .../icatalogservices-autodone-method.md | 29 +- .../hosting/icatalogservices-interface.md | 35 +- .../icatalogservices-notautodone-method.md | 29 +- .../hosting/iceefilegen-class.md | 243 ++++ ...ourcemonitor-getcurrentallocated-method.md | 93 +- ...esourcemonitor-getcurrentcputime-method.md | 91 +- ...sourcemonitor-getcurrentsurvived-method.md | 107 +- .../iclrappdomainresourcemonitor-interface.md | 83 +- ...nager-getbindingidentityfromfile-method.md | 121 +- ...ger-getbindingidentityfromstream-method.md | 113 +- ...ager-getclrassemblyreferencelist-method.md | 101 +- ...etprobingassembliesfromreference-method.md | 109 +- ...-getreferencedassembliesfromfile-method.md | 117 +- ...etreferencedassembliesfromstream-method.md | 117 +- .../iclrassemblyidentitymanager-interface.md | 69 +- ...yidentitymanager-isstronglynamed-method.md | 89 +- .../iclrassemblyreferencelist-interface.md | 59 +- ...celist-isassemblyreferenceinlist-method.md | 79 +- ...-isstringassemblyreferenceinlist-method.md | 79 +- .../iclrcontrol-getclrmanager-method.md | 123 +- .../hosting/iclrcontrol-interface.md | 51 +- ...rcontrol-setappdomainmanagertype-method.md | 89 +- ...iclrdebugmanager-beginconnection-method.md | 109 +- .../iclrdebugmanager-endconnection-method.md | 99 +- .../iclrdebugmanager-getdacl-method.md | 58 + .../hosting/iclrdebugmanager-interface.md | 77 +- ...rdebugmanager-isdebuggerattached-method.md | 93 +- ...rdebugmanager-setconnectiontasks-method.md | 115 +- .../iclrdebugmanager-setdacl-method.md | 58 + ...ugmanager-setsymbolreadingpolicy-method.md | 79 +- .../hosting/iclrdomainmanager-interface.md | 57 +- ...nmanager-setappdomainmanagertype-method.md | 111 +- ...setpropertiesfordefaultappdomain-method.md | 103 +- ...reportingmanager-begincustomdump-method.md | 121 +- ...orreportingmanager-endcustomdump-method.md | 83 +- ...ketparametersforcurrentexception-method.md | 67 +- .../iclrerrorreportingmanager-interface.md | 65 +- .../hosting/iclrgcmanager-collect-method.md | 93 +- .../hosting/iclrgcmanager-getstats-method.md | 113 +- .../hosting/iclrgcmanager-interface.md | 65 +- ...iclrgcmanager-setgcstartuplimits-method.md | 111 +- .../hosting/iclrgcmanager2-interface.md | 61 +- ...rgcmanager2-setgcstartuplimitsex-method.md | 111 +- ...dingpolicymanager-evaluatepolicy-method.md | 86 ++ .../iclrhostbindingpolicymanager-interface.md | 51 +- ...ymanager-modifyapplicationpolicy-method.md | 141 +-- .../iclrhostprotectionmanager-interface.md | 51 +- ...nager-seteagerserializegrantsets-method.md | 71 +- ...onmanager-setprotectedcategories-method.md | 93 +- .../iclriocompletionmanager-interface.md | 57 +- ...lriocompletionmanager-oncomplete-method.md | 121 +- ...clrmemorynotificationcallback-interface.md | 57 +- ...ioncallback-onmemorynotification-method.md | 97 +- ...ahost-enumerateinstalledruntimes-method.md | 58 + ...metahost-enumerateloadedruntimes-method.md | 97 +- .../iclrmetahost-exitprocess-method.md | 55 + .../hosting/iclrmetahost-getruntime-method.md | 113 +- .../iclrmetahost-getversionfromfile-method.md | 107 +- .../hosting/iclrmetahost-interface.md | 81 +- ...host-querylegacyv2runtimebinding-method.md | 93 +- ...requestruntimeloadednotification-method.md | 165 +-- ...tahostpolicy-getrequestedruntime-method.md | 7 +- .../hosting/iclrmetahostpolicy-interface.md | 77 +- .../hosting/iclroneventmanager-interface.md | 63 +- ...entmanager-registeractiononevent-method.md | 105 +- ...tmanager-unregisteractiononevent-method.md | 89 +- .../hosting/iclrpolicymanager-interface.md | 59 +- ...policymanager-setactiononfailure-method.md | 83 +- ...policymanager-setactionontimeout-method.md | 135 +-- ...lrpolicymanager-setdefaultaction-method.md | 121 +- .../iclrpolicymanager-settimeout-method.md | 75 ++ ...olicymanager-settimeoutandaction-method.md | 131 +-- ...ager-setunhandledexceptionpolicy-method.md | 93 +- .../iclrprobingassemblyenum-get-method.md | 5 +- .../iclrprobingassemblyenum-interface.md | 57 +- .../iclrreferenceassemblyenum-get-method.md | 75 ++ .../iclrreferenceassemblyenum-interface.md | 49 +- ...lrruntimehost-executeapplication-method.md | 141 +-- ...lrruntimehost-executeinappdomain-method.md | 105 +- ...mehost-executeindefaultappdomain-method.md | 86 ++ .../iclrruntimehost-getclrcontrol-method.md | 95 +- ...untimehost-getcurrentappdomainid-method.md | 93 +- .../hosting/iclrruntimehost-interface.md | 81 +- .../iclrruntimehost-sethostcontrol-method.md | 95 +- .../hosting/iclrruntimehost-start-method.md | 79 +- .../hosting/iclrruntimehost-stop-method.md | 75 +- .../iclrruntimehost-unloadappdomain-method.md | 101 +- ...untimeinfo-bindaslegacyv2runtime-method.md | 58 + ...ntimeinfo-getdefaultstartupflags-method.md | 101 +- .../iclrruntimeinfo-getinterface-method.md | 87 ++ .../iclrruntimeinfo-getprocaddress-method.md | 70 ++ ...rruntimeinfo-getruntimedirectory-method.md | 95 +- ...iclrruntimeinfo-getversionstring-method.md | 107 +- .../hosting/iclrruntimeinfo-interface.md | 71 +- .../iclrruntimeinfo-isloadable-method.md | 91 +- .../iclrruntimeinfo-isloaded-method.md | 115 +- .../iclrruntimeinfo-isstarted-method.md | 65 ++ .../iclrruntimeinfo-loaderrorstring-method.md | 78 ++ .../iclrruntimeinfo-loadlibrary-method.md | 70 ++ ...ntimeinfo-setdefaultstartupflags-method.md | 93 +- ...rongname-gethashfromassemblyfile-method.md | 70 ++ ...ongname-gethashfromassemblyfilew-method.md | 70 ++ .../iclrstrongname-gethashfromblob-method.md | 73 ++ .../iclrstrongname-gethashfromfile-method.md | 74 ++ .../iclrstrongname-gethashfromfilew-method.md | 74 ++ ...iclrstrongname-gethashfromhandle-method.md | 70 ++ .../hosting/iclrstrongname-interface.md | 101 +- ...name-strongnamecompareassemblies-method.md | 71 ++ ...rstrongname-strongnamefreebuffer-method.md | 69 +- ...iclrstrongname-strongnamegetblob-method.md | 63 ++ ...gname-strongnamegetblobfromimage-method.md | 66 ++ ...trongname-strongnamegetpublickey-method.md | 119 +- ...clrstrongname-strongnamehashsize-method.md | 57 + ...lrstrongname-strongnamekeydelete-method.md | 79 +- .../iclrstrongname-strongnamekeygen-method.md | 111 +- ...clrstrongname-strongnamekeygenex-method.md | 123 +- ...rstrongname-strongnamekeyinstall-method.md | 95 +- ...me-strongnamesignaturegeneration-method.md | 137 +-- ...-strongnamesignaturegenerationex-method.md | 157 +-- ...rongname-strongnamesignaturesize-method.md | 61 + ...-strongnamesignatureverification-method.md | 115 +- ...trongnamesignatureverificationex-method.md | 95 +- ...mesignatureverificationfromimage-method.md | 123 +- ...name-strongnametokenfromassembly-method.md | 99 +- ...me-strongnametokenfromassemblyex-method.md | 115 +- ...ame-strongnametokenfrompublickey-method.md | 103 +- .../hosting/iclrstrongname2-interface.md | 53 +- ...anager-createrwlockowneriterator-method.md | 115 +- ...anager-deleterwlockowneriterator-method.md | 93 +- .../iclrsyncmanager-getmonitorowner-method.md | 109 +- ...lrsyncmanager-getrwlockownernext-method.md | 103 +- .../hosting/iclrsyncmanager-interface.md | 55 +- .../hosting/iclrtask-abort-method.md | 79 +- .../hosting/iclrtask-exittask-method.md | 79 +- .../hosting/iclrtask-getmemstats-method.md | 85 +- .../hosting/iclrtask-interface.md | 81 +- .../hosting/iclrtask-locksheld-method.md | 85 +- ...iclrtask-needspriorityscheduling-method.md | 93 +- .../hosting/iclrtask-reset-method.md | 125 ++- .../hosting/iclrtask-rudeabort-method.md | 77 +- .../iclrtask-settaskidentifier-method.md | 93 +- .../hosting/iclrtask-switchin-method.md | 99 +- .../hosting/iclrtask-switchout-method.md | 79 +- .../hosting/iclrtask-yieldtask-method.md | 79 +- ...iclrtask2-beginpreventasyncabort-method.md | 87 +- .../iclrtask2-endpreventasyncabort-method.md | 83 +- .../hosting/iclrtask2-interface.md | 75 +- .../iclrtaskmanager-createtask-method.md | 103 +- .../iclrtaskmanager-getcurrenttask-method.md | 93 +- ...lrtaskmanager-getcurrenttasktype-method.md | 63 +- .../hosting/iclrtaskmanager-interface.md | 65 +- .../iclrtaskmanager-setlocale-method.md | 93 +- .../iclrtaskmanager-setuilocale-method.md | 93 +- .../iclrvalidator-formateventinfo-method.md | 77 ++ .../hosting/iclrvalidator-interface.md | 5 +- .../hosting/iclrvalidator-validate-method.md | 5 +- ...uration-adddebuggerspecialthread-method.md | 71 +- .../hosting/icorconfiguration-interface.md | 55 +- ...uration-setdebuggerthreadcontrol-method.md | 63 +- ...orconfiguration-setgchostcontrol-method.md | 63 +- ...configuration-setgcthreadcontrol-method.md | 71 +- .../icorruntimehost-closeenum-method.md | 81 +- .../icorruntimehost-createdomain-method.md | 97 +- .../icorruntimehost-createdomainex-method.md | 113 +- ...corruntimehost-createdomainsetup-method.md | 89 +- .../icorruntimehost-createevidence-method.md | 89 +- ...imehost-createlogicalthreadstate-method.md | 49 +- .../icorruntimehost-currentdomain-method.md | 81 +- ...imehost-deletelogicalthreadstate-method.md | 49 +- .../icorruntimehost-enumdomains-method.md | 58 + ...icorruntimehost-getconfiguration-method.md | 71 +- ...icorruntimehost-getdefaultdomain-method.md | 85 +- .../hosting/icorruntimehost-interface.md | 87 +- ...imehost-locksheldbylogicalthread-method.md | 67 +- .../hosting/icorruntimehost-mapfile-method.md | 53 + .../icorruntimehost-nextdomain-method.md | 85 +- .../hosting/icorruntimehost-start-method.md | 75 +- .../hosting/icorruntimehost-stop-method.md | 79 +- ...ehost-switchinlogicalthreadstate-method.md | 63 +- ...host-switchoutlogicalthreadstate-method.md | 63 +- .../icorruntimehost-unloaddomain-method.md | 81 +- ...pool-corbindiocompletioncallback-method.md | 45 + ...dpool-corcallorqueueuserworkitem-method.md | 46 + .../icorthreadpool-corchangetimer-method.md | 47 + .../icorthreadpool-corcreatetimer-method.md | 49 + .../icorthreadpool-cordeletetimer-method.md | 46 + ...hreadpool-corgetavailablethreads-method.md | 45 + .../icorthreadpool-corgetmaxthreads-method.md | 45 + ...rthreadpool-corqueueuserworkitem-method.md | 47 + ...l-corregisterwaitforsingleobject-method.md | 50 + .../icorthreadpool-corsetmaxthreads-method.md | 45 + ...icorthreadpool-corunregisterwait-method.md | 46 + .../hosting/icorthreadpool-interface.md | 73 +- .../hosting/idebuggerinfo-interface.md | 49 +- ...idebuggerinfo-isdebuggerattached-method.md | 63 +- .../idebuggerthreadcontrol-interface.md | 53 +- ...control-releaseallruntimethreads-method.md | 57 +- ...control-startblockingfordebugger-method.md | 71 +- ...trol-threadisblockingfordebugger-method.md | 61 +- .../hosting/igchost-collect-method.md | 49 + .../hosting/igchost-getstats-method.md | 71 +- .../hosting/igchost-getthreadstats-method.md | 53 + .../hosting/igchost-interface.md | 65 +- .../igchost-setgcstartuplimits-method.md | 60 + .../igchost-setvirtualmemlimit-method.md | 53 + .../hosting/igchost2-interface.md | 53 +- .../igchost2-setgcstartuplimitsex-method.md | 57 + .../hosting/igchostcontrol-interface.md | 41 + ...stcontrol-requestvirtualmemlimit-method.md | 53 + .../hosting/igcthreadcontrol-interface.md | 53 +- ...gcthreadcontrol-suspensionending-method.md | 71 +- ...threadcontrol-suspensionstarting-method.md | 57 +- ...ol-threadisblockingforsuspension-method.md | 57 +- ...assemblymanager-getassemblystore-method.md | 99 +- ...anager-getnonhoststoreassemblies-method.md | 119 +- .../hosting/ihostassemblymanager-interface.md | 63 +- .../hosting/ihostassemblystore-interface.md | 71 +- ...ostassemblystore-provideassembly-method.md | 129 +-- ...ihostassemblystore-providemodule-method.md | 121 +- .../hosting/ihostautoevent-interface.md | 51 +- .../hosting/ihostautoevent-set-method.md | 71 +- .../hosting/ihostautoevent-wait-method.md | 91 +- .../ihostcontrol-gethostmanager-method.md | 92 ++ .../hosting/ihostcontrol-interface.md | 51 +- ...ihostcontrol-setappdomainmanager-method.md | 105 +- .../hosting/ihostcrst-enter-method.md | 97 +- .../hosting/ihostcrst-interface.md | 63 +- .../hosting/ihostcrst-leave-method.md | 79 +- .../hosting/ihostcrst-setspincount-method.md | 97 +- .../hosting/ihostcrst-tryenter-method.md | 101 +- .../hosting/ihostgcmanager-interface.md | 53 +- .../ihostgcmanager-suspensionending-method.md | 97 +- ...hostgcmanager-suspensionstarting-method.md | 79 +- ...er-threadisblockingforsuspension-method.md | 79 +- .../ihostiocompletionmanager-bind-method.md | 105 +- ...ionmanager-closeiocompletionport-method.md | 95 +- ...onmanager-createiocompletionport-method.md | 95 +- ...etionmanager-getavailablethreads-method.md | 95 +- ...ionmanager-gethostoverlappedsize-method.md | 109 +- ...ocompletionmanager-getmaxthreads-method.md | 95 +- ...ocompletionmanager-getminthreads-method.md | 95 +- ...manager-initializehostoverlapped-method.md | 103 +- .../ihostiocompletionmanager-interface.md | 77 +- ...anager-setclriocompletionmanager-method.md | 93 +- ...ocompletionmanager-setmaxthreads-method.md | 95 +- ...ocompletionmanager-setminthreads-method.md | 95 +- .../hosting/ihostmalloc-alloc-method.md | 107 +- .../hosting/ihostmalloc-debugalloc-method.md | 119 +- .../hosting/ihostmalloc-free-method.md | 95 +- .../hosting/ihostmalloc-interface.md | 61 +- .../hosting/ihostmanualevent-interface.md | 53 +- .../hosting/ihostmanualevent-reset-method.md | 71 +- .../hosting/ihostmanualevent-set-method.md | 71 +- .../hosting/ihostmanualevent-wait-method.md | 91 +- ...ager-acquiredvirtualaddressspace-method.md | 57 + .../ihostmemorymanager-createmalloc-method.md | 103 +- ...ihostmemorymanager-getmemoryload-method.md | 103 +- .../hosting/ihostmemorymanager-interface.md | 75 +- ...manager-needsvirtualaddressspace-method.md | 83 +- ...gistermemorynotificationcallback-method.md | 97 +- ...ager-releasedvirtualaddressspace-method.md | 71 +- .../ihostmemorymanager-virtualalloc-method.md | 139 +-- .../ihostmemorymanager-virtualfree-method.md | 115 +- ...hostmemorymanager-virtualprotect-method.md | 117 +- .../ihostmemorymanager-virtualquery-method.md | 121 +- .../hosting/ihostpolicymanager-interface.md | 53 +- ...ostpolicymanager-ondefaultaction-method.md | 87 +- .../ihostpolicymanager-onfailure-method.md | 89 +- .../ihostpolicymanager-ontimeout-method.md | 87 +- .../ihostsecuritycontext-capture-method.md | 91 +- .../hosting/ihostsecuritycontext-interface.md | 57 +- ...curitymanager-getsecuritycontext-method.md | 97 +- ...ymanager-impersonateloggedonuser-method.md | 97 +- .../hosting/ihostsecuritymanager-interface.md | 87 +- ...tsecuritymanager-openthreadtoken-method.md | 109 +- ...hostsecuritymanager-reverttoself-method.md | 79 +- ...curitymanager-setsecuritycontext-method.md | 105 +- ...stsecuritymanager-setthreadtoken-method.md | 97 +- .../hosting/ihostsemaphore-interface.md | 51 +- .../ihostsemaphore-releasesemaphore-method.md | 101 +- .../hosting/ihostsemaphore-wait-method.md | 91 +- ...ihostsyncmanager-createautoevent-method.md | 95 +- .../ihostsyncmanager-createcrst-method.md | 95 +- ...cmanager-createcrstwithspincount-method.md | 103 +- ...ostsyncmanager-createmanualevent-method.md | 103 +- ...stsyncmanager-createmonitorevent-method.md | 107 +- ...cmanager-createrwlockreaderevent-method.md | 111 +- ...cmanager-createrwlockwriterevent-method.md | 103 +- ...ihostsyncmanager-createsemaphore-method.md | 111 +- .../hosting/ihostsyncmanager-interface.md | 73 +- ...ostsyncmanager-setclrsyncmanager-method.md | 93 +- .../hosting/ihosttask-alert-method.md | 83 +- .../hosting/ihosttask-getpriority-method.md | 93 +- .../hosting/ihosttask-interface.md | 67 +- .../hosting/ihosttask-join-method.md | 89 +- .../hosting/ihosttask-setclrtask-method.md | 93 +- .../hosting/ihosttask-setpriority-method.md | 133 +-- .../hosting/ihosttask-start-method.md | 71 +- ...ihosttaskmanager-begindelayabort-method.md | 81 +- ...ttaskmanager-beginthreadaffinity-method.md | 79 +- ...osttaskmanager-callneedshosthook-method.md | 103 +- .../ihosttaskmanager-createtask-method.md | 117 +- .../ihosttaskmanager-enddelayabort-method.md | 81 +- ...osttaskmanager-endthreadaffinity-method.md | 81 +- .../ihosttaskmanager-enterruntime-method.md | 81 +- .../ihosttaskmanager-getcurrenttask-method.md | 95 +- ...osttaskmanager-getstackguarantee-method.md | 63 +- .../hosting/ihosttaskmanager-interface.md | 87 +- .../ihosttaskmanager-leaveruntime-method.md | 117 +- ...ttaskmanager-reverseenterruntime-method.md | 81 +- ...ttaskmanager-reverseleaveruntime-method.md | 77 +- ...osttaskmanager-setclrtaskmanager-method.md | 93 +- .../ihosttaskmanager-setlocale-method.md | 95 +- ...osttaskmanager-setstackguarantee-method.md | 53 +- .../ihosttaskmanager-setuilocale-method.md | 95 +- .../hosting/ihosttaskmanager-sleep-method.md | 101 +- .../ihosttaskmanager-switchtotask-method.md | 97 +- ...dpoolmanager-getavailablethreads-method.md | 95 +- ...tthreadpoolmanager-getmaxthreads-method.md | 99 +- ...tthreadpoolmanager-getminthreads-method.md | 95 +- .../ihostthreadpoolmanager-interface.md | 67 +- ...eadpoolmanager-queueuserworkitem-method.md | 109 +- ...tthreadpoolmanager-setmaxthreads-method.md | 95 +- ...tthreadpoolmanager-setminthreads-method.md | 95 +- ...imanagedobject-getobjectidentity-method.md | 61 + ...anagedobject-getserializedbuffer-method.md | 53 + .../hosting/imanagedobject-interface.md | 42 + docs/framework/unmanaged-api/hosting/index.md | 35 + .../hosting/iobjecthandle-interface.md | 41 + .../hosting/iobjecthandle-unwrap-method.md | 45 + .../itypename-getassemblyname-method.md | 44 + .../itypename-getmodifierlength-method.md | 44 + .../hosting/itypename-getmodifiers-method.md | 46 + .../hosting/itypename-getnamecount-method.md | 44 + .../hosting/itypename-getnames-method.md | 46 + .../itypename-gettypeargumentcount-method.md | 44 + .../itypename-gettypearguments-method.md | 46 + .../hosting/itypename-interface.md | 37 + .../itypenamebuilder-addarray-method.md | 44 + ...itypenamebuilder-addassemblyspec-method.md | 44 + .../itypenamebuilder-addbyref-method.md | 5 +- .../itypenamebuilder-addname-method.md | 44 + .../itypenamebuilder-addpointer-method.md | 42 + .../itypenamebuilder-addszarray-method.md | 42 + .../hosting/itypenamebuilder-clear-method.md | 42 + ...namebuilder-closegenericargument-method.md | 49 +- ...amebuilder-closegenericarguments-method.md | 49 +- .../hosting/itypenamebuilder-interface.md | 37 + ...enamebuilder-opengenericargument-method.md | 49 +- ...namebuilder-opengenericarguments-method.md | 49 +- .../itypenamebuilder-tostring-method.md | 44 + ...penamefactory-gettypenamebuilder-method.md | 44 + .../hosting/itypenamefactory-interface.md | 38 + .../itypenamefactory-parsetypename-method.md | 46 + .../ivalidator-formateventinfo-method.md | 61 + .../hosting/ivalidator-interface.md | 5 +- .../hosting/ivalidator-validate-method.md | 5 +- .../hosting/loadlibraryshim-function.md | 117 +- .../hosting/loadstringrc-function.md | 76 ++ .../hosting/loadstringrcex-function.md | 85 ++ .../hosting/lockclrversion-function.md | 157 +-- ...ped-completion-routine-function-pointer.md | 95 +- ...lpthread-start-routine-function-pointer.md | 54 + .../hosting/malloc-type-enumeration.md | 51 + .../hosting/mdainfo-structure.md | 95 +- .../metahost-config-flags-enumeration.md | 83 +- .../metahost-policy-flags-enumeration.md | 93 +- .../hosting/modulebindinfo-structure.md | 81 +- ...ework-4-hosting-global-static-functions.md | 15 +- .../hosting/rundll32shimw-function.md | 62 + .../hosting/runtime-info-flags-enumeration.md | 75 ++ .../hosting/stackoverflowinfo-structure.md | 77 +- .../hosting/stackoverflowtype-enumeration.md | 57 + .../hosting/startup-flags-enumeration.md | 133 +-- .../strongnamegetpublickeyex-method.md | 155 +-- ...rongnamesignatureverificationex2-method.md | 101 +- docs/framework/unmanaged-api/hosting/toc.yml | 1000 +++++++++++++++++ .../hosting/typenamefactory-coclass.md | 49 + .../hosting/validatorflags-enumeration.md | 5 +- .../hosting/wait-option-enumeration.md | 81 +- .../waitortimercallback-function-pointer.md | 83 +- 574 files changed, 22979 insertions(+), 21516 deletions(-) delete mode 100644 docs/core/unmanaged-api/hosting/bucketparameters-structure.md delete mode 100644 docs/core/unmanaged-api/hosting/callfunctionshim-function.md delete mode 100644 docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md delete mode 100644 docs/core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md delete mode 100644 docs/core/unmanaged-api/hosting/coinitializeee-function.md delete mode 100644 docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md delete mode 100644 docs/core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md delete mode 100644 docs/core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md delete mode 100644 docs/core/unmanaged-api/hosting/corexemain2-function.md delete mode 100644 docs/core/unmanaged-api/hosting/corlaunchapplication-function.md delete mode 100644 docs/core/unmanaged-api/hosting/createiceefilegen-function.md delete mode 100644 docs/core/unmanaged-api/hosting/customdumpitem-structure.md delete mode 100644 docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md delete mode 100644 docs/core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md delete mode 100644 docs/core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md delete mode 100644 docs/core/unmanaged-api/hosting/eclrevent-enumeration.md delete mode 100644 docs/core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md delete mode 100644 docs/core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md delete mode 100644 docs/core/unmanaged-api/hosting/etasktype-enumeration.md delete mode 100644 docs/core/unmanaged-api/hosting/getcorrequiredversion-function.md delete mode 100644 docs/core/unmanaged-api/hosting/getfileversion-function.md delete mode 100644 docs/core/unmanaged-api/hosting/getrealprocaddress-function.md delete mode 100644 docs/core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md delete mode 100644 docs/core/unmanaged-api/hosting/host-type-enumeration.md delete mode 100644 docs/core/unmanaged-api/hosting/hosting-structures.md delete mode 100644 docs/core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md delete mode 100644 docs/core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iceefilegen-class.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrdebugmanager-getdacl-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrdebugmanager-setdacl-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md delete mode 100644 docs/core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md delete mode 100644 docs/core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md delete mode 100644 docs/core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md delete mode 100644 docs/core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md delete mode 100644 docs/core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md delete mode 100644 docs/core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md delete mode 100644 docs/core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md delete mode 100644 docs/core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md delete mode 100644 docs/core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md delete mode 100644 docs/core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md delete mode 100644 docs/core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md delete mode 100644 docs/core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md delete mode 100644 docs/core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md delete mode 100644 docs/core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md delete mode 100644 docs/core/unmanaged-api/hosting/igchost-collect-method.md delete mode 100644 docs/core/unmanaged-api/hosting/igchost-getthreadstats-method.md delete mode 100644 docs/core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md delete mode 100644 docs/core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md delete mode 100644 docs/core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md delete mode 100644 docs/core/unmanaged-api/hosting/igchostcontrol-interface.md delete mode 100644 docs/core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md delete mode 100644 docs/core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md delete mode 100644 docs/core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md delete mode 100644 docs/core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md delete mode 100644 docs/core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md delete mode 100644 docs/core/unmanaged-api/hosting/imanagedobject-interface.md delete mode 100644 docs/core/unmanaged-api/hosting/index.md delete mode 100644 docs/core/unmanaged-api/hosting/iobjecthandle-interface.md delete mode 100644 docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md delete mode 100644 docs/core/unmanaged-api/hosting/itypename-getassemblyname-method.md delete mode 100644 docs/core/unmanaged-api/hosting/itypename-getmodifierlength-method.md delete mode 100644 docs/core/unmanaged-api/hosting/itypename-getmodifiers-method.md delete mode 100644 docs/core/unmanaged-api/hosting/itypename-getnamecount-method.md delete mode 100644 docs/core/unmanaged-api/hosting/itypename-getnames-method.md delete mode 100644 docs/core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md delete mode 100644 docs/core/unmanaged-api/hosting/itypename-gettypearguments-method.md delete mode 100644 docs/core/unmanaged-api/hosting/itypename-interface.md delete mode 100644 docs/core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md delete mode 100644 docs/core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md delete mode 100644 docs/core/unmanaged-api/hosting/itypenamebuilder-addname-method.md delete mode 100644 docs/core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md delete mode 100644 docs/core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md delete mode 100644 docs/core/unmanaged-api/hosting/itypenamebuilder-clear-method.md delete mode 100644 docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md delete mode 100644 docs/core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md delete mode 100644 docs/core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md delete mode 100644 docs/core/unmanaged-api/hosting/itypenamefactory-interface.md delete mode 100644 docs/core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md delete mode 100644 docs/core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md delete mode 100644 docs/core/unmanaged-api/hosting/loadstringrc-function.md delete mode 100644 docs/core/unmanaged-api/hosting/loadstringrcex-function.md delete mode 100644 docs/core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md delete mode 100644 docs/core/unmanaged-api/hosting/malloc-type-enumeration.md delete mode 100644 docs/core/unmanaged-api/hosting/rundll32shimw-function.md delete mode 100644 docs/core/unmanaged-api/hosting/runtime-info-flags-enumeration.md delete mode 100644 docs/core/unmanaged-api/hosting/stackoverflowtype-enumeration.md delete mode 100644 docs/core/unmanaged-api/hosting/typenamefactory-coclass.md rename docs/{core => framework}/unmanaged-api/hosting/assemblybindinfo-structure.md (63%) create mode 100644 docs/framework/unmanaged-api/hosting/bucketparameters-structure.md create mode 100644 docs/framework/unmanaged-api/hosting/callfunctionshim-function.md rename docs/{core => framework}/unmanaged-api/hosting/clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md (66%) rename docs/{core => framework}/unmanaged-api/hosting/clr-hosting-interfaces.md (60%) rename docs/{core => framework}/unmanaged-api/hosting/clrcreateinstance-function.md (72%) rename docs/{core => framework}/unmanaged-api/hosting/clrcreatemanagedinstance-function.md (62%) create mode 100644 docs/framework/unmanaged-api/hosting/clrruntimehost-coclass.md create mode 100644 docs/framework/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md rename docs/{core => framework}/unmanaged-api/hosting/coeeshutdowncom-function.md (65%) rename docs/{core => framework}/unmanaged-api/hosting/coinitializecor-function.md (60%) create mode 100644 docs/framework/unmanaged-api/hosting/coinitializeee-function.md create mode 100644 docs/framework/unmanaged-api/hosting/comcallunmarshal-coclass.md create mode 100644 docs/framework/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md rename docs/{core => framework}/unmanaged-api/hosting/cor-gc-stats-structure.md (56%) rename docs/{core => framework}/unmanaged-api/hosting/cor-gc-thread-stats-structure.md (52%) create mode 100644 docs/framework/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md rename docs/{core => framework}/unmanaged-api/hosting/corbindtocurrentruntime-function.md (60%) rename docs/{core => framework}/unmanaged-api/hosting/corbindtoruntime-function.md (74%) rename docs/{core => framework}/unmanaged-api/hosting/corbindtoruntimebycfg-function.md (50%) rename docs/{core => framework}/unmanaged-api/hosting/corbindtoruntimeex-function.md (71%) rename docs/{core => framework}/unmanaged-api/hosting/corbindtoruntimehost-function.md (77%) rename docs/{core => framework}/unmanaged-api/hosting/cordllmain-function.md (53%) rename docs/{core => framework}/unmanaged-api/hosting/corexemain-function.md (59%) create mode 100644 docs/framework/unmanaged-api/hosting/corexemain2-function.md rename docs/{core => framework}/unmanaged-api/hosting/corexitprocess-function.md (52%) rename docs/{core => framework}/unmanaged-api/hosting/corimageunloading-function.md (53%) create mode 100644 docs/framework/unmanaged-api/hosting/corlaunchapplication-function.md rename docs/{core => framework}/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md (58%) rename docs/{core => framework}/unmanaged-api/hosting/corruntimehost-coclass.md (53%) rename docs/{core => framework}/unmanaged-api/hosting/corvalidateimage-function.md (61%) rename docs/{core => framework}/unmanaged-api/hosting/couninitializecor-function.md (65%) rename docs/{core => framework}/unmanaged-api/hosting/couninitializeee-function.md (64%) rename docs/{core => framework}/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md (68%) create mode 100644 docs/framework/unmanaged-api/hosting/createiceefilegen-function.md create mode 100644 docs/framework/unmanaged-api/hosting/customdumpitem-structure.md rename docs/{core => framework}/unmanaged-api/hosting/deprecated-clr-hosting-functions.md (51%) rename docs/{core => framework}/unmanaged-api/hosting/deprecated-clr-hosting-interfaces-and-coclasses.md (68%) create mode 100644 docs/framework/unmanaged-api/hosting/destroyiceefilegen-function.md rename docs/{core => framework}/unmanaged-api/hosting/eapicategories-enumeration.md (63%) create mode 100644 docs/framework/unmanaged-api/hosting/ebindpolicylevels-enumeration.md create mode 100644 docs/framework/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md create mode 100644 docs/framework/unmanaged-api/hosting/eclrevent-enumeration.md rename docs/{core => framework}/unmanaged-api/hosting/eclrfailure-enumeration.md (58%) rename docs/{core => framework}/unmanaged-api/hosting/eclroperation-enumeration.md (67%) rename docs/{core => framework}/unmanaged-api/hosting/eclrunhandledexception-enumeration.md (58%) rename docs/{core => framework}/unmanaged-api/hosting/econtexttype-enumeration.md (58%) rename docs/{core => framework}/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md (57%) create mode 100644 docs/framework/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md create mode 100644 docs/framework/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md rename docs/{core => framework}/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md (55%) rename docs/{core => framework}/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md (50%) rename docs/{core => framework}/unmanaged-api/hosting/ememoryavailable-enumeration.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/ememorycriticallevel-enumeration.md (72%) rename docs/{core => framework}/unmanaged-api/hosting/epolicyaction-enumeration.md (65%) rename docs/{core => framework}/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md (52%) create mode 100644 docs/framework/unmanaged-api/hosting/etasktype-enumeration.md rename docs/{core => framework}/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md (54%) rename docs/{core => framework}/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md (54%) rename docs/{core => framework}/unmanaged-api/hosting/getclridentitymanager-function.md (54%) create mode 100644 docs/framework/unmanaged-api/hosting/getcorrequiredversion-function.md rename docs/{core => framework}/unmanaged-api/hosting/getcorsystemdirectory-function.md (63%) rename docs/{core => framework}/unmanaged-api/hosting/getcorversion-function.md (66%) create mode 100644 docs/framework/unmanaged-api/hosting/getfileversion-function.md create mode 100644 docs/framework/unmanaged-api/hosting/getrealprocaddress-function.md rename docs/{core => framework}/unmanaged-api/hosting/getrequestedruntimeinfo-function.md (56%) rename docs/{core => framework}/unmanaged-api/hosting/getrequestedruntimeversion-function.md (51%) create mode 100644 docs/framework/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md rename docs/{core => framework}/unmanaged-api/hosting/getversionfromprocess-function.md (54%) create mode 100644 docs/framework/unmanaged-api/hosting/host-type-enumeration.md rename docs/{core => framework}/unmanaged-api/hosting/hosting-coclasses.md (55%) rename docs/{core => framework}/unmanaged-api/hosting/hosting-enumerations.md (64%) rename docs/{core => framework}/unmanaged-api/hosting/hosting-global-static-functions.md (60%) rename docs/{core => framework}/unmanaged-api/hosting/hosting-interfaces.md (67%) create mode 100644 docs/framework/unmanaged-api/hosting/hosting-structures.md rename docs/{core => framework}/unmanaged-api/hosting/iactiononclrevent-interface.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/iactiononclrevent-onevent-method.md (60%) create mode 100644 docs/framework/unmanaged-api/hosting/iapartmentcallback-docallback-method.md create mode 100644 docs/framework/unmanaged-api/hosting/iapartmentcallback-interface.md rename docs/{core => framework}/unmanaged-api/hosting/iappdomainbinding-interface.md (51%) create mode 100644 docs/framework/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md rename docs/{core => framework}/unmanaged-api/hosting/iappdomainsetup-interface.md (72%) rename docs/{core => framework}/unmanaged-api/hosting/icatalogservices-autodone-method.md (67%) rename docs/{core => framework}/unmanaged-api/hosting/icatalogservices-interface.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/icatalogservices-notautodone-method.md (67%) create mode 100644 docs/framework/unmanaged-api/hosting/iceefilegen-class.md rename docs/{core => framework}/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentallocated-method.md (52%) rename docs/{core => framework}/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentcputime-method.md (58%) rename docs/{core => framework}/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md (64%) rename docs/{core => framework}/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md (62%) rename docs/{core => framework}/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromfile-method.md (56%) rename docs/{core => framework}/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromstream-method.md (51%) rename docs/{core => framework}/unmanaged-api/hosting/iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md (55%) rename docs/{core => framework}/unmanaged-api/hosting/iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md (61%) rename docs/{core => framework}/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md (58%) rename docs/{core => framework}/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md (61%) rename docs/{core => framework}/unmanaged-api/hosting/iclrassemblyidentitymanager-interface.md (68%) rename docs/{core => framework}/unmanaged-api/hosting/iclrassemblyidentitymanager-isstronglynamed-method.md (52%) rename docs/{core => framework}/unmanaged-api/hosting/iclrassemblyreferencelist-interface.md (66%) rename docs/{core => framework}/unmanaged-api/hosting/iclrassemblyreferencelist-isassemblyreferenceinlist-method.md (60%) rename docs/{core => framework}/unmanaged-api/hosting/iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md (56%) rename docs/{core => framework}/unmanaged-api/hosting/iclrcontrol-getclrmanager-method.md (55%) rename docs/{core => framework}/unmanaged-api/hosting/iclrcontrol-interface.md (63%) rename docs/{core => framework}/unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.md (52%) rename docs/{core => framework}/unmanaged-api/hosting/iclrdebugmanager-beginconnection-method.md (64%) rename docs/{core => framework}/unmanaged-api/hosting/iclrdebugmanager-endconnection-method.md (64%) create mode 100644 docs/framework/unmanaged-api/hosting/iclrdebugmanager-getdacl-method.md rename docs/{core => framework}/unmanaged-api/hosting/iclrdebugmanager-interface.md (68%) rename docs/{core => framework}/unmanaged-api/hosting/iclrdebugmanager-isdebuggerattached-method.md (55%) rename docs/{core => framework}/unmanaged-api/hosting/iclrdebugmanager-setconnectiontasks-method.md (64%) create mode 100644 docs/framework/unmanaged-api/hosting/iclrdebugmanager-setdacl-method.md rename docs/{core => framework}/unmanaged-api/hosting/iclrdebugmanager-setsymbolreadingpolicy-method.md (56%) rename docs/{core => framework}/unmanaged-api/hosting/iclrdomainmanager-interface.md (58%) rename docs/{core => framework}/unmanaged-api/hosting/iclrdomainmanager-setappdomainmanagertype-method.md (64%) rename docs/{core => framework}/unmanaged-api/hosting/iclrdomainmanager-setpropertiesfordefaultappdomain-method.md (60%) rename docs/{core => framework}/unmanaged-api/hosting/iclrerrorreportingmanager-begincustomdump-method.md (58%) rename docs/{core => framework}/unmanaged-api/hosting/iclrerrorreportingmanager-endcustomdump-method.md (61%) rename docs/{core => framework}/unmanaged-api/hosting/iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md (60%) rename docs/{core => framework}/unmanaged-api/hosting/iclrerrorreportingmanager-interface.md (61%) rename docs/{core => framework}/unmanaged-api/hosting/iclrgcmanager-collect-method.md (55%) rename docs/{core => framework}/unmanaged-api/hosting/iclrgcmanager-getstats-method.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/iclrgcmanager-interface.md (64%) rename docs/{core => framework}/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md (54%) rename docs/{core => framework}/unmanaged-api/hosting/iclrgcmanager2-interface.md (61%) rename docs/{core => framework}/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md (54%) create mode 100644 docs/framework/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md rename docs/{core => framework}/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md (62%) rename docs/{core => framework}/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md (54%) rename docs/{core => framework}/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md (56%) rename docs/{core => framework}/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md (67%) rename docs/{core => framework}/unmanaged-api/hosting/iclriocompletionmanager-interface.md (63%) rename docs/{core => framework}/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md (56%) rename docs/{core => framework}/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md (63%) create mode 100644 docs/framework/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md rename docs/{core => framework}/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md (54%) create mode 100644 docs/framework/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md rename docs/{core => framework}/unmanaged-api/hosting/iclrmetahost-getruntime-method.md (62%) rename docs/{core => framework}/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md (52%) rename docs/{core => framework}/unmanaged-api/hosting/iclrmetahost-interface.md (67%) rename docs/{core => framework}/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md (54%) rename docs/{core => framework}/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md (53%) rename docs/{core => framework}/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md (90%) rename docs/{core => framework}/unmanaged-api/hosting/iclrmetahostpolicy-interface.md (65%) rename docs/{core => framework}/unmanaged-api/hosting/iclroneventmanager-interface.md (60%) rename docs/{core => framework}/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/iclrpolicymanager-interface.md (62%) rename docs/{core => framework}/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md (87%) rename docs/{core => framework}/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md (61%) rename docs/{core => framework}/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md (64%) create mode 100644 docs/framework/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md rename docs/{core => framework}/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md (60%) rename docs/{core => framework}/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md (91%) rename docs/{core => framework}/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md (61%) create mode 100644 docs/framework/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md rename docs/{core => framework}/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md (62%) rename docs/{core => framework}/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md (59%) create mode 100644 docs/framework/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md rename docs/{core => framework}/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md (55%) rename docs/{core => framework}/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md (54%) rename docs/{core => framework}/unmanaged-api/hosting/iclrruntimehost-interface.md (71%) rename docs/{core => framework}/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md (58%) rename docs/{core => framework}/unmanaged-api/hosting/iclrruntimehost-start-method.md (53%) rename docs/{core => framework}/unmanaged-api/hosting/iclrruntimehost-stop-method.md (55%) rename docs/{core => framework}/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md (56%) create mode 100644 docs/framework/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md rename docs/{core => framework}/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md (55%) create mode 100644 docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md create mode 100644 docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md rename docs/{core => framework}/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md (51%) rename docs/{core => framework}/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md (61%) rename docs/{core => framework}/unmanaged-api/hosting/iclrruntimeinfo-interface.md (76%) rename docs/{core => framework}/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md (60%) create mode 100644 docs/framework/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md create mode 100644 docs/framework/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md create mode 100644 docs/framework/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md rename docs/{core => framework}/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md (57%) create mode 100644 docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md create mode 100644 docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md create mode 100644 docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md create mode 100644 docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md create mode 100644 docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md create mode 100644 docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md rename docs/{core => framework}/unmanaged-api/hosting/iclrstrongname-interface.md (75%) create mode 100644 docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md rename docs/{core => framework}/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md (62%) create mode 100644 docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md create mode 100644 docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md rename docs/{core => framework}/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md (56%) create mode 100644 docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md rename docs/{core => framework}/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md (52%) rename docs/{core => framework}/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md (53%) rename docs/{core => framework}/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md (52%) rename docs/{core => framework}/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md (50%) rename docs/{core => framework}/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md (59%) create mode 100644 docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md rename docs/{core => framework}/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md (60%) rename docs/{core => framework}/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md (60%) rename docs/{core => framework}/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md (52%) rename docs/{core => framework}/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md (51%) rename docs/{core => framework}/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md (50%) rename docs/{core => framework}/unmanaged-api/hosting/iclrstrongname2-interface.md (50%) rename docs/{core => framework}/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md (63%) rename docs/{core => framework}/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md (60%) rename docs/{core => framework}/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md (55%) rename docs/{core => framework}/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/iclrsyncmanager-interface.md (62%) rename docs/{core => framework}/unmanaged-api/hosting/iclrtask-abort-method.md (61%) rename docs/{core => framework}/unmanaged-api/hosting/iclrtask-exittask-method.md (55%) rename docs/{core => framework}/unmanaged-api/hosting/iclrtask-getmemstats-method.md (55%) rename docs/{core => framework}/unmanaged-api/hosting/iclrtask-interface.md (77%) rename docs/{core => framework}/unmanaged-api/hosting/iclrtask-locksheld-method.md (51%) rename docs/{core => framework}/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md (60%) rename docs/{core => framework}/unmanaged-api/hosting/iclrtask-reset-method.md (63%) rename docs/{core => framework}/unmanaged-api/hosting/iclrtask-rudeabort-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md (63%) rename docs/{core => framework}/unmanaged-api/hosting/iclrtask-switchin-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/iclrtask-switchout-method.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/iclrtask-yieldtask-method.md (63%) rename docs/{core => framework}/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md (68%) rename docs/{core => framework}/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md (67%) rename docs/{core => framework}/unmanaged-api/hosting/iclrtask2-interface.md (71%) rename docs/{core => framework}/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md (64%) rename docs/{core => framework}/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md (63%) rename docs/{core => framework}/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md (50%) rename docs/{core => framework}/unmanaged-api/hosting/iclrtaskmanager-interface.md (72%) rename docs/{core => framework}/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md (55%) rename docs/{core => framework}/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md (56%) create mode 100644 docs/framework/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md rename docs/{core => framework}/unmanaged-api/hosting/iclrvalidator-interface.md (82%) rename docs/{core => framework}/unmanaged-api/hosting/iclrvalidator-validate-method.md (90%) rename docs/{core => framework}/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/icorconfiguration-interface.md (68%) rename docs/{core => framework}/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md (53%) rename docs/{core => framework}/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md (50%) rename docs/{core => framework}/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md (56%) rename docs/{core => framework}/unmanaged-api/hosting/icorruntimehost-closeenum-method.md (55%) rename docs/{core => framework}/unmanaged-api/hosting/icorruntimehost-createdomain-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md (65%) rename docs/{core => framework}/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md (65%) rename docs/{core => framework}/unmanaged-api/hosting/icorruntimehost-createevidence-method.md (64%) rename docs/{core => framework}/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md (56%) rename docs/{core => framework}/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md (61%) rename docs/{core => framework}/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md (56%) create mode 100644 docs/framework/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md rename docs/{core => framework}/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md (61%) rename docs/{core => framework}/unmanaged-api/hosting/icorruntimehost-interface.md (69%) rename docs/{core => framework}/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md (52%) create mode 100644 docs/framework/unmanaged-api/hosting/icorruntimehost-mapfile-method.md rename docs/{core => framework}/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/icorruntimehost-start-method.md (52%) rename docs/{core => framework}/unmanaged-api/hosting/icorruntimehost-stop-method.md (56%) rename docs/{core => framework}/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md (51%) rename docs/{core => framework}/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md (51%) rename docs/{core => framework}/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md (55%) create mode 100644 docs/framework/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md create mode 100644 docs/framework/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md create mode 100644 docs/framework/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md create mode 100644 docs/framework/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md create mode 100644 docs/framework/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md create mode 100644 docs/framework/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md create mode 100644 docs/framework/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md create mode 100644 docs/framework/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md create mode 100644 docs/framework/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md create mode 100644 docs/framework/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md create mode 100644 docs/framework/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md rename docs/{core => framework}/unmanaged-api/hosting/icorthreadpool-interface.md (50%) rename docs/{core => framework}/unmanaged-api/hosting/idebuggerinfo-interface.md (50%) rename docs/{core => framework}/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md (50%) rename docs/{core => framework}/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md (55%) rename docs/{core => framework}/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md (52%) rename docs/{core => framework}/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md (54%) create mode 100644 docs/framework/unmanaged-api/hosting/igchost-collect-method.md rename docs/{core => framework}/unmanaged-api/hosting/igchost-getstats-method.md (53%) create mode 100644 docs/framework/unmanaged-api/hosting/igchost-getthreadstats-method.md rename docs/{core => framework}/unmanaged-api/hosting/igchost-interface.md (60%) create mode 100644 docs/framework/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md create mode 100644 docs/framework/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md rename docs/{core => framework}/unmanaged-api/hosting/igchost2-interface.md (57%) create mode 100644 docs/framework/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md create mode 100644 docs/framework/unmanaged-api/hosting/igchostcontrol-interface.md create mode 100644 docs/framework/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md rename docs/{core => framework}/unmanaged-api/hosting/igcthreadcontrol-interface.md (54%) rename docs/{core => framework}/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md (52%) rename docs/{core => framework}/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md (53%) rename docs/{core => framework}/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md (58%) rename docs/{core => framework}/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md (62%) rename docs/{core => framework}/unmanaged-api/hosting/ihostassemblymanager-interface.md (68%) rename docs/{core => framework}/unmanaged-api/hosting/ihostassemblystore-interface.md (63%) rename docs/{core => framework}/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md (66%) rename docs/{core => framework}/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md (63%) rename docs/{core => framework}/unmanaged-api/hosting/ihostautoevent-interface.md (55%) rename docs/{core => framework}/unmanaged-api/hosting/ihostautoevent-set-method.md (56%) rename docs/{core => framework}/unmanaged-api/hosting/ihostautoevent-wait-method.md (60%) create mode 100644 docs/framework/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md rename docs/{core => framework}/unmanaged-api/hosting/ihostcontrol-interface.md (55%) rename docs/{core => framework}/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/ihostcrst-enter-method.md (53%) rename docs/{core => framework}/unmanaged-api/hosting/ihostcrst-interface.md (60%) rename docs/{core => framework}/unmanaged-api/hosting/ihostcrst-leave-method.md (58%) rename docs/{core => framework}/unmanaged-api/hosting/ihostcrst-setspincount-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/ihostcrst-tryenter-method.md (55%) rename docs/{core => framework}/unmanaged-api/hosting/ihostgcmanager-interface.md (66%) rename docs/{core => framework}/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md (58%) rename docs/{core => framework}/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md (61%) rename docs/{core => framework}/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md (56%) rename docs/{core => framework}/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md (53%) rename docs/{core => framework}/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md (60%) rename docs/{core => framework}/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md (65%) rename docs/{core => framework}/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md (58%) rename docs/{core => framework}/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md (58%) rename docs/{core => framework}/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md (62%) rename docs/{core => framework}/unmanaged-api/hosting/ihostiocompletionmanager-interface.md (65%) rename docs/{core => framework}/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md (60%) rename docs/{core => framework}/unmanaged-api/hosting/ihostmalloc-alloc-method.md (58%) rename docs/{core => framework}/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md (61%) rename docs/{core => framework}/unmanaged-api/hosting/ihostmalloc-free-method.md (52%) rename docs/{core => framework}/unmanaged-api/hosting/ihostmalloc-interface.md (54%) rename docs/{core => framework}/unmanaged-api/hosting/ihostmanualevent-interface.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/ihostmanualevent-reset-method.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/ihostmanualevent-set-method.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/ihostmanualevent-wait-method.md (59%) create mode 100644 docs/framework/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md rename docs/{core => framework}/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/ihostmemorymanager-interface.md (72%) rename docs/{core => framework}/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md (50%) rename docs/{core => framework}/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md (68%) rename docs/{core => framework}/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md (56%) rename docs/{core => framework}/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md (58%) rename docs/{core => framework}/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md (56%) rename docs/{core => framework}/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md (52%) rename docs/{core => framework}/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md (60%) rename docs/{core => framework}/unmanaged-api/hosting/ihostpolicymanager-interface.md (70%) rename docs/{core => framework}/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md (63%) rename docs/{core => framework}/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md (62%) rename docs/{core => framework}/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/ihostsecuritycontext-interface.md (64%) rename docs/{core => framework}/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md (61%) rename docs/{core => framework}/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/ihostsecuritymanager-interface.md (62%) rename docs/{core => framework}/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md (63%) rename docs/{core => framework}/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md (66%) rename docs/{core => framework}/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md (58%) rename docs/{core => framework}/unmanaged-api/hosting/ihostsemaphore-interface.md (60%) rename docs/{core => framework}/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/ihostsemaphore-wait-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md (58%) rename docs/{core => framework}/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md (60%) rename docs/{core => framework}/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/ihostsyncmanager-interface.md (63%) rename docs/{core => framework}/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md (61%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttask-alert-method.md (62%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttask-getpriority-method.md (55%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttask-interface.md (64%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttask-join-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttask-setclrtask-method.md (56%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttask-setpriority-method.md (60%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttask-start-method.md (55%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md (58%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md (66%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md (65%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md (56%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md (62%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md (61%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md (66%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md (55%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md (50%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttaskmanager-interface.md (77%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md (63%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md (64%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md (67%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md (56%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md (63%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md (51%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md (65%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md (55%) rename docs/{core => framework}/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md (52%) rename docs/{core => framework}/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md (55%) rename docs/{core => framework}/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md (61%) rename docs/{core => framework}/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md (64%) rename docs/{core => framework}/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md (57%) rename docs/{core => framework}/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md (60%) rename docs/{core => framework}/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md (60%) create mode 100644 docs/framework/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md create mode 100644 docs/framework/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md create mode 100644 docs/framework/unmanaged-api/hosting/imanagedobject-interface.md create mode 100644 docs/framework/unmanaged-api/hosting/index.md create mode 100644 docs/framework/unmanaged-api/hosting/iobjecthandle-interface.md create mode 100644 docs/framework/unmanaged-api/hosting/iobjecthandle-unwrap-method.md create mode 100644 docs/framework/unmanaged-api/hosting/itypename-getassemblyname-method.md create mode 100644 docs/framework/unmanaged-api/hosting/itypename-getmodifierlength-method.md create mode 100644 docs/framework/unmanaged-api/hosting/itypename-getmodifiers-method.md create mode 100644 docs/framework/unmanaged-api/hosting/itypename-getnamecount-method.md create mode 100644 docs/framework/unmanaged-api/hosting/itypename-getnames-method.md create mode 100644 docs/framework/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md create mode 100644 docs/framework/unmanaged-api/hosting/itypename-gettypearguments-method.md create mode 100644 docs/framework/unmanaged-api/hosting/itypename-interface.md create mode 100644 docs/framework/unmanaged-api/hosting/itypenamebuilder-addarray-method.md create mode 100644 docs/framework/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md rename docs/{core => framework}/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md (76%) create mode 100644 docs/framework/unmanaged-api/hosting/itypenamebuilder-addname-method.md create mode 100644 docs/framework/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md create mode 100644 docs/framework/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md create mode 100644 docs/framework/unmanaged-api/hosting/itypenamebuilder-clear-method.md rename docs/{core => framework}/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md (50%) rename docs/{core => framework}/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md (51%) create mode 100644 docs/framework/unmanaged-api/hosting/itypenamebuilder-interface.md rename docs/{core => framework}/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md (50%) rename docs/{core => framework}/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md (50%) create mode 100644 docs/framework/unmanaged-api/hosting/itypenamebuilder-tostring-method.md create mode 100644 docs/framework/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md create mode 100644 docs/framework/unmanaged-api/hosting/itypenamefactory-interface.md create mode 100644 docs/framework/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md create mode 100644 docs/framework/unmanaged-api/hosting/ivalidator-formateventinfo-method.md rename docs/{core => framework}/unmanaged-api/hosting/ivalidator-interface.md (78%) rename docs/{core => framework}/unmanaged-api/hosting/ivalidator-validate-method.md (87%) rename docs/{core => framework}/unmanaged-api/hosting/loadlibraryshim-function.md (63%) create mode 100644 docs/framework/unmanaged-api/hosting/loadstringrc-function.md create mode 100644 docs/framework/unmanaged-api/hosting/loadstringrcex-function.md rename docs/{core => framework}/unmanaged-api/hosting/lockclrversion-function.md (51%) rename docs/{core => framework}/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md (50%) create mode 100644 docs/framework/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md create mode 100644 docs/framework/unmanaged-api/hosting/malloc-type-enumeration.md rename docs/{core => framework}/unmanaged-api/hosting/mdainfo-structure.md (61%) rename docs/{core => framework}/unmanaged-api/hosting/metahost-config-flags-enumeration.md (59%) rename docs/{core => framework}/unmanaged-api/hosting/metahost-policy-flags-enumeration.md (69%) rename docs/{core => framework}/unmanaged-api/hosting/modulebindinfo-structure.md (65%) rename docs/{core => framework}/unmanaged-api/hosting/net-framework-4-hosting-global-static-functions.md (70%) create mode 100644 docs/framework/unmanaged-api/hosting/rundll32shimw-function.md create mode 100644 docs/framework/unmanaged-api/hosting/runtime-info-flags-enumeration.md rename docs/{core => framework}/unmanaged-api/hosting/stackoverflowinfo-structure.md (53%) create mode 100644 docs/framework/unmanaged-api/hosting/stackoverflowtype-enumeration.md rename docs/{core => framework}/unmanaged-api/hosting/startup-flags-enumeration.md (54%) rename docs/{core => framework}/unmanaged-api/hosting/strongnamegetpublickeyex-method.md (51%) rename docs/{core => framework}/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md (55%) create mode 100644 docs/framework/unmanaged-api/hosting/toc.yml create mode 100644 docs/framework/unmanaged-api/hosting/typenamefactory-coclass.md rename docs/{core => framework}/unmanaged-api/hosting/validatorflags-enumeration.md (87%) rename docs/{core => framework}/unmanaged-api/hosting/wait-option-enumeration.md (56%) rename docs/{core => framework}/unmanaged-api/hosting/waitortimercallback-function-pointer.md (55%) diff --git a/docs/core/unmanaged-api/hosting/bucketparameters-structure.md b/docs/core/unmanaged-api/hosting/bucketparameters-structure.md deleted file mode 100644 index af337396909b9..0000000000000 --- a/docs/core/unmanaged-api/hosting/bucketparameters-structure.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -description: "Learn more about: BucketParameters Structure" -title: "BucketParameters Structure" -ms.date: "03/30/2017" -api_name: - - "BucketParameters" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "BucketParameters" -helpviewer_keywords: - - "BucketParameters structure [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# BucketParameters Structure - -Stores the type name of an event and the parameters for the current exception that is associated with the event. - -## Syntax - -```cpp -typedef struct _BucketParameters { - BOOL fInited; - WCHAR pszEventTypeName[255]; - WCHAR pszParams[10][255]; -} BucketParameters; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`fInited`|`true`, if the rest of this structure is valid; otherwise, `false`.| -|`pszEventTypeName`|Name of the event type.| -|`pszParams`|An array of strings, each of which specifies a parameter for the current exception associated with the event.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.idl - - **.NET versions:** Available since .NET Framework 2.0 - -## See also - -- [Hosting Structures](hosting-structures.md) diff --git a/docs/core/unmanaged-api/hosting/callfunctionshim-function.md b/docs/core/unmanaged-api/hosting/callfunctionshim-function.md deleted file mode 100644 index c7ddccc7376c2..0000000000000 --- a/docs/core/unmanaged-api/hosting/callfunctionshim-function.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -description: "Learn more about: CallFunctionShim Function" -title: "CallFunctionShim Function" -ms.date: "03/30/2017" -api_name: - - "CallFunctionShim" -api_location: - - "mscoree.dll" -api_type: - - "DLLExport" -f1_keywords: - - "CallFunctionShim" -helpviewer_keywords: - - "CallfunctionShim function [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# CallFunctionShim Function - -Makes a call to the function that has the specified name and parameters in the specified library. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT CallFunctionShim ( - [in] LPCWSTR szDllName, - [in] LPCSTR szFunctionName, - [in] LPVOID lpvArgument1, - [in] LPVOID lpvArgument2, - [in] LPCWSTR szVersion, - [in] LPVOID pvReserved -); -``` - -## Parameters - - `szDllName` - [in] The name of the library containing the function. - - `szFunctionName` - [in] The name of the function. - - `lpvArgument1` - [in] The first argument to pass to the function. - - `lpvArgument2` - [in] The second argument to pass to the function. - - `szVersion` - [in] The version of the library that contains the function. - - `pvReserved` - [in] Reserved for future use. Pass zero in this parameter. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 1.0 - -## See also - -- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md b/docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md deleted file mode 100644 index 363b2607389f3..0000000000000 --- a/docs/core/unmanaged-api/hosting/clrruntimehost-coclass.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -description: "Learn more about: CLRRuntimeHost Coclass" -title: "CLRRuntimeHost Coclass" -ms.date: "03/30/2017" -api_name: - - "CLRRuntimeHost Coclass" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CLRRuntimeHost" -helpviewer_keywords: - - "CLRRuntimeHost coclass [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# CLRRuntimeHost Coclass - -Provides interfaces for managing code execution by the runtime. - -## Syntax - -```cpp -coclass CLRRuntimeHost { - [default] interface ICLRRuntimeHost; - interface ICLRValidator; -}; -``` - -## Interfaces - -|Interface|Description| -|---------------|-----------------| -|[ICLRRuntimeHost Interface](iclrruntimehost-interface.md)|Provides methods for controlling the execution of applications by the runtime.| -|[ICLRValidator Interface](iclrvalidator-interface.md)|Provides methods for validation of portable executable images and for detailed reporting of validation errors.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.idl - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - -## See also - -- [Hosting Coclasses](hosting-coclasses.md) diff --git a/docs/core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md b/docs/core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md deleted file mode 100644 index 29ae773e887c6..0000000000000 --- a/docs/core/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -description: "Learn more about: CLSID_RESOLUTION_FLAGS Enumeration" -title: "CLSID_RESOLUTION_FLAGS Enumeration" -ms.date: "03/30/2017" -api_name: - - "CLSID_RESOLUTION_FLAGS" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CLSID_RESOLUTION_FLAGS" -helpviewer_keywords: - - "CLSID_RESOLUTION_FLAGS enumeration [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# CLSID_RESOLUTION_FLAGS Enumeration - -Contains values that indicate how the common language runtime (CLR) should resolve a `CLSID`. - -## Syntax - -```cpp -typedef enum { - CLSID_RESOLUTION_DEFAULT = 0x0, - CLSID_RESOLUTION_REGISTERED = 0x1 -} CLSID_RESOLUTION_FLAGS; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`CLSID_RESOLUTION_DEFAULT`|Indicates the default behavior.| -|`CLSID_RESOLUTION_REGISTERED`|Indicates that the runtime searches the registry and applies shim policy.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **.NET versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] - -## See also - -- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/coinitializeee-function.md b/docs/core/unmanaged-api/hosting/coinitializeee-function.md deleted file mode 100644 index f595093842f43..0000000000000 --- a/docs/core/unmanaged-api/hosting/coinitializeee-function.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -description: "Learn more about: CoInitializeEE Function" -title: "CoInitializeEE Function" -ms.date: "03/30/2017" -api_name: - - "CoInitializeEE" -api_location: - - "mscoree.dll" - - "mscorsvr.dll" -api_type: - - "DLLExport" -f1_keywords: - - "CoInitializeEE" -helpviewer_keywords: - - "CoInitializeEE function [.NET Framework hosting]" -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](../../../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 Global Static Functions](../metadata/metadata-global-static-functions.md) diff --git a/docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md b/docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md deleted file mode 100644 index 76d1c17050541..0000000000000 --- a/docs/core/unmanaged-api/hosting/comcallunmarshal-coclass.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -description: "Learn more about: ComCallUnmarshal Coclass" -title: "ComCallUnmarshal Coclass" -ms.date: "03/30/2017" -api_name: - - "ComCallUnmarshal Coclass" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ComCallUnmarshal" -helpviewer_keywords: - - "ComCallUnmarshal coclass [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ComCallUnmarshal Coclass - -Provides interfaces for managing the marshalling of interface pointers. - -## Syntax - -```cpp -coclass ComCallUnmarshal { - [default] interface IMarshal; -}; -``` - -## Interfaces - -|Interface|Description| -|---------------|-----------------| -|`IMarshal`|Provides methods for creating, initializing, and managing a proxy in a client process.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.idl - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** Available since .NET Framework 1.0 - -## See also - -- [Hosting Coclasses](hosting-coclasses.md) diff --git a/docs/core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md b/docs/core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md deleted file mode 100644 index 29436174aa568..0000000000000 --- a/docs/core/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -description: "Learn more about: COR_GC_STAT_TYPES Enumeration" -title: "COR_GC_STAT_TYPES Enumeration" -ms.date: "03/30/2017" -api_name: - - "COR_GC_STAT_TYPES" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "COR_GC_STAT_TYPES" -helpviewer_keywords: - - "COR_GC_STAT_TYPES enumeration [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# COR_GC_STAT_TYPES Enumeration - -Specifies the statistics to be recorded for a garbage collection. - -## Syntax - -```cpp -typedef enum { - COR_GC_COUNTS = 0x00000001 - COR_GC_MEMORYUSAGE = 0x00000002 -} COR_GC_STAT_TYPES; -``` - -## Remarks - - This enumeration specifies which statistics in the [COR_GC_STATS](cor-gc-stats-structure.md) structure are to be set by [ICLRGCManager::GetStats](iclrgcmanager-getstats-method.md) method. - -## Members - -|Member|Description| -|------------|-----------------| -|`COR_GC_COUNTS`|Records the number of garbage collections performed for each generation.| -|`COR_GC_MEMORYUSAGE`|Records memory usage and garbage collection size statistics.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl, GCHost.h - - **.NET versions:** Available since .NET Framework 1.0 - -## See also - -- [COR_GC_STATS Structure](cor-gc-stats-structure.md) -- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md b/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md deleted file mode 100644 index e2c1ba0781d5c..0000000000000 --- a/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -description: "Learn more about: COR_GC_THREAD_STATS_TYPES Enumeration" -title: "COR_GC_THREAD_STATS_TYPES Enumeration" -ms.date: "03/30/2017" -api_name: - - "COR_GC_THREAD_STATS_TYPES" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "COR_GC_THREAD_STATS_TYPES" -helpviewer_keywords: - - "COR_GC_THREAD_STATS_TYPES enumeration [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# COR_GC_THREAD_STATS_TYPES Enumeration - -Indicates the garbage collection statistics for a thread. - -## Syntax - -```cpp -typedef enum { - COR_GC_THREAD_HAS_PROMOTED_BYTES = 0x00000001 -} COR_GC_THREAD_STATS_TYPES; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`COR_GC_THREAD_HAS_PROMOTED_BYTES`|The thread has bytes that were promoted in the most recent garbage collection.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl, GCHost.h - - **.NET versions:** Available since .NET Framework 1.0 - -## See also - -- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/corexemain2-function.md b/docs/core/unmanaged-api/hosting/corexemain2-function.md deleted file mode 100644 index 6812b15ba7d0b..0000000000000 --- a/docs/core/unmanaged-api/hosting/corexemain2-function.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -description: "Learn more about: _CorExeMain2 Function" -title: "_CorExeMain2 Function" -ms.date: "03/30/2017" -api_name: - - "_CorExeMain2" -api_location: - - "mscoree.dll" -api_type: - - "DLLExport" -f1_keywords: - - "_CorExeMain2" -helpviewer_keywords: - - "_CorExeMain2 function [.NET Framework hosting]" -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 - - `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](../../../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 Global Static Functions](../metadata/metadata-global-static-functions.md) diff --git a/docs/core/unmanaged-api/hosting/corlaunchapplication-function.md b/docs/core/unmanaged-api/hosting/corlaunchapplication-function.md deleted file mode 100644 index 648e8eaf4768c..0000000000000 --- a/docs/core/unmanaged-api/hosting/corlaunchapplication-function.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -description: "Learn more about: CorLaunchApplication Function" -title: "CorLaunchApplication Function" -ms.date: "03/30/2017" -api_name: - - "CorLaunchApplication" -api_location: - - "mscoree.dll" - - "clr.dll" -api_type: - - "COM" -f1_keywords: - - "CorLaunchApplication" -helpviewer_keywords: - - "CorLaunchApplication function [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# CorLaunchApplication Function - -Starts the application at the specified network path, using the specified manifests and other application data. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT CorLaunchApplication ( - [in] HOST_TYPE dwClickOnceHost, - [in] LPCWSTR pwzAppFullName, - [in] DWORD dwManifestPaths, - [in] LPCWSTR *ppwzManifestPaths, - [in] DWORD dwActivationData, - [in] LPCWSTR *ppwzActivationData, - [out] LPPROCESS_INFORMATION lpProcessInformation -); -``` - -## Parameters - - `dwClickOnceHost` - [in] A value of the [HOST_TYPE](host-type-enumeration.md) enumeration that specifies the type of host that is launching the application. - - `pwzAppFullName` - [in] The full name of the application that is being launched. - - `dwManifestPaths` - [in] The number of manifest paths for the application. - - `ppwzManifestPaths` - [in] An array of strings, each of which specifies a path to a manifest for the application that is being launched. - - `dwActivationData` - [in] The number of activation data items for the application that is being launched. - - `ppwzActivationData` - [in] An array of strings, each of which is an activation data item for the application that is being launched. - - `lpProcessInformation` - [out] A pointer to information about the process in which the application has been loaded. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - -## See also - -- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/createiceefilegen-function.md b/docs/core/unmanaged-api/hosting/createiceefilegen-function.md deleted file mode 100644 index 50daf8562b0c2..0000000000000 --- a/docs/core/unmanaged-api/hosting/createiceefilegen-function.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -description: "Learn more about: CreateICeeFileGen Function" -title: "CreateICeeFileGen Function" -ms.date: "03/30/2017" -api_name: - - "CreateICeeFileGen" -api_location: - - "mscoree.dll" - - "mscorpehost.dll" - - "mscorpe.dll" -api_type: - - "COM" -f1_keywords: - - "CreateICeeFileGen" -helpviewer_keywords: - - "CreateICeeFileGen function [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# CreateICeeFileGen Function - -Creates an [ICeeFileGen](iceefilegen-class.md) object. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT CreateICeeFileGen ( - [out] ICeeFileGen **ceeFileGen -); -``` - -## Parameters - - `ceeFileGen` - [out] A pointer to the address of a new `ICeeFileGen` object. - -## Return Value - - This method returns standard COM error codes. - -## Remarks - - The `ICeeFileGen` object is used to create common language runtime (CLR) portable executable (PE) files. - - Call the [DestroyICeeFileGen](destroyiceefilegen-function.md) function to destroy the `ICeeFileGen` object when finished. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** ICeeFileGen.h - - **Library:** MSCorPE.dll - - **.NET versions:** Available since .NET Framework 1.0 - -## See also - -- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/customdumpitem-structure.md b/docs/core/unmanaged-api/hosting/customdumpitem-structure.md deleted file mode 100644 index be6ce2e3d1bce..0000000000000 --- a/docs/core/unmanaged-api/hosting/customdumpitem-structure.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -description: "Learn more about: CustomDumpItem Structure" -title: "CustomDumpItem Structure" -ms.date: "03/30/2017" -api_name: - - "CustomDumpItem" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CustomDumpItem" -helpviewer_keywords: - - "CustomDumpItem structure [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# CustomDumpItem Structure - -Describes an item to be added to a custom dump in error reporting. - -## Syntax - -```cpp -struct { - ECustomDumpItemKind itemKind; - union { - UINT_PTR pReserved; - } -} CustomDumpItem; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`itemKind`|An [ECustomDumpItemKind](ecustomdumpitemkind-enumeration.md) value that indicates the kind of item to be added.| -|`pReserved`|Not currently used. Any items added to the union must be no larger than pointer size. If a `struct` is required, you must allocate it separately and point to it.| - -## Remarks - - [ICLRErrorReportingManager::BeginCustomDump](iclrerrorreportingmanager-begincustomdump-method.md) takes a parameter of type `CustomDumpItem`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.idl - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - -## See also - -- [Hosting Structures](hosting-structures.md) diff --git a/docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md b/docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md deleted file mode 100644 index f62fd41857684..0000000000000 --- a/docs/core/unmanaged-api/hosting/destroyiceefilegen-function.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -description: "Learn more about: DestroyICeeFileGen Function" -title: "DestroyICeeFileGen Function" -ms.date: "03/30/2017" -api_name: - - "DestroyICeeFileGen" -api_location: - - "mscoree.dll" - - "mscorpehost.dll" - - "mscorpe.dll" -api_type: - - "COM" -f1_keywords: - - "DestroyICeeFileGen" -helpviewer_keywords: - - "DestroyICeeFileGen function [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# DestroyICeeFileGen Function - -Destroys an [ICeeFileGen](iceefilegen-class.md) object. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT DestroyICeeFileGen ( - [in] ICeeFileGen **ceeFileGen -); -``` - -## Parameters - - `ceeFileGen` - [in] The `ICeeFileGen` object to destroy. - -## Return Value - - This method returns standard COM error codes. - -## Remarks - - `DestroyICeeFileGen` destroys the `ICeeFileGen` object created by the [CreateICeeFileGen](createiceefilegen-function.md) function. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** ICeeFileGen.h - - **Library:** MSCorPE.dll - - **.NET versions:** Available since .NET Framework 1.0 - -## See also - -- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md b/docs/core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md deleted file mode 100644 index a058ba480654d..0000000000000 --- a/docs/core/unmanaged-api/hosting/ebindpolicylevels-enumeration.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -description: "Learn more about: EBindPolicyLevels Enumeration" -title: "EBindPolicyLevels Enumeration" -ms.date: "03/30/2017" -api_name: - - "EBindPolicyLevels" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "EBindPolicyLevels" -helpviewer_keywords: - - "EBindPolicyLevels enumeration [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# EBindPolicyLevels Enumeration - -Provides flags to specify the level at which to apply or modify assembly policy. - -## Syntax - -```cpp -typedef enum { - ePolicyLevelNone = 0x0, - ePolicyLevelRetargetable = 0x1, - ePolicyUnifiedToCLR = 0x2, - ePolicyLevelApp = 0x4, - ePolicyLevelPublisher = 0x8, - ePolicyLevelHost = 0x10, - ePolicyLevelAdmin = 0x20 - ePolicyPortability = 0x40 -} EBindPolicyLevels; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`ePolicyLevelAdmin`|Specifies that policy should be applied at the administrator level.| -|`ePolicyLevelApp`|Specifies that policy should be applied at the application level.| -|`ePolicyLevelHost`|Specifies that policy should be applied at the host level.| -|`ePolicyLevelNone`|Specifies no policy-level flags.| -|`ePolicyLevelPublisher`|Specifies that policy should be applied at the publisher level.| -|`ePolicyLevelRetargetable`|Specifies that policy should be applicable at variable levels.| -|`ePolicyPortability`|Specifies that policy should support portability between implementations of a .NET Framework assembly. See the [\](../../../framework/configure-apps/file-schema/runtime/supportportability-element.md) configuration file element.| -|`ePolicyUnifiedToCLR`|Specifies that policy should be unified to that of the common language runtime (CLR).| - -## Remarks - - This enumeration is passed to methods of the [ICLRHostBindingPolicyManager](iclrhostbindingpolicymanager-interface.md) interface to specify changes in application policy. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - -## See also - -- [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) -- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md b/docs/core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md deleted file mode 100644 index 4c94074067d1a..0000000000000 --- a/docs/core/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -description: "Learn more about: ECLRAssemblyIdentityFlags Enumeration" -title: "ECLRAssemblyIdentityFlags Enumeration" -ms.date: "03/30/2017" -api_name: - - "ECLRAssemblyIdentityFlags" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ECLRAssemblyIdentityFlags" -helpviewer_keywords: - - "ECLRAssemblyIdentityFlags enumeration [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ECLRAssemblyIdentityFlags Enumeration - -Indicates the type of an assembly's identity. - -## Syntax - -```cpp -typedef enum _CLRAssemblyIdentityFlags { - CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT = 0 -} ECLRAssemblyIdentityFlags; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT`|The identity is canonicalized.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **.NET versions:** Available since .NET Framework 2.0 - -## See also - -- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/eclrevent-enumeration.md b/docs/core/unmanaged-api/hosting/eclrevent-enumeration.md deleted file mode 100644 index ab2310a50971c..0000000000000 --- a/docs/core/unmanaged-api/hosting/eclrevent-enumeration.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -description: "Learn more about: EClrEvent Enumeration" -title: "EClrEvent Enumeration" -ms.date: "03/30/2017" -api_name: - - "EClrEvent" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "EClrEvent" -helpviewer_keywords: - - "EClrEvent enumeration [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# EClrEvent Enumeration - -Describes the common language runtime (CLR) events for which the host can register callbacks. - -## Syntax - -```cpp -typedef enum { - Event_ClrDisabled, - Event_DomainUnload, - Event_MDAFired, - Event_StackOverflow -} EClrEvent; -``` - -## Members - -| Member | Description | -|-----------------------|--------------------------------------------------------------------------------| -| `Event_ClrDisabled` | Specifies a fatal CLR error. | -| `Event_DomainUnload` | Specifies the unloading of a particular . | -| `Event_MDAFired` | Specifies that a Managed Debugging Assistant (MDA) message has been generated. | -| `Event_StackOverflow` | Specifies that a stack overflow error has occurred. | - -## Remarks - - The host can register callbacks for any of the event types described by `EClrEvent` by calling methods of the [ICLROnEventManager](iclroneventmanager-interface.md) interface. The host gets a pointer to this interface by calling the [ICLRControl::GetCLRManager](iclrcontrol-getclrmanager-method.md) method. - - The `Event_CLRDisabled` and `Event_DomainUnload` events can be raised more than once and from different threads to signal an unload or the disabling of the CLR. - - The `Event_MDAFired` event raises the creation of an [MDAInfo](mdainfo-structure.md) instance that contains the details of the MDA message. For more information about MDAs, see [Diagnosing Errors with Managed Debugging Assistants](../../../framework/debug-trace-profile/diagnosing-errors-with-managed-debugging-assistants.md). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - -## See also - -- [IActionOnCLREvent Interface](iactiononclrevent-interface.md) -- [ICLRControl Interface](iclrcontrol-interface.md) -- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md b/docs/core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md deleted file mode 100644 index 790893d24d043..0000000000000 --- a/docs/core/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -description: "Learn more about: ECustomDumpItemKind Enumeration" -title: "ECustomDumpItemKind Enumeration" -ms.date: "03/30/2017" -api_name: - - "ECustomDumpItemKind" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ECustomDumpItemKind" -helpviewer_keywords: - - "ECustomDumpItemKind enumeration [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ECustomDumpItemKind Enumeration - -Reserved for future extension of the [CustomDumpItem](customdumpitem-structure.md) structure. - -## Syntax - -```cpp -typedef enum { - DUMP_ITEM_None = 0 -} ECustomDumpItemKind; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`DUMP_ITEM_None`|Reserved for future use.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - -## See also - -- [ICLRErrorReportingManager Interface](iclrerrorreportingmanager-interface.md) -- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md b/docs/core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md deleted file mode 100644 index 1d6c09d5630cc..0000000000000 --- a/docs/core/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -description: "Learn more about: EHostApplicationPolicy Enumeration" -title: "EHostApplicationPolicy Enumeration" -ms.date: "03/30/2017" -api_name: - - "EHostApplicationPolicy" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "EHostApplicationPolicy" -helpviewer_keywords: - - "EHostApplicationPolicy enumeration [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# EHostApplicationPolicy Enumeration - -Indicates how to modify an [IHostAssemblyManager](ihostassemblymanager-interface.md) interface object. This enumeration has been deprecated. - -## Syntax - -```cpp -typedef enum _HostApplicationPolicy { - HOST_APPLICATION_BINDING_POLICY = 1 -} EHostApplicationPolicy; -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - -## See also - -- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/etasktype-enumeration.md b/docs/core/unmanaged-api/hosting/etasktype-enumeration.md deleted file mode 100644 index ea9e7bc37118e..0000000000000 --- a/docs/core/unmanaged-api/hosting/etasktype-enumeration.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -description: "Learn more about: ETaskType Enumeration" -title: "ETaskType Enumeration" -ms.date: "03/30/2017" -api_name: - - "ETaskType" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ETaskType" -helpviewer_keywords: - - "ETaskType enumeration [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ETaskType Enumeration - -Contains values that indicate the type of task that is represented by either an [ICLRTask](iclrtask-interface.md) or an [IHostTask](ihosttask-interface.md) interface. - -## Syntax - -```cpp -typedef enum ETaskType { - TT_DEBUGGERHELPER = 0x1, - TT_GC = 0x2, - TT_FINALIZER = 0x4, - TT_THREADPOOL_TIMER = 0x8, - TT_THREADPOOL_GATE = 0x10, - TT_THREADPOOL_WORKER = 0x20, - TT_THREADPOOL_IOCOMPLETION = 0x40, - TT_ADUNLOAD = 0x80, - TT_USER = 0x100, - TT_THREADPOOL_WAIT = 0x200, - TT_UNKNOWN = 0x80000000 -} ETaskType; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`TT_ADUNLOAD`|The interface represents an application domain unloading task.| -|`TT_DEBUGGERHELPER`|The interface represents a debugger helper task.| -|`TT_FINALIZER`|The interface represents a finalizer task.| -|`TT_GC`|The interface represents a garbage collection task.| -|`TT_THREADPOOL_GATE`|The interface represents a gate thread task.| -|`TT_THREADPOOL_IOCOMPLETION`|The interface represents an I/O thread task or a completion port thread task.| -|`TT_THREADPOOL_TIMER`|The interface represents a timer thread task.| -|`TT_THREADPOOL_WAIT`|The interface represents a wait thread task.| -|`TT_THREADPOOL_WORKER`|The interface represents a worker thread task.| -|`TT_UNKNOWN`|The task is unknown.| -|`TT_USER`|The interface represents a user task.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - -## See also - -- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/getcorrequiredversion-function.md b/docs/core/unmanaged-api/hosting/getcorrequiredversion-function.md deleted file mode 100644 index ea3df399c586c..0000000000000 --- a/docs/core/unmanaged-api/hosting/getcorrequiredversion-function.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -description: "Learn more about: GetCORRequiredVersion Function" -title: "GetCORRequiredVersion Function" -ms.date: "03/30/2017" -api_name: - - "GetCORRequiredVersion" -api_location: - - "mscoree.dll" -api_type: - - "DLLExport" -f1_keywords: - - "GetCORRequiredVersion" -helpviewer_keywords: - - "GetCORRequiredVersion function [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# GetCORRequiredVersion Function - -Gets the required common language runtime (CLR) version number. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT GetCORRequiredVersion ( - [out] LPWSTR pbuffer, - [in] DWORD cchBuffer, - [out] DWORD *dwLength -); -``` - -## Parameters - - `pbuffer` - [out] A buffer containing a string that specifies the version number. - - `cchBuffer` - [in] The size, in bytes, of the buffer. - - `dwLength` - [out] The number of bytes returned in the buffer. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 1.0 - -## See also - -- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/getfileversion-function.md b/docs/core/unmanaged-api/hosting/getfileversion-function.md deleted file mode 100644 index 540d94d828a8b..0000000000000 --- a/docs/core/unmanaged-api/hosting/getfileversion-function.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -description: "Learn more about: GetFileVersion Function" -title: "GetFileVersion Function" -ms.date: "03/30/2017" -api_name: - - "GetFileVersion" -api_location: - - "mscoree.dll" -api_type: - - "DLLExport" -f1_keywords: - - "GetFileVersion" -helpviewer_keywords: - - "GetFileVersion function [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# GetFileVersion Function - -Gets the common language runtime (CLR) version information of the specified file, using the specified buffer. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT GetFileVersion ( - [in] LPCWSTR szFilename, - [in, out] LPWSTR szBuffer, - [in] DWORD cchBuffer, - [out] DWORD *dwLength -); -``` - -## Parameters - - `szFilename` - [in] The path of the file to be examined. - - `szBuffer` - [in, out] The buffer allocated for the version information that is returned. - - `cchBuffer` - [in] The size, in wide characters, of `szBuffer`. - - `dwLength` - [out] The size, in bytes, of the returned `szBuffer`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **.NET versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] - -## See also - -- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/getrealprocaddress-function.md b/docs/core/unmanaged-api/hosting/getrealprocaddress-function.md deleted file mode 100644 index 8ae8d7d3ec8e6..0000000000000 --- a/docs/core/unmanaged-api/hosting/getrealprocaddress-function.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -description: "Learn more about: GetRealProcAddress Function" -title: "GetRealProcAddress Function" -ms.date: "03/30/2017" -api_name: - - "GetRealProcAddress" -api_location: - - "mscoree.dll" -api_type: - - "DLLExport" -f1_keywords: - - "GetRealProcAddress" -helpviewer_keywords: - - "GetRealProcAddress function [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# GetRealProcAddress Function - -Gets the address of the specified function that is exported from the latest installed version of the common language runtime (CLR). - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT GetRealProcAddress ( - [in] LPCSTR pwszProcName, - [out] VOID **ppv -); -``` - -## Parameters - - `pwszProcName` - [in] The name of the function. - - `ppv` - [out] The location that receives a pointer to the address of the function. - -## Return Value - - This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values defined in CorError.h. - -|Return code|Description| -|-----------------|-----------------| -|S_OK|The method completed successfully.| -|E_POINTER|`ppv` is not valid.| -|CLR_E_SHIM_RUNTIMEEXPORT|The function is not exported from the runtime.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 1.0 - -## See also - -- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md b/docs/core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md deleted file mode 100644 index c76966e471dce..0000000000000 --- a/docs/core/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -description: "Learn more about: GetRequestedRuntimeVersionForCLSID Function" -title: "GetRequestedRuntimeVersionForCLSID Function" -ms.date: "03/30/2017" -api_name: - - "GetRequestedRuntimeVersionForCLSID" -api_location: - - "mscoree.dll" -api_type: - - "DLLExport" -f1_keywords: - - "GetRequestedRuntimeVersionForCLSID" -helpviewer_keywords: - - "GetRequestedRuntimeVersionForCLSID function [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# GetRequestedRuntimeVersionForCLSID Function - -Gets the appropriate common language runtime (CLR) version information for the class with the specified `CLSID`. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT GetRequestedRuntimeVersionForCLSID ( - [in] REFCLSID rclsid, - [out] LPWSTR pVersion, - [in] DWORD cchBuffer, - [out] DWORD* dwLength, - [in] CLSID_RESOLUTION_FLAGS dwResolutionFlags -); -``` - -## Parameters - - `rclsid` - [in] The `CLSID` of the component. - - `pVersion` - [out] A buffer that contains the version number string upon successful completion. - - `cchBuffer` - [in] The size, in wide characters, of the `pVersion` buffer. - - `dwLength` - [out] The length, in bytes, of the returned buffer. - - `dwResolutionFlags` - [in] One of the CLSID_RESOLUTION_FLAGS values. The following values are supported: - -- CLSID_RESOLUTION_DEFAULT: (0x0) Specifies that default interop behavior should be used. - -- CLSID_RESOLUTION_REGISTERED: (0x1) Specifies that the registry should be searched and shim policy should be applied. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The function returned successfully.| -|E_INVALIDARG|One of the parameters has an invalid type or format.| -|ERROR_INSUFFICIENT_BUFFER|The `pVersion` buffer is not large enough to hold the entire version string.| -|REGDB_E_CLASSNOTREG|There is no class registered with the specified `CLSID`.| -|E_POINTER|`dwLength` is null, or `cchBuffer` is large enough to hold the version string, but `pVersion` is null.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **.NET versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] - -## See also - -- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/host-type-enumeration.md b/docs/core/unmanaged-api/hosting/host-type-enumeration.md deleted file mode 100644 index 25e4322d36a03..0000000000000 --- a/docs/core/unmanaged-api/hosting/host-type-enumeration.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -description: "Learn more about: HOST_TYPE Enumeration" -title: "HOST_TYPE Enumeration" -ms.date: "03/30/2017" -api_name: - - "HOST_TYPE" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "HOST_TYPE" -helpviewer_keywords: - - "HOST_TYPE enumeration [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# HOST_TYPE Enumeration - -Contains values that specify the type of host that is launching an application. - -## Syntax - -```cpp -typedef enum { - HOST_TYPE_DEFAULT = 0x0, - HOST_TYPE_APPLAUNCH = 0x1, - HOST_TYPE_CORFLAG = 0x2 -} HOST_TYPE; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`HOST_TYPE_APPLAUNCH`|Launch the application from AppLaunch.exe.

Use this value for partially-trusted applications.| -|`HOST_TYPE_CORFLAG`|Launch the application directly. That is, launch the application from its own .exe file.

Use this value for fully-trusted applications.| -|`HOST_TYPE_DEFAULT`|Same as HOST_TYPE_APPLAUNCH.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - -## See also - -- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/hosting-structures.md b/docs/core/unmanaged-api/hosting/hosting-structures.md deleted file mode 100644 index 865edd4ef6ff2..0000000000000 --- a/docs/core/unmanaged-api/hosting/hosting-structures.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -description: "Learn more about: Hosting Structures" -title: "Hosting Structures" -ms.date: "03/30/2017" -helpviewer_keywords: - - "hosting structures [.NET Framework]" - - "unmanaged structures [.NET Framework], hosting" - - "structures [.NET Framework hosting]" ---- -# Hosting Structures - -This section describes the unmanaged structures that the hosting API uses. - -## In This Section - - [AssemblyBindInfo Structure](assemblybindinfo-structure.md) - Provides detailed information about the referenced assembly. - - [BucketParameters Structure](bucketparameters-structure.md) - Stores the type name of an event and the parameters for the current exception that is associated with the event. - - [COR_GC_STATS Structure](cor-gc-stats-structure.md) - Provides statistics about the garbage collection mechanism of the common language runtime (CLR). - - [COR_GC_THREAD_STATS Structure](cor-gc-thread-stats-structure.md) - Contains per-thread statistics pertaining to garbage collection. - - [CustomDumpItem Structure](customdumpitem-structure.md) - Describes an item to be added to a custom dump in error reporting. - - [MDAInfo Structure](mdainfo-structure.md) - Provides details about the `Event_MDAFired` event, which triggers the creation of a managed debugging assistant (MDA). - - [ModuleBindInfo Structure](modulebindinfo-structure.md) - Provides detailed information about the referenced module and the assembly that contains it. - - [StackOverflowInfo Structure](stackoverflowinfo-structure.md) - Stores the type of overflow that occurred and information on the exception that was thrown due to the overflow. - -## Related Sections - - [Hosting Coclasses](hosting-coclasses.md) - - [Hosting Interfaces](hosting-interfaces.md) - - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) - - [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md b/docs/core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md deleted file mode 100644 index a16aa15797c84..0000000000000 --- a/docs/core/unmanaged-api/hosting/iapartmentcallback-docallback-method.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -description: "Learn more about: IApartmentCallback::DoCallback Method" -title: "IApartmentCallback::DoCallback Method" -ms.date: "03/30/2017" -api_name: - - "IApartmentCallback.DoCallback" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "DoCallback" -helpviewer_keywords: - - "IApartmentCallback::DoCallback method [.NET Framework hosting]" - - "DoCallback method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# IApartmentCallback::DoCallback Method - -Executes the specified function within an apartment. - -## Syntax - -```cpp -HRESULT _stdcall DoCallback( - [in] SIZE_T pFunc, - [in] SIZE_T pData -); -``` - -## Parameters - - `pFunc` - [in] A pointer to the function to be executed within the apartment. - - `pData` - [in] A pointer to the function's argument. - -## 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 2.0 - -## See also - -- [IApartmentCallback Interface](iapartmentcallback-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md b/docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md deleted file mode 100644 index 3e12503ac2f42..0000000000000 --- a/docs/core/unmanaged-api/hosting/iapartmentcallback-interface.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -description: "Learn more about: IApartmentCallback Interface" -title: "IApartmentCallback Interface" -ms.date: "03/30/2017" -api_name: - - "IApartmentCallback" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IApartmentCallback" -helpviewer_keywords: - - "IApartmentCallback interface [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# IApartmentCallback Interface - -Provides methods for making callbacks within an apartment. An *apartment* is a logical container within a process for objects that share the same thread access requirements. - -## Methods - -|Method|Description| -|------------|-----------------| -|[DoCallback Method](iapartmentcallback-docallback-method.md)|Executes the specified function within an apartment.| - -## 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 2.0 - -## See also - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md b/docs/core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md deleted file mode 100644 index 388131500ba67..0000000000000 --- a/docs/core/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -description: "Learn more about: IAppDomainBinding::OnAppDomain Method" -title: "IAppDomainBinding::OnAppDomain Method" -ms.date: "03/30/2017" -api_name: - - "IAppDomainBinding.OnAppDomain" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "OnAppDomain" -helpviewer_keywords: - - "IAppDomainBinding::OnAppDomain method [.NET Framework hosting]" - - "OnAppDomain method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# IAppDomainBinding::OnAppDomain Method - -Called by the common language runtime (CLR) to notify the host that an application domain has been created. - -## Syntax - -```cpp -HRESULT OnAppDomain ( - [in] IUnknown* pAppdomain -); -``` - -## Parameters - - `pAppdomain` - [in] A pointer to an [IUnknown](/cpp/atl/iunknown) interface object that represents the new application domain. - -## 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 2.0 - -## See also - -- [IAppDomainBinding Interface](iappdomainbinding-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iceefilegen-class.md b/docs/core/unmanaged-api/hosting/iceefilegen-class.md deleted file mode 100644 index 20260f45da7b0..0000000000000 --- a/docs/core/unmanaged-api/hosting/iceefilegen-class.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -description: "Learn more about: ICeeFileGen Class" -title: "ICeeFileGen Class" -ms.date: "03/30/2017" -api_name: - - "ICeeFileGen" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICeeFileGen" -helpviewer_keywords: - - "ICeeFileGen class [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICeeFileGen Class - -Provides functionality for creating a native portable executable (PE) file. The interface will typically be used by compilers to generate their compiled output executable. - -> [!NOTE] -> `ICeeFileGen` supports the .NET Framework infrastructure and is not intended to be used directly from your code. - - This interface has been deprecated and will be removed in a future release. - -## Syntax - -```cpp -class ICeeFileGen { -public: - virtual HRESULT CreateCeeFile(HCEEFILE *ceeFile); - - virtual HRESULT EmitMetaData (HCEEFILE ceeFile, - IMetaDataEmit *emitter, mdScope scope); - - virtual HRESULT EmitLibraryName (HCEEFILE ceeFile, - IMetaDataEmit *emitter, mdScope scope); - - virtual HRESULT EmitMethod (); - - virtual HRESULT GetMethodRVA (HCEEFILE ceeFile, - ULONG codeOffset, ULONG *codeRVA); - - virtual HRESULT EmitSignature (); - - virtual HRESULT EmitString (HCEEFILE ceeFile, - __in LPWSTR strValue, ULONG *strRef); - - virtual HRESULT GenerateCeeFile (HCEEFILE ceeFile); - - virtual HRESULT SetOutputFileName (HCEEFILE ceeFile, - __in LPWSTR outputFileName); - - virtual HRESULT GetOutputFileName (HCEEFILE ceeFile, - __out LPWSTR *outputFileName); - - virtual HRESULT SetResourceFileName (HCEEFILE ceeFile, - __in LPWSTR resourceFileName); - - virtual HRESULT GetResourceFileName (HCEEFILE ceeFile, - __out LPWSTR *resourceFileName); - - virtual HRESULT SetImageBase(HCEEFILE ceeFile, size_t imageBase); - - virtual HRESULT SetSubsystem(HCEEFILE ceeFile, DWORD subsystem, - DWORD major, DWORD minor); - - virtual HRESULT SetEntryClassToken (); - - virtual HRESULT GetEntryClassToken (); - - virtual HRESULT SetEntryPointDescr (); - - virtual HRESULT GetEntryPointDescr (); - - virtual HRESULT SetEntryPointFlags (); - - virtual HRESULT GetEntryPointFlags (); - - virtual HRESULT SetDllSwitch (HCEEFILE ceeFile, BOOL dllSwitch); - - virtual HRESULT GetDllSwitch (HCEEFILE ceeFile, BOOL *dllSwitch); - - virtual HRESULT SetLibraryName (HCEEFILE ceeFile, - __in LPWSTR LibraryName); - - virtual HRESULT GetLibraryName (HCEEFILE ceeFile, - __out LPWSTR *LibraryName); - - virtual HRESULT SetLibraryGuid (HCEEFILE ceeFile, - __in LPWSTR LibraryGuid); - - virtual HRESULT DestroyCeeFile(HCEEFILE *ceeFile); - - virtual HRESULT GetSectionCreate (HCEEFILE ceeFile, - const char *name, DWORD flags, HCEESECTION *section); - - virtual HRESULT GetIlSection (HCEEFILE ceeFile, - HCEESECTION *section); - - virtual HRESULT GetRdataSection (HCEEFILE ceeFile, - HCEESECTION *section); - - virtual HRESULT GetSectionDataLen (HCEESECTION section, - ULONG *dataLen); - - virtual HRESULT GetSectionBlock (HCEESECTION section, ULONG len, - ULONG align=1, void **ppBytes=0); - - virtual HRESULT TruncateSection (HCEESECTION section, ULONG len); - - virtual HRESULT AddSectionReloc (HCEESECTION section, - ULONG offset, HCEESECTION relativeTo, - CeeSectionRelocType relocType); - - virtual HRESULT SetSectionDirectoryEntry (HCEESECTION section, - ULONG num); - - virtual HRESULT CreateSig (); - - virtual HRESULT AddSigArg (); - - virtual HRESULT SetSigReturnType (); - - virtual HRESULT SetSigCallingConvention (); - - virtual HRESULT DeleteSig (); - - virtual HRESULT SetEntryPoint (HCEEFILE ceeFile, - mdMethodDef method); - - virtual HRESULT GetEntryPoint (HCEEFILE ceeFile, - mdMethodDef *method); - - virtual HRESULT SetComImageFlags (HCEEFILE ceeFile, DWORD mask); - - virtual HRESULT GetComImageFlags (HCEEFILE ceeFile, DWORD *mask); - - virtual HRESULT GetIMapTokenIface(HCEEFILE ceeFile, - IMetaDataEmit *emitter, IUnknown **pIMapToken); - - virtual HRESULT SetDirectoryEntry (HCEEFILE ceeFile, - HCEESECTION section, ULONG num, ULONG size, ULONG offset = 0); - - virtual HRESULT EmitMetaDataEx (HCEEFILE ceeFile, - IMetaDataEmit *emitter); - - virtual HRESULT EmitLibraryNameEx (HCEEFILE ceeFile, - IMetaDataEmit *emitter); - - virtual HRESULT GetIMapTokenIfaceEx(HCEEFILE ceeFile, - IMetaDataEmit *emitter, IUnknown **pIMapToken); - - virtual HRESULT EmitMacroDefinitions(HCEEFILE ceeFile, - void *pData, DWORD cData); - - virtual HRESULT CreateCeeFileFromICeeGen(ICeeGen *pFromICeeGen, - HCEEFILE *ceeFile, DWORD createFlags = - ICEE_CREATE_FILE_PURE_IL); - - virtual HRESULT SetManifestEntry(HCEEFILE ceeFile, ULONG size, - ULONG offset); - - virtual HRESULT SetEnCRVABase(HCEEFILE ceeFile, ULONG dataBase, - ULONG rdataBase); - - virtual HRESULT GenerateCeeMemoryImage (HCEEFILE ceeFile, - void **ppImage); - - virtual HRESULT ComputeSectionOffset(HCEESECTION section, - __in char *ptr, unsigned *offset); - - virtual HRESULT ComputeOffset(HCEEFILE file, __in char *ptr, - HCEESECTION *pSection, unsigned *offset); - - virtual HRESULT GetCorHeader(HCEEFILE ceeFile, - IMAGE_COR20_HEADER **header); - - virtual HRESULT LinkCeeFile (HCEEFILE ceeFile); - - virtual HRESULT FixupCeeFile (HCEEFILE ceeFile); - - virtual HRESULT GetSectionRVA (HCEESECTION section, ULONG *rva); - - virtual HRESULT ComputeSectionPointer(HCEESECTION section, - ULONG offset, __out char **ptr); - - virtual HRESULT SetObjSwitch (HCEEFILE ceeFile, BOOL objSwitch); - - virtual HRESULT GetObjSwitch (HCEEFILE ceeFile, BOOL *objSwitch); - - virtual HRESULT SetVTableEntry(HCEEFILE ceeFile, ULONG size, - ULONG offset); - - virtual HRESULT SetStrongNameEntry(HCEEFILE ceeFile, ULONG size, - ULONG offset); - - virtual HRESULT EmitMetaDataAt (HCEEFILE ceeFile, - IMetaDataEmit *emitter, HCEESECTION section, DWORD offset, - BYTE* buffer, unsigned buffLen); - - virtual HRESULT GetFileTimeStamp (HCEEFILE ceeFile, - DWORD *pTimeStamp); - - virtual HRESULT AddNotificationHandler(HCEEFILE ceeFile, - IUnknown *pHandler); - - virtual HRESULT SetFileAlignment(HCEEFILE ceeFile, - ULONG fileAlignment); - - virtual HRESULT ClearComImageFlags (HCEEFILE ceeFile, DWORD mask); - - virtual HRESULT CreateCeeFileEx(HCEEFILE *ceeFile, - ULONG createFlags); - - virtual HRESULT SetImageBase64(HCEEFILE ceeFile, - ULONGLONG imageBase); - - virtual HRESULT GetHeaderInfo (HCEEFILE ceeFile, - PIMAGE_NT_HEADERS *ppNtHeaders, - PIMAGE_SECTION_HEADER *ppSections, ULONG *pNumSections); - - virtual HRESULT CreateCeeFileEx2(HCEEFILE *ceeFile, - ULONG createFlags, LPCWSTR seedFileName = NULL); - - virtual HRESULT SetVTableEntry64(HCEEFILE ceeFile, ULONG size, - void* ptr); -}; -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** ICeeFileGen.h - - **.NET Framework Version:** 1.0 - -## See also - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/iclrdebugmanager-getdacl-method.md b/docs/core/unmanaged-api/hosting/iclrdebugmanager-getdacl-method.md deleted file mode 100644 index 7f931d9581df8..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrdebugmanager-getdacl-method.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -description: "Learn more about: ICLRDebugManager::GetDacl Method" -title: "ICLRDebugManager::GetDacl Method" -ms.date: "03/30/2017" -api_name: - - "ICLRDebugManager.GetDacl" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRDebugManager::GetDacl" -helpviewer_keywords: - - "GetDacl method [.NET Framework hosting]" - - "ICLRDebugManager::GetDacl method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRDebugManager::GetDacl Method - -This method is not implemented. - -## Syntax - -```cpp -HRESULT GetDacl ( - [out] PACL* ppacl -); -``` - -## Parameters - - `ppacl` - [out] An interface pointer to the Access Control List (ACL). - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|E_NOTIMPL|The method is not implemented.| - -## 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 2.0 - -## See also - -- [ICLRControl Interface](iclrcontrol-interface.md) -- [ICLRDebugManager Interface](iclrdebugmanager-interface.md) -- [SetDacl Method](iclrdebugmanager-setdacl-method.md) -- [IHostControl Interface](ihostcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrdebugmanager-setdacl-method.md b/docs/core/unmanaged-api/hosting/iclrdebugmanager-setdacl-method.md deleted file mode 100644 index 12aedacb1f57f..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrdebugmanager-setdacl-method.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -description: "Learn more about: ICLRDebugManager::SetDacl Method" -title: "ICLRDebugManager::SetDacl Method" -ms.date: "03/30/2017" -api_name: - - "ICLRDebugManager.SetDacl" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRDebugManager::SetDacl" -helpviewer_keywords: - - "SetDacl method [.NET Framework hosting]" - - "ICLRDebugManager::SetDacl method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRDebugManager::SetDacl Method - -This method is not implemented. - -## Syntax - -```cpp -HRESULT SetDacl ( - [in] PACL pacl -); -``` - -## Parameters - - `pacl` - [in] A pointer to the Access Control List (ACL). - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|E_NOTIMPL|The method is not implemented.| - -## 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 2.0 - -## See also - -- [ICLRControl Interface](iclrcontrol-interface.md) -- [ICLRDebugManager Interface](iclrdebugmanager-interface.md) -- [GetDacl Method](iclrdebugmanager-getdacl-method.md) -- [IHostControl Interface](ihostcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md b/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md deleted file mode 100644 index a79b533f62a69..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -description: "Learn more about: ICLRHostBindingPolicyManager::EvaluatePolicy Method" -title: "ICLRHostBindingPolicyManager::EvaluatePolicy Method" -ms.date: "03/30/2017" -api_name: - - "ICLRHostBindingPolicyManager.EvaluatePolicy" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRHostBindingPolicyManager::EvaluatePolicy" -helpviewer_keywords: - - "ICLRHostBindingPolicyManager::EvaluatePolicy method [.NET Framework hosting]" - - "EvaluatePolicy method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRHostBindingPolicyManager::EvaluatePolicy Method - -Evaluates binding policy on behalf of the host. - -## Syntax - -```cpp -HRESULT EvaluatePolicy ( - [in] LPCWSTR pwzReferenceIdentity, - [in] BYTE *pbApplicationPolicy, - [in] DWORD cbAppPolicySize, - [out, size_is(*pcchPostPolicyReferenceIdentity)] LPWSTR pwzPostPolicyReferenceIdentity, - [in, out] DWORD *pcchPostPolicyReferenceIdentity, - [out] DWORD *pdwPoliciesApplied -); -``` - -## Parameters - - `pwzReferenceIdentity` - [in] A reference to the assembly before the policy evaluation. - - `pbApplicationPolicy` - [in] A pointer to a buffer that contains the policy data. - - `cbAppPolicySize` - [in] The size of the `pbApplicationPolicy` buffer. - - `pwzPostPolicyReferenceIdentity` - [out] A reference to the assembly after the evaluation of the new policy data. - - `pcchPostPolicyReferenceIdentity` - [in, out] A pointer to the size of the assembly identity reference buffer after the evaluation of the new policy data. - - `pdwPoliciesApplied` - [out] A pointer to a logical OR combination of [EBindPolicyLevels](ebindpolicylevels-enumeration.md) values, indicating which policies have been applied. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The evaluation completed successfully.| -|E_INVALIDARG|Either `pwzReferenceIdentity` or `pbApplicationPolicy` is a null reference.| -|ERROR_INSUFFICIENT_BUFFER|`cbAppPolicySize` is too small.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The `EvaluatePolicy` method allows the host to influence binding policy to maintain host-specific assembly versioning requirements. The policy engine itself remains inside the CLR. - -## 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 2.0 - -## See also - -- [ICLRHostBindingPolicyManager Interface](iclrhostbindingpolicymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md deleted file mode 100644 index a7717ad3f2fd8..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -description: "Learn more about: ICLRMetaHost::EnumerateInstalledRuntimes Method" -title: "ICLRMetaHost::EnumerateInstalledRuntimes Method" -ms.date: "03/30/2017" -api_name: - - "ICLRMetaHost.EnumerateInstalledRuntimes" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRMetaHost::EnumerateInstalledRuntimes" -helpviewer_keywords: - - "ICLRMetaHost::EnumerateInstalledRuntimes method [.NET Framework hosting]" - - "EnumerateInstalledRuntimes method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRMetaHost::EnumerateInstalledRuntimes Method - -Returns an enumeration that contains a valid [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface for each version of the common language runtime (CLR) that is installed on a computer. - -## Syntax - -```cpp -HRESULT EnumerateInstalledRuntimes ( - [out, retval] IEnumUnknown **ppEnumerator); -``` - -## Parameters - - `ppEnumerator` - [out] An enumeration of [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interfaces corresponding to each version of the CLR that is installed on the computer. - -## 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|`ppEnumerator` is null.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - -## See also - -- [ICLRMetaHost Interface](iclrmetahost-interface.md) -- [Hosting](index.md) diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md b/docs/core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md deleted file mode 100644 index 8bfcccd44c00c..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: "Learn more about: ICLRMetaHost::ExitProcess Method" -title: "ICLRMetaHost::ExitProcess Method" -ms.date: "03/30/2017" -api_name: - - "ICLRMetaHost.ExitProcess" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRMetaHost::ExitProcess" -helpviewer_keywords: - - "ICLRMetaHost::ExitProcess method [.NET Framework hosting]" - - "ExitProcess method, ICLRMetaHost interface [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRMetaHost::ExitProcess Method - -Attempts to shut down all loaded runtimes gracefully and then terminates the process. Supersedes the [CorExitProcess](corexitprocess-function.md) function. - -## Syntax - -```cpp -HRESULT ExitProcess ( - [in] INT32 iExitCode); -``` - -## Parameters - - `iExitCode` - [in] The exit code for the process. - -## Return Value - - This method never returns, so its return value is undefined. - -## Remarks - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - -## See also - -- [ICLRMetaHost Interface](iclrmetahost-interface.md) -- [Hosting](index.md) diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md b/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md deleted file mode 100644 index 9c0764e8ba77c..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -description: "Learn more about: ICLRPolicyManager::SetTimeout Method" -title: "ICLRPolicyManager::SetTimeout Method" -ms.date: "03/30/2017" -api_name: - - "ICLRPolicyManager.SetTimeout" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRPolicyManager::SetTimeout" -helpviewer_keywords: - - "SetTimeout method [.NET Framework hosting]" - - "ICLRPolicyManager::SetTimeout method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRPolicyManager::SetTimeout Method - -Sets a timeout value for the specified operation. - -## Syntax - -```cpp -HRESULT SetTimeout ( - [in] EClrOperation operation, - [in] DWORD dsMilliseconds -); -``` - -## Parameters - - `operation` - [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the common language runtime (CLR) operation for which to set a timeout. The following values are supported: - -- OPR_AppDomainUnload - -- OPR_ProcessExit - -- OPR_ThreadRudeAbortInCriticalRegion - -- OPR_ThreadRudeAbortInNonCriticalRegion - - `dwMilliseconds` - [in] The new timeout value, in milliseconds. A value of INFINITE causes the operation never to time out. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetTimeout` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_INVALIDARG|A timeout cannot be set for the specified `operation`, or an invalid value was supplied for `operation`.| - -## 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 2.0 - -## See also - -- [EClrOperation Enumeration](eclroperation-enumeration.md) -- [ICLRControl Interface](iclrcontrol-interface.md) -- [ICLRPolicyManager Interface](iclrpolicymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md b/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md deleted file mode 100644 index cf64328c2f4e4..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -description: "Learn more about: ICLRReferenceAssemblyEnum::Get Method" -title: "ICLRReferenceAssemblyEnum::Get Method" -ms.date: "03/30/2017" -api_name: - - "ICLRReferenceAssemblyEnum.Get" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRReferenceAssemblyEnum::Get" -helpviewer_keywords: - - "ICLRReferenceAssemblyEnum::Get method [.NET Framework hosting]" - - "Get method, ICLRReferenceAssemblyEnum interface [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRReferenceAssemblyEnum::Get Method - -Gets the assembly identity at the supplied index. - -## Syntax - -```cpp -HRESULT Get ( - [in] DWORD dwIndex, - [out, size_is(*pcchBufferSize)] LPWSTR pwzBuffer, - [in, out] DWORD *pcchBufferSize -); -``` - -## Parameters - - `dwIndex` - [in] The zero-based index of the assembly identity to return. - - `pwzBuffer` - [out] A buffer containing the assembly identity data. - - `pcchBufferSize` - [in, out] The size of the `pwzBuffer` buffer. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Get` returned successfully.| -|ERROR_INSUFFICIENT_BUFFER|`pwzBuffer` is too small.| -|ERROR_NO_MORE_ITEMS|The enumeration contains no more items.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| - -## Remarks - - `Get` is typically called twice. The first call supplies a null value for `pwzBuffer`, and sets `pcchBufferSize` to the size appropriate for `pwzBuffer`. The second call supplies an appropriately sized `pwzBuffer`, and contains the canonical assembly identity data upon completion. - -## 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 2.0 - -## See also - -- [ICLRAssemblyReferenceList Interface](iclrassemblyreferencelist-interface.md) -- [ICLRReferenceAssemblyEnum Interface](iclrreferenceassemblyenum-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md b/docs/core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md deleted file mode 100644 index bbd0b36485894..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -description: "Learn more about: ICLRRuntimeHost::ExecuteInDefaultAppDomain Method" -title: "ICLRRuntimeHost::ExecuteInDefaultAppDomain Method" -ms.date: "03/30/2017" -api_name: - - "ICLRRuntimeHost.ExecuteInDefaultAppDomain" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRRuntimeHost::ExecuteInDefaultAppDomain" -helpviewer_keywords: - - "ICLRRuntimeHost::ExecuteInDefaultAppDomain method [.NET Framework hosting]" - - "ExecuteInDefaultAppDomain method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRRuntimeHost::ExecuteInDefaultAppDomain Method - -Calls the specified method of the specified type in the specified managed assembly. - -## Syntax - -```cpp -HRESULT ExecuteInDefaultAppDomain ( - [in] LPCWSTR pwzAssemblyPath, - [in] LPCWSTR pwzTypeName, - [in] LPCWSTR pwzMethodName, - [in] LPCWSTR pwzArgument, - [out] DWORD *pReturnValue -); -``` - -## Parameters - - `pwzAssemblyPath` - [in] The path to the that defines the whose method is to be invoked. - - `pwzTypeName` - [in] The name of the that defines the method to invoke. - - `pwzMethodName` - [in] The name of the method to invoke. - - `pwzArgument` - [in] The string parameter to pass to the method. - - `pReturnValue` - [out] The integer value returned by the invoked method. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`ExecuteInDefaultAppDomain` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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 CRL is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The invoked method must have the following signature: - -```cpp -static int pwzMethodName (String pwzArgument) -``` - - where `pwzMethodName` represents the name of the invoked method, and `pwzArgument` represents the string value passed as a parameter to that method. If the HRESULT value is set to S_OK, `pReturnValue` is set to the integer value returned by the invoked method. Otherwise, `pReturnValue` is not set. - -## 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 2.0 - -## See also - -- [ICLRRuntimeHost Interface](iclrruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md deleted file mode 100644 index 868512a0a59fe..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -description: "Learn more about: ICLRRuntimeInfo::BindAsLegacyV2Runtime Method" -title: "ICLRRuntimeInfo::BindAsLegacyV2Runtime Method" -ms.date: "03/30/2017" -api_name: - - "ICLRRuntimeInfo.BindAsLegacyV2Runtime" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRRuntimeInfo::BindAsLegacyV2Runtime" -helpviewer_keywords: - - "ICLRRuntimeInfo::BindAsLegacyV2Runtime method [.NET Framework hosting]" - - "BindAsLegacyV2Runtime method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRRuntimeInfo::BindAsLegacyV2Runtime Method - -Binds the current runtime for all legacy common language runtime (CLR) version 2 activation policy decisions. - -## Syntax - -```cpp -HRESULT BindAsLegacyV2Runtime (); -``` - -## Return Value - - This method returns the following specific HRESULTs: - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|Either binding succeeded, or this runtime was already bound as the legacy CLR version 2 activation policy runtime.| -|CLR_E_SHIM_LEGACYRUNTIMEALREADYBOUND|A different runtime was already bound to the legacy CLR version 2 activation policy.| - -## Remarks - - If the current runtime is already bound for all legacy CLR version 2 activation policy decisions (for example, by using the `useLegacyV2RuntimeActivationPolicy` attribute on the [\ element](../../../framework/configure-apps/file-schema/startup/startup-element.md) in the configuration file), this method does not return an error result; instead, the result is S_OK, just as it would be if the method had successfully bound legacy activation policy. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - -## See also - -- [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) -- [Hosting Interfaces](hosting-interfaces.md) -- [Hosting](index.md) -- [\ Element](../../../framework/configure-apps/file-schema/startup/startup-element.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md deleted file mode 100644 index a1ddd9d2b19b8..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -description: "Learn more about: ICLRRuntimeInfo::GetInterface Method" -title: "ICLRRuntimeInfo::GetInterface Method" -ms.date: "03/30/2017" -api_name: - - "ICLRRuntimeInfo.GetInterface" -api_location: - - "mscordbi.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRRuntimeInfo::GetInterface" -helpviewer_keywords: - - "GetInterface method [.NET Framework hosting]" - - "ICLRRuntimeInfo::GetInterface method [.NET Framework hosting]" -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| -|CLSID_CLRDebuggingLegacy|IID_ICorDebug| -|CLSID_CLRStrongName|IID_ICLRStrongName| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - -## See also - -- [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) -- [Hosting Interfaces](hosting-interfaces.md) -- [Hosting](index.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md deleted file mode 100644 index ba576765e76f7..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -description: "Learn more about: ICLRRuntimeInfo::GetProcAddress Method" -title: "ICLRRuntimeInfo::GetProcAddress Method" -ms.date: "03/30/2017" -api_name: - - "ICLRRuntimeInfo.GetProcAddress" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRRuntimeInfo::GetProcAddress" -helpviewer_keywords: - - "GetProcAddress method [.NET Framework hosting]" - - "ICLRRuntimeInfo::GetProcAddress method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRRuntimeInfo::GetProcAddress Method - -Gets the address of a specified function that was exported from the common language runtime (CLR) associated with this interface. - - This method supersedes the [GetRealProcAddress](getrealprocaddress-function.md) function. - -## Syntax - -```cpp -HRESULT GetProcAddress( - [in] LPCSTR pszProcName, - [out, retval] LPVOID *ppProc); -``` - -## Parameters - - `pszProcName` - [in] The name of the exported function. - - `ppProc` - [out] The address of the exported function. - -## 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|`pszProcName` or `ppProc` is null.| -|CLR_E_SHIM_RUNTIMEEXPORT|The specified function is not an exported function.| - -## Remarks - - This method causes the CLR to be loaded but not initialized. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - -## See also - -- [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) -- [Hosting Interfaces](hosting-interfaces.md) -- [Hosting](index.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md deleted file mode 100644 index c615511c88ea1..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -description: "Learn more about: ICLRRuntimeInfo::IsStarted Method" -title: "ICLRRuntimeInfo::IsStarted Method" -ms.date: "03/30/2017" -api_name: - - "ICLRRuntimeInfo.IsStarted" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRRuntimeInfo::IsStarted" -helpviewer_keywords: - - "IsStarted method [.NET Framework hosting]" - - "ICLRRuntimeInfo::IsStarted method [.NET Framework hosting]" ---- -# ICLRRuntimeInfo::IsStarted Method - -Indicates whether the runtime has been started (that is, whether the [ICLRRuntimeHost::Start method](iclrruntimehost-start-method.md) has been called and has succeeded). - -## Syntax - -```cpp -HRESULT IsStarted( - [out] BOOL *pbStarted, - [out] DWORD *pdwStartupFlags); -``` - -## Parameters - - `pbStarted` - [out] `true` if this runtime is started; otherwise, `false`. - - `pdwStartupFlags` - [out] Returns the flags that were used to start the runtime. - -## 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_NOTIMPL|The common language runtime (CLR) version is earlier than the CLR version in the .NET Framework 4.| - -## Remarks - - This method does not work with CLR versions earlier than the CLR version in the .NET Framework 4. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - -## See also - -- [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) -- [Hosting Interfaces](hosting-interfaces.md) -- [Hosting](index.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md deleted file mode 100644 index 13ed1e2e30ed0..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -description: "Learn more about: ICLRRuntimeInfo::LoadErrorString Method" -title: "ICLRRuntimeInfo::LoadErrorString Method" -ms.date: "03/30/2017" -api_name: - - "ICLRRuntimeInfo.LoadErrorString" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRRuntimeInfo::LoadErrorString" -helpviewer_keywords: - - "ICLRRuntimeInfo::LoadErrorString method [.NET Framework hosting]" - - "LoadErrorString method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRRuntimeInfo::LoadErrorString Method - -Translates an HRESULT value into an appropriate error message for the specified culture. - - This method supersedes the following functions: - -- [LoadStringRC](loadstringrc-function.md) - -- [LoadStringRCEx](loadstringrcex-function.md) - -## Syntax - -```cpp -HRESULT LoadErrorString( - [in] UINT iResourceID, - [out, size_is(*pcchBuffer)] LPWSTR pwzBuffer, - [in, out] DWORD *pcchBuffer, - [in, lcid] LONG iLocaleID); -``` - -## Parameters - - `iResourceID` - [in] The HRESULT to translate. - - `pwzBuffer` - [out] The message string associated with the given HRESULT. - - `pcchBuffer` - [in, out] The size of `pwzbuffer` to avoid buffer overruns. If `pwzbuffer` is null, `pcchBuffer` provides the expected size of `pwzbuffer` to allow preallocation. - - `iLocaleID` - [in] The culture identifier. To use the default culture, you must specify -1. - -## 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|`pcchBuffer` is null.| -|E_INVALIDARG|`pwzBuffer` is null.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - -## See also - -- [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) -- [Hosting Interfaces](hosting-interfaces.md) -- [Hosting](index.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md b/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md deleted file mode 100644 index 3a0681317ffe2..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -description: "Learn more about: ICLRRuntimeInfo::LoadLibrary Method" -title: "ICLRRuntimeInfo::LoadLibrary Method" -ms.date: "03/30/2017" -api_name: - - "ICLRRuntimeInfo.LoadLibrary" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRRuntimeInfo::LoadLibrary" -helpviewer_keywords: - - "ICLRRuntimeInfo::LoadLibrary method [.NET Framework hosting]" - - "LoadLibrary method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRRuntimeInfo::LoadLibrary Method - -Loads a .NET Framework library from the common language runtime (CLR) represented by an [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface. - - This method supersedes the [LoadLibraryShim](loadlibraryshim-function.md) function. - -## Syntax - -```cpp -HRESULT LoadLibrary( - [in] LPCWSTR pwzDllName, - [out, retval] HMODULE *phndModule); -``` - -## Parameters - - `pwzDllName` - [in] The name of the assembly to be loaded. - - `phndModule` - [out] A handle to the loaded assembly. - -## 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|`pwzDllName` or `phndModule` is null.| -|E_OUTOFMEMORY|Not enough memory is available to handle the request.| - -## Remarks - - This method only loads DLLs included in the .NET Framework redistributable package. It can not load user-generated assemblies. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - -## See also - -- [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) -- [Hosting Interfaces](hosting-interfaces.md) -- [Hosting](index.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md deleted file mode 100644 index 7dc2cb550f153..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -description: "Learn more about: ICLRStrongName::GetHashFromAssemblyFile Method" -title: "ICLRStrongName::GetHashFromAssemblyFile Method" -ms.date: "03/30/2017" -api_name: - - "ICLRStrongName.GetHashFromAssemblyFile" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRStrongName::GetHashFromAssemblyFile" -helpviewer_keywords: - - "ICLRStrongName::GetHashFromAssemblyFile method [.NET Framework hosting]" - - "GetHashFromAssemblyFile method, ICLRStrongName interface [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRStrongName::GetHashFromAssemblyFile Method - -Gets a hash of the specified assembly file, using the specified hash algorithm. - -## Syntax - -```cpp -HRESULT GetHashFromAssemblyFile ( - [in] LPCSTR szFilePath, - [in, out] unsigned int *piHashAlg, - [out] BYTE *pbHash, - [in] DWORD cchHash, - [out] DWORD *pchHash -); -``` - -## Parameters - - `szFilePath` - [in] The path to the file to be hashed. - - `piHashAlg` - [in, out] A constant that specifies the hash algorithm. Use zero for the default hash algorithm. - - `pbHash` - [out] The returned hash buffer. - - `cchHash` - [in] The requested maximum size of `pbHash`. - - `pchHash` - [out] The returned size, in bytes, of `pbHash`. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - -## See also - -- [GetHashFromAssemblyFileW Method](iclrstrongname-gethashfromassemblyfilew-method.md) -- [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md deleted file mode 100644 index 689a426435bf8..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -description: "Learn more about: ICLRStrongName::GetHashFromAssemblyFileW Method" -title: "ICLRStrongName::GetHashFromAssemblyFileW Method" -ms.date: "03/30/2017" -api_name: - - "ICLRStrongName.GetHashFromAssemblyFileW" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRStrongName::GetHashFromAssemblyFileW" -helpviewer_keywords: - - "ICLRStrongName::GetHashFromAssemblyFileW method [.NET Framework hosting]" - - "GetHashFromAssemblyFileW method, ICLRStrongName interface [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRStrongName::GetHashFromAssemblyFileW Method - -Generates a hash over the contents of the file specified by a Unicode string. - -## Syntax - -```cpp -HRESULT GetHashFromAssemblyFileW ( - [in] LPCWSTR wszFilePath, - [in, out] unsigned int *piHashAlg, - [out] BYTE *pbHash, - [in] DWORD cchHash, - [out] DWORD *pchHash -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the file to be hashed. This parameter must be a Unicode string. - - `piHashAlg` - [in, out] A constant that specifies the hash algorithm. Use zero for the default hash algorithm. - - `pbHash` - [out] The returned hash buffer. - - `cchHash` - [in] The requested maximum size of `pbHash`. - - `pchHash` - [out] The returned size, in bytes, of `pbHash`. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - -## See also - -- [GetHashFromAssemblyFile Method](iclrstrongname-gethashfromassemblyfile-method.md) -- [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md deleted file mode 100644 index 70f3a20791041..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -description: "Learn more about: ICLRStrongName::GetHashFromBlob Method" -title: "ICLRStrongName::GetHashFromBlob Method" -ms.date: "03/30/2017" -api_name: - - "ICLRStrongName.GetHashFromBlob" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRStrongName::GetHashFromBlob" -helpviewer_keywords: - - "ICLRStrongName::GetHashFromBlob method [.NET Framework hosting]" - - "GetHashFromBlob method, ICLRStrongName interface [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRStrongName::GetHashFromBlob Method - -Gets a hash of the assembly at the specified memory address, using the specified hash algorithm. - -## Syntax - -```cpp -HRESULT GetHashFromBlob ( - [in] BYTE *pbBlob, - [in] DWORD cchBlob, - [in, out] unsigned int *piHashAlg, - [out] BYTE *pbHash, - [in] DWORD cchHash, - [out] DWORD *pchHash -); -``` - -## Parameters - - `pbBlob` - [in] A pointer to the address of the memory block to be hashed. - - `cchBlob` - [in] The length, in bytes, of the memory block. - - `piHashAlg` - [in, out] A constant that specifies the hash algorithm. Use zero for the default algorithm. - - `pbHash` - [out] The returned hash buffer. - - `cchHash` - [in] The requested maximum size of `pbHash`. - - `pchHash` - [out] The size, in bytes, of the returned `pbHash`. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - -## See also - -- [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md deleted file mode 100644 index a568d4f1d8f3f..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -description: "Learn more about: ICLRStrongName::GetHashFromFile Method" -title: "ICLRStrongName::GetHashFromFile Method" -ms.date: "03/30/2017" -api_name: - - "ICLRStrongName.GetHashFromFile" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRStrongName::GetHashFromFile" -helpviewer_keywords: - - "ICLRStrongName::GetHashFromFile method [.NET Framework hosting]" - - "GetHashFromFile method, ICLRStrongName interface [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRStrongName::GetHashFromFile Method - -Generates a hash over the contents of the specified file. - -## Syntax - -```cpp -HRESULT GetHashFromFile ( - [in] LPCSTR szFilePath, - [in, out] unsigned int *piHashAlg, - [out] BYTE *pbHash, - [in] DWORD cchHash, - [out] DWORD *pchHash -); -``` - -## Parameters - - `szFilePath` - [in] The name of the file to hash. - - `piHashAlg` - [in, out] The algorithm to use when generating the hash. Valid algorithms are those defined by the Win32 CryptoAPI. If `piHashAlg` is set to 0, the default algorithm CALG_SHA-1 is used. - - `pbHash` - [out] A byte array containing the generated hash. - - `cchHash` - [in] The maximum size of the buffer that `pbHash` points to. - - `pchHash` - [out] The size, in bytes, of the returned `pbHash`. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - This method is the same as the [ICLRStrongName::GetHashFromFileW](iclrstrongname-gethashfromfilew-method.md) method, except that the file name specification is ANSI instead of Unicode. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - -## See also - -- [GetHashFromFileW Method](iclrstrongname-gethashfromfilew-method.md) -- [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md deleted file mode 100644 index 1c1a51297e3c2..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -description: "Learn more about: ICLRStrongName::GetHashFromFileW Method" -title: "ICLRStrongName::GetHashFromFileW Method" -ms.date: "03/30/2017" -api_name: - - "ICLRStrongName.GetHashFromFileW" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRStrongName::GetHashFromFileW" -helpviewer_keywords: - - "GetHashFromFileW method, ICLRStrongName interface [.NET Framework hosting]" - - "ICLRStrongName::GetHashFromFileW method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRStrongName::GetHashFromFileW Method - -Generates a hash over the contents of the file specified by a Unicode string. - -## Syntax - -```cpp -HRESULT GetHashFromFileW ( - [in] LPCWSTR wszFilePath, - [in, out] unsigned int *piHashAlg, - [out] BYTE *pbHash, - [in] DWORD cchHash, - [out] DWORD *pchHash -); -``` - -## Parameters - - `wszFilePath` - [in] The Unicode name of the file to hash. - - `piHashAlg` - [in, out] The algorithm to use when generating the hash. Valid algorithms are those defined by the Win32 CryptoAPI. If `piHashAlg` is set to 0, the default algorithm CALG_SHA-1 is used. - - `pbHash` - [out] A byte array containing the generated hash. - - `cchHash` - [in] The maximum size of the buffer pointed to by `pbHash`. - - `pchHash` - [out] The size, in bytes, of `pbHash`. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - This method is the same as the [ICLRStrongName::GetHashFromFile](iclrstrongname-gethashfromfile-method.md) method, except that the file name specification is Unicode instead of ANSI. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - -## See also - -- [GetHashFromFile Method](iclrstrongname-gethashfromfile-method.md) -- [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md deleted file mode 100644 index cfd1c2cb1a971..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -description: "Learn more about: ICLRStrongName::GetHashFromHandle Method" -title: "ICLRStrongName::GetHashFromHandle Method" -ms.date: "03/30/2017" -api_name: - - "ICLRStrongName.GetHashFromHandle" - - "ICLRStrongName.StrongNameCompareAssemblies" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRStrongName::GetHashFromHandle" -helpviewer_keywords: - - "GetHashFromHandle method, ICLRStrongName interface [.NET Framework hosting]" - - "ICLRStrongName::GetHashFromHandle method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRStrongName::GetHashFromHandle Method - -Generates a hash over the contents of the file that has the specified file handle, using the specified hash algorithm. - -## Syntax - -```cpp -HRESULT GetHashFromHandle ( - [in] HANDLE hFile, - [in, out] unsigned int *piHashAlg, - [out] BYTE *pbHash, - [in] DWORD cchHash, - [out] DWORD *pchHash -); -``` - -## Parameters - - `hFile` - [in] The handle of the file to be hashed. - - `piHashAlg` - [in, out] A constant that specifies the hash algorithm. Use zero for the default algorithm. - - `pbHash` - [out] The returned hash buffer. - - `cchHash` - [in] The requested maximum size of `pbHash`. - - `pchHash` - [out] The size, in bytes, of the returned `pbHash`. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - -## See also - -- [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md deleted file mode 100644 index e4311f6835dbc..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -description: "Learn more about: ICLRStrongName::StrongNameCompareAssemblies Method" -title: "ICLRStrongName::StrongNameCompareAssemblies Method" -ms.date: "03/30/2017" -api_name: - - "ICLRStrongName.StrongNameCompareAssemblies" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRStrongName::StrongNameCompareAssemblies" -helpviewer_keywords: - - "ICLRStrongName::StrongNameCompareAssemblies method [.NET Framework hosting]" - - "StrongNameCompareAssemblies method, ICLRStrongName interface [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRStrongName::StrongNameCompareAssemblies Method - -Determines whether two assemblies differ only by their strong name signatures. - -## Syntax - -```cpp -HRESULT StrongNameCompareAssemblies ( - [in] LPCWSTR wszAssembly1, - [in] LPCWSTR wszAssembly2, - [out] DWORD *pdwResult -); -``` - -## Parameters - - `wszAssembly1` - [in] The path to the first assembly. - - `wszAssembly2` - [in] The path to the second assembly. - - `pdwResult` - [out] One of the following values: - -- `SN_CMP_DIFFERENT` (0) - Specifies that the assemblies contain different data. - -- `SN_CMP_IDENTICAL` (1) - Specifies that the assemblies are exactly the same, including their signatures and checksum. - -- `SN_CMP_SIGONLY` (2) - Specifies that the assemblies differ only by signature and checksum. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - -## Remarks - - The strong name signature of an assembly consists of the assembly's text name, version, culture, and public key token. - -## See also - -- [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md deleted file mode 100644 index c165188bfdc34..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -description: "Learn more about: ICLRStrongName::StrongNameGetBlob Method" -title: "ICLRStrongName::StrongNameGetBlob Method" -ms.date: "03/30/2017" -api_name: - - "ICLRStrongName.StrongNameGetBlob" - - "ICLRStrongName.StrongNameGetBlob" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRStrongName::StrongNameGetBlob" -helpviewer_keywords: - - "ICLRStrongName::StrongNameGetBlob method [.NET Framework hosting]" - - "StrongNameGetBlob method, ICLRStrongName interface [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRStrongName::StrongNameGetBlob Method - -Fills the specified buffer with the binary representation of the executable file at the specified address. - -## Syntax - -```cpp -HRESULT StrongNameGetBlob ( - [in] LPCWSTR wszFilePath, - [in] BYTE *pbBlob, - [in, out] DWORD *pcbBlob -); -``` - -## Parameters - - `wszFilePath` - [in] A valid path to the executable file to be loaded. - - `pbBlob` - [in] The buffer into which to load the executable file. - - `pcbBlob` - [in, out] The requested maximum size, in bytes, of `pbBlob`. Upon return, the actual size, in bytes, of `pbBlob`. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - -## See also - -- [StrongNameGetBlobFromImage Method](iclrstrongname-strongnamegetblobfromimage-method.md) -- [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md deleted file mode 100644 index af96c9559b516..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -description: "Learn more about: ICLRStrongName::StrongNameGetBlobFromImage Method" -title: "ICLRStrongName::StrongNameGetBlobFromImage Method" -ms.date: "03/30/2017" -api_name: - - "ICLRStrongName.StrongNameGetBlobFromImage" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRStrongName::StrongNameGetBlobFromImage" -helpviewer_keywords: - - "StrongNameGetBlobFromImage method, ICLRStrongName interface [.NET Framework hosting]" - - "ICLRStrongName::StrongNameGetBlobFromImage method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRStrongName::StrongNameGetBlobFromImage Method - -Gets a binary representation of the assembly image at the specified memory address. - -## Syntax - -```cpp -HRESULT StrongNameGetBlobFromImage ( - [in] BYTE *pbBase, - [in] DWORD dwLength, - [in] BYTE *pbBlob, - [in, out] DWORD *pcbBlob -); -``` - -## Parameters - - `pbBase` - [in] The memory address of the mapped assembly manifest. - - `dwLength` - [in] The size, in bytes, of the image at `pbBase`. - - `pbBlob` - [in] A buffer to contain the binary representation of the image. - - `pcbBlob` - [in, out] The requested maximum size, in bytes, of `pbBlob`. Upon return, the actual size, in bytes, of `pbBlob`. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - -## See also - -- [StrongNameGetBlob Method](iclrstrongname-strongnamegetblob-method.md) -- [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md deleted file mode 100644 index 038bb5f71578f..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -description: "Learn more about: ICLRStrongName::StrongNameHashSize Method" -title: "ICLRStrongName::StrongNameHashSize Method" -ms.date: "03/30/2017" -api_name: - - "ICLRStrongName.StrongNameHashSize" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRStrongName::StrongNameHashSize" -helpviewer_keywords: - - "ICLRStrongName::StrongNameHashSize method [.NET Framework hosting]" - - "StrongNameHashSize method, ICLRStrongName interface [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRStrongName::StrongNameHashSize Method - -Gets the buffer size required for a hash, using the specified hash algorithm. - -## Syntax - -```cpp -HRESULT StrongNameHashSize ( - [in] ULONG ulHashAlg, - [out] DWORD *pcbSize -); -``` - -## Parameters - - `ulHashAlg` - [in] The hash algorithm used to compute the buffer size. - - `pcbSize` - [out] The returned buffer size, in bytes. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - -## See also - -- [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md b/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md deleted file mode 100644 index 7046e1a6b96b1..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -description: "Learn more about: ICLRStrongName::StrongNameSignatureSize Method" -title: "ICLRStrongName::StrongNameSignatureSize Method" -ms.date: "03/30/2017" -api_name: - - "ICLRStrongName.StrongNameSignatureSize" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRStrongName::StrongNameSignatureSize" -helpviewer_keywords: - - "ICLRStrongName::StrongNameSignatureSize method [.NET Framework hosting]" - - "StrongNameSignatureSize method, ICLRStrongName interface [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRStrongName::StrongNameSignatureSize Method - -Returns the size of the strong name signature. This method is typically used by compilers to determine how much space to reserve in the file when creating a delay-signed assembly. - -## Syntax - -```cpp -HRESULT StrongNameSignatureSize ( - [in] BYTE *pbPublicKeyBlob, - [in] ULONG cbPublicKeyBlob, - [in] DWORD *pcbSize -); -``` - -## Parameters - - `pbPublicKeyBlob` - [in] A structure of type [PublicKeyBlob]((../../../framework/unmanaged-api/strong-naming/publickeyblob-structure.md) that contains the public portion of the key pair used to generate the strong name signature. - - `cbPublicKeyBlob` - [in] The size, in bytes, of `pbPublicKeyBlob`. - - `pcbSize` - [in] The number of bytes required to store the strong name signature. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - -## See also - -- [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md b/docs/core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md deleted file mode 100644 index 46efaf2c2dc2d..0000000000000 --- a/docs/core/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -description: "Learn more about: ICLRValidator::FormatEventInfo Method" -title: "ICLRValidator::FormatEventInfo Method" -ms.date: "03/30/2017" -api_name: - - "ICLRValidator.FormatEventInfo" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICLRValidator::FormatEventInfo" -helpviewer_keywords: - - "FormatEventInfo method, ICLRValidator interface [.NET Framework hosting]" - - "ICLRValidator::FormatEventInfo method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICLRValidator::FormatEventInfo Method - -Gets a detailed message about the specified validation error. - -## Syntax - -```cpp -HRESULT FormatEventInfo ( - [in] HRESULT hVECode, - [in] VEContext Context, - [in, out] LPWSTR msg, - [in] unsigned long ulMaxLength, - [in] SAFEARRAY(VARIANT) psa -); -``` - -## Parameters - - `hVECode` - [in] The HRESULT value that was passed to the validation error handler. - - `Context` - [in] A `VEContext` instance that contains context information about the validation errors. - - `msg` - [in, out] The friendly error message. - - `ulMaxLength` - [in] The maximum length of the error message. - - `psa` - [in] A safe array of additional parameters to be used in the message. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`FormatEventInfo` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** IValidator.idl, IValidator.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - -## See also - -- [ICLRErrorReportingManager Interface](iclrerrorreportingmanager-interface.md) -- [ICLRValidator Interface](iclrvalidator-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md deleted file mode 100644 index aa55dfe2db060..0000000000000 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -description: "Learn more about: ICorRuntimeHost::EnumDomains Method" -title: "ICorRuntimeHost::EnumDomains Method" -ms.date: "03/30/2017" -api_name: - - "ICorRuntimeHost.EnumDomains" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICorRuntimeHost::EnumDomains" -helpviewer_keywords: - - "ICorRuntimeHost::EnumDomains method [.NET Framework hosting]" - - "EnumDomains method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICorRuntimeHost::EnumDomains Method - -Gets an enumerator for the domains in the current process. - -## Syntax - -```cpp -HRESULT EnumDomains ( - [out] HCORENUM *hEnum -); -``` - -## Parameters - - `hEnum` - [out] An enumerator for the domains. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Version:** 1.0, 1.1 - -## See also - -- [ICorRuntimeHost Interface](icorruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md b/docs/core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md deleted file mode 100644 index 42758d05f9f0f..0000000000000 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-mapfile-method.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -description: "Learn more about: ICorRuntimeHost::MapFile Method" -title: "ICorRuntimeHost::MapFile Method" -ms.date: "03/30/2017" -api_name: - - "ICorRuntimeHost.MapFile" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ICorRuntimeHost::MapFile" -helpviewer_keywords: - - "ICorRuntimeHost::MapFile method [.NET Framework hosting]" - - "MapFile method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICorRuntimeHost::MapFile Method - -Maps the specified file into memory. This method is obsolete. - -## Syntax - -```cpp -HRESULT MapFile( - [in] HANDLE hFile, - [out] HMODULE* hMapAddress -); -``` - -## Parameters - - `hFile` - [in] The handle of the file to be mapped. - - `hMapAddress` - [out] The starting memory address at which to begin mapping the file. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Version:** 1.0, 1.1 - -## See also - -- [ICorRuntimeHost Interface](icorruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md deleted file mode 100644 index 546533d5445de..0000000000000 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -description: "Learn more about: ICorThreadpool::CorBindIoCompletionCallback Method" -title: "ICorThreadpool::CorBindIoCompletionCallback Method" -ms.date: "03/30/2017" -api_name: - - "ICorThreadpool.CorBindIoCompletionCallback" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorBindIoCompletionCallback" -helpviewer_keywords: - - "CorBindIoCompletionCallback method [.NET Framework hosting]" - - "ICorThreadpool::CorBindIoCompletionCallback method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICorThreadpool::CorBindIoCompletionCallback Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CorBindIoCompletionCallback ( - [in] HANDLE fileHandle, - [in] LPOVERLAPPED_COMPLETION_ROUTINE callback -); -``` - -## 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 2.0 - -## See also - -- [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md deleted file mode 100644 index bc81303f4af39..0000000000000 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: "Learn more about: ICorThreadpool::CorCallOrQueueUserWorkItem Method" -title: "ICorThreadpool::CorCallOrQueueUserWorkItem Method" -ms.date: "03/30/2017" -api_name: - - "ICorThreadpool.CorCallOrQueueUserWorkItem" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorCallOrQueueUserWorkItem" -helpviewer_keywords: - - "ICorThreadpool::CorCallOrQueueUserWorkItem method [.NET Framework hosting]" - - "CorCallOrQueueUserWorkItem method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICorThreadpool::CorCallOrQueueUserWorkItem Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CorCallOrQueueUserWorkItem ( - [in] LPTHREAD_START_ROUTINE Function, - [in] PVOID Context, - [out] BOOL* result -); -``` - -## 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 2.0 - -## See also - -- [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md deleted file mode 100644 index 88b813e8c9231..0000000000000 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -description: "Learn more about: ICorThreadpool::CorChangeTimer Method" -title: "ICorThreadpool::CorChangeTimer Method" -ms.date: "03/30/2017" -api_name: - - "ICorThreadpool.CorChangeTimer" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorChangeTimer" -helpviewer_keywords: - - "CorChangeTimer method [.NET Framework hosting]" - - "ICorThreadpool::CorChangeTimer method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICorThreadpool::CorChangeTimer Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CorChangeTimer ( - [in] HANDLE Timer, - [in] ULONG DueTime, - [in] ULONG Period, - [out] BOOL* result -); -``` - -## 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 2.0 - -## See also - -- [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md deleted file mode 100644 index 81e1d32bcf73b..0000000000000 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -description: "Learn more about: ICorThreadpool::CorCreateTimer Method" -title: "ICorThreadpool::CorCreateTimer Method" -ms.date: "03/30/2017" -api_name: - - "ICorThreadpool.CorCreateTimer" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorCreateTimer" -helpviewer_keywords: - - "CorCreateTimer method [.NET Framework hosting]" - - "ICorThreadpool::CorCreateTimer method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICorThreadpool::CorCreateTimer Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CorCreateTimer ( - [in] HANDLE* phNewTimer, - [in] WAITORTIMERCALLBACK Callback, - [in] PVOID Parameter, - [in] DWORD DueTime, - [in] DWORD Period, - [out] BOOL* result -); -``` - -## 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 2.0 - -## See also - -- [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md deleted file mode 100644 index a05bbb92b7750..0000000000000 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: "Learn more about: ICorThreadpool::CorDeleteTimer Method" -title: "ICorThreadpool::CorDeleteTimer Method" -ms.date: "03/30/2017" -api_name: - - "ICorThreadpool.CorDeleteTimer" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorDeleteTimer" -helpviewer_keywords: - - "ICorThreadpool::CorDeleteTimer method [.NET Framework hosting]" - - "CorDeleteTimer method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICorThreadpool::CorDeleteTimer Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CorDeleteTimer ( - [in] HANDLE Timer, - [in] HANDLE CompletionEvent, - [out] BOOL* result -); -``` - -## 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 2.0 - -## See also - -- [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md deleted file mode 100644 index be44305de034e..0000000000000 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -description: "Learn more about: ICorThreadpool::CorGetAvailableThreads Method" -title: "ICorThreadpool::CorGetAvailableThreads Method" -ms.date: "03/30/2017" -api_name: - - "ICorThreadpool.CorGetAvailableThreads" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorGetAvailableThreads" -helpviewer_keywords: - - "CorGetAvailableThreads method [.NET Framework hosting]" - - "ICorThreadpool::CorGetAvailableThreads method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICorThreadpool::CorGetAvailableThreads Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CorGetAvailableThreads ( - [out] DWORD *AvailableWorkerThreads, - [out] DWORD *AvailableIOCompletionThreads -); -``` - -## 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 2.0 - -## See also - -- [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md deleted file mode 100644 index e5be8ee736f97..0000000000000 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -description: "Learn more about: ICorThreadpool::CorGetMaxThreads Method" -title: "ICorThreadpool::CorGetMaxThreads Method" -ms.date: "03/30/2017" -api_name: - - "ICorThreadpool.CorGetMaxThreads" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorGetMaxThreads" -helpviewer_keywords: - - "CorGetMaxThreads method [.NET Framework hosting]" - - "ICorThreadpool::CorGetMaxThreads method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICorThreadpool::CorGetMaxThreads Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CorGetMaxThreads ( - [out] DWORD *MaxWorkerThreads, - [out] DWORD *MaxIOCompletionThreads -); -``` - -## 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 2.0 - -## See also - -- [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md deleted file mode 100644 index 755cab2afb74e..0000000000000 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -description: "Learn more about: ICorThreadpool::CorQueueUserWorkItem Method" -title: "ICorThreadpool::CorQueueUserWorkItem Method" -ms.date: "03/30/2017" -api_name: - - "ICorThreadpool.CorQueueUserWorkItem" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorQueueUserWorkItem" -helpviewer_keywords: - - "ICorThreadpool::CorQueueUserWorkItem method [.NET Framework hosting]" - - "CorQueueUserWorkItem method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICorThreadpool::CorQueueUserWorkItem Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CorQueueUserWorkItem ( - [in] LPTHREAD_START_ROUTINE Function, - [in] PVOID Context, - [in] BOOL executeOnlyOnce, - [out] BOOL* result -); -``` - -## 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 2.0 - -## See also - -- [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md deleted file mode 100644 index d98bb23a1abbe..0000000000000 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -description: "Learn more about: ICorThreadpool::CorRegisterWaitForSingleObject Method" -title: "ICorThreadpool::CorRegisterWaitForSingleObject Method" -ms.date: "03/30/2017" -api_name: - - "ICorThreadpool.CorRegisterWaitForSingleObject" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorRegisterWaitForSingleObject" -helpviewer_keywords: - - "ICorThreadpool::CorRegisterWaitForSingleObject method [.NET Framework hosting]" - - "CorRegisterWaitForSingleObject method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICorThreadpool::CorRegisterWaitForSingleObject Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CorRegisterWaitForSingleObject ( - [in] HANDLE* phNewWaitObject, - [in] HANDLE hWaitObject, - [in] WAITORTIMERCALLBACK Callback, - [in] PVOID Context, - [in] ULONG timeout, - [in] BOOL executeOnlyOnce, - [out] BOOL* result -); -``` - -## 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 2.0 - -## See also - -- [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md deleted file mode 100644 index fda3afdbdbb51..0000000000000 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -description: "Learn more about: ICorThreadpool::CorSetMaxThreads Method" -title: "ICorThreadpool::CorSetMaxThreads Method" -ms.date: "03/30/2017" -api_name: - - "ICorThreadpool.CorSetMaxThreads" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorSetMaxThreads" -helpviewer_keywords: - - "ICorThreadpool::CorSetMaxThreads method [.NET Framework hosting]" - - "CorSetMaxThreads method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICorThreadpool::CorSetMaxThreads Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CorSetMaxThreads ( - [in] DWORD MaxWorkerThreads, - [in] DWORD MaxIOCompletionThreads -); -``` - -## 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 2.0 - -## See also - -- [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md b/docs/core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md deleted file mode 100644 index 0730f69fcda8d..0000000000000 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: "Learn more about: ICorThreadpool::CorUnregisterWait Method" -title: "ICorThreadpool::CorUnregisterWait Method" -ms.date: "03/30/2017" -api_name: - - "ICorThreadpool.CorUnregisterWait" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "CorUnregisterWait" -helpviewer_keywords: - - "CorUnregisterWait method [.NET Framework hosting]" - - "ICorThreadpool::CorUnregisterWait method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ICorThreadpool::CorUnregisterWait Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CorUnregisterWait ( - [in] HANDLE hWaitObject, - [in] HANDLE CompletionEvent, - [out] BOOL* result -); -``` - -## 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 2.0 - -## See also - -- [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/igchost-collect-method.md b/docs/core/unmanaged-api/hosting/igchost-collect-method.md deleted file mode 100644 index cd7adabf43e7f..0000000000000 --- a/docs/core/unmanaged-api/hosting/igchost-collect-method.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -description: "Learn more about: IGCHost::Collect Method" -title: "IGCHost::Collect Method" -ms.date: "03/30/2017" -api_name: - - "IGCHost.Collect" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "Collect" -helpviewer_keywords: - - "Collect method, IGCHost interface [.NET Framework hosting]" - - "IGCHost::Collect method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# IGCHost::Collect Method - -Forces a collection to occur for the given generation, regardless of the state of the current garbage collection. - -## Syntax - -```cpp -HRESULT Collect ( - [in] LONG Generation -); -``` - -## Parameters - - `Generation` - [in] The generation on which to perform the garbage collection. A value of -1 indicates that all generations will undergo a garbage collection. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl, GCHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - -## See also - -- [IGCHost Interface](igchost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/igchost-getthreadstats-method.md b/docs/core/unmanaged-api/hosting/igchost-getthreadstats-method.md deleted file mode 100644 index 1cdda0c832894..0000000000000 --- a/docs/core/unmanaged-api/hosting/igchost-getthreadstats-method.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -description: "Learn more about: IGCHost::GetThreadStats Method" -title: "IGCHost::GetThreadStats Method" -ms.date: "03/30/2017" -api_name: - - "IGCHost.GetThreadStats" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "GetThreadStats" -helpviewer_keywords: - - "IGCHost::GetThreadStats method [.NET Framework hosting]" - - "GetThreadStats method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# IGCHost::GetThreadStats Method - -Gets the per-thread statistics for garbage collection. - -## Syntax - -```cpp -HRESULT GetThreadStats ( - [in] DWORD *pFiberCookie, - [in, out] COR_GC_THREAD_STATS *pStats -); -``` - -## Parameters - - `pFiberCookie` - [in] A pointer to a fiber cookie that specifies the thread for which to retrieve the statistics. - - `pStats` - [in, out] A pointer to a [COR_GC_THREAD_STATS](cor-gc-thread-stats-structure.md) structure that contains the garbage collection statistics for the specified thread. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl, GCHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - -## See also - -- [IGCHost Interface](igchost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md b/docs/core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md deleted file mode 100644 index ae6dc579ee1ad..0000000000000 --- a/docs/core/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -description: "Learn more about: IGCHost::SetGCStartupLimits Method" -title: "IGCHost::SetGCStartupLimits Method" -ms.date: "03/30/2017" -api_name: - - "IGCHost.SetGCStartupLimits" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "SetGCStartupLimits" -helpviewer_keywords: - - "SetGCStartupLimits method, IGCHost interface [.NET Framework hosting]" - - "IGCHost::SetGCStartupLimits method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# IGCHost::SetGCStartupLimits Method - -Sets the segment size and the maximum size for generation 0. - -> [!IMPORTANT] -> Starting with .NET Framework 4.5, you can set segment size and maximum generation 0 size to values greater than `DWORD` by using the [IGCHost2::SetGCStartupLimitsEx](igchost2-setgcstartuplimitsex-method.md) method. - -## Syntax - -```cpp -HRESULT SetGCStartupLimits ( - [in] DWORD SegmentSize, - [in] DWORD MaxGen0Size -); -``` - -## Parameters - - `SegmentSize` - [in] The size of the segment used by the garbage collection system. - - `MaxGen0Size` - [in] The maximum size for generation 0. - -## Remarks - - The `SetGCStartupLimits` method may be called only once. These values cannot be changed later. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl, GCHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - -## See also - -- [IGCHost Interface](igchost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md b/docs/core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md deleted file mode 100644 index cea9113a35a95..0000000000000 --- a/docs/core/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -description: "Learn more about: IGCHost::SetVirtualMemLimit Method" -title: "IGCHost::SetVirtualMemLimit Method" -ms.date: "03/30/2017" -api_name: - - "IGCHost.SetVirtualMemLimit" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "SetVirtualMemLimit" -helpviewer_keywords: - - "IGCHost::SetVirtualMemLimit method [.NET Framework hosting]" - - "SetVirtualMemLimit method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# IGCHost::SetVirtualMemLimit Method - -Sets the maximum size of the runtime's virtual memory. - -## Syntax - -```cpp -HRESULT SetVirtualMemLimit ( - [in] SIZE_T sztMaxVirtualMemMB -); -``` - -## Parameters - - `sztMaxVirtualMemMB` - [in] The maximum size, in megabytes, of the runtime's virtual memory. - -## Remarks - - The maximum size of the runtime's virtual memory can be changed dynamically. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl, GCHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - -## See also - -- [IGCHost Interface](igchost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md b/docs/core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md deleted file mode 100644 index 1350127d847ec..0000000000000 --- a/docs/core/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -description: "Learn more about: IGCHost2::SetGCStartupLimitsEx Method" -title: "IGCHost2::SetGCStartupLimitsEx Method" -ms.date: "03/30/2017" -api_name: - - "IGCHost2.SetGCStartupLimitsEx" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IGCHost2::SetGCStartupLimitsEx" -helpviewer_keywords: - - "IGCHost2::SetGCStartupLimitsEx method [.NET Framework hosting]" - - "SetGCStartupLimitsEx method, IGCHost2 interface [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# IGCHost2::SetGCStartupLimitsEx Method - -Sets the segment size and the maximum size for generation 0. - -## Syntax - -```cpp -HRESULT SetGCStartupLimitsEx ( - [in] SIZE_T SegmentSize, - [in] SIZE_T MaxGen0Size -); -``` - -## Parameters - - `SegmentSize` - [in] The size of the segment used by the garbage collection system. - - `MaxGen0Size` - [in] The maximum size for generation 0. - -## Remarks - - The values that `SetGCStartupLimitsEx` sets can be specified only before the host is started. These values cannot be changed later. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl, GCHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] - -## See also - -- [IGCHost2 Interface](igchost2-interface.md) diff --git a/docs/core/unmanaged-api/hosting/igchostcontrol-interface.md b/docs/core/unmanaged-api/hosting/igchostcontrol-interface.md deleted file mode 100644 index 989cbb0f7b39c..0000000000000 --- a/docs/core/unmanaged-api/hosting/igchostcontrol-interface.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -description: "Learn more about: IGCHostControl Interface" -title: "IGCHostControl Interface" -ms.date: "03/30/2017" -api_name: - - "IGCHostControl" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IGCHostControl" -helpviewer_keywords: - - "IGCHostControl interface [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# IGCHostControl Interface - -Provides a method that allows the garbage collector to request the host to change the limits of virtual memory. - -## Methods - -|Method|Description| -|------------|-----------------| -|[RequestVirtualMemLimit Method](igchostcontrol-requestvirtualmemlimit-method.md)|Requests the host to change the limits of virtual memory.| - -## 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 2.0 - -## See also - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md b/docs/core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md deleted file mode 100644 index 887e2609521c7..0000000000000 --- a/docs/core/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -description: "Learn more about: IGCHostControl::RequestVirtualMemLimit Method" -title: "IGCHostControl::RequestVirtualMemLimit Method" -ms.date: "03/30/2017" -api_name: - - "IGCHostControl.RequestVirtualMemLimit" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "RequestVirtualMemLimit" -helpviewer_keywords: - - "IGCHostControl::RequestVirtualMemLimit method [.NET Framework hosting]" - - "RequestVirtualMemLimit method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# IGCHostControl::RequestVirtualMemLimit Method - -Requests the host to change the limits of virtual memory. - -## Syntax - -```cpp -HRESULT RequestVirtualMemLimit ( - [in] SIZE_T sztMaxVirtualMemMB, - [in, out] SIZE_T* psztNewMaxVirtualMemMB -); -``` - -## Parameters - - `sztMaxVirtualMemMB` - [in] The requested size of memory to be allocated. - - `psztNewMaxVirtualMemMB` - [in, out] A pointer to the actual size of memory allocated. - -## 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 2.0 - -## See also - -- [IGCHostControl Interface](igchostcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md b/docs/core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md deleted file mode 100644 index 5ae6eeaa4a9f0..0000000000000 --- a/docs/core/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -description: "Learn more about: IHostControl::GetHostManager Method" -title: "IHostControl::GetHostManager Method" -ms.date: "03/30/2017" -api_name: - - "IHostControl.GetHostManager" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IHostControl::GetHostManager" -helpviewer_keywords: - - "GetHostManager method [.NET Framework hosting]" - - "IHostControl::GetHostManager method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# IHostControl::GetHostManager Method - -Gets an interface pointer to the host's implementation of the interface with the specified `IID`. - -## Syntax - -```cpp -HRESULT GetHostManager ( - [in] REFIID riid, - [out, iid_is(riid)] void** ppObject -); -``` - -## Parameters - - `riid` - [in] The `IID` of the interface that the common language runtime (CLR) is querying for. - - `ppObject` - [out] A pointer to the host-implemented interface, or null if the host does not support this interface. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetHostManager` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_INVALIDARG|The requested `IID` is not valid.| -|E_NOINTERFACE|The requested interface is not supported.| - -## Remarks - - The CLR queries the host to determine whether it supports one or more of the following interfaces: - -- [IHostMemoryManager](ihostmemorymanager-interface.md) - -- [IHostTaskManager](ihosttaskmanager-interface.md) - -- [IHostThreadPoolManager](ihostthreadpoolmanager-interface.md) - -- [IHostIoCompletionManager](ihostiocompletionmanager-interface.md) - -- [IHostSyncManager](ihostsyncmanager-interface.md) - -- [IHostAssemblyManager](ihostassemblymanager-interface.md) - -- [IHostGCManager](ihostgcmanager-interface.md) - -- [IHostPolicyManager](ihostpolicymanager-interface.md) - -- [IHostSecurityManager](ihostsecuritymanager-interface.md) - - If the host supports the specified interface, it sets `ppObject` to its implementation of that interface. Otherwise, it sets `ppObject` to null. - - The CLR does not call `Release` on host managers, even when you shut it down. - -## 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 2.0 - -## See also - -- [IHostControl Interface](ihostcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md b/docs/core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md deleted file mode 100644 index ca14173b64c9f..0000000000000 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -description: "Learn more about: IHostMemoryManager::AcquiredVirtualAddressSpace Method" -title: "IHostMemoryManager::AcquiredVirtualAddressSpace Method" -ms.date: "03/30/2017" -api_name: - - "IHostMemoryManager.AcquiredVirtualAddressSpace" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IHostMemoryManager::AcquiredVirtualAddressSpace" -helpviewer_keywords: - - "IHostMemoryManager::AcquiredVirtualAddressSpace method [.NET Framework hosting]" - - "AcquiredVirtualAddressSpace method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# IHostMemoryManager::AcquiredVirtualAddressSpace Method - -Notifies the host that the common language runtime (CLR) has acquired the specified memory from the operating system. - -## Syntax - -```cpp -HRESULT AcquiredVirtualAddressSpace( - [in] LPVOID startAddress, - [in] SIZE_T size -); -``` - -## Parameters - - `startAddress` - [in] The starting address of the memory. - - `size` - [in] The size, in bytes, of the memory. - -## Remarks - - The `AcquiredVirtualAddressSpace` method is a callback method and must be implemented by the writer of the hosting application. It is called by the CLR. - -## 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 2.0 - -## See also - -- [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md b/docs/core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md deleted file mode 100644 index 9ede7d9e844e5..0000000000000 --- a/docs/core/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -description: "Learn more about: IManagedObject::GetObjectIdentity Method" -title: "IManagedObject::GetObjectIdentity Method" -ms.date: "03/30/2017" -api_name: - - "IManagedObject.GetObjectIdentity" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "GetObjectIdentity" -helpviewer_keywords: - - "GetObjectIdentity method [.NET Framework hosting]" - - "IManagedObject::GetObjectIdentity method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# IManagedObject::GetObjectIdentity Method - -Gets the identity of this managed object. - -## Syntax - -```cpp -HRESULT GetObjectIdentity ( - [out] BSTR* pBSTRGUID, - [out] int* AppDomainID, - [out] CCW_PTR pCCW -); -``` - -## Parameters - - `pBSTRGUID` - [out] A pointer to the GUID of the process in which the object resides. - - `AppDomainID` - [out] A pointer to the ID of the object's application domain. - - `pCCW` - [out] A pointer to object's index in the COM classic v-table. - -## Remarks - - The identity of a managed object includes process GUID, application domain ID, and the object's index in the COM classic v-table. - -## 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 2.0 - -## See also - -- [IManagedObject Interface](imanagedobject-interface.md) diff --git a/docs/core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md b/docs/core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md deleted file mode 100644 index a9b8fe7248fee..0000000000000 --- a/docs/core/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -description: "Learn more about: IManagedObject::GetSerializedBuffer Method" -title: "IManagedObject::GetSerializedBuffer Method" -ms.date: "03/30/2017" -api_name: - - "IManagedObject.GetSerializedBuffer" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "GetSerializedBuffer" -helpviewer_keywords: - - "IManagedObject::GetSerializedBuffer method [.NET Framework hosting]" - - "GetSerializedBuffer method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# IManagedObject::GetSerializedBuffer Method - -Gets the string representation of this managed object. - -## Syntax - -```cpp -HRESULT GetSerializedBuffer ( - [out] BSTR *pBSTR -); -``` - -## Parameters - - `pBSTR` - [out] A pointer to a string that is the serialized object. - -## Remarks - - The `GetSerializedBuffer` method serializes the object so it can be marshalled to the client. - -## 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 2.0 - -## See also - -- [IManagedObject Interface](imanagedobject-interface.md) diff --git a/docs/core/unmanaged-api/hosting/imanagedobject-interface.md b/docs/core/unmanaged-api/hosting/imanagedobject-interface.md deleted file mode 100644 index 02cc2f97ef3ad..0000000000000 --- a/docs/core/unmanaged-api/hosting/imanagedobject-interface.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -description: "Learn more about: IManagedObject Interface" -title: "IManagedObject Interface" -ms.date: "03/30/2017" -api_name: - - "IManagedObject" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IManagedObject" -helpviewer_keywords: - - "IManagedObject interface [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# IManagedObject Interface - -Provides methods for controlling a managed object. - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetObjectIdentity Method](imanagedobject-getobjectidentity-method.md)|Gets the identity of this managed object.| -|[GetSerializedBuffer Method](imanagedobject-getserializedbuffer-method.md)|Gets the string representation of this managed object.| - -## 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 2.0 - -## See also - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/index.md b/docs/core/unmanaged-api/hosting/index.md deleted file mode 100644 index 6252ee1c363ad..0000000000000 --- a/docs/core/unmanaged-api/hosting/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -description: "Learn more about unmanaged APIs for .NET hosting" -title: ".NET hosting (unmanaged API reference)" -ms.date: "09/19/2023" -helpviewer_keywords: - - "unmanaged API reference [.NET], hosting" - - "native API reference [.NET], hosting" - - "hosting [.NET], using the unmanaged API" ---- -# .NET hosting (unmanaged API reference) - -The hosting API enables unmanaged hosts to integrate the common language runtime (CLR) into their applications. - -These APIs that can be used with both .NET Framework and .NET. - -## In This Section - - [Hosting Coclasses](hosting-coclasses.md)\ - Describes the unmanaged coclasses that the hosting API uses. - - [Hosting Enumerations](hosting-enumerations.md)\ - Describes the unmanaged enumerations that the hosting API uses. - - [Hosting Global Static Functions](hosting-global-static-functions.md)\ - Describes the unmanaged global static functions that the hosting API uses. - - [Hosting Interfaces](hosting-interfaces.md)\ - Describes the unmanaged interfaces that enable a runtime host to integrate the CLR into an unmanaged application. - - [Hosting Structures](hosting-structures.md)\ - Describes the unmanaged structures that the hosting API uses. - -## Related Sections - - [Runtime Hosts](/previous-versions/dotnet/netframework-4.0/a51xd4ze(v=vs.100))\ - Describes the runtime hosts included with .NET Framework. diff --git a/docs/core/unmanaged-api/hosting/iobjecthandle-interface.md b/docs/core/unmanaged-api/hosting/iobjecthandle-interface.md deleted file mode 100644 index be8f44d8c335b..0000000000000 --- a/docs/core/unmanaged-api/hosting/iobjecthandle-interface.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -description: "Learn more about: IObjectHandle Interface" -title: "IObjectHandle Interface" -ms.date: "03/30/2017" -api_name: - - "IObjectHandle" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "IObjectHandle" -helpviewer_keywords: - - "IObjectHandle interface [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# IObjectHandle Interface - -Provides a method for unwrapping marshal-by-value objects from indirection. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Unwrap Method](iobjecthandle-unwrap-method.md)|Unwraps a marshal-by-value object from indirection.| - -## 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 2.0 - -## See also - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md b/docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md deleted file mode 100644 index 2c8dff7c5a209..0000000000000 --- a/docs/core/unmanaged-api/hosting/iobjecthandle-unwrap-method.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -description: "Learn more about: IObjectHandle::Unwrap Method" -title: "IObjectHandle::Unwrap Method" -ms.date: "03/30/2017" -api_name: - - "IObjectHandle.Unwrap" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "Unwrap" -helpviewer_keywords: - - "Unwrap method [.NET Framework hosting]" - - "IObjectHandle::Unwrap method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# IObjectHandle::Unwrap Method - -Unwraps a marshal-by-value object from indirection. - -## Syntax - -```cpp -HRESULT Unwrap ( - [out, retval] VARIANT *ppv -); -``` - -## Parameters - - `ppv` - [out] A pointer to the object to be unwrapped. - -## 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 2.0 diff --git a/docs/core/unmanaged-api/hosting/itypename-getassemblyname-method.md b/docs/core/unmanaged-api/hosting/itypename-getassemblyname-method.md deleted file mode 100644 index 9034d569d0333..0000000000000 --- a/docs/core/unmanaged-api/hosting/itypename-getassemblyname-method.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -description: "Learn more about: ITypeName::GetAssemblyName Method" -title: "ITypeName::GetAssemblyName Method" -ms.date: "03/30/2017" -api_name: - - "ITypeName.GetAssemblyName" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "GetAssemblyName" -helpviewer_keywords: - - "ITypeName::GetAssemblyName method [.NET Framework hosting]" - - "GetAssemblyName method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ITypeName::GetAssemblyName Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT GetAssemblyName ( - [out, retval] BSTR* rgbszAssemblyNames -); -``` - -## 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 2.0 - -## See also - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypename-getmodifierlength-method.md b/docs/core/unmanaged-api/hosting/itypename-getmodifierlength-method.md deleted file mode 100644 index 50e0fa2e71fee..0000000000000 --- a/docs/core/unmanaged-api/hosting/itypename-getmodifierlength-method.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -description: "Learn more about: ITypeName::GetModifierLength Method" -title: "ITypeName::GetModifierLength Method" -ms.date: "03/30/2017" -api_name: - - "ITypeName.GetModifierLength" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "GetModifierLength" -helpviewer_keywords: - - "ITypeName::GetModifierLength method [.NET Framework hosting]" - - "GetModifierLength method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ITypeName::GetModifierLength Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT GetModifierLength ( - [out, retval] DWORD* pCount -); -``` - -## 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 2.0 - -## See also - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypename-getmodifiers-method.md b/docs/core/unmanaged-api/hosting/itypename-getmodifiers-method.md deleted file mode 100644 index 5c73f1cbfa25f..0000000000000 --- a/docs/core/unmanaged-api/hosting/itypename-getmodifiers-method.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: "Learn more about: ITypeName::GetModifiers Method" -title: "ITypeName::GetModifiers Method" -ms.date: "03/30/2017" -api_name: - - "ITypeName.GetModifiers" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "GetModifiers" -helpviewer_keywords: - - "ITypeName::GetModifiers method [.NET Framework hosting]" - - "GetModifiers method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ITypeName::GetModifiers Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT GetModifiers ( - [in] DWORD count, - [out] DWORD* rgModifiers, - [out, retval] DWORD* pCount -); -``` - -## 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 2.0 - -## See also - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypename-getnamecount-method.md b/docs/core/unmanaged-api/hosting/itypename-getnamecount-method.md deleted file mode 100644 index 692116cda8747..0000000000000 --- a/docs/core/unmanaged-api/hosting/itypename-getnamecount-method.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -description: "Learn more about: ITypeName::GetNameCount Method" -title: "ITypeName::GetNameCount Method" -ms.date: "03/30/2017" -api_name: - - "ITypeName.GetNameCount" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "GetNameCount" -helpviewer_keywords: - - "GetNameCount method [.NET Framework hosting]" - - "ITypeName::GetNameCount method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ITypeName::GetNameCount Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT GetNameCount ( - [out, retval] DWORD* pCount -); -``` - -## 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 2.0 - -## See also - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypename-getnames-method.md b/docs/core/unmanaged-api/hosting/itypename-getnames-method.md deleted file mode 100644 index f5f0148bca5ea..0000000000000 --- a/docs/core/unmanaged-api/hosting/itypename-getnames-method.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: "Learn more about: ITypeName::GetNames Method" -title: "ITypeName::GetNames Method" -ms.date: "03/30/2017" -api_name: - - "ITypeName.GetNames" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "GetNames" -helpviewer_keywords: - - "ITypeName::GetNames method [.NET Framework hosting]" - - "GetNames method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ITypeName::GetNames Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT GetNames ( - [in] DWORD count, - [out] BSTR* rgbszNames, - [out, retval] DWORD* pCount -); -``` - -## 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 2.0 - -## See also - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md b/docs/core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md deleted file mode 100644 index dcb5ba8d69b85..0000000000000 --- a/docs/core/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -description: "Learn more about: ITypeName::GetTypeArgumentCount Method" -title: "ITypeName::GetTypeArgumentCount Method" -ms.date: "03/30/2017" -api_name: - - "ITypeName.GetTypeArgumentCount" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "GetTypeArgumentCount" -helpviewer_keywords: - - "GetTypeArgumentCount method [.NET Framework hosting]" - - "ITypeName::GetTypeArgumentCount method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ITypeName::GetTypeArgumentCount Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT GetTypeArgumentCount ( - [out, retval] DWORD* pCount -); -``` - -## 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 2.0 - -## See also - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypename-gettypearguments-method.md b/docs/core/unmanaged-api/hosting/itypename-gettypearguments-method.md deleted file mode 100644 index c910538ec3d68..0000000000000 --- a/docs/core/unmanaged-api/hosting/itypename-gettypearguments-method.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: "Learn more about: ITypeName::GetTypeArguments Method" -title: "ITypeName::GetTypeArguments Method" -ms.date: "03/30/2017" -api_name: - - "ITypeName.GetTypeArguments" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "GetTypeArguments" -helpviewer_keywords: - - "ITypeName::GetTypeArguments method [.NET Framework hosting]" - - "GetTypeArguments method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ITypeName::GetTypeArguments Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT GetTypeArguments ( - [in] DWORD count, - [out] ITypeName** rgpArguments, - [out, retval] DWORD* pCount -); -``` - -## 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 2.0 - -## See also - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypename-interface.md b/docs/core/unmanaged-api/hosting/itypename-interface.md deleted file mode 100644 index cff1b38934e06..0000000000000 --- a/docs/core/unmanaged-api/hosting/itypename-interface.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -description: "Learn more about: ITypeName Interface" -title: "ITypeName Interface" -ms.date: "03/30/2017" -api_name: - - "ITypeName" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ITypeName" -helpviewer_keywords: - - "ITypeName interface [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ITypeName Interface - -Provides methods for obtaining type name information. - - This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## 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 2.0 - -## See also - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md deleted file mode 100644 index 3faa428c42906..0000000000000 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addarray-method.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -description: "Learn more about: ITypeNameBuilder::AddArray Method" -title: "ITypeNameBuilder::AddArray Method" -ms.date: "03/30/2017" -api_name: - - "ITypeNameBuilder.AddArray" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "AddArray" -helpviewer_keywords: - - "ITypeNameBuilder::AddArray method [.NET Framework hosting]" - - "AddArray method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ITypeNameBuilder::AddArray Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT AddArray ( - [in] DWORD rank -); -``` - -## 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 - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md deleted file mode 100644 index 516a4a97526ca..0000000000000 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -description: "Learn more about: ITypeNameBuilder::AddAssemblySpec Method" -title: "ITypeNameBuilder::AddAssemblySpec Method" -ms.date: "03/30/2017" -api_name: - - "ITypeNameBuilder.AddAssemblySpec" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "AddAssemblySpec" -helpviewer_keywords: - - "ITypeNameBuilder::AddAssemblySpec method [.NET Framework hosting]" - - "AddAssemblySpec method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ITypeNameBuilder::AddAssemblySpec Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT AddAssemblySpec ( - [in] LPCWSTR szAssemblySpec -); -``` - -## 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 2.0 - -## See also - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addname-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addname-method.md deleted file mode 100644 index 3731e5c998c5c..0000000000000 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addname-method.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -description: "Learn more about: ITypeNameBuilder::AddName Method" -title: "ITypeNameBuilder::AddName Method" -ms.date: "03/30/2017" -api_name: - - "ITypeNameBuilder.AddName" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "AddName" -helpviewer_keywords: - - "ITypeNameBuilder::AddName method [.NET Framework hosting]" - - "AddName method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ITypeNameBuilder::AddName Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT AddName ( - [in] LPCWSTR szName -); -``` - -## 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 2.0 - -## See also - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md deleted file mode 100644 index 8124322708e9b..0000000000000 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -description: "Learn more about: ITypeNameBuilder::AddPointer Method" -title: "ITypeNameBuilder::AddPointer Method" -ms.date: "03/30/2017" -api_name: - - "ITypeNameBuilder.AddPointer" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "AddPointer" -helpviewer_keywords: - - "ITypeNameBuilder::AddPointer method [.NET Framework hosting]" - - "AddPointer method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ITypeNameBuilder::AddPointer Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT AddPointer ( ); -``` - -## 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 2.0 - -## See also - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md deleted file mode 100644 index 218d41a0cfcf3..0000000000000 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -description: "Learn more about: ITypeNameBuilder::AddSzArray Method" -title: "ITypeNameBuilder::AddSzArray Method" -ms.date: "03/30/2017" -api_name: - - "ITypeNameBuilder.AddSzArray" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "AddSzArray" -helpviewer_keywords: - - "AddSzArray method [.NET Framework hosting]" - - "ITypeNameBuilder::AddSzArray method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ITypeNameBuilder::AddSzArray Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT AddSzArray ( ); -``` - -## 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 2.0 - -## See also - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-clear-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-clear-method.md deleted file mode 100644 index d4b3e6951da93..0000000000000 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-clear-method.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -description: "Learn more about: ITypeNameBuilder::Clear Method" -title: "ITypeNameBuilder::Clear Method" -ms.date: "03/30/2017" -api_name: - - "ITypeNameBuilder.Clear" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "Clear" -helpviewer_keywords: - - "Clear method [.NET Framework hosting]" - - "ITypeNameBuilder::Clear method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ITypeNameBuilder::Clear Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT Clear ( ); -``` - -## 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 - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md deleted file mode 100644 index 3d58a974b793f..0000000000000 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-interface.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -description: "Learn more about: ITypeNameBuilder Interface" -title: "ITypeNameBuilder Interface" -ms.date: "03/30/2017" -api_name: - - "ITypeNameBuilder" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ITypeNameBuilder" -helpviewer_keywords: - - "ITypeNameBuilder interface [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ITypeNameBuilder Interface - -Provides methods for building a type name. - - This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## 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 2.0 - -## See also - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md b/docs/core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md deleted file mode 100644 index 81750a47f375f..0000000000000 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-tostring-method.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -description: "Learn more about: ITypeNameBuilder::ToString Method" -title: "ITypeNameBuilder::ToString Method" -ms.date: "03/30/2017" -api_name: - - "ITypeNameBuilder.ToString" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ToString" -helpviewer_keywords: - - "ToString method [.NET Framework hosting]" - - "ITypeNameBuilder::ToString method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ITypeNameBuilder::ToString Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT ToString ( - [out, retval] BSTR* pszStringRepresentation -); -``` - -## 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 2.0 - -## See also - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md b/docs/core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md deleted file mode 100644 index 8755555cec745..0000000000000 --- a/docs/core/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -description: "Learn more about: ITypeNameFactory::GetTypeNameBuilder Method" -title: "ITypeNameFactory::GetTypeNameBuilder Method" -ms.date: "03/30/2017" -api_name: - - "ITypeNameFactory.GetTypeNameBuilder" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "GetTypeNameBuilder" -helpviewer_keywords: - - "ITypeNameFactory::GetTypeNameBuilder method [.NET Framework hosting]" - - "GetTypeNameBuilder method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ITypeNameFactory::GetTypeNameBuilder Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT GetTypeNameBuilder ( - [out, retval] ITypeNameBuilder** ppTypeBuilder -); -``` - -## 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 2.0 - -## See also - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamefactory-interface.md b/docs/core/unmanaged-api/hosting/itypenamefactory-interface.md deleted file mode 100644 index 4e93fdfe7888f..0000000000000 --- a/docs/core/unmanaged-api/hosting/itypenamefactory-interface.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -description: "Learn more about: ITypeNameFactory Interface" -title: "ITypeNameFactory Interface" -ms.date: "03/30/2017" -api_name: - - "ITypeNameFactory" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ITypeNameFactory" -helpviewer_keywords: - - "ITypeNameFactory interface [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ITypeNameFactory Interface - -Provides methods for deconstructing a type name. - - This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## 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 2.0 - -## See also - -- [Hosting Interfaces](hosting-interfaces.md) -- [TypeNameFactory Coclass](typenamefactory-coclass.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md b/docs/core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md deleted file mode 100644 index 1a4e09c329e59..0000000000000 --- a/docs/core/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: "Learn more about: ITypeNameFactory::ParseTypeName Method" -title: "ITypeNameFactory::ParseTypeName Method" -ms.date: "03/30/2017" -api_name: - - "ITypeNameFactory.ParseTypeName" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "ParseTypeName" -helpviewer_keywords: - - "ITypeNameFactory::ParseTypeName method [.NET Framework hosting]" - - "ParseTypeName method [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# ITypeNameFactory::ParseTypeName Method - -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT ParseTypeName ( - [in] LPCWSTR szName, - [out] DWORD* pError, - [out, retval] ITypeName** ppTypeName -); -``` - -## 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 2.0 - -## See also - -- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md b/docs/core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md deleted file mode 100644 index 77109eae3874d..0000000000000 --- a/docs/core/unmanaged-api/hosting/ivalidator-formateventinfo-method.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -description: "Learn more about: IValidator::FormatEventInfo Method" -title: "IValidator::FormatEventInfo Method" -ms.date: "03/30/2017" -api_name: - - "IValidator.FormatEventInfo" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "FormatEventInfo" -helpviewer_keywords: - - "IValidator::FormatEventInfo method [.NET Framework hosting]" - - "FormatEventInfo method, IValidator interface [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# IValidator::FormatEventInfo Method - -Gets the error message corresponding to the specified validation error. - -## Syntax - -```cpp -HRESULT FormatEventInfo( - [in] HRESULT hVECode, - [in] VEContext Context, - [in, out] LPWSTR msg, - [in] unsigned long ulMaxLength, - [in] SAFEARRAY(VARIANT) psa -); -``` - -## Parameters - - `hVECode` - [in] The HRESULT value that was passed to the validation error handler. - - `Context` - [in] A `VEContext` instance that contains context information about the validation error. - - `msg` - [in, out] A string that contains the returned error message. - - `ulMaxLength` - [in] The maximum length of the error message. - - `psa` - [in] A safe array that contains additional parameters describing the error. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** IValidator.idl, IValidator.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 diff --git a/docs/core/unmanaged-api/hosting/loadstringrc-function.md b/docs/core/unmanaged-api/hosting/loadstringrc-function.md deleted file mode 100644 index 90ed9e0fffe41..0000000000000 --- a/docs/core/unmanaged-api/hosting/loadstringrc-function.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -description: "Learn more about: LoadStringRC Function" -title: "LoadStringRC Function" -ms.date: "03/30/2017" -api_name: - - "LoadStringRC" -api_location: - - "mscoree.dll" -api_type: - - "DLLExport" -f1_keywords: - - "LoadStringRC" -helpviewer_keywords: - - "LoadStringRC function [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# LoadStringRC Function - -Translates an HRESULT value into an error message by using the default culture of the current thread. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT LoadStringRC ( - [in] UINT iResourceID, - [out] LPWSTR szBuffer, - [in] int iMax, - [in] int bQuiet -); -``` - -## Parameters - - `iResourceID` - [in] An HRESULT. - - `szBuffer` - [out] A buffer that contains the error message upon successful completion. - - `iMax` - [in] The size of the error message buffer. - - `bQuiet` - [in] Ignored. - -## Return Value - - This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values. - -|Return code|Description| -|-----------------|-----------------| -|S_OK|The method completed successfully.| -|E_INVALIDARG|`szBuffer` is null or `iMax` is zero (0).| - -## Remarks - - If the method does not complete successfully, `szBuffer` contains an empty string. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll and Mscorwks.dll. Use MSCorEE.dll instead of Mscorwks.dll to ensure that you target the correct version of the .NET Framework. - - **.NET versions:** Available since .NET Framework 2.0 - -## See also - -- [LoadStringRCEx Function](loadstringrcex-function.md) -- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/loadstringrcex-function.md b/docs/core/unmanaged-api/hosting/loadstringrcex-function.md deleted file mode 100644 index f02484fdc58d1..0000000000000 --- a/docs/core/unmanaged-api/hosting/loadstringrcex-function.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -description: "Learn more about: LoadStringRCEx Function" -title: "LoadStringRCEx Function" -ms.date: "03/30/2017" -api_name: - - "LoadStringRCEx" -api_location: - - "mscoree.dll" -api_type: - - "DLLExport" -f1_keywords: - - "LoadStringRCEx" -helpviewer_keywords: - - "LoadStringRCEx function [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# LoadStringRCEx Function - -Translates an HRESULT value to an appropriate error message for the specified culture. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT LoadStringRCEx ( - [in] LCID lcid, - [in] UINT iResouceID, - [out] LPWSTR szBuffer, - [in] int iMax, - [in] int bQuiet, - [out] int *pcwchUsed -); -``` - -## Parameters - - `lcid` - [in] A culture identifier. Pass -1 for `lcid` to use the default culture. - - `iResourceID` - [in] An HRESULT. - - `szBuffer` - [out] A buffer that contains the error message upon successful completion. - - `iMax` - [in] The size of the error message buffer. - - `bQuiet` - [in] Ignored. - - `pcwchUsed` - [out] A pointer to the length of the error message. - -## Return Value - - This method returns standard COM error codes, as defined in WinError.h, in addition to the following values. - -|Return code|Description| -|-----------------|-----------------| -|S_OK|The method completed successfully.| -|E_INVALIDARG|`szBuffer` is null, or `iMax` is zero (0).| - -## Remarks - - If the method does not complete successfully, `szBuffer` contains an empty string. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - -## See also - -- -- [LoadStringRC Function](loadstringrc-function.md) -- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md b/docs/core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md deleted file mode 100644 index 7aa83e77388f8..0000000000000 --- a/docs/core/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -description: "Learn more about: LPTHREAD_START_ROUTINE Function Pointer" -title: "LPTHREAD_START_ROUTINE Function Pointer" -ms.date: "03/30/2017" -api_name: - - "LPTHREAD_START_ROUTINE" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "LPTHREAD_START_ROUTINE" -helpviewer_keywords: - - "LPTHREAD_START_ROUTINE function pointer [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# LPTHREAD_START_ROUTINE Function Pointer - -Points to a function that notifies the host that a thread has started to execute. - - This function pointer has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -typedef DWORD (__stdcall *LPTHREAD_START_ROUTINE) ( - [in] LPVOID lpThreadParameter -); -``` - -## Parameters - - `lpThreadParameter` - [in] A pointer to the code that has started executing. - -## Remarks - - The function to which `LPTHREAD_START_ROUTINE` points is a callback function and must be implemented by the writer of the hosting application. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorWks.dll - - **.NET versions:** Available since .NET Framework 1.0 - -## See also - -- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/malloc-type-enumeration.md b/docs/core/unmanaged-api/hosting/malloc-type-enumeration.md deleted file mode 100644 index 2330878c0b89f..0000000000000 --- a/docs/core/unmanaged-api/hosting/malloc-type-enumeration.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -description: "Learn more about: MALLOC_TYPE Enumeration" -title: "MALLOC_TYPE Enumeration" -ms.date: "03/30/2017" -api_name: - - "MALLOC_TYPE" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "MALLOC_TYPE" -helpviewer_keywords: - - "MALLOC_TYPE Enumeration" -topic_type: - - "apiref" ---- -# MALLOC_TYPE Enumeration - -Contains values that specify the characteristics of the memory that is being allocated. - -## Syntax - -```cpp -typedef enum { - MALLOC_THREADSAFE = 0x1, - MALLOC_EXECUTABLE = 0x2, -} MALLOC_TYPE; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`MALLOC_EXECUTABLE`|The allocated memory can contain an executable file.| -|`MALLOC_THREADSAFE`|The allocated memory is thread-safe. That is, the memory can be accessed by multiple threads without any synchronization.

If this flag is not set, calls on the object must be serialized.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - -## See also - -- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/rundll32shimw-function.md b/docs/core/unmanaged-api/hosting/rundll32shimw-function.md deleted file mode 100644 index 557a7d81f42ca..0000000000000 --- a/docs/core/unmanaged-api/hosting/rundll32shimw-function.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -description: "Learn more about: RunDll32ShimW Function" -title: "RunDll32ShimW Function" -ms.date: "03/30/2017" -api_name: - - "RunDll32ShimW" -api_location: - - "mscoree.dll" -api_type: - - "DLLExport" -f1_keywords: - - "RunDll32ShimW" -helpviewer_keywords: - - "RunDll32ShimW function [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# RunDll32ShimW Function - -Executes the specified command. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT RunDll32ShimW ( - [in] HWND hwnd, - [in] HINSTANCE hinst, - [in] LPCWSTR lpszCmdLine, - [in] int nCmdShow -); -``` - -## Parameters - - `hwnd` - [in] A handle to a window in which the command output will be displayed. - - `hinst` - [in] A handle to the library that contains the command. - - `lpszCmdLine` - [in] A string that specifies the command to be executed. - - `nCmdShow` - [in] An integer that specifies the display mode for the output window. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 1.0 - -## See also - -- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/runtime-info-flags-enumeration.md b/docs/core/unmanaged-api/hosting/runtime-info-flags-enumeration.md deleted file mode 100644 index 5be6534cf22fd..0000000000000 --- a/docs/core/unmanaged-api/hosting/runtime-info-flags-enumeration.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -description: "Learn more about: RUNTIME_INFO_FLAGS Enumeration" -title: "RUNTIME_INFO_FLAGS Enumeration" -ms.date: "03/30/2017" -api_name: - - "RUNTIME_INFO_FLAGS" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "RUNTIME_INFO_FLAGS" -helpviewer_keywords: - - "RUNTIME_INFO_FLAGS enumeration [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# RUNTIME_INFO_FLAGS Enumeration - -Contains values that indicate what information about the common language runtime (CLR) should be returned. - -## Syntax - -```cpp -typedef enum { - - RUNTIME_INFO_UPGRADE_VERSION = 0x01, - RUNTIME_INFO_REQUEST_IA64 = 0x02, - RUNTIME_INFO_REQUEST_AMD64 = 0x04, - RUNTIME_INFO_REQUEST_X86 = 0x08, - RUNTIME_INFO_DONT_RETURN_DIRECTORY = 0x10, - RUNTIME_INFO_DONT_RETURN_VERSION = 0x20, - RUNTIME_INFO_DONT_SHOW_ERROR_DIALOG = 0x40, - RUNTIME_INFO_IGNORE_ERROR_MODE = 0x1000 - -} RUNTIME_INFO_FLAGS; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`RUNTIME_INFO_DONT_RETURN_DIRECTORY`|Indicates that directory information should not be included.| -|`RUNTIME_INFO_DONT_RETURN_VERSION`|Indicates that version information should not be included.| -|`RUNTIME_INFO_DONT_SHOW_ERROR_DIALOG`|Indicates that an error dialog box should not be shown upon failure.| -|`RUNTIME_INFO_IGNORE_ERROR_MODE`|Indicates that the effects of calling the [SetErrorMode](/windows/win32/api/errhandlingapi/nf-errhandlingapi-seterrormode) function with the SEM_FAILCRITICALERRORS flag should be overridden. That is, an installation dialog box should be shown upon failure, instead of being suppressed.| -|`RUNTIME_INFO_REQUEST_AMD64`|Indicates a request for information about an AMD-64-compatible version of the runtime.| -|`RUNTIME_INFO_REQUEST_IA64`|Indicates a request for information about an IA-64-compatible version of the runtime.| -|`RUNTIME_INFO_REQUEST_X86`|Indicates a request for information about an x86-compatible version of the runtime.| -|`RUNTIME_INFO_UPGRADE_VERSION`|Indicates that version upgrade information should be included.| - -## Remarks - - The following platform architecture flags can be specified only one at a time and cannot be combined: - -- RUNTIME_INFO_REQUEST_IA64 - -- RUNTIME_INFO_REQUEST_AMD64 - -- RUNTIME_INFO_REQUEST_X86 - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - -## See also - -- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/stackoverflowtype-enumeration.md b/docs/core/unmanaged-api/hosting/stackoverflowtype-enumeration.md deleted file mode 100644 index 1ce0eb09efce3..0000000000000 --- a/docs/core/unmanaged-api/hosting/stackoverflowtype-enumeration.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -description: "Learn more about: StackOverflowType Enumeration" -title: "StackOverflowType Enumeration" -ms.date: "03/30/2017" -api_name: - - "StackOverflowType" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "StackOverflowType" -helpviewer_keywords: - - "StackOverflowType enumeration [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# StackOverflowType Enumeration - -Contains values that indicate the underlying cause of a stack overflow event. - -## Syntax - -```cpp -typedef enum { - SO_Managed, - SO_ClrEngine, - SO_Other -} StackOverflowType; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`SO_ClrEngine`|The stack overflow was caused by the execution engine.| -|`SO_Managed`|The stack overflow was caused by managed code.| -|`SO_Other`|The stack overflow was caused by unmanaged code.| - -## Remarks - - This information is passed to the host through a call to the [IActionOnCLREvent::OnEvent](iactiononclrevent-onevent-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - -## See also - -- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/typenamefactory-coclass.md b/docs/core/unmanaged-api/hosting/typenamefactory-coclass.md deleted file mode 100644 index 09b623f8dac85..0000000000000 --- a/docs/core/unmanaged-api/hosting/typenamefactory-coclass.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -description: "Learn more about: TypeNameFactory Coclass" -title: "TypeNameFactory Coclass" -ms.date: "03/30/2017" -api_name: - - "TypeNameFactory Coclass" -api_location: - - "mscoree.dll" -api_type: - - "COM" -f1_keywords: - - "TypeNameFactory" -helpviewer_keywords: - - "TypeNameFactory coclass [.NET Framework hosting]" -topic_type: - - "apiref" ---- -# TypeNameFactory Coclass - -Provides an interface for managing the deconstruction of a type name. - -## Syntax - -```cpp -coclass TypeNameFactory { - [default] interface ITypeNameFactory; -}; -``` - -## Interfaces - -|Interface|Description| -|---------------|-----------------| -|[ITypeNameFactory Interface](itypenamefactory-interface.md)|This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.idl - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - -## See also - -- [Hosting Coclasses](hosting-coclasses.md) diff --git a/docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md b/docs/framework/unmanaged-api/hosting/assemblybindinfo-structure.md similarity index 63% rename from docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md rename to docs/framework/unmanaged-api/hosting/assemblybindinfo-structure.md index b3127b7435294..64ab190159926 100644 --- a/docs/core/unmanaged-api/hosting/assemblybindinfo-structure.md +++ b/docs/framework/unmanaged-api/hosting/assemblybindinfo-structure.md @@ -2,57 +2,58 @@ description: "Learn more about: AssemblyBindInfo Structure" title: "AssemblyBindInfo Structure" ms.date: "03/30/2017" -api_name: +api_name: - "AssemblyBindInfo" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "AssemblyBindInfo" -helpviewer_keywords: +helpviewer_keywords: - "AssemblyBindInfo structure [.NET Framework hosting]" -topic_type: +ms.assetid: 6fc01e98-c2e7-49de-ab9f-95937cc89017 +topic_type: - "apiref" --- # AssemblyBindInfo Structure -Provides detailed information about the referenced assembly. +Provides detailed information about the referenced assembly. + +## Syntax + +```cpp +typedef struct _AssemblyBindInfo { + DWORD dwAppDomainId; + LPCWSTR lpReferencedIdentity; + LPCWSTR lpPostPolicyIdentity; + DWORD ePolicyLevel; +} AssemblyBindInfo; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`dwAppDomainId`|A unique identifier for the `IStream` returned by a call to [IHostAssemblyStore::ProvideAssembly](ihostassemblystore-provideassembly-method.md), from which the referenced assembly is to be loaded.| +|`lpReferencedIdentity`|A unique identifier for the referenced assembly.| +|`lpPostPolicyIdentity`|The identifier for the referenced assembly after the application of any binding policy values.| +|`ePolicyLevel`|One of the [EPolicyAction](epolicyaction-enumeration.md) values that indicate which versioning policies, if any, should be applied to the referenced assembly.| + +## Remarks -## Syntax - -```cpp -typedef struct _AssemblyBindInfo { - DWORD dwAppDomainId; - LPCWSTR lpReferencedIdentity; - LPCWSTR lpPostPolicyIdentity; - DWORD ePolicyLevel; -} AssemblyBindInfo; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`dwAppDomainId`|A unique identifier for the `IStream` returned by a call to [IHostAssemblyStore::ProvideAssembly](ihostassemblystore-provideassembly-method.md), from which the referenced assembly is to be loaded.| -|`lpReferencedIdentity`|A unique identifier for the referenced assembly.| -|`lpPostPolicyIdentity`|The identifier for the referenced assembly after the application of any binding policy values.| -|`ePolicyLevel`|One of the [EPolicyAction](epolicyaction-enumeration.md) values that indicate which versioning policies, if any, should be applied to the referenced assembly.| - -## Remarks - - The host supplies the unique identifier `dwAppDomainId` to the common language runtime (CLR). After a call to `IHostAssemblyStore::ProvideAssembly` returns, the runtime uses the identifier to determine whether the contents of the `IStream` have been mapped. If so, the runtime loads the existing copy rather than remapping the stream. The runtime also uses this identifier as a lookup key for streams returned from calls to [IHostAssemblyStore::ProvideModule](ihostassemblystore-providemodule-method.md). Therefore, the identifier must be unique for module requests and for assembly requests. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.idl - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 + The host supplies the unique identifier `dwAppDomainId` to the common language runtime (CLR). After a call to `IHostAssemblyStore::ProvideAssembly` returns, the runtime uses the identifier to determine whether the contents of the `IStream` have been mapped. If so, the runtime loads the existing copy rather than remapping the stream. The runtime also uses this identifier as a lookup key for streams returned from calls to [IHostAssemblyStore::ProvideModule](ihostassemblystore-providemodule-method.md). Therefore, the identifier must be unique for module requests and for assembly requests. + +## Requirements + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.idl + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [Hosting Structures](hosting-structures.md) diff --git a/docs/framework/unmanaged-api/hosting/bucketparameters-structure.md b/docs/framework/unmanaged-api/hosting/bucketparameters-structure.md new file mode 100644 index 0000000000000..c0d9b7abda666 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/bucketparameters-structure.md @@ -0,0 +1,51 @@ +--- +description: "Learn more about: BucketParameters Structure" +title: "BucketParameters Structure" +ms.date: "03/30/2017" +api_name: + - "BucketParameters" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "BucketParameters" +helpviewer_keywords: + - "BucketParameters structure [.NET Framework hosting]" +ms.assetid: 9432487e-f276-45d6-9a13-9a68024dbd46 +topic_type: + - "apiref" +--- +# BucketParameters Structure + +Stores the type name of an event and the parameters for the current exception that is associated with the event. + +## Syntax + +```cpp +typedef struct _BucketParameters { + BOOL fInited; + WCHAR pszEventTypeName[255]; + WCHAR pszParams[10][255]; +} BucketParameters; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`fInited`|`true`, if the rest of this structure is valid; otherwise, `false`.| +|`pszEventTypeName`|Name of the event type.| +|`pszParams`|An array of strings, each of which specifies a parameter for the current exception associated with the event.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.idl + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + +## See also + +- [Hosting Structures](hosting-structures.md) diff --git a/docs/framework/unmanaged-api/hosting/callfunctionshim-function.md b/docs/framework/unmanaged-api/hosting/callfunctionshim-function.md new file mode 100644 index 0000000000000..2a1f757d6065d --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/callfunctionshim-function.md @@ -0,0 +1,70 @@ +--- +description: "Learn more about: CallFunctionShim Function" +title: "CallFunctionShim Function" +ms.date: "03/30/2017" +api_name: + - "CallFunctionShim" +api_location: + - "mscoree.dll" +api_type: + - "DLLExport" +f1_keywords: + - "CallFunctionShim" +helpviewer_keywords: + - "CallfunctionShim function [.NET Framework hosting]" +ms.assetid: 37118465-ddf3-41f0-bf27-335b72777e63 +topic_type: + - "apiref" +--- +# CallFunctionShim Function + +Makes a call to the function that has the specified name and parameters in the specified library. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT CallFunctionShim ( + [in] LPCWSTR szDllName, + [in] LPCSTR szFunctionName, + [in] LPVOID lpvArgument1, + [in] LPVOID lpvArgument2, + [in] LPCWSTR szVersion, + [in] LPVOID pvReserved +); +``` + +## Parameters + + `szDllName` + [in] The name of the library containing the function. + + `szFunctionName` + [in] The name of the function. + + `lpvArgument1` + [in] The first argument to pass to the function. + + `lpvArgument2` + [in] The second argument to pass to the function. + + `szVersion` + [in] The version of the library that contains the function. + + `pvReserved` + [in] Reserved for future use. Pass zero in this parameter. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + +## See also + +- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md b/docs/framework/unmanaged-api/hosting/clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md similarity index 66% rename from docs/core/unmanaged-api/hosting/clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md rename to docs/framework/unmanaged-api/hosting/clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md index 66101f02a45a1..fb742e2519859 100644 --- a/docs/core/unmanaged-api/hosting/clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md +++ b/docs/framework/unmanaged-api/hosting/clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md @@ -2,59 +2,60 @@ description: "Learn more about: CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5" title: "CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - "hosting interfaces [.NET Framework], version 4" - ".NET Framework 4, hosting interfaces" - "interfaces [.NET Framework hosting], version 4" +ms.assetid: f6af6116-f5b0-4bda-a276-fffdba70893d --- # CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5 -This section describes interfaces that unmanaged hosts can use to integrate the common language runtime (CLR) in the .NET Framework 4, .NET Framework 4.5, and later versions into their applications. These interfaces provide methods for a host to configure and load the runtime into a process. - - Starting with the .NET Framework 4, all hosting interfaces have the following characteristics: - -- They use lifetime management (`AddRef` and `Release`), encapsulation (implicit context) and `QueryInterface` from COM. - -- They do not use COM types such as `BSTR`, `SAFEARRAY`, or `VARIANT`. - -- There are no apartment models, aggregation, or registry activation that use the [CoCreateInstance function](/windows/win32/api/combaseapi/nf-combaseapi-cocreateinstance). - -## In This Section - - [ICLRAppDomainResourceMonitor Interface](iclrappdomainresourcemonitor-interface.md) - Provides methods that inspect an application domain's memory and CPU usage. - - [ICLRDomainManager Interface](iclrdomainmanager-interface.md) - Enables the host to specify the application domain manager that will be used to initialize the default application domain, and to specify initialization properties. - - [ICLRGCManager2 Interface](iclrgcmanager2-interface.md) - Provides the [SetGCStartupLimitsEx](iclrgcmanager2-setgcstartuplimitsex-method.md) method, which enables a host to set the size of the garbage collection segment and the maximum size of the garbage collection system's generation 0 to values greater than `DWORD`. - - [ICLRMetaHost Interface](iclrmetahost-interface.md) - Provides methods that return a specific version of the CLR, list all installed CLRs, list all in-process runtimes, return the activation interface, and discover the CLR version used to compile an assembly. - - [ICLRMetaHostPolicy Interface](iclrmetahostpolicy-interface.md) - Provides the [GetRequestedRuntime](iclrmetahostpolicy-getrequestedruntime-method.md) method that provides a CLR interface based on policy criteria, managed assembly, version, and configuration file. - - [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) - Provides methods that return information about a specific runtime, including version, directory, and load status. - - [ICLRStrongName Interface](iclrstrongname-interface.md) - Provides basic global static functions for signing assemblies with strong names. All the [ICLRStrongName](iclrstrongname-interface.md) methods return standard COM HRESULTs. - - [ICLRStrongName2 Interface](iclrstrongname2-interface.md) - Provides the ability to create strong names using the SHA-2 group of Secure Hash Algorithms (SHA-256, SHA-384, and SHA-512). - - [ICLRTask2 Interface](iclrtask2-interface.md) - Provides all the functionality of the [ICLRTask Interface](iclrtask-interface.md); in addition, provides methods that allow thread aborts to be delayed on the current thread. - -## Related Sections - - [Deprecated CLR Hosting Interfaces and Coclasses](deprecated-clr-hosting-interfaces-and-coclasses.md) - Describes the hosting interfaces provided with the .NET Framework versions 1.0 and 1.1. - - [CLR Hosting Interfaces](clr-hosting-interfaces.md) - Describes the hosting interfaces provided with the .NET Framework versions 2.0, 3.0, and 3.5. - - [Hosting](index.md) +This section describes interfaces that unmanaged hosts can use to integrate the common language runtime (CLR) in the .NET Framework 4, .NET Framework 4.5, and later versions into their applications. These interfaces provide methods for a host to configure and load the runtime into a process. + + Starting with the .NET Framework 4, all hosting interfaces have the following characteristics: + +- They use lifetime management (`AddRef` and `Release`), encapsulation (implicit context) and `QueryInterface` from COM. + +- They do not use COM types such as `BSTR`, `SAFEARRAY`, or `VARIANT`. + +- There are no apartment models, aggregation, or registry activation that use the [CoCreateInstance function](/windows/win32/api/combaseapi/nf-combaseapi-cocreateinstance). + +## In This Section + + [ICLRAppDomainResourceMonitor Interface](iclrappdomainresourcemonitor-interface.md) + Provides methods that inspect an application domain's memory and CPU usage. + + [ICLRDomainManager Interface](iclrdomainmanager-interface.md) + Enables the host to specify the application domain manager that will be used to initialize the default application domain, and to specify initialization properties. + + [ICLRGCManager2 Interface](iclrgcmanager2-interface.md) + Provides the [SetGCStartupLimitsEx](iclrgcmanager2-setgcstartuplimitsex-method.md) method, which enables a host to set the size of the garbage collection segment and the maximum size of the garbage collection system's generation 0 to values greater than `DWORD`. + + [ICLRMetaHost Interface](iclrmetahost-interface.md) + Provides methods that return a specific version of the CLR, list all installed CLRs, list all in-process runtimes, return the activation interface, and discover the CLR version used to compile an assembly. + + [ICLRMetaHostPolicy Interface](iclrmetahostpolicy-interface.md) + Provides the [GetRequestedRuntime](iclrmetahostpolicy-getrequestedruntime-method.md) method that provides a CLR interface based on policy criteria, managed assembly, version, and configuration file. + + [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) + Provides methods that return information about a specific runtime, including version, directory, and load status. + + [ICLRStrongName Interface](iclrstrongname-interface.md) + Provides basic global static functions for signing assemblies with strong names. All the [ICLRStrongName](iclrstrongname-interface.md) methods return standard COM HRESULTs. + + [ICLRStrongName2 Interface](iclrstrongname2-interface.md) + Provides the ability to create strong names using the SHA-2 group of Secure Hash Algorithms (SHA-256, SHA-384, and SHA-512). + + [ICLRTask2 Interface](iclrtask2-interface.md) + Provides all the functionality of the [ICLRTask Interface](iclrtask-interface.md); in addition, provides methods that allow thread aborts to be delayed on the current thread. + +## Related Sections + + [Deprecated CLR Hosting Interfaces and Coclasses](deprecated-clr-hosting-interfaces-and-coclasses.md) + Describes the hosting interfaces provided with the .NET Framework versions 1.0 and 1.1. + + [CLR Hosting Interfaces](clr-hosting-interfaces.md) + Describes the hosting interfaces provided with the .NET Framework versions 2.0, 3.0, and 3.5. + + [Hosting](index.md) Introduces hosting in the .NET Framework. diff --git a/docs/core/unmanaged-api/hosting/clr-hosting-interfaces.md b/docs/framework/unmanaged-api/hosting/clr-hosting-interfaces.md similarity index 60% rename from docs/core/unmanaged-api/hosting/clr-hosting-interfaces.md rename to docs/framework/unmanaged-api/hosting/clr-hosting-interfaces.md index 04833614f9066..842da1be4ba10 100644 --- a/docs/core/unmanaged-api/hosting/clr-hosting-interfaces.md +++ b/docs/framework/unmanaged-api/hosting/clr-hosting-interfaces.md @@ -2,188 +2,189 @@ description: "Learn more about: CLR Hosting Interfaces" title: "CLR Hosting Interfaces" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - "interfaces [.NET Framework hosting], version 2.0" - "hosting interfaces [.NET Framework], version 2.0" - ".NET Framework 2.0, hosting interfaces" +ms.assetid: 703b8381-43db-4a4d-9faa-cca39302d922 --- # CLR Hosting Interfaces -This section describes the interfaces that unmanaged hosts can use to integrate the common language runtime (CLR) into their applications. The information pertains to the .NET Framework version 2.0 and later versions. These interfaces enable the host to control many more aspects of the runtime than was possible in versions 1.0 and 1.1, and provide much tighter integration between the CLR and the host's execution model. - - In the .NET Framework version 1.0 and 1.1, the hosting model enabled an unmanaged host to load the CLR into a process, to configure certain settings, and to receive event notifications. However, in general, the host and the CLR ran independently in that process. In the .NET Framework version 2.0 and later versions, new layers of abstraction let the host provide many of the resources currently provided by the types in the Win32 assembly, and extend the set of capabilities that the host can configure. - -## In This Section - - [IActionOnCLREvent Interface](iactiononclrevent-interface.md) - Provides a method that performs a callback for a registered event. - - [IApartmentCallback Interface](iapartmentcallback-interface.md) - Provides methods for making callbacks within an apartment. - - [IAppDomainBinding Interface](iappdomainbinding-interface.md) - Provides methods for setting run-time configuration. - - [ICatalogServices Interface](icatalogservices-interface.md) - Provides methods for cataloging services. (This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code.) - - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) - Provides methods that support communication between the host and the CLR about assemblies. - - [ICLRAssemblyReferenceList Interface](iclrassemblyreferencelist-interface.md) - Manages a list of assemblies that are loaded by the CLR and not by the host. - - [ICLRControl Interface](iclrcontrol-interface.md) - Provides methods for the host to gain access to, and configure various aspects of, the CLR. - - [ICLRDebugManager Interface](iclrdebugmanager-interface.md) - Provides methods that enable a host to associate a set of tasks with an identifier and a friendly name. - - [ICLRErrorReportingManager Interface](iclrerrorreportingmanager-interface.md) - Provides methods that enable the host to configure custom heap dumps for error reporting. - - [ICLRGCManager Interface](iclrgcmanager-interface.md) - Provides methods that enable a host to interact with the CLR's garbage collection system. - - [ICLRHostBindingPolicyManager Interface](iclrhostbindingpolicymanager-interface.md) - Provides methods for the host to evaluate and communicate changes in policy information for assemblies. - - [ICLRHostProtectionManager Interface](iclrhostprotectionmanager-interface.md) - Enables the host to block specific managed classes, methods, properties, and fields from running in partially trusted code. - - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) - Implements a callback method that enables the host to notify the CLR of the status of specified I/O requests. - - [ICLRMemoryNotificationCallback Interface](iclrmemorynotificationcallback-interface.md) - Enables the host to report memory pressure conditions using an approach similar to that of the Win32 `CreateMemoryResourceNotification` function. - - [ICLROnEventManager Interface](iclroneventmanager-interface.md) - Provides methods that enable the host to register and unregister callbacks for CLR events. - - [ICLRPolicyManager Interface](iclrpolicymanager-interface.md) - Provides methods that enable the host to specify policy actions to be taken in the event of failures and timeouts. - - [ICLRProbingAssemblyEnum Interface](iclrprobingassemblyenum-interface.md) - Provides methods that enable the host to get the probing identities of an assembly by using the assembly's identity information that is internal to the CLR, without needing to create or understand that identity. - - [ICLRReferenceAssemblyEnum Interface](iclrreferenceassemblyenum-interface.md) - Provides methods that enable the host to manipulate the set of assemblies referenced by a file or stream using assembly identity data that is internal to the CLR, without needing to create or understand those identities. - - [ICLRRuntimeHost Interface](iclrruntimehost-interface.md) - Provides capabilities similar to [ICorRuntimeHost](icorruntimehost-interface.md), with an additional method to set the host control interface. - - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) - Provides methods for the host to get information about requested tasks and to detect deadlocks in its synchronization implementation. - - [ICLRTask Interface](iclrtask-interface.md) - Provides methods that enable the host to make requests of the CLR, or to provide notification to the CLR about the associated task. - - [ICLRTaskManager Interface](iclrtaskmanager-interface.md) - Provides methods that enable the host to request explicitly that the CLR create a new task, get the currently executing task, and set the geographic language and culture for the task. - - [ICLRValidator Interface](iclrvalidator-interface.md) - Provides methods for validating portable executable (PE) images and reporting validation errors. - - [ICorConfiguration Interface](icorconfiguration-interface.md) - Provides methods for configuring the CLR. - - [ICorThreadpool Interface](icorthreadpool-interface.md) - Provides methods for accessing the thread pool. - - [IDebuggerInfo Interface](idebuggerinfo-interface.md) - Provides methods for obtaining information about the state of the debugging services. - - [IDebuggerThreadControl Interface](idebuggerthreadcontrol-interface.md) - Provides methods for notifying the host about the blocking and unblocking of threads by the debugging services. - - [IGCHost Interface](igchost-interface.md) - Provides methods for obtaining information about the garbage collection system and for controlling some aspects of garbage collection. - - [IGCHost2 Interface](igchost2-interface.md) - Provides the [SetGCStartupLimitsEx](igchost2-setgcstartuplimitsex-method.md) method that enables a host to set the size of the garbage collection segment and the maximum size of the garbage collection system's generation zero to values greater than `DWORD`. - - [IGCHostControl Interface](igchostcontrol-interface.md) - Provides a method that enables the garbage collector to request the host to change the limits of virtual memory. - - [IGCThreadControl Interface](igcthreadcontrol-interface.md) - Provides methods for participating in the scheduling of threads that would otherwise be blocked for garbage collection. - - [IHostAssemblyManager Interface](ihostassemblymanager-interface.md) - Provides methods that enable a host to specify sets of assemblies that should be loaded by the CLR or by the host. - - [IHostAssemblyStore Interface](ihostassemblystore-interface.md) - Provides methods that enable a host to load assemblies and modules independently of the CLR. - - [IHostAutoEvent Interface](ihostautoevent-interface.md) - Provides a representation of an auto-reset event implemented by the host. - - [IHostControl Interface](ihostcontrol-interface.md) - Provides methods for configuring the loading of assemblies, and for determining which hosting interfaces the host supports. - - [IHostCrst Interface](ihostcrst-interface.md) - Serves as the host's representation of a critical section for threading. - - [IHostGCManager Interface](ihostgcmanager-interface.md) - Provides methods that notify the host of events in the garbage collection mechanism implemented by the CLR. - - [IHostIoCompletionManager Interface](ihostiocompletionmanager-interface.md) - Provides methods that enable the CLR to interact with I/O completion ports provided by the host. - - [IHostMalloc Interface](ihostmalloc-interface.md) - Provides methods for the CLR to request fine-grained allocations from the heap through the host. - - [IHostManualEvent Interface](ihostmanualevent-interface.md) - Provides the host's implementation of a representation of a manual reset event. - - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) - Provides methods for the CLR to make virtual memory requests through the host, instead of using the standard Win32 virtual memory functions. - - [IHostPolicyManager Interface](ihostpolicymanager-interface.md) - Provides methods that notify the host of the actions the CLR performs in case of aborts, timeouts, or failures. - - [IHostSecurityContext Interface](ihostsecuritycontext-interface.md) - Enables the CLR to maintain security context information implemented by the host. - - [IHostSecurityManager Interface](ihostsecuritymanager-interface.md) - Provides methods that enable access to, and control over, the security context of the currently executing thread. - - [IHostSemaphore Interface](ihostsemaphore-interface.md) - Provides a representation of a semaphore implemented by the host. - - [IHostSyncManager Interface](ihostsyncmanager-interface.md) - Provides methods for the CLR to create synchronization primitives by calling the host, instead of using the Win32 synchronization functions. - - [IHostTask Interface](ihosttask-interface.md) - Provides methods that enable the CLR to communicate with the host to manage tasks. - - [IHostTaskManager Interface](ihosttaskmanager-interface.md) - Provides methods that enable the CLR to work with tasks through the host instead of using the standard operating system threading or fiber functions. - - [IHostThreadPoolManager Interface](ihostthreadpoolmanager-interface.md) - Provides methods for the CLR to configure the thread pool and to queue work items to the thread pool. - - [IManagedObject Interface](imanagedobject-interface.md) - Provides methods for controlling a managed object. - - "IObjectHandle" - Provides a method for unwrapping marshal-by-value objects from indirection. - - [ITypeName Interface](itypename-interface.md) - Provides methods for obtaining type name information. (This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code.) - - [ITypeNameBuilder Interface](itypenamebuilder-interface.md) - Provides methods for building a type name. (This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code.) - - [ITypeNameFactory Interface](itypenamefactory-interface.md) - Provides methods for deconstructing a type name. (This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code.) - - "IValidator" - Provides methods for validating portable executable (PE) images and reporting validation errors. - -## Related Sections - - [Deprecated CLR Hosting Interfaces and Coclasses](deprecated-clr-hosting-interfaces-and-coclasses.md) - Contains topics that describe the hosting interfaces provided in the .NET Framework version 1.0 and 1.1. - - [CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5](clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md) +This section describes the interfaces that unmanaged hosts can use to integrate the common language runtime (CLR) into their applications. The information pertains to the .NET Framework version 2.0 and later versions. These interfaces enable the host to control many more aspects of the runtime than was possible in versions 1.0 and 1.1, and provide much tighter integration between the CLR and the host's execution model. + + In the .NET Framework version 1.0 and 1.1, the hosting model enabled an unmanaged host to load the CLR into a process, to configure certain settings, and to receive event notifications. However, in general, the host and the CLR ran independently in that process. In the .NET Framework version 2.0 and later versions, new layers of abstraction let the host provide many of the resources currently provided by the types in the Win32 assembly, and extend the set of capabilities that the host can configure. + +## In This Section + + [IActionOnCLREvent Interface](iactiononclrevent-interface.md) + Provides a method that performs a callback for a registered event. + + [IApartmentCallback Interface](iapartmentcallback-interface.md) + Provides methods for making callbacks within an apartment. + + [IAppDomainBinding Interface](iappdomainbinding-interface.md) + Provides methods for setting run-time configuration. + + [ICatalogServices Interface](icatalogservices-interface.md) + Provides methods for cataloging services. (This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code.) + + [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) + Provides methods that support communication between the host and the CLR about assemblies. + + [ICLRAssemblyReferenceList Interface](iclrassemblyreferencelist-interface.md) + Manages a list of assemblies that are loaded by the CLR and not by the host. + + [ICLRControl Interface](iclrcontrol-interface.md) + Provides methods for the host to gain access to, and configure various aspects of, the CLR. + + [ICLRDebugManager Interface](iclrdebugmanager-interface.md) + Provides methods that enable a host to associate a set of tasks with an identifier and a friendly name. + + [ICLRErrorReportingManager Interface](iclrerrorreportingmanager-interface.md) + Provides methods that enable the host to configure custom heap dumps for error reporting. + + [ICLRGCManager Interface](iclrgcmanager-interface.md) + Provides methods that enable a host to interact with the CLR's garbage collection system. + + [ICLRHostBindingPolicyManager Interface](iclrhostbindingpolicymanager-interface.md) + Provides methods for the host to evaluate and communicate changes in policy information for assemblies. + + [ICLRHostProtectionManager Interface](iclrhostprotectionmanager-interface.md) + Enables the host to block specific managed classes, methods, properties, and fields from running in partially trusted code. + + [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) + Implements a callback method that enables the host to notify the CLR of the status of specified I/O requests. + + [ICLRMemoryNotificationCallback Interface](iclrmemorynotificationcallback-interface.md) + Enables the host to report memory pressure conditions using an approach similar to that of the Win32 `CreateMemoryResourceNotification` function. + + [ICLROnEventManager Interface](iclroneventmanager-interface.md) + Provides methods that enable the host to register and unregister callbacks for CLR events. + + [ICLRPolicyManager Interface](iclrpolicymanager-interface.md) + Provides methods that enable the host to specify policy actions to be taken in the event of failures and timeouts. + + [ICLRProbingAssemblyEnum Interface](iclrprobingassemblyenum-interface.md) + Provides methods that enable the host to get the probing identities of an assembly by using the assembly's identity information that is internal to the CLR, without needing to create or understand that identity. + + [ICLRReferenceAssemblyEnum Interface](iclrreferenceassemblyenum-interface.md) + Provides methods that enable the host to manipulate the set of assemblies referenced by a file or stream using assembly identity data that is internal to the CLR, without needing to create or understand those identities. + + [ICLRRuntimeHost Interface](iclrruntimehost-interface.md) + Provides capabilities similar to [ICorRuntimeHost](icorruntimehost-interface.md), with an additional method to set the host control interface. + + [ICLRSyncManager Interface](iclrsyncmanager-interface.md) + Provides methods for the host to get information about requested tasks and to detect deadlocks in its synchronization implementation. + + [ICLRTask Interface](iclrtask-interface.md) + Provides methods that enable the host to make requests of the CLR, or to provide notification to the CLR about the associated task. + + [ICLRTaskManager Interface](iclrtaskmanager-interface.md) + Provides methods that enable the host to request explicitly that the CLR create a new task, get the currently executing task, and set the geographic language and culture for the task. + + [ICLRValidator Interface](iclrvalidator-interface.md) + Provides methods for validating portable executable (PE) images and reporting validation errors. + + [ICorConfiguration Interface](icorconfiguration-interface.md) + Provides methods for configuring the CLR. + + [ICorThreadpool Interface](icorthreadpool-interface.md) + Provides methods for accessing the thread pool. + + [IDebuggerInfo Interface](idebuggerinfo-interface.md) + Provides methods for obtaining information about the state of the debugging services. + + [IDebuggerThreadControl Interface](idebuggerthreadcontrol-interface.md) + Provides methods for notifying the host about the blocking and unblocking of threads by the debugging services. + + [IGCHost Interface](igchost-interface.md) + Provides methods for obtaining information about the garbage collection system and for controlling some aspects of garbage collection. + + [IGCHost2 Interface](igchost2-interface.md) + Provides the [SetGCStartupLimitsEx](igchost2-setgcstartuplimitsex-method.md) method that enables a host to set the size of the garbage collection segment and the maximum size of the garbage collection system's generation zero to values greater than `DWORD`. + + [IGCHostControl Interface](igchostcontrol-interface.md) + Provides a method that enables the garbage collector to request the host to change the limits of virtual memory. + + [IGCThreadControl Interface](igcthreadcontrol-interface.md) + Provides methods for participating in the scheduling of threads that would otherwise be blocked for garbage collection. + + [IHostAssemblyManager Interface](ihostassemblymanager-interface.md) + Provides methods that enable a host to specify sets of assemblies that should be loaded by the CLR or by the host. + + [IHostAssemblyStore Interface](ihostassemblystore-interface.md) + Provides methods that enable a host to load assemblies and modules independently of the CLR. + + [IHostAutoEvent Interface](ihostautoevent-interface.md) + Provides a representation of an auto-reset event implemented by the host. + + [IHostControl Interface](ihostcontrol-interface.md) + Provides methods for configuring the loading of assemblies, and for determining which hosting interfaces the host supports. + + [IHostCrst Interface](ihostcrst-interface.md) + Serves as the host's representation of a critical section for threading. + + [IHostGCManager Interface](ihostgcmanager-interface.md) + Provides methods that notify the host of events in the garbage collection mechanism implemented by the CLR. + + [IHostIoCompletionManager Interface](ihostiocompletionmanager-interface.md) + Provides methods that enable the CLR to interact with I/O completion ports provided by the host. + + [IHostMalloc Interface](ihostmalloc-interface.md) + Provides methods for the CLR to request fine-grained allocations from the heap through the host. + + [IHostManualEvent Interface](ihostmanualevent-interface.md) + Provides the host's implementation of a representation of a manual reset event. + + [IHostMemoryManager Interface](ihostmemorymanager-interface.md) + Provides methods for the CLR to make virtual memory requests through the host, instead of using the standard Win32 virtual memory functions. + + [IHostPolicyManager Interface](ihostpolicymanager-interface.md) + Provides methods that notify the host of the actions the CLR performs in case of aborts, timeouts, or failures. + + [IHostSecurityContext Interface](ihostsecuritycontext-interface.md) + Enables the CLR to maintain security context information implemented by the host. + + [IHostSecurityManager Interface](ihostsecuritymanager-interface.md) + Provides methods that enable access to, and control over, the security context of the currently executing thread. + + [IHostSemaphore Interface](ihostsemaphore-interface.md) + Provides a representation of a semaphore implemented by the host. + + [IHostSyncManager Interface](ihostsyncmanager-interface.md) + Provides methods for the CLR to create synchronization primitives by calling the host, instead of using the Win32 synchronization functions. + + [IHostTask Interface](ihosttask-interface.md) + Provides methods that enable the CLR to communicate with the host to manage tasks. + + [IHostTaskManager Interface](ihosttaskmanager-interface.md) + Provides methods that enable the CLR to work with tasks through the host instead of using the standard operating system threading or fiber functions. + + [IHostThreadPoolManager Interface](ihostthreadpoolmanager-interface.md) + Provides methods for the CLR to configure the thread pool and to queue work items to the thread pool. + + [IManagedObject Interface](imanagedobject-interface.md) + Provides methods for controlling a managed object. + + "IObjectHandle" + Provides a method for unwrapping marshal-by-value objects from indirection. + + [ITypeName Interface](itypename-interface.md) + Provides methods for obtaining type name information. (This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code.) + + [ITypeNameBuilder Interface](itypenamebuilder-interface.md) + Provides methods for building a type name. (This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code.) + + [ITypeNameFactory Interface](itypenamefactory-interface.md) + Provides methods for deconstructing a type name. (This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code.) + + "IValidator" + Provides methods for validating portable executable (PE) images and reporting validation errors. + +## Related Sections + + [Deprecated CLR Hosting Interfaces and Coclasses](deprecated-clr-hosting-interfaces-and-coclasses.md) + Contains topics that describe the hosting interfaces provided in the .NET Framework version 1.0 and 1.1. + + [CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5](clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md) Contains topics that describe the hosting interfaces provided in the .NET Framework 4. diff --git a/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md b/docs/framework/unmanaged-api/hosting/clrcreateinstance-function.md similarity index 72% rename from docs/core/unmanaged-api/hosting/clrcreateinstance-function.md rename to docs/framework/unmanaged-api/hosting/clrcreateinstance-function.md index 6b15997f95b40..b2e2760299353 100644 --- a/docs/core/unmanaged-api/hosting/clrcreateinstance-function.md +++ b/docs/framework/unmanaged-api/hosting/clrcreateinstance-function.md @@ -1,6 +1,6 @@ --- -description: "Learn more about: CLRCreateInstance Function (hosting)" -title: "CLRCreateInstance Function for hosting" +description: "Learn more about: CLRCreateInstance Function (.NET Framework)" +title: "CLRCreateInstance Function for .NET Framework" ms.date: "03/30/2017" api_name: - "CLRCreateInstance" @@ -16,12 +16,13 @@ f1_keywords: helpviewer_keywords: - "CLRCreateInstance function [.NET Framework hosting]" - "CreateInterface function" +ms.assetid: 5de13327-96c6-4697-a89e-b8bf40717855 topic_type: - "apiref" --- -# CLRCreateInstance Function (hosting) +# CLRCreateInstance Function (.NET Framework) -Provides one of three interfaces: [ICLRMetaHost](iclrmetahost-interface.md), [ICLRMetaHostPolicy](iclrmetahostpolicy-interface.md), or [ICLRDebugging](../../../framework/unmanaged-api/debugging/iclrdebugging-interface.md). +Provides one of three interfaces: [ICLRMetaHost](iclrmetahost-interface.md), [ICLRMetaHostPolicy](iclrmetahostpolicy-interface.md), or [ICLRDebugging](../debugging/iclrdebugging-interface.md). ## Syntax @@ -42,26 +43,26 @@ HRESULT CLRCreateInstance( [in] One of three interface identifiers (IIDs): IID_ICLRMetaHost, IID_ICLRMetaHostPolicy, or IID_ICLRDebugging. `ppInterface`\ - [out] One of three interfaces: [ICLRMetaHost](iclrmetahost-interface.md), [ICLRMetaHostPolicy](iclrmetahostpolicy-interface.md), or [ICLRDebugging](../../../framework/unmanaged-api/debugging/iclrdebugging-interface.md). + [out] One of three interfaces: [ICLRMetaHost](iclrmetahost-interface.md), [ICLRMetaHostPolicy](iclrmetahostpolicy-interface.md), or [ICLRDebugging](../debugging/iclrdebugging-interface.md). ## 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 | `ppInterface` is null. | +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method completed successfully.| +|E_POINTER|`ppInterface` is null.| ## Remarks The following table shows the supported combinations for `clsid` and `riid`. -| `clsid` | `riid` | -|-------------------------|------------------------| -| CLSID_CLRMetaHost | IID_ICLRMetaHost | -| CLSID_CLRMetaHostPolicy | IID_ICLRMetaHostPolicy | -| CLSID_CLRDebugging | IID_ICLRDebugging | +|`clsid`|`riid`| +|--------------|------------| +|CLSID_CLRMetaHost|IID_ICLRMetaHost| +|CLSID_CLRMetaHostPolicy|IID_ICLRMetaHostPolicy| +|CLSID_CLRDebugging|IID_ICLRDebugging| The following code shows how to use `CLRCreateInstance` to get all three interfaces: @@ -94,13 +95,13 @@ hr = createInterface (CLSID_CLRDebugging, IID_ICLRDebugging, (LPVOID*)&pCLRDebu ## Requirements - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). **Header:** MetaHost.h **Library:** Included as a resource in MSCorEE.dll - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + **.NET Framework Versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] ## See also diff --git a/docs/core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md b/docs/framework/unmanaged-api/hosting/clrcreatemanagedinstance-function.md similarity index 62% rename from docs/core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md rename to docs/framework/unmanaged-api/hosting/clrcreatemanagedinstance-function.md index ff6eed095032b..896a6065d2e2d 100644 --- a/docs/core/unmanaged-api/hosting/clrcreatemanagedinstance-function.md +++ b/docs/framework/unmanaged-api/hosting/clrcreatemanagedinstance-function.md @@ -2,64 +2,65 @@ description: "Learn more about: ClrCreateManagedInstance Function" title: "ClrCreateManagedInstance Function" ms.date: "03/30/2017" -api_name: +api_name: - "ClrCreateManagedInstance" -api_location: +api_location: - "mscoree.dll" - "clr.dll" - "mscorwks.dll" - "mscoreei.dll" - "mscorsvr.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "ClrCreateManagedInstance" -helpviewer_keywords: +helpviewer_keywords: - "ClrCreateManagedInstance function [.NET Framework hosting]" -topic_type: +ms.assetid: 58ba42c0-4857-43bf-a039-73a4dc6544c2 +topic_type: - "apiref" --- # ClrCreateManagedInstance Function -Creates an instance of the specified managed type. - - This function has been deprecated in the .NET Framework 4. Use COM activation to create an instance of the managed type, or use hosting (see [CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5](clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md)). - -## Syntax - -```cpp -STDAPI ClrCreateManagedInstance ( +Creates an instance of the specified managed type. + + This function has been deprecated in the .NET Framework 4. Use COM activation to create an instance of the managed type, or use hosting (see [CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5](clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md)). + +## Syntax + +```cpp +STDAPI ClrCreateManagedInstance ( [in] LPCWSTR pTypeName, [in] REFIID riid, - [out] void **ppObject -); -``` - -## Parameters - - `pTypeName` - [in] A pointer to the name of the instance type being requested. - - `riid` - [in] The `IID` of the instance type being requested. - - `ppObject` - [out] A pointer to a pointer to an instance of the managed type that was requested by the caller. - -## Remarks - - The common language runtime should already be loaded into a process. For example, it can be loaded by using a call to the [CorBindToRuntimeEx](corbindtoruntimeex-function.md) function before the `ClrCreateManagedInstance` function is called. If the runtime is not loaded, `ClrCreateManagedInstance` first tries to load v1.0.3705 of the runtime. If that fails, it attempts to load the latest version of the runtime. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 1.0 - + [out] void **ppObject +); +``` + +## Parameters + + `pTypeName` + [in] A pointer to the name of the instance type being requested. + + `riid` + [in] The `IID` of the instance type being requested. + + `ppObject` + [out] A pointer to a pointer to an instance of the managed type that was requested by the caller. + +## Remarks + + The common language runtime should already be loaded into a process. For example, it can be loaded by using a call to the [CorBindToRuntimeEx](corbindtoruntimeex-function.md) function before the `ClrCreateManagedInstance` function is called. If the runtime is not loaded, `ClrCreateManagedInstance` first tries to load v1.0.3705 of the runtime. If that fails, it attempts to load the latest version of the runtime. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/clrruntimehost-coclass.md b/docs/framework/unmanaged-api/hosting/clrruntimehost-coclass.md new file mode 100644 index 0000000000000..c041c0e714b51 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/clrruntimehost-coclass.md @@ -0,0 +1,51 @@ +--- +description: "Learn more about: CLRRuntimeHost Coclass" +title: "CLRRuntimeHost Coclass" +ms.date: "03/30/2017" +api_name: + - "CLRRuntimeHost Coclass" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CLRRuntimeHost" +helpviewer_keywords: + - "CLRRuntimeHost coclass [.NET Framework hosting]" +ms.assetid: 2ac9cbf5-8a2d-4e4f-8831-0dad8ef0a897 +topic_type: + - "apiref" +--- +# CLRRuntimeHost Coclass + +Provides interfaces for managing code execution by the runtime. + +## Syntax + +```cpp +coclass CLRRuntimeHost { + [default] interface ICLRRuntimeHost; + interface ICLRValidator; +}; +``` + +## Interfaces + +|Interface|Description| +|---------------|-----------------| +|[ICLRRuntimeHost Interface](iclrruntimehost-interface.md)|Provides methods for controlling the execution of applications by the runtime.| +|[ICLRValidator Interface](iclrvalidator-interface.md)|Provides methods for validation of portable executable images and for detailed reporting of validation errors.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.idl + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + +## See also + +- [Hosting Coclasses](hosting-coclasses.md) diff --git a/docs/framework/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md b/docs/framework/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md new file mode 100644 index 0000000000000..dfe9acb2b1345 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/clsid-resolution-flags-enumeration.md @@ -0,0 +1,49 @@ +--- +description: "Learn more about: CLSID_RESOLUTION_FLAGS Enumeration" +title: "CLSID_RESOLUTION_FLAGS Enumeration" +ms.date: "03/30/2017" +api_name: + - "CLSID_RESOLUTION_FLAGS" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CLSID_RESOLUTION_FLAGS" +helpviewer_keywords: + - "CLSID_RESOLUTION_FLAGS enumeration [.NET Framework hosting]" +ms.assetid: cd8b9879-962a-4811-aa46-2e2b6bae0d84 +topic_type: + - "apiref" +--- +# CLSID_RESOLUTION_FLAGS Enumeration + +Contains values that indicate how the common language runtime (CLR) should resolve a `CLSID`. + +## Syntax + +```cpp +typedef enum { + CLSID_RESOLUTION_DEFAULT = 0x0, + CLSID_RESOLUTION_REGISTERED = 0x1 +} CLSID_RESOLUTION_FLAGS; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`CLSID_RESOLUTION_DEFAULT`|Indicates the default behavior.| +|`CLSID_RESOLUTION_REGISTERED`|Indicates that the runtime searches the registry and applies shim policy.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **.NET Framework Versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] + +## See also + +- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md b/docs/framework/unmanaged-api/hosting/coeeshutdowncom-function.md similarity index 65% rename from docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md rename to docs/framework/unmanaged-api/hosting/coeeshutdowncom-function.md index 018e3bad0bfd5..c44b17e3cdf88 100644 --- a/docs/core/unmanaged-api/hosting/coeeshutdowncom-function.md +++ b/docs/framework/unmanaged-api/hosting/coeeshutdowncom-function.md @@ -2,52 +2,53 @@ 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]" -topic_type: +ms.assetid: b634cae2-632f-4737-9be4-92d0652844d7 +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](../../../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 - +> 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) diff --git a/docs/core/unmanaged-api/hosting/coinitializecor-function.md b/docs/framework/unmanaged-api/hosting/coinitializecor-function.md similarity index 60% rename from docs/core/unmanaged-api/hosting/coinitializecor-function.md rename to docs/framework/unmanaged-api/hosting/coinitializecor-function.md index 443f65c05f93e..f48cf805b3d79 100644 --- a/docs/core/unmanaged-api/hosting/coinitializecor-function.md +++ b/docs/framework/unmanaged-api/hosting/coinitializecor-function.md @@ -2,40 +2,41 @@ 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]" -topic_type: +ms.assetid: 9b9079fb-579e-4141-b3f0-791072dd40dc +topic_type: - "apiref" --- # CoInitializeCor Function -`CoInitializeCor` is obsolete. - -## Syntax - -```cpp -STDAPI CoInitializeCor ( - DWORD fFlags -); -``` - -## Remarks - - To initialize the common language runtime, use either [CorBindToRuntimeEx](corbindtoruntimeex-function.md) or [CorBindToCurrentRuntime](corbindtocurrentruntime-function.md). - -## Requirements - - **Header:** Cor.h - +`CoInitializeCor` is obsolete. + +## Syntax + +```cpp +STDAPI CoInitializeCor ( + DWORD fFlags +); +``` + +## Remarks + + To initialize the common language runtime, use either [CorBindToRuntimeEx](corbindtoruntimeex-function.md) or [CorBindToCurrentRuntime](corbindtocurrentruntime-function.md). + +## Requirements + + **Header:** Cor.h + ## See also - [Metadata Global Static Functions](../metadata/metadata-global-static-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/coinitializeee-function.md b/docs/framework/unmanaged-api/hosting/coinitializeee-function.md new file mode 100644 index 0000000000000..a862de2ae0256 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/coinitializeee-function.md @@ -0,0 +1,63 @@ +--- +description: "Learn more about: CoInitializeEE Function" +title: "CoInitializeEE Function" +ms.date: "03/30/2017" +api_name: + - "CoInitializeEE" +api_location: + - "mscoree.dll" + - "mscorsvr.dll" +api_type: + - "DLLExport" +f1_keywords: + - "CoInitializeEE" +helpviewer_keywords: + - "CoInitializeEE function [.NET Framework hosting]" +ms.assetid: 7e42a928-5068-4ba6-b8c3-806551a01fa8 +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) diff --git a/docs/framework/unmanaged-api/hosting/comcallunmarshal-coclass.md b/docs/framework/unmanaged-api/hosting/comcallunmarshal-coclass.md new file mode 100644 index 0000000000000..6bd1331a43155 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/comcallunmarshal-coclass.md @@ -0,0 +1,49 @@ +--- +description: "Learn more about: ComCallUnmarshal Coclass" +title: "ComCallUnmarshal Coclass" +ms.date: "03/30/2017" +api_name: + - "ComCallUnmarshal Coclass" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ComCallUnmarshal" +helpviewer_keywords: + - "ComCallUnmarshal coclass [.NET Framework hosting]" +ms.assetid: 2adb5827-2268-4914-a1c6-f62b61880a45 +topic_type: + - "apiref" +--- +# ComCallUnmarshal Coclass + +Provides interfaces for managing the marshalling of interface pointers. + +## Syntax + +```cpp +coclass ComCallUnmarshal { + [default] interface IMarshal; +}; +``` + +## Interfaces + +|Interface|Description| +|---------------|-----------------| +|`IMarshal`|Provides methods for creating, initializing, and managing a proxy in a client process.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.idl + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + +## See also + +- [Hosting Coclasses](hosting-coclasses.md) diff --git a/docs/framework/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md b/docs/framework/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md new file mode 100644 index 0000000000000..ab1f264201edb --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/cor-gc-stat-types-enumeration.md @@ -0,0 +1,54 @@ +--- +description: "Learn more about: COR_GC_STAT_TYPES Enumeration" +title: "COR_GC_STAT_TYPES Enumeration" +ms.date: "03/30/2017" +api_name: + - "COR_GC_STAT_TYPES" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "COR_GC_STAT_TYPES" +helpviewer_keywords: + - "COR_GC_STAT_TYPES enumeration [.NET Framework hosting]" +ms.assetid: fc51d6db-f7f8-408b-b93d-c166fc712c99 +topic_type: + - "apiref" +--- +# COR_GC_STAT_TYPES Enumeration + +Specifies the statistics to be recorded for a garbage collection. + +## Syntax + +```cpp +typedef enum { + COR_GC_COUNTS = 0x00000001 + COR_GC_MEMORYUSAGE = 0x00000002 +} COR_GC_STAT_TYPES; +``` + +## Remarks + + This enumeration specifies which statistics in the [COR_GC_STATS](cor-gc-stats-structure.md) structure are to be set by [ICLRGCManager::GetStats](iclrgcmanager-getstats-method.md) method. + +## Members + +|Member|Description| +|------------|-----------------| +|`COR_GC_COUNTS`|Records the number of garbage collections performed for each generation.| +|`COR_GC_MEMORYUSAGE`|Records memory usage and garbage collection size statistics.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** GCHost.idl, GCHost.h + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + +## See also + +- [COR_GC_STATS Structure](cor-gc-stats-structure.md) +- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md b/docs/framework/unmanaged-api/hosting/cor-gc-stats-structure.md similarity index 56% rename from docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md rename to docs/framework/unmanaged-api/hosting/cor-gc-stats-structure.md index fbab9113226b8..115771810ef12 100644 --- a/docs/core/unmanaged-api/hosting/cor-gc-stats-structure.md +++ b/docs/framework/unmanaged-api/hosting/cor-gc-stats-structure.md @@ -2,85 +2,86 @@ description: "Learn more about: COR_GC_STATS Structure" title: "COR_GC_STATS Structure" ms.date: "03/30/2017" -api_name: +api_name: - "COR_GC_STATS" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "COR_GC_STATS" -helpviewer_keywords: +helpviewer_keywords: - "COR_GC_STATS structure [.NET Framework hosting]" -topic_type: +ms.assetid: 8d4ff73e-739b-40f6-9349-359fbc99c2f9 +topic_type: - "apiref" --- # COR_GC_STATS Structure -Provides statistics about the garbage collection mechanism of the common language runtime (CLR). - -## Syntax - -```cpp -typedef struct _COR_GC_STATS { +Provides statistics about the garbage collection mechanism of the common language runtime (CLR). + +## Syntax + +```cpp +typedef struct _COR_GC_STATS { ULONG Flags; - SIZE_T ExplicitGCCount; - SIZE_T GenCollectionsTaken[3]; + SIZE_T ExplicitGCCount; + SIZE_T GenCollectionsTaken[3]; SIZE_T CommittedKBytes; - SIZE_T ReservedKBytes; - SIZE_T Gen0HeapSizeKBytes; - SIZE_T Gen1HeapSizeKBytes; - SIZE_T Gen2HeapSizeKBytes; - SIZE_T LargeObjectHeapSizeKBytes; - SIZE_T KBytesPromotedFromGen0; - SIZE_T KBytesPromotedFromGen1; -} COR_GC_STATS; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`Flags`|Indicates which field values should be calculated and returned.| -|`ExplicitGCCount`|Indicates the number of garbage collections that were forced by external request.| -|`GenCollectionsTaken`|Indicates the number of garbage collections performed for each generation.| -|`CommittedKBytes`|The total number of kilobytes committed in all heaps.| -|`ReservedKBytes`|The total number of kilobytes reserved in all heaps.| -|`Gen0HeapSizeKBytes`|The size, in kilobytes, of the generation-zero heap.| -|`Gen1HeapSizeKBytes`|The size, in kilobytes, of the generation-one heap.| -|`Gen2HeapSizeKBytes`|The size, in kilobytes, of the generation-two heap.| -|`LargeObjectHeapSizeKBytes`|The size, in kilobytes, of the large object heap.| -|`KBytesPromotedFromGen0`|The size, in kilobytes, of the objects promoted from generation zero to generation one.| -|`KBytesPromotedFromGen1`|The size, in kilobytes, of the objects promoted from generation one to generation two.| - -## Remarks - - The [ICLRGCManager::GetStats](iclrgcmanager-getstats-method.md) method requires the `Flags` field of the `COR_GC_STATS` structure to be set to one or more values of the [COR_GC_STAT_TYPES](cor-gc-stat-types-enumeration.md) enumeration to specify which statistics are to be set. - - The following table maps the statistics provided by this structure to the two [COR_GC_STAT_TYPES](cor-gc-stat-types-enumeration.md) enumeration values, `COR_GC_COUNTS` and `COR_GC_MEMORYUSAGE`. - -|Specified by COR_GC_COUNTS|Specified by COR_GC_MEMORYUSAGE| -|----------------------------------|---------------------------------------| -|`ExplicitGCCount`

`GenCollectionsTaken`|`CommittedKBytes`

`ReservedKBytes`

`Gen0HeapSizeKBytes`

`Gen1HeapSizeKBytes`

`Gen2HeapSizeKBytes`

`LargeObjectHeapSizeKBytes`

`KBytesPromotedFromGen0`

`KBytesPromotedFromGen1`| - - An example of the usage is as follows: - -```cpp -COR_GC_STATS GCStats; -GCStats.Flags = COR_GC_COUNTS | COR_GC_MEMORYUSAGE; -pCLRGCManager->GetStats(&GCStats); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** Available since .NET Framework 1.0 - + SIZE_T ReservedKBytes; + SIZE_T Gen0HeapSizeKBytes; + SIZE_T Gen1HeapSizeKBytes; + SIZE_T Gen2HeapSizeKBytes; + SIZE_T LargeObjectHeapSizeKBytes; + SIZE_T KBytesPromotedFromGen0; + SIZE_T KBytesPromotedFromGen1; +} COR_GC_STATS; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`Flags`|Indicates which field values should be calculated and returned.| +|`ExplicitGCCount`|Indicates the number of garbage collections that were forced by external request.| +|`GenCollectionsTaken`|Indicates the number of garbage collections performed for each generation.| +|`CommittedKBytes`|The total number of kilobytes committed in all heaps.| +|`ReservedKBytes`|The total number of kilobytes reserved in all heaps.| +|`Gen0HeapSizeKBytes`|The size, in kilobytes, of the generation-zero heap.| +|`Gen1HeapSizeKBytes`|The size, in kilobytes, of the generation-one heap.| +|`Gen2HeapSizeKBytes`|The size, in kilobytes, of the generation-two heap.| +|`LargeObjectHeapSizeKBytes`|The size, in kilobytes, of the large object heap.| +|`KBytesPromotedFromGen0`|The size, in kilobytes, of the objects promoted from generation zero to generation one.| +|`KBytesPromotedFromGen1`|The size, in kilobytes, of the objects promoted from generation one to generation two.| + +## Remarks + + The [ICLRGCManager::GetStats](iclrgcmanager-getstats-method.md) method requires the `Flags` field of the `COR_GC_STATS` structure to be set to one or more values of the [COR_GC_STAT_TYPES](cor-gc-stat-types-enumeration.md) enumeration to specify which statistics are to be set. + + The following table maps the statistics provided by this structure to the two [COR_GC_STAT_TYPES](cor-gc-stat-types-enumeration.md) enumeration values, `COR_GC_COUNTS` and `COR_GC_MEMORYUSAGE`. + +|Specified by COR_GC_COUNTS|Specified by COR_GC_MEMORYUSAGE| +|----------------------------------|---------------------------------------| +|`ExplicitGCCount`

`GenCollectionsTaken`|`CommittedKBytes`

`ReservedKBytes`

`Gen0HeapSizeKBytes`

`Gen1HeapSizeKBytes`

`Gen2HeapSizeKBytes`

`LargeObjectHeapSizeKBytes`

`KBytesPromotedFromGen0`

`KBytesPromotedFromGen1`| + + An example of the usage is as follows: + +```cpp +COR_GC_STATS GCStats; +GCStats.Flags = COR_GC_COUNTS | COR_GC_MEMORYUSAGE; +pCLRGCManager->GetStats(&GCStats); +``` + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** GCHost.idl + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also - [Hosting Structures](hosting-structures.md) diff --git a/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md b/docs/framework/unmanaged-api/hosting/cor-gc-thread-stats-structure.md similarity index 52% rename from docs/core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md rename to docs/framework/unmanaged-api/hosting/cor-gc-thread-stats-structure.md index aecbc1ed584f1..02b46225229ee 100644 --- a/docs/core/unmanaged-api/hosting/cor-gc-thread-stats-structure.md +++ b/docs/framework/unmanaged-api/hosting/cor-gc-thread-stats-structure.md @@ -2,53 +2,54 @@ description: "Learn more about: COR_GC_THREAD_STATS Structure" title: "COR_GC_THREAD_STATS Structure" ms.date: "03/30/2017" -api_name: +api_name: - "COR_GC_THREAD_STATS" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "COR_GC_THREAD_STATS" -helpviewer_keywords: +helpviewer_keywords: - "COR_GC_THREAD_STATS structure [.NET Framework hosting]" -topic_type: +ms.assetid: 01f9a59b-7679-4d42-9ced-4a8981625c3d +topic_type: - "apiref" --- # COR_GC_THREAD_STATS Structure -Contains per-thread statistics pertaining to garbage collection. - -## Syntax - -```cpp -typedef struct _COR_GC_THREAD_STATS { +Contains per-thread statistics pertaining to garbage collection. + +## Syntax + +```cpp +typedef struct _COR_GC_THREAD_STATS { ULONGLONG PerThreadAllocation; ULONG Flags; -} COR_GC_THREAD_STATS; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`PerThreadAllocation`|The number of bytes of memory allocated on the thread that is associated with the current `COR_GC_THREAD_STATS` instance. This number is cleared to zero each time a generation-zero garbage collection occurs.| -|`Flags`|The number of bytes promoted to a higher generation at the most recent garbage collection.| - -## Remarks - - [ICLRTask::GetMemStats](iclrtask-getmemstats-method.md) takes an output parameter of type `COR_GC_THREAD_STATS`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** Available since .NET Framework 1.0 - +} COR_GC_THREAD_STATS; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`PerThreadAllocation`|The number of bytes of memory allocated on the thread that is associated with the current `COR_GC_THREAD_STATS` instance. This number is cleared to zero each time a generation-zero garbage collection occurs.| +|`Flags`|The number of bytes promoted to a higher generation at the most recent garbage collection.| + +## Remarks + + [ICLRTask::GetMemStats](iclrtask-getmemstats-method.md) takes an output parameter of type `COR_GC_THREAD_STATS`. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** GCHost.idl + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also - [Hosting Structures](hosting-structures.md) diff --git a/docs/framework/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md b/docs/framework/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md new file mode 100644 index 0000000000000..3953288aa843a --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/cor-gc-thread-stats-types-enumeration.md @@ -0,0 +1,47 @@ +--- +description: "Learn more about: COR_GC_THREAD_STATS_TYPES Enumeration" +title: "COR_GC_THREAD_STATS_TYPES Enumeration" +ms.date: "03/30/2017" +api_name: + - "COR_GC_THREAD_STATS_TYPES" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "COR_GC_THREAD_STATS_TYPES" +helpviewer_keywords: + - "COR_GC_THREAD_STATS_TYPES enumeration [.NET Framework hosting]" +ms.assetid: aa227704-0ab1-4b08-aee2-1f439762162e +topic_type: + - "apiref" +--- +# COR_GC_THREAD_STATS_TYPES Enumeration + +Indicates the garbage collection statistics for a thread. + +## Syntax + +```cpp +typedef enum { + COR_GC_THREAD_HAS_PROMOTED_BYTES = 0x00000001 +} COR_GC_THREAD_STATS_TYPES; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`COR_GC_THREAD_HAS_PROMOTED_BYTES`|The thread has bytes that were promoted in the most recent garbage collection.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** GCHost.idl, GCHost.h + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + +## See also + +- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/corbindtocurrentruntime-function.md b/docs/framework/unmanaged-api/hosting/corbindtocurrentruntime-function.md similarity index 60% rename from docs/core/unmanaged-api/hosting/corbindtocurrentruntime-function.md rename to docs/framework/unmanaged-api/hosting/corbindtocurrentruntime-function.md index 7e0a8caf91b5b..af90f77be1983 100644 --- a/docs/core/unmanaged-api/hosting/corbindtocurrentruntime-function.md +++ b/docs/framework/unmanaged-api/hosting/corbindtocurrentruntime-function.md @@ -2,65 +2,66 @@ description: "Learn more about: CorBindToCurrentRuntime Function" title: "CorBindToCurrentRuntime Function" ms.date: "03/30/2017" -api_name: +api_name: - "CorBindToCurrentRuntime" -api_location: +api_location: - "mscoree.dll" - "mscoreei.dll" -api_type: +api_type: - "HeaderDef" -f1_keywords: +f1_keywords: - "CorBindToCurrentRuntime" -helpviewer_keywords: +helpviewer_keywords: - "CorBindToCurrentRuntime function [.NET Framework hosting]" -topic_type: +ms.assetid: 6105c13e-d9cd-44d2-a95a-924e042830c7 +topic_type: - "apiref" --- # CorBindToCurrentRuntime Function -Loads the common language runtime (CLR) into a process by using version information stored in an XML file. The format of the XML file is modeled after the standard application configuration file. For more information about configuration files, see [Configuration File Schema](../../../framework/configure-apps/file-schema/index.md). - - This function has been deprecated in the .NET Framework 4. See [Loading the Common Language Runtime into a Process](/previous-versions/dotnet/netframework-4.0/01918c6x(v=vs.100)). - -## Syntax - -```cpp -HRESULT CorBindToCurrentRuntime ( - [in] LPCWSTR pwszFileName, - [in] REFCLSID rclsid, - [in] REFIID riid, - [out] LPVOID *ppv -); -``` - -## Parameters - - `pwszFileName` - [in] The name of an application configuration file that specifies the version of the CLR to load. If the file name is not fully qualified, it is assumed to be in the same directory as the executable making the call. - - The version of the runtime to be loaded is described by the version attribute in the [\](../../../framework/configure-apps/file-schema/startup/requiredruntime-element.md) element of the configuration file. - - If no version is specified, or if the `` element cannot be found, the latest version of the CLR that is installed on the machine is loaded. - - `rclsid` - [in] The `CLSID` of the coclass that implements either the [ICorRuntimeHost](icorruntimehost-interface.md) or the [ICLRRuntimeHost](iclrruntimehost-interface.md) interface. Supported values are CLSID_CorRuntimeHost or CLSID_CLRRuntimeHost. - - `riid` - [in] The `IID` of the interface you are requesting. Supported values are IID_ICorRuntimeHost or IID_ICLRRuntimeHost. - - `ppv` - [out] The returned interface pointer. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 1.0 - +Loads the common language runtime (CLR) into a process by using version information stored in an XML file. The format of the XML file is modeled after the standard application configuration file. For more information about configuration files, see [Configuration File Schema](../../configure-apps/file-schema/index.md). + + This function has been deprecated in the .NET Framework 4. See [Loading the Common Language Runtime into a Process](/previous-versions/dotnet/netframework-4.0/01918c6x(v=vs.100)). + +## Syntax + +```cpp +HRESULT CorBindToCurrentRuntime ( + [in] LPCWSTR pwszFileName, + [in] REFCLSID rclsid, + [in] REFIID riid, + [out] LPVOID *ppv +); +``` + +## Parameters + + `pwszFileName` + [in] The name of an application configuration file that specifies the version of the CLR to load. If the file name is not fully qualified, it is assumed to be in the same directory as the executable making the call. + + The version of the runtime to be loaded is described by the version attribute in the [\](../../configure-apps/file-schema/startup/requiredruntime-element.md) element of the configuration file. + + If no version is specified, or if the `` element cannot be found, the latest version of the CLR that is installed on the machine is loaded. + + `rclsid` + [in] The `CLSID` of the coclass that implements either the [ICorRuntimeHost](icorruntimehost-interface.md) or the [ICLRRuntimeHost](iclrruntimehost-interface.md) interface. Supported values are CLSID_CorRuntimeHost or CLSID_CLRRuntimeHost. + + `riid` + [in] The `IID` of the interface you are requesting. Supported values are IID_ICorRuntimeHost or IID_ICLRRuntimeHost. + + `ppv` + [out] The returned interface pointer. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also - [CorBindToRuntime Function](corbindtoruntime-function.md) diff --git a/docs/core/unmanaged-api/hosting/corbindtoruntime-function.md b/docs/framework/unmanaged-api/hosting/corbindtoruntime-function.md similarity index 74% rename from docs/core/unmanaged-api/hosting/corbindtoruntime-function.md rename to docs/framework/unmanaged-api/hosting/corbindtoruntime-function.md index 3975c5d6b0299..4cc10d40370b6 100644 --- a/docs/core/unmanaged-api/hosting/corbindtoruntime-function.md +++ b/docs/framework/unmanaged-api/hosting/corbindtoruntime-function.md @@ -2,95 +2,96 @@ description: "Learn more about: CorBindToRuntime Function" title: "CorBindToRuntime Function" ms.date: "03/30/2017" -api_name: +api_name: - "CorBindToRuntime" -api_location: +api_location: - "mscoree.dll" - "mscoreei.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "CorBindToRuntime" -helpviewer_keywords: +helpviewer_keywords: - "CorBindToRuntime function [.NET Framework hosting]" -topic_type: +ms.assetid: 799740aa-46ec-4532-95da-6444565b4971 +topic_type: - "apiref" --- # CorBindToRuntime Function -Enables unmanaged hosts to load the common language runtime (CLR) into a process. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT CorBindToRuntime ( +Enables unmanaged hosts to load the common language runtime (CLR) into a process. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT CorBindToRuntime ( [in] LPCWSTR pwszVersion, [in] LPCWSTR pwszBuildFlavor, [in] REFCLSID rclsid, [in] REFIID riid, - [out] LPVOID FAR *ppv -); -``` - -## Parameters - - `pwszVersion` - [in] A string describing the version of the CLR you want to load. - - A version number in the .NET Framework consists of four parts separated by periods: *major.minor.build.revision*. The string passed as `pwszVersion` must start with the character "v" followed by the first three parts of the version number (for example, "v1.0.1529"). - - Some versions of the CLR are installed with a policy statement that specifies compatibility with previous versions of the CLR. By default, the startup shim evaluates `pwszVersion` against policy statements and loads the latest version of the runtime that is compatible with the version being requested. A host can force the shim to skip policy evaluation and load the exact version specified in `pwszVersion` by passing a value of `STARTUP_LOADER_SAFEMODE` for the `flags` parameter, as described below. - - If the caller specifies null for `pwszVersion`, the latest version of the runtime is loaded. Passing null gives the host no control over which version of the runtime is loaded. Although this approach may be appropriate in some scenarios, it is strongly recommended that the host supply a specific version to load. - - `pwszBuildFlavor` - [in] A string that specifies whether to load the server or the workstation build of the CLR. Valid values are `svr` and `wks`. The server build is optimized to take advantage of multiple processors for garbage collections, and the workstation build is optimized for client applications running on a single-processor machine. - - If `pwszBuildFlavor` is set to null, the workstation build is loaded. When running on a single-processor machine, the workstation build is always loaded, even if `pwszBuildFlavor` is set to `svr`. However, if `pwszBuildFlavor` is set to `svr` and concurrent garbage collection is specified (see the description of the `flags` parameter), the server build is loaded. - - `rclsid` - [in] The `CLSID` of the coclass that implements either the [ICorRuntimeHost](icorruntimehost-interface.md) or the [ICLRRuntimeHost](iclrruntimehost-interface.md) interface. Supported values are CLSID_CorRuntimeHost or CLSID_CLRRuntimeHost. - - `riid` - [in] The `IID` of the requested interface from `rclsid`. Supported values are IID_ICorRuntimeHost or IID_ICLRRuntimeHost. - - `ppv` - [out] The returned interface pointer to `riid`. - -## Remarks - - If `pwszVersion` specifies a runtime version that does not exist, `CorBindToRuntimeEx` returns an HRESULT value of CLR_E_SHIM_RUNTIMELOAD. - - [CorBindToRuntimeEx](corbindtoruntimeex-function.md) and `CorBindToRuntime` perform the same operation, but the `CorBindToRuntimeEx` function allows you to set flags to specify the behavior of the CLR. - -## Execution Context and Flow of Windows Identity - - In version 1 of the CLR, the object does not flow across asynchronous points such as new threads, thread pools, or timer callbacks. In version 2.0 of the CLR, an object wraps some information about the currently executing thread and flows it across any asynchronous point, but not across application domain boundaries. Similarly, the object also flows across any asynchronous point. Therefore, the current impersonation on the thread, if any, flows too. - - You can alter the flow in two ways: - -1. By modifying the settings to suppress the flow on a per-thread basis (see the , , and methods). - -2. By changing the process default mode to the version 1 compatibility mode, where the object does not flow across any asynchronous point, regardless of the settings on the current thread. How you change the default mode depends on whether you use a managed executable or an unmanaged hosting interface to load the CLR: - - 1. For managed executables, you must set the `enabled` attribute of the [\](../../../framework/configure-apps/file-schema/runtime/legacyimpersonationpolicy-element.md) element to `true`. - - 2. For unmanaged hosting interfaces, set the `STARTUP_LEGACY_IMPERSONATION` flag in the `flags` parameter when calling the `CorBindToRuntimeEx` function. - - The version 1 compatibility mode applies to the entire process and to all the application domains in the process. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 1.0 - + [out] LPVOID FAR *ppv +); +``` + +## Parameters + + `pwszVersion` + [in] A string describing the version of the CLR you want to load. + + A version number in the .NET Framework consists of four parts separated by periods: *major.minor.build.revision*. The string passed as `pwszVersion` must start with the character "v" followed by the first three parts of the version number (for example, "v1.0.1529"). + + Some versions of the CLR are installed with a policy statement that specifies compatibility with previous versions of the CLR. By default, the startup shim evaluates `pwszVersion` against policy statements and loads the latest version of the runtime that is compatible with the version being requested. A host can force the shim to skip policy evaluation and load the exact version specified in `pwszVersion` by passing a value of `STARTUP_LOADER_SAFEMODE` for the `flags` parameter, as described below. + + If the caller specifies null for `pwszVersion`, the latest version of the runtime is loaded. Passing null gives the host no control over which version of the runtime is loaded. Although this approach may be appropriate in some scenarios, it is strongly recommended that the host supply a specific version to load. + + `pwszBuildFlavor` + [in] A string that specifies whether to load the server or the workstation build of the CLR. Valid values are `svr` and `wks`. The server build is optimized to take advantage of multiple processors for garbage collections, and the workstation build is optimized for client applications running on a single-processor machine. + + If `pwszBuildFlavor` is set to null, the workstation build is loaded. When running on a single-processor machine, the workstation build is always loaded, even if `pwszBuildFlavor` is set to `svr`. However, if `pwszBuildFlavor` is set to `svr` and concurrent garbage collection is specified (see the description of the `flags` parameter), the server build is loaded. + + `rclsid` + [in] The `CLSID` of the coclass that implements either the [ICorRuntimeHost](icorruntimehost-interface.md) or the [ICLRRuntimeHost](iclrruntimehost-interface.md) interface. Supported values are CLSID_CorRuntimeHost or CLSID_CLRRuntimeHost. + + `riid` + [in] The `IID` of the requested interface from `rclsid`. Supported values are IID_ICorRuntimeHost or IID_ICLRRuntimeHost. + + `ppv` + [out] The returned interface pointer to `riid`. + +## Remarks + + If `pwszVersion` specifies a runtime version that does not exist, `CorBindToRuntimeEx` returns an HRESULT value of CLR_E_SHIM_RUNTIMELOAD. + + [CorBindToRuntimeEx](corbindtoruntimeex-function.md) and `CorBindToRuntime` perform the same operation, but the `CorBindToRuntimeEx` function allows you to set flags to specify the behavior of the CLR. + +## Execution Context and Flow of Windows Identity + + In version 1 of the CLR, the object does not flow across asynchronous points such as new threads, thread pools, or timer callbacks. In version 2.0 of the CLR, an object wraps some information about the currently executing thread and flows it across any asynchronous point, but not across application domain boundaries. Similarly, the object also flows across any asynchronous point. Therefore, the current impersonation on the thread, if any, flows too. + + You can alter the flow in two ways: + +1. By modifying the settings to suppress the flow on a per-thread basis (see the , , and methods). + +2. By changing the process default mode to the version 1 compatibility mode, where the object does not flow across any asynchronous point, regardless of the settings on the current thread. How you change the default mode depends on whether you use a managed executable or an unmanaged hosting interface to load the CLR: + + 1. For managed executables, you must set the `enabled` attribute of the [\](../../configure-apps/file-schema/runtime/legacyimpersonationpolicy-element.md) element to `true`. + + 2. For unmanaged hosting interfaces, set the `STARTUP_LEGACY_IMPERSONATION` flag in the `flags` parameter when calling the `CorBindToRuntimeEx` function. + + The version 1 compatibility mode applies to the entire process and to all the application domains in the process. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also - [CorBindToCurrentRuntime Function](corbindtocurrentruntime-function.md) diff --git a/docs/core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md b/docs/framework/unmanaged-api/hosting/corbindtoruntimebycfg-function.md similarity index 50% rename from docs/core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md rename to docs/framework/unmanaged-api/hosting/corbindtoruntimebycfg-function.md index f944cf958fcc5..8ba79290f85b5 100644 --- a/docs/core/unmanaged-api/hosting/corbindtoruntimebycfg-function.md +++ b/docs/framework/unmanaged-api/hosting/corbindtoruntimebycfg-function.md @@ -2,72 +2,73 @@ description: "Learn more about: CorBindToRuntimeByCfg Function" title: "CorBindToRuntimeByCfg Function" ms.date: "03/30/2017" -api_name: +api_name: - "CorBindToRuntimeByCfg" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "CorBindToRuntimeByCfg" -helpviewer_keywords: +helpviewer_keywords: - "CorBindToRuntimeByCfg function [.NET Framework hosting]" -topic_type: +ms.assetid: ded1e492-a782-4185-9c66-709e421c1782 +topic_type: - "apiref" --- # CorBindToRuntimeByCfg Function -Loads the common language runtime (CLR) into a process by using version information that is read from an XML file. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT CorBindToRuntimeByCfg ( - [in] IStream *pCfgStream, - [in] DWORD reserved, - [in] DWORD startupFlags, - [in] REFCLSID rclsid, +Loads the common language runtime (CLR) into a process by using version information that is read from an XML file. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT CorBindToRuntimeByCfg ( + [in] IStream *pCfgStream, + [in] DWORD reserved, + [in] DWORD startupFlags, + [in] REFCLSID rclsid, [in] REFIID riid, - [out] LPVOID FAR* ppv -); -``` - -## Parameters - - `pCfgStream` - [in] A pointer to an `IStream` object that reads the XML file. - - `reserved` - [in] Reserved for future use. Use 0 (zero) as value. - - `startupFlags` - [in] A value of the [STARTUP_FLAGS](startup-flags-enumeration.md) enumeration that specifies the startup behavior of the CLR. - - `rclsid` - [in] The `CLSID` of the coclass that implements either the [ICorRuntimeHost](icorruntimehost-interface.md) or the [ICLRRuntimeHost](iclrruntimehost-interface.md) interface. Supported values are CLSID_CorRuntimeHost or CLSID_CLRRuntimeHost. - - `riid` - [in] The `IID` of either the `ICorRuntimeHost` or the `ICLRRuntimeHost` interface. Supported values are IID_ICorRuntimeHost or IID_ICLRRuntimeHost. - - `ppv` - [out] A pointer to the address of the returned interface. - -## Remarks - - The format of the XML file is modeled after the standard application configuration file. For more information about XML files, see [Configuration File Schema](../../../framework/configure-apps/file-schema/index.md). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 1.0 - + [out] LPVOID FAR* ppv +); +``` + +## Parameters + + `pCfgStream` + [in] A pointer to an `IStream` object that reads the XML file. + + `reserved` + [in] Reserved for future use. Use 0 (zero) as value. + + `startupFlags` + [in] A value of the [STARTUP_FLAGS](startup-flags-enumeration.md) enumeration that specifies the startup behavior of the CLR. + + `rclsid` + [in] The `CLSID` of the coclass that implements either the [ICorRuntimeHost](icorruntimehost-interface.md) or the [ICLRRuntimeHost](iclrruntimehost-interface.md) interface. Supported values are CLSID_CorRuntimeHost or CLSID_CLRRuntimeHost. + + `riid` + [in] The `IID` of either the `ICorRuntimeHost` or the `ICLRRuntimeHost` interface. Supported values are IID_ICorRuntimeHost or IID_ICLRRuntimeHost. + + `ppv` + [out] A pointer to the address of the returned interface. + +## Remarks + + The format of the XML file is modeled after the standard application configuration file. For more information about XML files, see [Configuration File Schema](../../configure-apps/file-schema/index.md). + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also - [CorBindToCurrentRuntime Function](corbindtocurrentruntime-function.md) diff --git a/docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md b/docs/framework/unmanaged-api/hosting/corbindtoruntimeex-function.md similarity index 71% rename from docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md rename to docs/framework/unmanaged-api/hosting/corbindtoruntimeex-function.md index dcf77fcbf01d8..841d734129753 100644 --- a/docs/core/unmanaged-api/hosting/corbindtoruntimeex-function.md +++ b/docs/framework/unmanaged-api/hosting/corbindtoruntimeex-function.md @@ -2,138 +2,139 @@ description: "Learn more about: CorBindToRuntimeEx Function" title: "CorBindToRuntimeEx Function" ms.date: "03/30/2017" -api_name: +api_name: - "CorBindToRuntimeEx" -api_location: +api_location: - "mscoree.dll" - "mscoreei.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "CorBindToRuntimeEx" -helpviewer_keywords: +helpviewer_keywords: - "CorBindToRuntimeEx function [.NET Framework hosting]" -topic_type: +ms.assetid: aae9fb17-5d01-41da-9773-1b5b5b642d81 +topic_type: - "apiref" --- # CorBindToRuntimeEx Function -Enables unmanaged hosts to load the common language runtime (CLR) into a process. The [CorBindToRuntime](corbindtoruntime-function.md) and `CorBindToRuntimeEx` functions perform the same operation, but the `CorBindToRuntimeEx` function allows you to set flags to specify the behavior of the CLR. - - This function has been deprecated in the .NET Framework 4. - - This function takes a set of parameters that allow a host to do the following: - -- Specify the version of the runtime that will be loaded. - -- Indicate whether the server or workstation build should be loaded. - -- Control whether concurrent garbage collection or non-concurrent garbage collection is done. - +Enables unmanaged hosts to load the common language runtime (CLR) into a process. The [CorBindToRuntime](corbindtoruntime-function.md) and `CorBindToRuntimeEx` functions perform the same operation, but the `CorBindToRuntimeEx` function allows you to set flags to specify the behavior of the CLR. + + This function has been deprecated in the .NET Framework 4. + + This function takes a set of parameters that allow a host to do the following: + +- Specify the version of the runtime that will be loaded. + +- Indicate whether the server or workstation build should be loaded. + +- Control whether concurrent garbage collection or non-concurrent garbage collection is done. + > [!NOTE] -> Concurrent garbage collection is not supported in applications running the WOW64 x86 emulator on 64-bit systems that implement the Intel Itanium architecture (formerly called IA-64). For more information about using WOW64 on 64-bit Windows systems, see [Running 32-bit Applications](/windows/desktop/WinProg64/running-32-bit-applications). - -- Control whether assemblies are loaded as domain-neutral. - -- Obtain an interface pointer to an [ICorRuntimeHost](icorruntimehost-interface.md) that can be used to set additional options for configuring an instance of the CLR before it is started. - -## Syntax - -```cpp -HRESULT CorBindToRuntimeEx ( +> Concurrent garbage collection is not supported in applications running the WOW64 x86 emulator on 64-bit systems that implement the Intel Itanium architecture (formerly called IA-64). For more information about using WOW64 on 64-bit Windows systems, see [Running 32-bit Applications](/windows/desktop/WinProg64/running-32-bit-applications). + +- Control whether assemblies are loaded as domain-neutral. + +- Obtain an interface pointer to an [ICorRuntimeHost](icorruntimehost-interface.md) that can be used to set additional options for configuring an instance of the CLR before it is started. + +## Syntax + +```cpp +HRESULT CorBindToRuntimeEx ( [in] LPCWSTR pwszVersion, [in] LPCWSTR pwszBuildFlavor, [in] DWORD startupFlags, [in] REFCLSID rclsid, [in] REFIID riid, - [out] LPVOID FAR *ppv -); -``` - -## Parameters - - `pwszVersion` - [in] A string describing the version of the CLR you want to load. - - A version number in the .NET Framework consists of four parts separated by periods: *major.minor.build.revision*. The string passed as `pwszVersion` must start with the character "v" followed by the first three parts of the version number (for example, "v1.0.1529"). - - Some versions of the CLR are installed with a policy statement that specifies compatibility with previous versions of the CLR. By default, the startup shim evaluates `pwszVersion` against policy statements and loads the latest version of the runtime that is compatible with the version being requested. A host can force the shim to skip policy evaluation and load the exact version specified in `pwszVersion` by passing a value of `STARTUP_LOADER_SAFEMODE` for the `startupFlags` parameter, as described below. - - If the caller specifies null for `pwszVersion`, `CorBindToRuntimeEx` identifies the set of installed runtimes whose version numbers are lower than the .NET Framework 4 runtime, and loads the latest version of the runtime from that set. It won't load the .NET Framework 4 or later, and fails if no earlier version is installed. Note that passing null gives the host no control over which version of the runtime is loaded. Although this approach may be appropriate in some scenarios, it is strongly recommended that the host supply a specific version to load. - - `pwszBuildFlavor` - [in] A string that specifies whether to load the server or the workstation build of the CLR. Valid values are `svr` and `wks`. The server build is optimized to take advantage of multiple processors for garbage collections, and the workstation build is optimized for client applications running on a single-processor machine. - - If `pwszBuildFlavor` is set to null, the workstation build is loaded. When running on a single-processor machine, the workstation build is always loaded, even if `pwszBuildFlavor` is set to `svr`. However, if `pwszBuildFlavor` is set to `svr` and concurrent garbage collection is specified (see the description of the `startupFlags` parameter), the server build is loaded. - - `startupFlags` - [in] A combination of values of the [STARTUP_FLAGS](startup-flags-enumeration.md) enumeration. These flags control concurrent garbage collection, domain-neutral code, and the behavior of the `pwszVersion` parameter. The default is single domain if no flag is set. The following values are valid: - -- `STARTUP_CONCURRENT_GC` - -- `STARTUP_LOADER_OPTIMIZATION_SINGLE_DOMAIN` - -- `STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN` - -- `STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN_HOST` - -- `STARTUP_LOADER_SAFEMODE` - -- `STARTUP_LOADER_SETPREFERENCE` - -- `STARTUP_SERVER_GC` - -- `STARTUP_HOARD_GC_VM` - -- `STARTUP_SINGLE_VERSION_HOSTING_INTERFACE` - -- `STARTUP_LEGACY_IMPERSONATION` - -- `STARTUP_DISABLE_COMMITTHREADSTACK` - -- `STARTUP_ALWAYSFLOW_IMPERSONATION` - - For descriptions of these flags, see the [STARTUP_FLAGS](startup-flags-enumeration.md) enumeration. - - `rclsid` - [in] The `CLSID` of the coclass that implements either the [ICorRuntimeHost](icorruntimehost-interface.md) or the [ICLRRuntimeHost](iclrruntimehost-interface.md) interface. Supported values are CLSID_CorRuntimeHost or CLSID_CLRRuntimeHost. - - `riid` - [in] The `IID` of the requested interface from `rclsid`. Supported values are IID_ICorRuntimeHost or IID_ICLRRuntimeHost. - - `ppv` - [out] The returned interface pointer to `riid`. - -## Remarks - - If `pwszVersion` specifies a runtime version that does not exist, `CorBindToRuntimeEx` returns an HRESULT value of CLR_E_SHIM_RUNTIMELOAD. - -## Execution Context and Flow of Windows Identity - - In version 1 of the CLR, the object does not flow across asynchronous points such as new threads, thread pools, or timer callbacks. In version 2.0 of the CLR, an object wraps some information about the currently executing thread and flows it across any asynchronous point, but not across application domain boundaries. Similarly, the object also flows across any asynchronous point. Therefore, the current impersonation on the thread, if any, flows too. - - You can alter the flow in two ways: - -1. By modifying the settings to suppress the flow on a per-thread basis (see the , , and methods). - -2. By changing the process default mode to the version 1 compatibility mode, where the object does not flow across any asynchronous point, regardless of the settings on the current thread. How you change the default mode depends on whether you use a managed executable or an unmanaged hosting interface to load the CLR: - - 1. For managed executables, you must set the `enabled` attribute of the [\](../../../framework/configure-apps/file-schema/runtime/legacyimpersonationpolicy-element.md) element to `true`. - - 2. For unmanaged hosting interfaces, set the `STARTUP_LEGACY_IMPERSONATION` flag in the `startupFlags` parameter when calling the `CorBindToRuntimeEx` function. - - The version 1 compatibility mode applies to the entire process and to all the application domains in the process. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 1.0 - + [out] LPVOID FAR *ppv +); +``` + +## Parameters + + `pwszVersion` + [in] A string describing the version of the CLR you want to load. + + A version number in the .NET Framework consists of four parts separated by periods: *major.minor.build.revision*. The string passed as `pwszVersion` must start with the character "v" followed by the first three parts of the version number (for example, "v1.0.1529"). + + Some versions of the CLR are installed with a policy statement that specifies compatibility with previous versions of the CLR. By default, the startup shim evaluates `pwszVersion` against policy statements and loads the latest version of the runtime that is compatible with the version being requested. A host can force the shim to skip policy evaluation and load the exact version specified in `pwszVersion` by passing a value of `STARTUP_LOADER_SAFEMODE` for the `startupFlags` parameter, as described below. + + If the caller specifies null for `pwszVersion`, `CorBindToRuntimeEx` identifies the set of installed runtimes whose version numbers are lower than the .NET Framework 4 runtime, and loads the latest version of the runtime from that set. It won't load the .NET Framework 4 or later, and fails if no earlier version is installed. Note that passing null gives the host no control over which version of the runtime is loaded. Although this approach may be appropriate in some scenarios, it is strongly recommended that the host supply a specific version to load. + + `pwszBuildFlavor` + [in] A string that specifies whether to load the server or the workstation build of the CLR. Valid values are `svr` and `wks`. The server build is optimized to take advantage of multiple processors for garbage collections, and the workstation build is optimized for client applications running on a single-processor machine. + + If `pwszBuildFlavor` is set to null, the workstation build is loaded. When running on a single-processor machine, the workstation build is always loaded, even if `pwszBuildFlavor` is set to `svr`. However, if `pwszBuildFlavor` is set to `svr` and concurrent garbage collection is specified (see the description of the `startupFlags` parameter), the server build is loaded. + + `startupFlags` + [in] A combination of values of the [STARTUP_FLAGS](startup-flags-enumeration.md) enumeration. These flags control concurrent garbage collection, domain-neutral code, and the behavior of the `pwszVersion` parameter. The default is single domain if no flag is set. The following values are valid: + +- `STARTUP_CONCURRENT_GC` + +- `STARTUP_LOADER_OPTIMIZATION_SINGLE_DOMAIN` + +- `STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN` + +- `STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN_HOST` + +- `STARTUP_LOADER_SAFEMODE` + +- `STARTUP_LOADER_SETPREFERENCE` + +- `STARTUP_SERVER_GC` + +- `STARTUP_HOARD_GC_VM` + +- `STARTUP_SINGLE_VERSION_HOSTING_INTERFACE` + +- `STARTUP_LEGACY_IMPERSONATION` + +- `STARTUP_DISABLE_COMMITTHREADSTACK` + +- `STARTUP_ALWAYSFLOW_IMPERSONATION` + + For descriptions of these flags, see the [STARTUP_FLAGS](startup-flags-enumeration.md) enumeration. + + `rclsid` + [in] The `CLSID` of the coclass that implements either the [ICorRuntimeHost](icorruntimehost-interface.md) or the [ICLRRuntimeHost](iclrruntimehost-interface.md) interface. Supported values are CLSID_CorRuntimeHost or CLSID_CLRRuntimeHost. + + `riid` + [in] The `IID` of the requested interface from `rclsid`. Supported values are IID_ICorRuntimeHost or IID_ICLRRuntimeHost. + + `ppv` + [out] The returned interface pointer to `riid`. + +## Remarks + + If `pwszVersion` specifies a runtime version that does not exist, `CorBindToRuntimeEx` returns an HRESULT value of CLR_E_SHIM_RUNTIMELOAD. + +## Execution Context and Flow of Windows Identity + + In version 1 of the CLR, the object does not flow across asynchronous points such as new threads, thread pools, or timer callbacks. In version 2.0 of the CLR, an object wraps some information about the currently executing thread and flows it across any asynchronous point, but not across application domain boundaries. Similarly, the object also flows across any asynchronous point. Therefore, the current impersonation on the thread, if any, flows too. + + You can alter the flow in two ways: + +1. By modifying the settings to suppress the flow on a per-thread basis (see the , , and methods). + +2. By changing the process default mode to the version 1 compatibility mode, where the object does not flow across any asynchronous point, regardless of the settings on the current thread. How you change the default mode depends on whether you use a managed executable or an unmanaged hosting interface to load the CLR: + + 1. For managed executables, you must set the `enabled` attribute of the [\](../../configure-apps/file-schema/runtime/legacyimpersonationpolicy-element.md) element to `true`. + + 2. For unmanaged hosting interfaces, set the `STARTUP_LEGACY_IMPERSONATION` flag in the `startupFlags` parameter when calling the `CorBindToRuntimeEx` function. + + The version 1 compatibility mode applies to the entire process and to all the application domains in the process. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also - [CorBindToCurrentRuntime Function](corbindtocurrentruntime-function.md) diff --git a/docs/core/unmanaged-api/hosting/corbindtoruntimehost-function.md b/docs/framework/unmanaged-api/hosting/corbindtoruntimehost-function.md similarity index 77% rename from docs/core/unmanaged-api/hosting/corbindtoruntimehost-function.md rename to docs/framework/unmanaged-api/hosting/corbindtoruntimehost-function.md index d88ba842965af..bda3717ab85dc 100644 --- a/docs/core/unmanaged-api/hosting/corbindtoruntimehost-function.md +++ b/docs/framework/unmanaged-api/hosting/corbindtoruntimehost-function.md @@ -17,14 +17,14 @@ topic_type: --- # CorBindToRuntimeHost Function -Enables hosts to load a specified version of the common language runtime (CLR) into a process. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT CorBindToRuntimeHost ( +Enables hosts to load a specified version of the common language runtime (CLR) into a process. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT CorBindToRuntimeHost ( [in] LPCWSTR pwszVersion, [in] LPCWSTR pwszBuildFlavor, [in] LPCWSTR pwszHostConfigFile, @@ -32,57 +32,57 @@ HRESULT CorBindToRuntimeHost ( [in] DWORD startupFlags, [in] REFCLSID rclsid, [in] REFIID riid, - [out] LPVOID FAR *ppv -); -``` - -## Parameters - - `pwszVersion` - [in] A string that describes the version of the CLR you want to load. - - A version number in the .NET Framework consists of four parts separated by periods: *major.minor.build.revision*. The string passed as `pwszVersion` must start with the character "v" followed by the first three parts of the version number (for example, "v1.0.1529"). - - Some versions of the CLR are installed with a policy statement that specifies compatibility with previous versions of the CLR. By default, the startup shim evaluates `pwszVersion` against policy statements and loads the latest version of the runtime that is compatible with the version being requested. A host can force the shim to skip policy evaluation and load the exact version specified in `pwszVersion` by passing a value of STARTUP_LOADER_SAFEMODE for the `startupFlags` parameter. - - If `pwszVersion` is `null`, the method does not load any version of the CLR. Instead, it returns CLR_E_SHIM_RUNTIMELOAD, which indicates that it failed to load the runtime. - - `pwszBuildFlavor` - [in] A string that specifies whether to load the server or the workstation build of the CLR. Valid values are `svr` and `wks`. The server build is optimized to take advantage of multiple processors for garbage collections, and the workstation build is optimized for client applications running on a single-processor machine. - - If `pwszBuildFlavor` is set to null, the workstation build is loaded. When running on a single-processor machine, the workstation build is always loaded, even if `pwszBuildFlavor` is set to `svr`. However, if `pwszBuildFlavor` is set to `svr` and concurrent garbage collection is specified (see the description of the `startupFlags` parameter), the server build is loaded. - + [out] LPVOID FAR *ppv +); +``` + +## Parameters + + `pwszVersion` + [in] A string that describes the version of the CLR you want to load. + + A version number in the .NET Framework consists of four parts separated by periods: *major.minor.build.revision*. The string passed as `pwszVersion` must start with the character "v" followed by the first three parts of the version number (for example, "v1.0.1529"). + + Some versions of the CLR are installed with a policy statement that specifies compatibility with previous versions of the CLR. By default, the startup shim evaluates `pwszVersion` against policy statements and loads the latest version of the runtime that is compatible with the version being requested. A host can force the shim to skip policy evaluation and load the exact version specified in `pwszVersion` by passing a value of STARTUP_LOADER_SAFEMODE for the `startupFlags` parameter. + + If `pwszVersion` is `null`, the method does not load any version of the CLR. Instead, it returns CLR_E_SHIM_RUNTIMELOAD, which indicates that it failed to load the runtime. + + `pwszBuildFlavor` + [in] A string that specifies whether to load the server or the workstation build of the CLR. Valid values are `svr` and `wks`. The server build is optimized to take advantage of multiple processors for garbage collections, and the workstation build is optimized for client applications running on a single-processor machine. + + If `pwszBuildFlavor` is set to null, the workstation build is loaded. When running on a single-processor machine, the workstation build is always loaded, even if `pwszBuildFlavor` is set to `svr`. However, if `pwszBuildFlavor` is set to `svr` and concurrent garbage collection is specified (see the description of the `startupFlags` parameter), the server build is loaded. + > [!NOTE] -> Concurrent garbage collection is not supported in applications running the WOW64 x86 emulator on 64-bit systems that implement the Intel Itanium architecture (formerly called IA-64). For more information about using WOW64 on 64-bit Windows systems, see [Running 32-bit Applications](/windows/desktop/WinProg64/running-32-bit-applications). - - `pwszHostConfigFile` - [in] The name of a host configuration file that specifies the version of the CLR to load. If the file name does not include a fully qualified path, the file is assumed to be in the same directory as the executable that is making the call. - - `pReserved` - [in] Reserved for future extensibility. - - `startupFlags` - [in] A set of flags that controls concurrent garbage collection, domain-neutral code, and the behavior of the `pwszVersion` parameter. The default is single domain if no flag is set. For a list of supported values, see the [STARTUP_FLAGS enumeration](startup-flags-enumeration.md). - - `rclsid` - [in] The `CLSID` of the coclass that implements either the [ICorRuntimeHost](icorruntimehost-interface.md) or the [ICLRRuntimeHost](iclrruntimehost-interface.md) interface. Supported values are CLSID_CorRuntimeHost or CLSID_CLRRuntimeHost. - - `riid` - [in] The `IID` of the interface you are requesting. Supported values are IID_ICorRuntimeHost or IID_ICLRRuntimeHost. - - `ppv` - [out] An interface pointer to the version of the runtime that was loaded. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.idl - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 1.0 - +> Concurrent garbage collection is not supported in applications running the WOW64 x86 emulator on 64-bit systems that implement the Intel Itanium architecture (formerly called IA-64). For more information about using WOW64 on 64-bit Windows systems, see [Running 32-bit Applications](/windows/desktop/WinProg64/running-32-bit-applications). + + `pwszHostConfigFile` + [in] The name of a host configuration file that specifies the version of the CLR to load. If the file name does not include a fully qualified path, the file is assumed to be in the same directory as the executable that is making the call. + + `pReserved` + [in] Reserved for future extensibility. + + `startupFlags` + [in] A set of flags that controls concurrent garbage collection, domain-neutral code, and the behavior of the `pwszVersion` parameter. The default is single domain if no flag is set. For a list of supported values, see the [STARTUP_FLAGS enumeration](startup-flags-enumeration.md). + + `rclsid` + [in] The `CLSID` of the coclass that implements either the [ICorRuntimeHost](icorruntimehost-interface.md) or the [ICLRRuntimeHost](iclrruntimehost-interface.md) interface. Supported values are CLSID_CorRuntimeHost or CLSID_CLRRuntimeHost. + + `riid` + [in] The `IID` of the interface you are requesting. Supported values are IID_ICorRuntimeHost or IID_ICLRRuntimeHost. + + `ppv` + [out] An interface pointer to the version of the runtime that was loaded. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.idl + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also - [CorBindToCurrentRuntime Function](corbindtocurrentruntime-function.md) diff --git a/docs/core/unmanaged-api/hosting/cordllmain-function.md b/docs/framework/unmanaged-api/hosting/cordllmain-function.md similarity index 53% rename from docs/core/unmanaged-api/hosting/cordllmain-function.md rename to docs/framework/unmanaged-api/hosting/cordllmain-function.md index a609845a06d42..9a329189ad375 100644 --- a/docs/core/unmanaged-api/hosting/cordllmain-function.md +++ b/docs/framework/unmanaged-api/hosting/cordllmain-function.md @@ -2,68 +2,69 @@ 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]" -topic_type: +ms.assetid: bc7b51cf-39d3-48ec-a5cb-2f179fbefff8 +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](../../../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 - + + 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) diff --git a/docs/core/unmanaged-api/hosting/corexemain-function.md b/docs/framework/unmanaged-api/hosting/corexemain-function.md similarity index 59% rename from docs/core/unmanaged-api/hosting/corexemain-function.md rename to docs/framework/unmanaged-api/hosting/corexemain-function.md index 4c776cd277010..708c87a9e02a7 100644 --- a/docs/core/unmanaged-api/hosting/corexemain-function.md +++ b/docs/framework/unmanaged-api/hosting/corexemain-function.md @@ -2,50 +2,51 @@ 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]" -topic_type: +ms.assetid: 898f76e2-16f4-4a63-b7d9-dad2d3824d8a +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](../../../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 - + + 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) diff --git a/docs/framework/unmanaged-api/hosting/corexemain2-function.md b/docs/framework/unmanaged-api/hosting/corexemain2-function.md new file mode 100644 index 0000000000000..fc3bd53e240bd --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/corexemain2-function.md @@ -0,0 +1,64 @@ +--- +description: "Learn more about: _CorExeMain2 Function" +title: "_CorExeMain2 Function" +ms.date: "03/30/2017" +api_name: + - "_CorExeMain2" +api_location: + - "mscoree.dll" +api_type: + - "DLLExport" +f1_keywords: + - "_CorExeMain2" +helpviewer_keywords: + - "_CorExeMain2 function [.NET Framework hosting]" +ms.assetid: 72ea68b4-689f-4733-9416-9664b75e8892 +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 + + `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)] + +## See also + +- [Metadata Global Static Functions](../metadata/metadata-global-static-functions.md) diff --git a/docs/core/unmanaged-api/hosting/corexitprocess-function.md b/docs/framework/unmanaged-api/hosting/corexitprocess-function.md similarity index 52% rename from docs/core/unmanaged-api/hosting/corexitprocess-function.md rename to docs/framework/unmanaged-api/hosting/corexitprocess-function.md index a4d5447f16e94..bda4228850f8b 100644 --- a/docs/core/unmanaged-api/hosting/corexitprocess-function.md +++ b/docs/framework/unmanaged-api/hosting/corexitprocess-function.md @@ -2,57 +2,58 @@ description: "Learn more about: CorExitProcess Function" title: "CorExitProcess Function" ms.date: "03/30/2017" -api_name: +api_name: - "CorExitProcess" -api_location: +api_location: - "mscoree.dll" - "clr.dll" - "mscorwks.dll" - "mscoreei.dll" - "mscorsvr.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "CorExitProcess" -helpviewer_keywords: +helpviewer_keywords: - "CorExitProcess function [.NET Framework hosting]" -topic_type: +ms.assetid: a5cab4c6-990e-47f3-8798-cf422b791015 +topic_type: - "apiref" --- # CorExitProcess Function -Shuts down the current unmanaged process. - - This function has been deprecated in the .NET Framework 4. Use the [ICLRMetaHost::ExitProcess](iclrmetahost-exitprocess-method.md) method instead. - -## Syntax - -```cpp +Shuts down the current unmanaged process. + + This function has been deprecated in the .NET Framework 4. Use the [ICLRMetaHost::ExitProcess](iclrmetahost-exitprocess-method.md) method instead. + +## Syntax + +```cpp void STDMETHODCALLTYPE CorExitProcess ( - int exitCode -); -``` - -## Parameters - - `exitCode` - An integer that specifies the process exit code. - -## Remarks - + int exitCode +); +``` + +## Parameters + + `exitCode` + An integer that specifies the process exit code. + +## Remarks + > [!NOTE] -> Beginning with the .NET Framework 4, `CorExitProcess` exits every started runtime in the process, not just the runtime to which the legacy APIs have been bound. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 1.0 - +> Beginning with the .NET Framework 4, `CorExitProcess` exits every started runtime in the process, not just the runtime to which the legacy APIs have been bound. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/corimageunloading-function.md b/docs/framework/unmanaged-api/hosting/corimageunloading-function.md similarity index 53% rename from docs/core/unmanaged-api/hosting/corimageunloading-function.md rename to docs/framework/unmanaged-api/hosting/corimageunloading-function.md index 5f534d2f6f7c5..23492f385aa43 100644 --- a/docs/core/unmanaged-api/hosting/corimageunloading-function.md +++ b/docs/framework/unmanaged-api/hosting/corimageunloading-function.md @@ -2,48 +2,49 @@ 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]" -topic_type: +ms.assetid: b4367214-6dac-4280-aa11-fd487ff30bc4 +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](../../../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 - + [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) diff --git a/docs/framework/unmanaged-api/hosting/corlaunchapplication-function.md b/docs/framework/unmanaged-api/hosting/corlaunchapplication-function.md new file mode 100644 index 0000000000000..8b9c83e294621 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/corlaunchapplication-function.md @@ -0,0 +1,75 @@ +--- +description: "Learn more about: CorLaunchApplication Function" +title: "CorLaunchApplication Function" +ms.date: "03/30/2017" +api_name: + - "CorLaunchApplication" +api_location: + - "mscoree.dll" + - "clr.dll" +api_type: + - "COM" +f1_keywords: + - "CorLaunchApplication" +helpviewer_keywords: + - "CorLaunchApplication function [.NET Framework hosting]" +ms.assetid: 71f362a9-8fe2-47ce-9302-05a645cf3d7d +topic_type: + - "apiref" +--- +# CorLaunchApplication Function + +Starts the application at the specified network path, using the specified manifests and other application data. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT CorLaunchApplication ( + [in] HOST_TYPE dwClickOnceHost, + [in] LPCWSTR pwzAppFullName, + [in] DWORD dwManifestPaths, + [in] LPCWSTR *ppwzManifestPaths, + [in] DWORD dwActivationData, + [in] LPCWSTR *ppwzActivationData, + [out] LPPROCESS_INFORMATION lpProcessInformation +); +``` + +## Parameters + + `dwClickOnceHost` + [in] A value of the [HOST_TYPE](host-type-enumeration.md) enumeration that specifies the type of host that is launching the application. + + `pwzAppFullName` + [in] The full name of the application that is being launched. + + `dwManifestPaths` + [in] The number of manifest paths for the application. + + `ppwzManifestPaths` + [in] An array of strings, each of which specifies a path to a manifest for the application that is being launched. + + `dwActivationData` + [in] The number of activation data items for the application that is being launched. + + `ppwzActivationData` + [in] An array of strings, each of which is an activation data item for the application that is being launched. + + `lpProcessInformation` + [out] A pointer to information about the process in which the application has been loaded. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + +## See also + +- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md b/docs/framework/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md similarity index 58% rename from docs/core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md rename to docs/framework/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md index 4d8753eb25ae1..43fd6e4383232 100644 --- a/docs/core/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md +++ b/docs/framework/unmanaged-api/hosting/cormarkthreadinthreadpool-function.md @@ -2,39 +2,40 @@ description: "Learn more about: CorMarkThreadInThreadPool Function" title: "CorMarkThreadInThreadPool Function" ms.date: "03/30/2017" -api_name: +api_name: - "CorMarkThreadInThreadPool" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "CorMarkThreadInThreadPool" -helpviewer_keywords: +helpviewer_keywords: - "CorMarkThreadInThreadPool function [.NET Framework hosting]" -topic_type: +ms.assetid: 3f958d41-e82e-4ec3-ae6f-16c7b3b31e3e +topic_type: - "apiref" --- # CorMarkThreadInThreadPool Function -Marks the currently executing thread-pool thread for the execution of managed code. Starting with .NET Framework version 2.0, this function has no effect. It is not required, and can be removed from your code. This function is deprecated in the .NET Framework 4. - -## Syntax - -```cpp -void CorMarkThreadInThreadPool (); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 1.0 - +Marks the currently executing thread-pool thread for the execution of managed code. Starting with .NET Framework version 2.0, this function has no effect. It is not required, and can be removed from your code. This function is deprecated in the .NET Framework 4. + +## Syntax + +```cpp +void CorMarkThreadInThreadPool (); +``` + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/corruntimehost-coclass.md b/docs/framework/unmanaged-api/hosting/corruntimehost-coclass.md similarity index 53% rename from docs/core/unmanaged-api/hosting/corruntimehost-coclass.md rename to docs/framework/unmanaged-api/hosting/corruntimehost-coclass.md index 50ae304b66325..cf534395c9964 100644 --- a/docs/core/unmanaged-api/hosting/corruntimehost-coclass.md +++ b/docs/framework/unmanaged-api/hosting/corruntimehost-coclass.md @@ -2,55 +2,56 @@ description: "Learn more about: CorRuntimeHost Coclass" title: "CorRuntimeHost Coclass" ms.date: "03/30/2017" -api_name: +api_name: - "CorRuntimeHost Coclass" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CorRuntimeHost" -helpviewer_keywords: +helpviewer_keywords: - "CoRuntimeHost coclass [.NET Framework hosting]" -topic_type: +ms.assetid: 5833740b-7d67-44b4-865c-b5bf45e291e3 +topic_type: - "apiref" --- # CorRuntimeHost Coclass -Provides interfaces for managing applications that are being executed by the common language runtime. - -## Syntax - -```cpp -coclass CorRuntimeHost { - [default] interface ICorRuntimeHost; - interface IGCHost; - interface ICorConfiguration; - interface IValidator; - interface IDebuggerInfo; -}; -``` - -## Interfaces - -|Interface|Description| -|---------------|-----------------| -|[ICorConfiguration Interface](icorconfiguration-interface.md)|Provides methods for configuring the common language runtime (CLR).| -|[ICorRuntimeHost Interface](icorruntimehost-interface.md)|Provides methods that enable the host to start and stop the common language runtime explicitly, to create and configure application domains, to access the default domain, and to enumerate all domains running in the process.| -|[IDebuggerInfo Interface](idebuggerinfo-interface.md)|Provides methods for obtaining information about the state of the debugging services.| -|[IGCHost Interface](igchost-interface.md)|Provides methods for obtaining information about the garbage collection system and for controlling some aspects of garbage collection.| -|"IValidator"|Provides methods for validation of portable executable images and detailed reporting of validation errors.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.idl - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** Available since .NET Framework 1.0 - +Provides interfaces for managing applications that are being executed by the common language runtime. + +## Syntax + +```cpp +coclass CorRuntimeHost { + [default] interface ICorRuntimeHost; + interface IGCHost; + interface ICorConfiguration; + interface IValidator; + interface IDebuggerInfo; +}; +``` + +## Interfaces + +|Interface|Description| +|---------------|-----------------| +|[ICorConfiguration Interface](icorconfiguration-interface.md)|Provides methods for configuring the common language runtime (CLR).| +|[ICorRuntimeHost Interface](icorruntimehost-interface.md)|Provides methods that enable the host to start and stop the common language runtime explicitly, to create and configure application domains, to access the default domain, and to enumerate all domains running in the process.| +|[IDebuggerInfo Interface](idebuggerinfo-interface.md)|Provides methods for obtaining information about the state of the debugging services.| +|[IGCHost Interface](igchost-interface.md)|Provides methods for obtaining information about the garbage collection system and for controlling some aspects of garbage collection.| +|"IValidator"|Provides methods for validation of portable executable images and detailed reporting of validation errors.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.idl + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also - [Hosting Coclasses](hosting-coclasses.md) diff --git a/docs/core/unmanaged-api/hosting/corvalidateimage-function.md b/docs/framework/unmanaged-api/hosting/corvalidateimage-function.md similarity index 61% rename from docs/core/unmanaged-api/hosting/corvalidateimage-function.md rename to docs/framework/unmanaged-api/hosting/corvalidateimage-function.md index dfb0e37350473..c2b91d387f4bc 100644 --- a/docs/core/unmanaged-api/hosting/corvalidateimage-function.md +++ b/docs/framework/unmanaged-api/hosting/corvalidateimage-function.md @@ -2,83 +2,84 @@ 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]" -topic_type: +ms.assetid: 0117e080-05f9-4772-885d-e1847230947c +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](../../../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 - + [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) diff --git a/docs/core/unmanaged-api/hosting/couninitializecor-function.md b/docs/framework/unmanaged-api/hosting/couninitializecor-function.md similarity index 65% rename from docs/core/unmanaged-api/hosting/couninitializecor-function.md rename to docs/framework/unmanaged-api/hosting/couninitializecor-function.md index 54bea80cccdaa..b491716f17953 100644 --- a/docs/core/unmanaged-api/hosting/couninitializecor-function.md +++ b/docs/framework/unmanaged-api/hosting/couninitializecor-function.md @@ -2,34 +2,35 @@ 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]" -topic_type: +ms.assetid: 50a95b8b-9766-470e-bb29-2c7ecddfd4a1 +topic_type: - "apiref" --- # CoUninitializeCor Function -`CoUninitializeCor` is obsolete. - -## Syntax - -```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. +`CoUninitializeCor` is obsolete. + +## Syntax + +```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. + ## See also - [Metadata Global Static Functions](../metadata/metadata-global-static-functions.md) diff --git a/docs/core/unmanaged-api/hosting/couninitializeee-function.md b/docs/framework/unmanaged-api/hosting/couninitializeee-function.md similarity index 64% rename from docs/core/unmanaged-api/hosting/couninitializeee-function.md rename to docs/framework/unmanaged-api/hosting/couninitializeee-function.md index 7f53d8577b590..ff8f0ed97ccf6 100644 --- a/docs/core/unmanaged-api/hosting/couninitializeee-function.md +++ b/docs/framework/unmanaged-api/hosting/couninitializeee-function.md @@ -2,36 +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]" -topic_type: +ms.assetid: 5f5a311a-839a-465f-89d9-ff1c74da9736 +topic_type: - "apiref" --- # CoUninitializeEE Function -`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). +`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). + ## See also - [CoInitializeEE Function](coinitializeee-function.md) diff --git a/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md b/docs/framework/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md similarity index 68% rename from docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md rename to docs/framework/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md index ffae4220449ec..e9bf85224e952 100644 --- a/docs/core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md +++ b/docs/framework/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md @@ -13,6 +13,7 @@ f1_keywords: - "CreateDebuggingInterfaceFromVersion" helpviewer_keywords: - "CreateDebuggingInterfaceFromVersion function [.NET Framework hosting]" +ms.assetid: a746a849-463c-44f5-a2f0-9e812ed8bcc3 topic_type: - "apiref" --- @@ -20,7 +21,7 @@ topic_type: Creates an [ICorDebug](../debugging/icordebug-interface.md) object based on the specified version information. - This function is obsolete starting in .NET Framework 4. Instead, to get an interface for the common language runtime (CLR) 2.0, use the [ICLRRuntimeInfo::GetInterface](iclrruntimeinfo-getinterface-method.md) method and specify the class identifier `CLSID_CLRDebuggingLegacy` and the interface identifier `IID_ICorDebug`. To get an interface for CLR 4 or later, call the [CLRCreateInstance](clrcreateinstance-function.md) function and specify the class identifier `CLSID_CLRDebugging` and the interface identifier `IID_ICLRDebugging`. + This function is obsolete in the .NET Framework 4. Instead, to get an interface for the common language runtime (CLR) 2.0, use the [ICLRRuntimeInfo::GetInterface](iclrruntimeinfo-getinterface-method.md) method and specify the class identifier CLSID_CLRDebuggingLegacy and the interface identifier IID_ICorDebug. To get an interface for CLR 4 or later, call the [CLRCreateInstance](clrcreateinstance-function.md) function and specify the class identifier CLSID_CLRDebugging and the interface identifier IID_ICLRDebugging. ## Syntax @@ -35,7 +36,7 @@ HRESULT CreateDebuggingInterfaceFromVersion ( ## Parameters `iDebuggerVersion`\ - [in] The version of `ICorDebug` that is expected by the debugger. See the [CorDebugInterfaceVersion](../../../framework/debugging/cordebuginterfaceversion-enumeration.md) enumeration for valid values. + [in] The version of `ICorDebug` that is expected by the debugger. See the [CorDebugInterfaceVersion](../debugging/cordebuginterfaceversion-enumeration.md) enumeration for valid values. `szDebuggeeVersion`\ [in] The common language runtime version associated with the application or process to be debugged. See the [GetVersionFromProcess](getversionfromprocess-function.md) or [GetRequestedRuntimeVersion](getrequestedruntimeversion-function.md) method for information on retrieving this value. @@ -58,13 +59,13 @@ HRESULT CreateDebuggingInterfaceFromVersion ( ## Requirements - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). **Header:** MSCorEE.h **Library:** MSCorEE.dll - **.NET versions:** Available since .NET Framework 2.0 + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] ## See also diff --git a/docs/framework/unmanaged-api/hosting/createiceefilegen-function.md b/docs/framework/unmanaged-api/hosting/createiceefilegen-function.md new file mode 100644 index 0000000000000..24ab165a71b1a --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/createiceefilegen-function.md @@ -0,0 +1,62 @@ +--- +description: "Learn more about: CreateICeeFileGen Function" +title: "CreateICeeFileGen Function" +ms.date: "03/30/2017" +api_name: + - "CreateICeeFileGen" +api_location: + - "mscoree.dll" + - "mscorpehost.dll" + - "mscorpe.dll" +api_type: + - "COM" +f1_keywords: + - "CreateICeeFileGen" +helpviewer_keywords: + - "CreateICeeFileGen function [.NET Framework hosting]" +ms.assetid: e36e1fd8-8456-4359-bdc3-3ec1765f041f +topic_type: + - "apiref" +--- +# CreateICeeFileGen Function + +Creates an [ICeeFileGen](iceefilegen-class.md) object. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT CreateICeeFileGen ( + [out] ICeeFileGen **ceeFileGen +); +``` + +## Parameters + + `ceeFileGen` + [out] A pointer to the address of a new `ICeeFileGen` object. + +## Return Value + + This method returns standard COM error codes. + +## Remarks + + The `ICeeFileGen` object is used to create common language runtime (CLR) portable executable (PE) files. + + Call the [DestroyICeeFileGen](destroyiceefilegen-function.md) function to destroy the `ICeeFileGen` object when finished. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** ICeeFileGen.h + + **Library:** MSCorPE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + +## See also + +- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/customdumpitem-structure.md b/docs/framework/unmanaged-api/hosting/customdumpitem-structure.md new file mode 100644 index 0000000000000..aad14b6167376 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/customdumpitem-structure.md @@ -0,0 +1,57 @@ +--- +description: "Learn more about: CustomDumpItem Structure" +title: "CustomDumpItem Structure" +ms.date: "03/30/2017" +api_name: + - "CustomDumpItem" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CustomDumpItem" +helpviewer_keywords: + - "CustomDumpItem structure [.NET Framework hosting]" +ms.assetid: fd9085ff-7beb-4c38-97f0-037cd8ba4f65 +topic_type: + - "apiref" +--- +# CustomDumpItem Structure + +Describes an item to be added to a custom dump in error reporting. + +## Syntax + +```cpp +struct { + ECustomDumpItemKind itemKind; + union { + UINT_PTR pReserved; + } +} CustomDumpItem; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`itemKind`|An [ECustomDumpItemKind](ecustomdumpitemkind-enumeration.md) value that indicates the kind of item to be added.| +|`pReserved`|Not currently used. Any items added to the union must be no larger than pointer size. If a `struct` is required, you must allocate it separately and point to it.| + +## Remarks + + [ICLRErrorReportingManager::BeginCustomDump](iclrerrorreportingmanager-begincustomdump-method.md) takes a parameter of type `CustomDumpItem`. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.idl + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + +## See also + +- [Hosting Structures](hosting-structures.md) diff --git a/docs/core/unmanaged-api/hosting/deprecated-clr-hosting-functions.md b/docs/framework/unmanaged-api/hosting/deprecated-clr-hosting-functions.md similarity index 51% rename from docs/core/unmanaged-api/hosting/deprecated-clr-hosting-functions.md rename to docs/framework/unmanaged-api/hosting/deprecated-clr-hosting-functions.md index 68ec5e60e081d..ebffca45d0571 100644 --- a/docs/core/unmanaged-api/hosting/deprecated-clr-hosting-functions.md +++ b/docs/framework/unmanaged-api/hosting/deprecated-clr-hosting-functions.md @@ -2,154 +2,160 @@ description: "Learn more about: Deprecated CLR Hosting Functions" title: "Deprecated CLR Hosting Functions" ms.date: "03/30/2017" +helpviewer_keywords: + - ".NET Framework 1.1, hosting global static functions" + - "global static functions [.NET Framework hosting], version 2.0" + - ".NET Framework 2.0, hosting global static functions" + - "hosting global static functions [.NET Framework], version 2.0" +ms.assetid: 91fbbb35-e543-4814-b806-371cebae8c5a --- # Deprecated CLR Hosting Functions -This section describes the unmanaged global static functions that earlier versions of the hosting API used. - - With the exception of the infrastructure functions (`_Cor*` functions), which are used only by .NET Framework, these functions are deprecated starting in .NET Framework 4. - -## Activation functions - - [ClrCreateManagedInstance Function](clrcreatemanagedinstance-function.md) - Deprecated. Creates an instance of the specified managed type. - - [CoInitializeCor Function](coinitializecor-function.md) - Obsolete. To initialize the common language runtime (CLR), use either [CorBindToRuntimeEx](corbindtoruntimeex-function.md) or [CorBindToCurrentRuntime](corbindtocurrentruntime-function.md). - - [CoInitializeEE Function](coinitializeee-function.md) - Deprecated. Ensures that the CLR execution engine is loaded into a process. Use the [ICLRRuntimeHost::Start](iclrruntimehost-start-method.md) method instead. - - [CorBindToCurrentRuntime Function](corbindtocurrentruntime-function.md) - Deprecated. Loads the common language runtime (CLR) into a process by using version information stored in an XML file. - - [CorBindToRuntime Function](corbindtoruntime-function.md) - Deprecated. Enables unmanaged hosts to load the CLR into a process. - - [CorBindToRuntimeByCfg Function](corbindtoruntimebycfg-function.md) - Deprecated. Loads the CLR into a process by using version information that is read from an XML file. - - [CorBindToRuntimeEx Function](corbindtoruntimeex-function.md) - Deprecated. Enables unmanaged hosts to load the CLR into a process, and allows you to set flags to specify the behavior of the CLR. - - [CorBindToRuntimeHost Function](corbindtoruntimehost-function.md) - Deprecated. Enables hosts to load a specified version of the CLR into a process. - - [GetCORRequiredVersion Function](getcorrequiredversion-function.md) - Deprecated. Gets the required CLR version number. - - [GetCORSystemDirectory Function](getcorsystemdirectory-function.md) - Deprecated. Returns the installation directory of the CLR that is loaded into the process. - - [GetRealProcAddress Function](getrealprocaddress-function.md) - Deprecated. Gets the address of the specified function that is exported from the latest installed version of the CLR. - - [GetRequestedRuntimeInfo Function](getrequestedruntimeinfo-function.md) - Deprecated. Gets version and directory information about the CLR requested by an application. - -## CLR version functions - - The functions in this section return a CLR version; they do not activate the CLR. - - [GetCORVersion Function](getcorversion-function.md) - Deprecated. Returns the version number of the CLR that is running in the current process. - - [GetFileVersion Function](getfileversion-function.md) - Deprecated. Gets the CLR version information of the specified file, using the specified buffer. - - [GetRequestedRuntimeVersion Function](getrequestedruntimeversion-function.md) - Deprecated. Gets the version number of the CLR requested by the specified application. If that version is not installed, gets the most recent version that is installed before the requested version. - - [GetRequestedRuntimeVersionForCLSID Function](getrequestedruntimeversionforclsid-function.md) - Deprecated. Gets the appropriate CLR version information for the class with the specified CLSID. - - [GetVersionFromProcess Function](getversionfromprocess-function.md) - Deprecated. Gets the version number of the CLR that is associated with the specified process handle. - - [LockClrVersion Function](lockclrversion-function.md) - Deprecated. Allows the host to determine which version of the CLR will be used within the process before explicitly initializing the CLR. - -## Hosting functions - - [CallFunctionShim Function](callfunctionshim-function.md) - Deprecated. Makes a call to the function that has the specified name and parameters in the specified library. - - [CoEEShutDownCOM Function](coeeshutdowncom-function.md) - Deprecated. Unloads a COM assembly from the process. - - [CorExitProcess Function](corexitprocess-function.md) - Deprecated. Shuts down the current unmanaged process. - - [CorLaunchApplication Function](corlaunchapplication-function.md) - Deprecated. Starts the application at the specified network path, using the specified manifests and other application data. - - [CorMarkThreadInThreadPool Function](cormarkthreadinthreadpool-function.md) - Deprecated. Marks the currently executing thread-pool thread for the execution of managed code. Starting with .NET Framework version 2.0, this function has no effect. It is not required, and can be removed from your code. - - [CoUninitializeCor Function](couninitializecor-function.md) - Obsolete. The CLR cannot be unloaded from a process. - - [CoUninitializeEE Function](couninitializeee-function.md) - Obsolete. - - [CreateDebuggingInterfaceFromVersion Function](createdebugginginterfacefromversion-function.md) - Deprecated. Creates an [ICorDebug](../../../framework/debugging/icordebug-interface.md) object based on the specified version information. - - [CreateICeeFileGen Function](createiceefilegen-function.md) - Deprecated. Creates an [ICeeFileGen](iceefilegen-class.md) object. - - [DestroyICeeFileGen Function](destroyiceefilegen-function.md) - Deprecated. Destroys an [ICeeFileGen](iceefilegen-class.md) object. - - [FExecuteInAppDomainCallback Function Pointer](fexecuteinappdomaincallback-function-pointer.md) - Deprecated. Points to a function that the CLR calls to execute managed code. - - [FLockClrVersionCallback Function Pointer](flockclrversioncallback-function-pointer.md) - Deprecated. Points to a function that the CLR calls to notify the host that initialization has either started or completed. - - [GetCLRIdentityManager Function](getclridentitymanager-function.md) - Deprecated. Gets a pointer to an interface that allows the CLR to manage identities. - - [LoadLibraryShim Function](loadlibraryshim-function.md) - Deprecated. Loads a specified version of a .NET Framework DLL. - - [LoadStringRC Function](loadstringrc-function.md) - Deprecated. Translates an HRESULT value into an error message by using the default culture of the current thread. - - [LoadStringRCEx Function](loadstringrcex-function.md) - Deprecated. Translates an HRESULT value to an appropriate error message for the specified culture. - - [LPOVERLAPPED_COMPLETION_ROUTINE Function Pointer](lpoverlapped-completion-routine-function-pointer.md) - Deprecated. Points to a function that notifies the host when an overlapped (that is, asynchronous) I/O to a device has completed. - - [LPTHREAD_START_ROUTINE Function Pointer](lpthread-start-routine-function-pointer.md) - Deprecated. Points to a function that notifies the host that a thread has started to execute. - - [RunDll32ShimW Function](rundll32shimw-function.md) - Deprecated. Executes the specified command. - - [WAITORTIMERCALLBACK Function Pointer](waitortimercallback-function-pointer.md) - Deprecated. Points to a function that notifies the host that a wait handle has either been signaled or timed out. - -## Infrastructure functions - - The functions in this section are for use by the .NET Framework only. - - [_CorDllMain Function](cordllmain-function.md) - Initializes the CLR, locates the managed entry point in the DLL assembly's CLR header, and begins execution. - - [_CorExeMain Function](corexemain-function.md) - Initializes the CLR, locates the managed entry point in the executable assembly's CLR header, and begins execution. - - [_CorExeMain2 Function](corexemain2-function.md) - Executes the entry point in the specified memory-mapped code. This function is called by the operating system loader. - - [_CorImageUnloading Function](corimageunloading-function.md) - Notifies the loader when the managed module images are unloaded. - - [_CorValidateImage Function](corvalidateimage-function.md) - Validates managed module images, and notifies the operating system loader after they have been loaded. - +This section describes the unmanaged global static functions that earlier versions of the hosting API used. + + With the exception of the infrastructure functions (`_Cor*` functions), which are used only by the .NET Framework, these functions have been deprecated in the .NET Framework 4. + +## Activation functions + + [ClrCreateManagedInstance Function](clrcreatemanagedinstance-function.md) + Deprecated. Creates an instance of the specified managed type. + + [CoInitializeCor Function](coinitializecor-function.md) + Obsolete. To initialize the common language runtime (CLR), use either [CorBindToRuntimeEx](corbindtoruntimeex-function.md) or [CorBindToCurrentRuntime](corbindtocurrentruntime-function.md). + + [CoInitializeEE Function](coinitializeee-function.md) + Deprecated. Ensures that the CLR execution engine is loaded into a process. Use the [ICLRRuntimeHost::Start](iclrruntimehost-start-method.md) method instead. + + [CorBindToCurrentRuntime Function](corbindtocurrentruntime-function.md) + Deprecated. Loads the common language runtime (CLR) into a process by using version information stored in an XML file. + + [CorBindToRuntime Function](corbindtoruntime-function.md) + Deprecated. Enables unmanaged hosts to load the CLR into a process. + + [CorBindToRuntimeByCfg Function](corbindtoruntimebycfg-function.md) + Deprecated. Loads the CLR into a process by using version information that is read from an XML file. + + [CorBindToRuntimeEx Function](corbindtoruntimeex-function.md) + Deprecated. Enables unmanaged hosts to load the CLR into a process, and allows you to set flags to specify the behavior of the CLR. + + [CorBindToRuntimeHost Function](corbindtoruntimehost-function.md) + Deprecated. Enables hosts to load a specified version of the CLR into a process. + + [GetCORRequiredVersion Function](getcorrequiredversion-function.md) + Deprecated. Gets the required CLR version number. + + [GetCORSystemDirectory Function](getcorsystemdirectory-function.md) + Deprecated. Returns the installation directory of the CLR that is loaded into the process. + + [GetRealProcAddress Function](getrealprocaddress-function.md) + Deprecated. Gets the address of the specified function that is exported from the latest installed version of the CLR. + + [GetRequestedRuntimeInfo Function](getrequestedruntimeinfo-function.md) + Deprecated. Gets version and directory information about the CLR requested by an application. + +## CLR version functions + + The functions in this section return a CLR version; they do not activate the CLR. + + [GetCORVersion Function](getcorversion-function.md) + Deprecated. Returns the version number of the CLR that is running in the current process. + + [GetFileVersion Function](getfileversion-function.md) + Deprecated. Gets the CLR version information of the specified file, using the specified buffer. + + [GetRequestedRuntimeVersion Function](getrequestedruntimeversion-function.md) + Deprecated. Gets the version number of the CLR requested by the specified application. If that version is not installed, gets the most recent version that is installed before the requested version. + + [GetRequestedRuntimeVersionForCLSID Function](getrequestedruntimeversionforclsid-function.md) + Deprecated. Gets the appropriate CLR version information for the class with the specified CLSID. + + [GetVersionFromProcess Function](getversionfromprocess-function.md) + Deprecated. Gets the version number of the CLR that is associated with the specified process handle. + + [LockClrVersion Function](lockclrversion-function.md) + Deprecated. Allows the host to determine which version of the CLR will be used within the process before explicitly initializing the CLR. + +## Hosting functions + + [CallFunctionShim Function](callfunctionshim-function.md) + Deprecated. Makes a call to the function that has the specified name and parameters in the specified library. + + [CoEEShutDownCOM Function](coeeshutdowncom-function.md) + Deprecated. Unloads a COM assembly from the process. + + [CorExitProcess Function](corexitprocess-function.md) + Deprecated. Shuts down the current unmanaged process. + + [CorLaunchApplication Function](corlaunchapplication-function.md) + Deprecated. Starts the application at the specified network path, using the specified manifests and other application data. + + [CorMarkThreadInThreadPool Function](cormarkthreadinthreadpool-function.md) + Deprecated. Marks the currently executing thread-pool thread for the execution of managed code. Starting with .NET Framework version 2.0, this function has no effect. It is not required, and can be removed from your code. + + [CoUninitializeCor Function](couninitializecor-function.md) + Obsolete. The CLR cannot be unloaded from a process. + + [CoUninitializeEE Function](couninitializeee-function.md) + Obsolete. + + [CreateDebuggingInterfaceFromVersion Function](createdebugginginterfacefromversion-function.md) + Deprecated. Creates an [ICorDebug](../debugging/icordebug-interface.md) object based on the specified version information. + + [CreateICeeFileGen Function](createiceefilegen-function.md) + Deprecated. Creates an [ICeeFileGen](iceefilegen-class.md) object. + + [DestroyICeeFileGen Function](destroyiceefilegen-function.md) + Deprecated. Destroys an [ICeeFileGen](iceefilegen-class.md) object. + + [FExecuteInAppDomainCallback Function Pointer](fexecuteinappdomaincallback-function-pointer.md) + Deprecated. Points to a function that the CLR calls to execute managed code. + + [FLockClrVersionCallback Function Pointer](flockclrversioncallback-function-pointer.md) + Deprecated. Points to a function that the CLR calls to notify the host that initialization has either started or completed. + + [GetCLRIdentityManager Function](getclridentitymanager-function.md) + Deprecated. Gets a pointer to an interface that allows the CLR to manage identities. + + [LoadLibraryShim Function](loadlibraryshim-function.md) + Deprecated. Loads a specified version of a .NET Framework DLL. + + [LoadStringRC Function](loadstringrc-function.md) + Deprecated. Translates an HRESULT value into an error message by using the default culture of the current thread. + + [LoadStringRCEx Function](loadstringrcex-function.md) + Deprecated. Translates an HRESULT value to an appropriate error message for the specified culture. + + [LPOVERLAPPED_COMPLETION_ROUTINE Function Pointer](lpoverlapped-completion-routine-function-pointer.md) + Deprecated. Points to a function that notifies the host when an overlapped (that is, asynchronous) I/O to a device has completed. + + [LPTHREAD_START_ROUTINE Function Pointer](lpthread-start-routine-function-pointer.md) + Deprecated. Points to a function that notifies the host that a thread has started to execute. + + [RunDll32ShimW Function](rundll32shimw-function.md) + Deprecated. Executes the specified command. + + [WAITORTIMERCALLBACK Function Pointer](waitortimercallback-function-pointer.md) + Deprecated. Points to a function that notifies the host that a wait handle has either been signaled or timed out. + +## Infrastructure functions + + The functions in this section are for use by the .NET Framework only. + + [_CorDllMain Function](cordllmain-function.md) + Initializes the CLR, locates the managed entry point in the DLL assembly's CLR header, and begins execution. + + [_CorExeMain Function](corexemain-function.md) + Initializes the CLR, locates the managed entry point in the executable assembly's CLR header, and begins execution. + + [_CorExeMain2 Function](corexemain2-function.md) + Executes the entry point in the specified memory-mapped code. This function is called by the operating system loader. + + [_CorImageUnloading Function](corimageunloading-function.md) + Notifies the loader when the managed module images are unloaded. + + [_CorValidateImage Function](corvalidateimage-function.md) + Validates managed module images, and notifies the operating system loader after they have been loaded. + ## See also - [.NET Framework 4 Hosting Global Static Functions](net-framework-4-hosting-global-static-functions.md) diff --git a/docs/core/unmanaged-api/hosting/deprecated-clr-hosting-interfaces-and-coclasses.md b/docs/framework/unmanaged-api/hosting/deprecated-clr-hosting-interfaces-and-coclasses.md similarity index 68% rename from docs/core/unmanaged-api/hosting/deprecated-clr-hosting-interfaces-and-coclasses.md rename to docs/framework/unmanaged-api/hosting/deprecated-clr-hosting-interfaces-and-coclasses.md index ec3babecb5ee8..0a0bcd13b9f65 100644 --- a/docs/core/unmanaged-api/hosting/deprecated-clr-hosting-interfaces-and-coclasses.md +++ b/docs/framework/unmanaged-api/hosting/deprecated-clr-hosting-interfaces-and-coclasses.md @@ -2,28 +2,29 @@ description: "Learn more about: Deprecated CLR Hosting Interfaces and Coclasses" title: "Deprecated CLR Hosting Interfaces and Coclasses" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - "interfaces [.NET Framework hosting], version 1" - ".NET Framework 1.1, hosting interfaces" - "hosting interfaces [.NET Framework], version 1" - ".NET Framework 1.0, hosting interfaces" +ms.assetid: 7b3d2755-cbab-4160-bc69-eb85791e38c7 --- # Deprecated CLR Hosting Interfaces and Coclasses -This section describes the interfaces that unmanaged hosts can use to integrate the common language runtime (CLR) in the .NET Framework versions 1.0 and 1.1 into their applications. These interfaces provide methods for a host to configure and load the runtime into a process. +This section describes the interfaces that unmanaged hosts can use to integrate the common language runtime (CLR) in the .NET Framework versions 1.0 and 1.1 into their applications. These interfaces provide methods for a host to configure and load the runtime into a process. + +## In This Section -## In This Section + IAppDomainSetup + Provides methods for the host to configure an . + + [ICeeFileGen Class](iceefilegen-class.md) + (Deprecated) Provides functionality for creating a native portable executable (PE) file. + + [ICorRuntimeHost Interface](icorruntimehost-interface.md) + Provides methods for the host to configure CLR settings. + +## Related Sections - IAppDomainSetup - Provides methods for the host to configure an . - - [ICeeFileGen Class](iceefilegen-class.md) - (Deprecated) Provides functionality for creating a native portable executable (PE) file. - - [ICorRuntimeHost Interface](icorruntimehost-interface.md) - Provides methods for the host to configure CLR settings. - -## Related Sections - - [CLR Hosting Interfaces](clr-hosting-interfaces.md) + [CLR Hosting Interfaces](clr-hosting-interfaces.md) Contains topics that describe the hosting interfaces provided with the .NET Framework version 2.0 and later versions. diff --git a/docs/framework/unmanaged-api/hosting/destroyiceefilegen-function.md b/docs/framework/unmanaged-api/hosting/destroyiceefilegen-function.md new file mode 100644 index 0000000000000..f7174816f5e73 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/destroyiceefilegen-function.md @@ -0,0 +1,60 @@ +--- +description: "Learn more about: DestroyICeeFileGen Function" +title: "DestroyICeeFileGen Function" +ms.date: "03/30/2017" +api_name: + - "DestroyICeeFileGen" +api_location: + - "mscoree.dll" + - "mscorpehost.dll" + - "mscorpe.dll" +api_type: + - "COM" +f1_keywords: + - "DestroyICeeFileGen" +helpviewer_keywords: + - "DestroyICeeFileGen function [.NET Framework hosting]" +ms.assetid: dc1e2235-e721-4cb2-a0b8-6b0c030d7bab +topic_type: + - "apiref" +--- +# DestroyICeeFileGen Function + +Destroys an [ICeeFileGen](iceefilegen-class.md) object. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT DestroyICeeFileGen ( + [in] ICeeFileGen **ceeFileGen +); +``` + +## Parameters + + `ceeFileGen` + [in] The `ICeeFileGen` object to destroy. + +## Return Value + + This method returns standard COM error codes. + +## Remarks + + `DestroyICeeFileGen` destroys the `ICeeFileGen` object created by the [CreateICeeFileGen](createiceefilegen-function.md) function. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** ICeeFileGen.h + + **Library:** MSCorPE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + +## See also + +- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/eapicategories-enumeration.md b/docs/framework/unmanaged-api/hosting/eapicategories-enumeration.md similarity index 63% rename from docs/core/unmanaged-api/hosting/eapicategories-enumeration.md rename to docs/framework/unmanaged-api/hosting/eapicategories-enumeration.md index e166a5f4867c3..47d9b6a3b32fc 100644 --- a/docs/core/unmanaged-api/hosting/eapicategories-enumeration.md +++ b/docs/framework/unmanaged-api/hosting/eapicategories-enumeration.md @@ -2,73 +2,74 @@ description: "Learn more about: EApiCategories Enumeration" title: "EApiCategories Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EApiCategories" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EApiCategories" -helpviewer_keywords: +helpviewer_keywords: - "EApiCategories enumeration [.NET Framework hosting]" -topic_type: +ms.assetid: 3c4a8a5a-8a46-4ac9-947f-4959bc9d6ac6 +topic_type: - "apiref" --- # EApiCategories Enumeration -Describes the categories of capabilities that the host can block from running in partially trusted code. +Describes the categories of capabilities that the host can block from running in partially trusted code. + +## Syntax + +```cpp +typedef enum { + eNoCategory = 0, + eSynchronization = 0x1, + eSharedState = 0x2, + eExternalProcessMgmt = 0x4, + eSelfAffectingProcessMgmt = 0x8, + eExternalThreading = 0x10, + eSelfAffectingThreading = 0x20, + eSecurityInfrastructure = 0x40, + eUI = 0x80, + eMayLeakOnAbort = 0x100, + eAll = 0x1ff +} EHostProtectionCategories; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`eAll`|Specifies that all managed classes and members that are covered by other `EApiCategories` fields be blocked from running in partially trusted code.| +|`eExternalProcessMgmt`|Specifies that managed classes and members that allow the creation, manipulation, and destruction of external processes be blocked from running in partially trusted code.| +|`eExternalThreading`|Specifies that managed classes and members that allow the creation, manipulation, and destruction of external threads be blocked from running in partially trusted code.| +|`eMayLeakOnAbort`|Specifies that managed types and members that could potentially leak memory on abort be blocked from running in partially trusted code.| +|`eNoCategory`|Specifies that no managed code categories be blocked from running in partially trusted code.| +|`eSecurityInfrastructure`|Specifies that the common language runtime (CLR) security infrastructure be blocked from being used by partially trusted code.| +|`eSelfAffectingProcessMgmt`|Specifies that managed classes and members whose capabilities can affect the hosted process be blocked from running in partially trusted code.| +|`eSelfAffectingThreading`|Specifies that managed classes and members whose capabilities can affect threads in the hosted process be blocked from running in partially trusted code.| +|`eSharedState`|Specifies that managed classes and members that expose shared state be blocked from running in partially trusted code.| +|`eSynchronization`|Specifies that common language runtime classes and members that allow user code to hold locks be blocked from running in partially trusted code.| +|`eUI`|Specifies that managed classes and members that allow or require human interaction be blocked from running in partially trusted code.| + +## Remarks -## Syntax - -```cpp -typedef enum { - eNoCategory = 0, - eSynchronization = 0x1, - eSharedState = 0x2, - eExternalProcessMgmt = 0x4, - eSelfAffectingProcessMgmt = 0x8, - eExternalThreading = 0x10, - eSelfAffectingThreading = 0x20, - eSecurityInfrastructure = 0x40, - eUI = 0x80, - eMayLeakOnAbort = 0x100, - eAll = 0x1ff -} EHostProtectionCategories; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`eAll`|Specifies that all managed classes and members that are covered by other `EApiCategories` fields be blocked from running in partially trusted code.| -|`eExternalProcessMgmt`|Specifies that managed classes and members that allow the creation, manipulation, and destruction of external processes be blocked from running in partially trusted code.| -|`eExternalThreading`|Specifies that managed classes and members that allow the creation, manipulation, and destruction of external threads be blocked from running in partially trusted code.| -|`eMayLeakOnAbort`|Specifies that managed types and members that could potentially leak memory on abort be blocked from running in partially trusted code.| -|`eNoCategory`|Specifies that no managed code categories be blocked from running in partially trusted code.| -|`eSecurityInfrastructure`|Specifies that the common language runtime (CLR) security infrastructure be blocked from being used by partially trusted code.| -|`eSelfAffectingProcessMgmt`|Specifies that managed classes and members whose capabilities can affect the hosted process be blocked from running in partially trusted code.| -|`eSelfAffectingThreading`|Specifies that managed classes and members whose capabilities can affect threads in the hosted process be blocked from running in partially trusted code.| -|`eSharedState`|Specifies that managed classes and members that expose shared state be blocked from running in partially trusted code.| -|`eSynchronization`|Specifies that common language runtime classes and members that allow user code to hold locks be blocked from running in partially trusted code.| -|`eUI`|Specifies that managed classes and members that allow or require human interaction be blocked from running in partially trusted code.| - -## Remarks - - The [ICLRHostProtectionManager::SetProtectedCategories](iclrhostprotectionmanager-setprotectedcategories-method.md) method takes a parameter of type `EApiCategories`. - - The `EApiCategories` enumeration and the `SetProtectedCategories` method are directly related to the managed class. The managed class is used with the enumeration, whose values correspond directly to the `EApiCategories` values, to mark managed types and members that expose capabilities corresponding to the categories described by `EApiCategories`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 + The [ICLRHostProtectionManager::SetProtectedCategories](iclrhostprotectionmanager-setprotectedcategories-method.md) method takes a parameter of type `EApiCategories`. + + The `EApiCategories` enumeration and the `SetProtectedCategories` method are directly related to the managed class. The managed class is used with the enumeration, whose values correspond directly to the `EApiCategories` values, to mark managed types and members that expose capabilities corresponding to the categories described by `EApiCategories`. + +## Requirements + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [ICLRHostProtectionManager Interface](iclrhostprotectionmanager-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/ebindpolicylevels-enumeration.md b/docs/framework/unmanaged-api/hosting/ebindpolicylevels-enumeration.md new file mode 100644 index 0000000000000..bb85a723237db --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/ebindpolicylevels-enumeration.md @@ -0,0 +1,68 @@ +--- +description: "Learn more about: EBindPolicyLevels Enumeration" +title: "EBindPolicyLevels Enumeration" +ms.date: "03/30/2017" +api_name: + - "EBindPolicyLevels" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "EBindPolicyLevels" +helpviewer_keywords: + - "EBindPolicyLevels enumeration [.NET Framework hosting]" +ms.assetid: a9e00b4f-b6d0-4257-bd88-4fe9af97b8fa +topic_type: + - "apiref" +--- +# EBindPolicyLevels Enumeration + +Provides flags to specify the level at which to apply or modify assembly policy. + +## Syntax + +```cpp +typedef enum { + ePolicyLevelNone = 0x0, + ePolicyLevelRetargetable = 0x1, + ePolicyUnifiedToCLR = 0x2, + ePolicyLevelApp = 0x4, + ePolicyLevelPublisher = 0x8, + ePolicyLevelHost = 0x10, + ePolicyLevelAdmin = 0x20 + ePolicyPortability = 0x40 +} EBindPolicyLevels; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`ePolicyLevelAdmin`|Specifies that policy should be applied at the administrator level.| +|`ePolicyLevelApp`|Specifies that policy should be applied at the application level.| +|`ePolicyLevelHost`|Specifies that policy should be applied at the host level.| +|`ePolicyLevelNone`|Specifies no policy-level flags.| +|`ePolicyLevelPublisher`|Specifies that policy should be applied at the publisher level.| +|`ePolicyLevelRetargetable`|Specifies that policy should be applicable at variable levels.| +|`ePolicyPortability`|Specifies that policy should support portability between implementations of a .NET Framework assembly. See the [\](../../configure-apps/file-schema/runtime/supportportability-element.md) configuration file element.| +|`ePolicyUnifiedToCLR`|Specifies that policy should be unified to that of the common language runtime (CLR).| + +## Remarks + + This enumeration is passed to methods of the [ICLRHostBindingPolicyManager](iclrhostbindingpolicymanager-interface.md) interface to specify changes in application policy. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + +## See also + +- [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) +- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/framework/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md b/docs/framework/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md new file mode 100644 index 0000000000000..801e6552b0cf0 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/eclrassemblyidentityflags-enumeration.md @@ -0,0 +1,47 @@ +--- +description: "Learn more about: ECLRAssemblyIdentityFlags Enumeration" +title: "ECLRAssemblyIdentityFlags Enumeration" +ms.date: "03/30/2017" +api_name: + - "ECLRAssemblyIdentityFlags" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ECLRAssemblyIdentityFlags" +helpviewer_keywords: + - "ECLRAssemblyIdentityFlags enumeration [.NET Framework hosting]" +ms.assetid: d1e0b654-ccaf-4fa2-9aa3-8e007813c84d +topic_type: + - "apiref" +--- +# ECLRAssemblyIdentityFlags Enumeration + +Indicates the type of an assembly's identity. + +## Syntax + +```cpp +typedef enum _CLRAssemblyIdentityFlags { + CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT = 0 +} ECLRAssemblyIdentityFlags; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT`|The identity is canonicalized.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + +## See also + +- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/framework/unmanaged-api/hosting/eclrevent-enumeration.md b/docs/framework/unmanaged-api/hosting/eclrevent-enumeration.md new file mode 100644 index 0000000000000..81f508b485b8a --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/eclrevent-enumeration.md @@ -0,0 +1,65 @@ +--- +description: "Learn more about: EClrEvent Enumeration" +title: "EClrEvent Enumeration" +ms.date: "03/30/2017" +api_name: + - "EClrEvent" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "EClrEvent" +helpviewer_keywords: + - "EClrEvent enumeration [.NET Framework hosting]" +ms.assetid: 7c36a7c2-75a2-4971-bc23-abf54c812154 +topic_type: + - "apiref" +--- +# EClrEvent Enumeration + +Describes the common language runtime (CLR) events for which the host can register callbacks. + +## Syntax + +```cpp +typedef enum { + Event_ClrDisabled, + Event_DomainUnload, + Event_MDAFired, + Event_StackOverflow +} EClrEvent; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`Event_ClrDisabled`|Specifies a fatal CLR error.| +|`Event_DomainUnload`|Specifies the unloading of a particular .| +|`Event_MDAFired`|Specifies that a Managed Debugging Assistant (MDA) message has been generated.| +|`Event_StackOverflow`|Specifies that a stack overflow error has occurred.| + +## Remarks + + The host can register callbacks for any of the event types described by `EClrEvent` by calling methods of the [ICLROnEventManager](iclroneventmanager-interface.md) interface. The host gets a pointer to this interface by calling the [ICLRControl::GetCLRManager](iclrcontrol-getclrmanager-method.md) method. + + The `Event_CLRDisabled` and `Event_DomainUnload` events can be raised more than once and from different threads to signal an unload or the disabling of the CLR. + + The `Event_MDAFired` event raises the creation of an [MDAInfo](mdainfo-structure.md) instance that contains the details of the MDA message. For more information about MDAs, see [Diagnosing Errors with Managed Debugging Assistants](../../debug-trace-profile/diagnosing-errors-with-managed-debugging-assistants.md). + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + +## See also + +- [IActionOnCLREvent Interface](iactiononclrevent-interface.md) +- [ICLRControl Interface](iclrcontrol-interface.md) +- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md b/docs/framework/unmanaged-api/hosting/eclrfailure-enumeration.md similarity index 58% rename from docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md rename to docs/framework/unmanaged-api/hosting/eclrfailure-enumeration.md index 72fd61b81c3b7..8034d6a1f23a0 100644 --- a/docs/core/unmanaged-api/hosting/eclrfailure-enumeration.md +++ b/docs/framework/unmanaged-api/hosting/eclrfailure-enumeration.md @@ -2,63 +2,64 @@ description: "Learn more about: EClrFailure Enumeration" title: "EClrFailure Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EClrFailure" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EClrFailure" -helpviewer_keywords: +helpviewer_keywords: - "EClrFailure enumeration [.NET Framework hosting]" -topic_type: +ms.assetid: 37b95cce-9bfb-4ecf-a00b-33dcba782c67 +topic_type: - "apiref" --- # EClrFailure Enumeration -Describes the set of failures for which a host can set policy actions. +Describes the set of failures for which a host can set policy actions. + +## Syntax + +```cpp +typedef enum { + FAIL_NonCriticalResource, + FAIL_CriticalResource, + FAIL_FatalRuntime, + FAIL_OrphanedLock + FAIL_StackOverflow + FAIL_AccessViolation + FAIL_CodeContract +} EClrFailure; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`FAIL_NonCriticalResource`|A failure occurred during an attempt to allocate a resource (such as a thread, a block of memory, or a lock) in a non-critical region of code.| +|`FAIL_CriticalResource`|A failure occurred during an attempt to allocate a resource (such as a thread, a block of memory, or a lock) in a critical region of code.| +|`FAIL_FatalRuntime`|The common language runtime (CLR) is no longer able to run managed code in the process. Henceforth, calls to any hosting functions return an HRESULT value of HOST_E_CLRNOTAVAILABLE.| +|`FAIL_OrphanedLock`|A thread has failed to release a lock upon returning from an object. The host cannot set this failure to cause a thread to abort.| +|`FAIL_StackOverflow`|A stack overflow has occurred.| +|`FAIL_AccessViolation`|An attempt was made to read or write protected memory. Not supported in the .NET Framework 4.| +|`FAIL_CodeContract`|A code contract failure occurred. See [Code Contracts](../../debug-trace-profile/code-contracts.md).| + +## Remarks -## Syntax - -```cpp -typedef enum { - FAIL_NonCriticalResource, - FAIL_CriticalResource, - FAIL_FatalRuntime, - FAIL_OrphanedLock - FAIL_StackOverflow - FAIL_AccessViolation - FAIL_CodeContract -} EClrFailure; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`FAIL_NonCriticalResource`|A failure occurred during an attempt to allocate a resource (such as a thread, a block of memory, or a lock) in a non-critical region of code.| -|`FAIL_CriticalResource`|A failure occurred during an attempt to allocate a resource (such as a thread, a block of memory, or a lock) in a critical region of code.| -|`FAIL_FatalRuntime`|The common language runtime (CLR) is no longer able to run managed code in the process. Henceforth, calls to any hosting functions return an HRESULT value of HOST_E_CLRNOTAVAILABLE.| -|`FAIL_OrphanedLock`|A thread has failed to release a lock upon returning from an object. The host cannot set this failure to cause a thread to abort.| -|`FAIL_StackOverflow`|A stack overflow has occurred.| -|`FAIL_AccessViolation`|An attempt was made to read or write protected memory. Not supported in the .NET Framework 4.| -|`FAIL_CodeContract`|A code contract failure occurred. See [Code Contracts](../../../framework/debug-trace-profile/code-contracts.md).| - -## Remarks - - See the [ICLRPolicyManager::SetActionOnFailure](iclrpolicymanager-setactiononfailure-method.md) method for a list of [EPolicyAction](epolicyaction-enumeration.md) values the host can use to specify the policy actions for failure conditions. For more information about critical and non-critical regions of code, see [EClrOperation](eclroperation-enumeration.md). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 + See the [ICLRPolicyManager::SetActionOnFailure](iclrpolicymanager-setactiononfailure-method.md) method for a list of [EPolicyAction](epolicyaction-enumeration.md) values the host can use to specify the policy actions for failure conditions. For more information about critical and non-critical regions of code, see [EClrOperation](eclroperation-enumeration.md). + +## Requirements + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [ICLRPolicyManager Interface](iclrpolicymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/eclroperation-enumeration.md b/docs/framework/unmanaged-api/hosting/eclroperation-enumeration.md similarity index 67% rename from docs/core/unmanaged-api/hosting/eclroperation-enumeration.md rename to docs/framework/unmanaged-api/hosting/eclroperation-enumeration.md index 12e7041668064..eec0b271dc991 100644 --- a/docs/core/unmanaged-api/hosting/eclroperation-enumeration.md +++ b/docs/framework/unmanaged-api/hosting/eclroperation-enumeration.md @@ -2,69 +2,70 @@ description: "Learn more about: EClrOperation Enumeration" title: "EClrOperation Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EClrOperation" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EClrOperation" -helpviewer_keywords: +helpviewer_keywords: - "EClrOperation enumeration [.NET Framework hosting]" -topic_type: +ms.assetid: 5aef6808-5aac-4b2f-a2c7-fee1575c55ed +topic_type: - "apiref" --- # EClrOperation Enumeration -Describes the set of operations for which a host can apply policy actions. - -## Syntax - -```cpp -typedef enum { - OPR_ThreadAbort, - OPR_ThreadRudeAbortInNonCriticalRegion, - OPR_ThreadRudeAbortInCriticalRegion, - OPR_AppDomainUnload, - OPR_AppDomainRudeUnload, - OPR_ProcessExit, - OPR_FinalizerRun -} EClrOperation; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`OPR_AppDomainRudeUnload`|The host can specify policy actions to be taken when an is unloaded in a non-graceful (rude) manner.| -|`OPR_AppDomainUnload`|The host can specify policy actions to be taken when an is unloaded.| -|`OPR_FinalizerRun`|The host can specify policy actions to be taken when finalizers run.| -|`OPR_ProcessExit`|The host can specify policy actions to be taken when the process exits.| -|`OPR_ThreadAbort`|The host can specify policy actions to be taken when a thread is aborted.| -|`OPR_ThreadRudeAbortInCriticalRegion`|The host can specify policy actions to be taken when a rude thread abort occurs in a critical region of code.| -|`OPR_ThreadRudeAbortInNonCriticalRegion`|The host can specify policy actions to be take when a rude thread abort occurs in a non-critical region of code.| - -## Remarks - - The common language runtime (CLR) reliability infrastructure distinguishes between aborts and resource allocation failures that occur in critical regions of code and those that occur in non-critical regions of code. This distinction is designed to allow hosts to set different policies depending on where a failure occurs in the code. - - A *critical region of code* is any space where the CLR cannot guarantee that aborting a task or failing to complete a request for resources will affect only the current task. For example, if a task is holding a lock and receives an HRESULT that indicates failure upon making a memory allocation request, it is insufficient simply to abort that task to ensure the stability of the , because the might contain other tasks waiting for the same lock. To abandon the current task might cause those other tasks to stop responding. In such a case, the host needs the ability to unload the entire rather than risk potential instability. - - A *non-critical region of code*, on the other hand, is a region where the CLR can guarantee that an abort or a failure will affect only the task upon which the error occurs. - - The CLR also distinguishes between graceful and non-graceful (rude) aborts. In general, a normal or graceful abort makes every effort to run exception-handling routines and finalizers before aborting a task, while a rude abort makes no such guarantees. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - +Describes the set of operations for which a host can apply policy actions. + +## Syntax + +```cpp +typedef enum { + OPR_ThreadAbort, + OPR_ThreadRudeAbortInNonCriticalRegion, + OPR_ThreadRudeAbortInCriticalRegion, + OPR_AppDomainUnload, + OPR_AppDomainRudeUnload, + OPR_ProcessExit, + OPR_FinalizerRun +} EClrOperation; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`OPR_AppDomainRudeUnload`|The host can specify policy actions to be taken when an is unloaded in a non-graceful (rude) manner.| +|`OPR_AppDomainUnload`|The host can specify policy actions to be taken when an is unloaded.| +|`OPR_FinalizerRun`|The host can specify policy actions to be taken when finalizers run.| +|`OPR_ProcessExit`|The host can specify policy actions to be taken when the process exits.| +|`OPR_ThreadAbort`|The host can specify policy actions to be taken when a thread is aborted.| +|`OPR_ThreadRudeAbortInCriticalRegion`|The host can specify policy actions to be taken when a rude thread abort occurs in a critical region of code.| +|`OPR_ThreadRudeAbortInNonCriticalRegion`|The host can specify policy actions to be take when a rude thread abort occurs in a non-critical region of code.| + +## Remarks + + The common language runtime (CLR) reliability infrastructure distinguishes between aborts and resource allocation failures that occur in critical regions of code and those that occur in non-critical regions of code. This distinction is designed to allow hosts to set different policies depending on where a failure occurs in the code. + + A *critical region of code* is any space where the CLR cannot guarantee that aborting a task or failing to complete a request for resources will affect only the current task. For example, if a task is holding a lock and receives an HRESULT that indicates failure upon making a memory allocation request, it is insufficient simply to abort that task to ensure the stability of the , because the might contain other tasks waiting for the same lock. To abandon the current task might cause those other tasks to stop responding. In such a case, the host needs the ability to unload the entire rather than risk potential instability. + + A *non-critical region of code*, on the other hand, is a region where the CLR can guarantee that an abort or a failure will affect only the task upon which the error occurs. + + The CLR also distinguishes between graceful and non-graceful (rude) aborts. In general, a normal or graceful abort makes every effort to run exception-handling routines and finalizers before aborting a task, while a rude abort makes no such guarantees. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [EClrFailure Enumeration](eclrfailure-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md b/docs/framework/unmanaged-api/hosting/eclrunhandledexception-enumeration.md similarity index 58% rename from docs/core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md rename to docs/framework/unmanaged-api/hosting/eclrunhandledexception-enumeration.md index eb4414bccd5c8..8a86d2a2cd494 100644 --- a/docs/core/unmanaged-api/hosting/eclrunhandledexception-enumeration.md +++ b/docs/framework/unmanaged-api/hosting/eclrunhandledexception-enumeration.md @@ -2,53 +2,54 @@ description: "Learn more about: EClrUnhandledException Enumeration" title: "EClrUnhandledException Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EClrUnhandledException" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EClrUnhandledException" -helpviewer_keywords: +helpviewer_keywords: - "EClrUnhandledException enumeration [.NET Framework hosting]" -topic_type: +ms.assetid: d231044e-2b53-4836-93f9-8117ff0e5c3a +topic_type: - "apiref" --- # EClrUnhandledException Enumeration -Describes the available options for managing exceptions that are unhandled in user code. - -## Syntax - -```cpp -typedef enum { - eRuntimeDeterminedPolicy, - eHostDeterminedPolicy -} EClrUnhandledException; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`eRuntimeDeterminedPolicy`|Specifies that the default behavior occurs. The process is torn down.| -|`eHostDeterminedPolicy`|Specifies that the common language runtime (CLR) ignores unhandled exceptions and lets the host determine any further action.| - -## Remarks - - To specify that the CLR behave like earlier versions, use the `eHostDeterminedPolicy` member. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - +Describes the available options for managing exceptions that are unhandled in user code. + +## Syntax + +```cpp +typedef enum { + eRuntimeDeterminedPolicy, + eHostDeterminedPolicy +} EClrUnhandledException; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`eRuntimeDeterminedPolicy`|Specifies that the default behavior occurs. The process is torn down.| +|`eHostDeterminedPolicy`|Specifies that the common language runtime (CLR) ignores unhandled exceptions and lets the host determine any further action.| + +## Remarks + + To specify that the CLR behave like earlier versions, use the `eHostDeterminedPolicy` member. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [EClrFailure Enumeration](eclrfailure-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/econtexttype-enumeration.md b/docs/framework/unmanaged-api/hosting/econtexttype-enumeration.md similarity index 58% rename from docs/core/unmanaged-api/hosting/econtexttype-enumeration.md rename to docs/framework/unmanaged-api/hosting/econtexttype-enumeration.md index 02f9d7034f84f..defb350588e8a 100644 --- a/docs/core/unmanaged-api/hosting/econtexttype-enumeration.md +++ b/docs/framework/unmanaged-api/hosting/econtexttype-enumeration.md @@ -2,53 +2,54 @@ description: "Learn more about: EContextType Enumeration" title: "EContextType Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EContextType" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EContextType" -helpviewer_keywords: +helpviewer_keywords: - "EContextType enumeration [.NET Framework hosting]" -topic_type: +ms.assetid: 92b926a9-b87e-408a-9036-df7b752c9492 +topic_type: - "apiref" --- # EContextType Enumeration -Describes the security context of the currently executing thread. - -## Syntax - -```cpp -typedef enum { - eCurrentContext = 0x00, - eRestrictedContext = 0x01 -} EContextType; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`eCurrentContext`|Indicates the context on the current thread at the time the common language runtime (CLR) calls the [IHostSecurityManager::GetSecurityContext](ihostsecuritymanager-getsecuritycontext-method.md) method, or the context requested by the CLR in a call to the [IHostSecurityManager::SetSecurityContext](ihostsecuritymanager-setsecuritycontext-method.md) method.| -|`eRestrictedContext`|Indicates a context over which the host has lower privileges, such as the garbage collector, or class or module constructors.| - -## Remarks - - The CLR supplies one of the `EContextType` values as a parameter value in calls to the `IHostSecurityManager::GetSecurityContext` and `IHostSecurityManager::SetSecurityContext` methods. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - +Describes the security context of the currently executing thread. + +## Syntax + +```cpp +typedef enum { + eCurrentContext = 0x00, + eRestrictedContext = 0x01 +} EContextType; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`eCurrentContext`|Indicates the context on the current thread at the time the common language runtime (CLR) calls the [IHostSecurityManager::GetSecurityContext](ihostsecuritymanager-getsecuritycontext-method.md) method, or the context requested by the CLR in a call to the [IHostSecurityManager::SetSecurityContext](ihostsecuritymanager-setsecuritycontext-method.md) method.| +|`eRestrictedContext`|Indicates a context over which the host has lower privileges, such as the garbage collector, or class or module constructors.| + +## Remarks + + The CLR supplies one of the `EContextType` values as a parameter value in calls to the `IHostSecurityManager::GetSecurityContext` and `IHostSecurityManager::SetSecurityContext` methods. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [IHostSecurityContext Interface](ihostsecuritycontext-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md b/docs/framework/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md similarity index 57% rename from docs/core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md rename to docs/framework/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md index 9ca244a7025df..303c9461d4244 100644 --- a/docs/core/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md +++ b/docs/framework/unmanaged-api/hosting/ecustomdumpflavor-enumeration.md @@ -2,53 +2,54 @@ description: "Learn more about: ECustomDumpFlavor Enumeration" title: "ECustomDumpFlavor Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "ECustomDumpFlavor" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ECustomDumpFlavor" -helpviewer_keywords: +helpviewer_keywords: - "ECustomDumpFlavor enumeration [.NET Framework hosting]" -topic_type: +ms.assetid: b39b3320-fac7-41f1-9a03-ab6fb0cd89c7 +topic_type: - "apiref" --- # ECustomDumpFlavor Enumeration -Contains values that indicate which items to include in a custom subset of a heap dump when reporting errors. - -## Syntax - -```cpp -typedef enum { - DUMP_FLAVOR_Mini = 1, - DUMP_FLAVOR_NonHeapCLRState = 2 -} ECustomDumpFlavor; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`DUMP_FLAVOR_Mini`|Specifies that the custom heap dump should start as a minidump and include extra data specified by any [CustomDumpItem](customdumpitem-structure.md) instances passed to the same method.| -|`DUMP_FLAVOR_NonHeapCLRState`|Specifies that the custom heap dump should gather all run-time state data that was not dynamically allocated.| - -## Remarks - - A parameter of type `ECustomDumpFlavor` is passed to the [ICLRErrorReportingManager::BeginCustomDump](iclrerrorreportingmanager-begincustomdump-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - +Contains values that indicate which items to include in a custom subset of a heap dump when reporting errors. + +## Syntax + +```cpp +typedef enum { + DUMP_FLAVOR_Mini = 1, + DUMP_FLAVOR_NonHeapCLRState = 2 +} ECustomDumpFlavor; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`DUMP_FLAVOR_Mini`|Specifies that the custom heap dump should start as a minidump and include extra data specified by any [CustomDumpItem](customdumpitem-structure.md) instances passed to the same method.| +|`DUMP_FLAVOR_NonHeapCLRState`|Specifies that the custom heap dump should gather all run-time state data that was not dynamically allocated.| + +## Remarks + + A parameter of type `ECustomDumpFlavor` is passed to the [ICLRErrorReportingManager::BeginCustomDump](iclrerrorreportingmanager-begincustomdump-method.md) method. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [ECustomDumpItemKind Enumeration](ecustomdumpitemkind-enumeration.md) diff --git a/docs/framework/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md b/docs/framework/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md new file mode 100644 index 0000000000000..ae2dfcb3794c2 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/ecustomdumpitemkind-enumeration.md @@ -0,0 +1,50 @@ +--- +description: "Learn more about: ECustomDumpItemKind Enumeration" +title: "ECustomDumpItemKind Enumeration" +ms.date: "03/30/2017" +api_name: + - "ECustomDumpItemKind" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ECustomDumpItemKind" +helpviewer_keywords: + - "ECustomDumpItemKind enumeration [.NET Framework hosting]" +ms.assetid: 7105a6c8-6e4e-48de-ac3d-74ac75e5de2e +topic_type: + - "apiref" +--- +# ECustomDumpItemKind Enumeration + +Reserved for future extension of the [CustomDumpItem](customdumpitem-structure.md) structure. + +## Syntax + +```cpp +typedef enum { + DUMP_ITEM_None = 0 +} ECustomDumpItemKind; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`DUMP_ITEM_None`|Reserved for future use.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + +## See also + +- [ICLRErrorReportingManager Interface](iclrerrorreportingmanager-interface.md) +- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/framework/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md b/docs/framework/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md new file mode 100644 index 0000000000000..7e2a098e57582 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/ehostapplicationpolicy-enumeration.md @@ -0,0 +1,43 @@ +--- +description: "Learn more about: EHostApplicationPolicy Enumeration" +title: "EHostApplicationPolicy Enumeration" +ms.date: "03/30/2017" +api_name: + - "EHostApplicationPolicy" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "EHostApplicationPolicy" +helpviewer_keywords: + - "EHostApplicationPolicy enumeration [.NET Framework hosting]" +ms.assetid: 0be52d90-1976-4bf7-9717-908833a8a78d +topic_type: + - "apiref" +--- +# EHostApplicationPolicy Enumeration + +Indicates how to modify an [IHostAssemblyManager](ihostassemblymanager-interface.md) interface object. This enumeration has been deprecated. + +## Syntax + +```cpp +typedef enum _HostApplicationPolicy { + HOST_APPLICATION_BINDING_POLICY = 1 +} EHostApplicationPolicy; +``` + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + +## See also + +- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md b/docs/framework/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md similarity index 55% rename from docs/core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md rename to docs/framework/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md index ef031eb5b1b9c..b1eb428d36b79 100644 --- a/docs/core/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md +++ b/docs/framework/unmanaged-api/hosting/ehostbindingpolicymodifyflags-enumeration.md @@ -2,57 +2,58 @@ description: "Learn more about: EHostBindingPolicyModifyFlags Enumeration" title: "EHostBindingPolicyModifyFlags Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EHostBindingPolicyModifyFlags" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EHostBindingPolicyModifyFlags" -helpviewer_keywords: +helpviewer_keywords: - "EHostBindingPolicyModifyFlags enumeration [.NET Framework hosting]" -topic_type: +ms.assetid: 0339af16-ee1d-48ec-837d-a79d9a9c89f8 +topic_type: - "apiref" --- # EHostBindingPolicyModifyFlags Enumeration -Allows the host to specify the type of redirection the common language runtime (CLR) should perform when applying policy modifications from a source assembly to a target assembly. - -## Syntax - -```cpp -typedef enum _hostBindingPolicyModifyFlags { - HOST_BINDING_POLICY_MODIFY_DEFAULT = 0, - HOST_BINDING_POLICY_MODIFY_CHAIN = 1, - HOST_BINDING_POLICY_MODIFY_REMOVE = 2, - HOST_BINDING_POLICY_MODIFY_MAX = 3 -} EHostBindingPolicyModifyFlags; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`HOST_BINDING_POLICY_MODIFY_CHAIN`|Specifies that the CLR will chain policy values of the source assembly onto those of the target assembly.| -|`HOST_BINDING_POLICY_MODIFY_DEFAULT`|Specifies that the CLR will perform the default action.| -|`HOST_BINDING_POLICY_MODIFY_MAX`|Specifies that the CLR will set the policy values of the target assembly to the maximum values.| -|`HOST_BINDING_POLICY_MODIFY_REMOVE`|Specifies that the CLR will replace policy values of the target assembly with those of the source assembly.| - -## Remarks - - The [ICLRHostBindingPolicyManager::ModifyApplicationPolicy](iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md) method takes a parameter of type `EHostBindingPolicyModifyFlags`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - +Allows the host to specify the type of redirection the common language runtime (CLR) should perform when applying policy modifications from a source assembly to a target assembly. + +## Syntax + +```cpp +typedef enum _hostBindingPolicyModifyFlags { + HOST_BINDING_POLICY_MODIFY_DEFAULT = 0, + HOST_BINDING_POLICY_MODIFY_CHAIN = 1, + HOST_BINDING_POLICY_MODIFY_REMOVE = 2, + HOST_BINDING_POLICY_MODIFY_MAX = 3 +} EHostBindingPolicyModifyFlags; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`HOST_BINDING_POLICY_MODIFY_CHAIN`|Specifies that the CLR will chain policy values of the source assembly onto those of the target assembly.| +|`HOST_BINDING_POLICY_MODIFY_DEFAULT`|Specifies that the CLR will perform the default action.| +|`HOST_BINDING_POLICY_MODIFY_MAX`|Specifies that the CLR will set the policy values of the target assembly to the maximum values.| +|`HOST_BINDING_POLICY_MODIFY_REMOVE`|Specifies that the CLR will replace policy values of the target assembly with those of the source assembly.| + +## Remarks + + The [ICLRHostBindingPolicyManager::ModifyApplicationPolicy](iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md) method takes a parameter of type `EHostBindingPolicyModifyFlags`. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [ICLRHostBindingPolicyManager Interface](iclrhostbindingpolicymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md b/docs/framework/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md similarity index 50% rename from docs/core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md rename to docs/framework/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md index 3a8c9cb5be4a3..570311f2fd9aa 100644 --- a/docs/core/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md +++ b/docs/framework/unmanaged-api/hosting/einitializenewdomainflags-enumeration.md @@ -2,51 +2,52 @@ description: "Learn more about: EInitializeNewDomainFlags Enumeration" title: "EInitializeNewDomainFlags Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EInitializeNewDomainFlags" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EInitializeNewDomainFlags" -helpviewer_keywords: +helpviewer_keywords: - "EInitializeNewDomainFlags enumeration [.NET Framework hosting]" +ms.assetid: 3a120ab2-f5ef-4c9b-8595-d3ed7247c342 --- # EInitializeNewDomainFlags Enumeration -Enables the host to provide the runtime with information about the initialization of an application domain. - -## Syntax - -```cpp -typedef enum { - eInitializeNewDomainFlags_None = 0x0000, - eInitializeNewDomainFlags_NoSecurityChanges = 0x0002 -} EInitializeNewDomainFlags; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`eInitializeNewDomainFlags_None`|No flags.| -|`eInitializeNewDomainFlags_NoSecurityChanges`|Informs the common language runtime (CLR) that the host will not make changes to the security state of the application domain in the method.| - -## Remarks - - The [ICLRDomainManager::SetAppDomainManagerType](iclrdomainmanager-setappdomainmanagertype-method.md) method takes a parameter of type `EInitializeNewDomainFlags`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Enables the host to provide the runtime with information about the initialization of an application domain. + +## Syntax + +```cpp +typedef enum { + eInitializeNewDomainFlags_None = 0x0000, + eInitializeNewDomainFlags_NoSecurityChanges = 0x0002 +} EInitializeNewDomainFlags; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`eInitializeNewDomainFlags_None`|No flags.| +|`eInitializeNewDomainFlags_NoSecurityChanges`|Informs the common language runtime (CLR) that the host will not make changes to the security state of the application domain in the method.| + +## Remarks + + The [ICLRDomainManager::SetAppDomainManagerType](iclrdomainmanager-setappdomainmanagertype-method.md) method takes a parameter of type `EInitializeNewDomainFlags`. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md b/docs/framework/unmanaged-api/hosting/ememoryavailable-enumeration.md similarity index 57% rename from docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md rename to docs/framework/unmanaged-api/hosting/ememoryavailable-enumeration.md index 2ca597f48f310..38802d4db65a5 100644 --- a/docs/core/unmanaged-api/hosting/ememoryavailable-enumeration.md +++ b/docs/framework/unmanaged-api/hosting/ememoryavailable-enumeration.md @@ -2,55 +2,56 @@ description: "Learn more about: EMemoryAvailable Enumeration" title: "EMemoryAvailable Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EMemoryAvailable" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EMemoryAvailable" -helpviewer_keywords: +helpviewer_keywords: - "EMemoryAvailable enumeration [.NET Framework hosting]" -topic_type: +ms.assetid: 38e72a06-dbed-473b-a59b-7e0b3ea4f2af +topic_type: - "apiref" --- # EMemoryAvailable Enumeration -Contains values that indicate the amount of free physical memory on the computer. These values logically map to the events for high and low memory returned from the `CreateMemoryResourceNotification` function in the Windows API. - -## Syntax - -```cpp -typedef enum { - eMemoryAvailableLow = 1, - eMemoryAvailableNeutral = 2, +Contains values that indicate the amount of free physical memory on the computer. These values logically map to the events for high and low memory returned from the `CreateMemoryResourceNotification` function in the Windows API. + +## Syntax + +```cpp +typedef enum { + eMemoryAvailableLow = 1, + eMemoryAvailableNeutral = 2, eMemoryAvailableHigh = 3 -} EMemoryAvailable; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`eMemoryAvailableHigh`|Plenty of physical memory is available.| -|`eMemoryAvailableLow`|Very little physical memory is available.| -|`eMemoryAvailableNeutral`|The available physical memory is neutral.| - -## Remarks - - This value is passed by the host to the common language runtime (CLR) by using a call to the [ICLRMemoryNotificationCallback::OnMemoryNotification](iclrmemorynotificationcallback-onmemorynotification-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - +} EMemoryAvailable; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`eMemoryAvailableHigh`|Plenty of physical memory is available.| +|`eMemoryAvailableLow`|Very little physical memory is available.| +|`eMemoryAvailableNeutral`|The available physical memory is neutral.| + +## Remarks + + This value is passed by the host to the common language runtime (CLR) by using a call to the [ICLRMemoryNotificationCallback::OnMemoryNotification](iclrmemorynotificationcallback-onmemorynotification-method.md) method. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md b/docs/framework/unmanaged-api/hosting/ememorycriticallevel-enumeration.md similarity index 72% rename from docs/core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md rename to docs/framework/unmanaged-api/hosting/ememorycriticallevel-enumeration.md index 63a8ed188c1e6..5e835bf908f57 100644 --- a/docs/core/unmanaged-api/hosting/ememorycriticallevel-enumeration.md +++ b/docs/framework/unmanaged-api/hosting/ememorycriticallevel-enumeration.md @@ -2,55 +2,56 @@ description: "Learn more about: EMemoryCriticalLevel Enumeration" title: "EMemoryCriticalLevel Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EMemoryCriticalLevel" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EMemoryCriticalLevel" -helpviewer_keywords: +helpviewer_keywords: - "EMemoryCriticalLevel enumeration [.NET Framework hosting]" -topic_type: +ms.assetid: 2ca8a7a2-7b54-4ba3-8e73-277c7df485f3 +topic_type: - "apiref" --- # EMemoryCriticalLevel Enumeration -Contains values that indicate the impact of a failure when a specific memory allocation has been requested but cannot be satisfied. - -## Syntax - -```cpp -typedef enum { - eTaskCritical = 0, - eAppDomainCritical = 1, - eProcessCritical = 2 -} EMemoryCriticalLevel; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`eAppDomainCritical`|Indicates that the allocation is critical for executing managed code in the domain that has requested the allocation. If memory cannot be allocated, the CLR cannot guarantee that the domain is still usable. The host decides what action to take when the allocation cannot be satisfied. It can instruct the CLR to abort the `AppDomain` automatically, or allow it to keep running by calling methods on [ICLRPolicyManager](iclrpolicymanager-interface.md).| -|`eProcessCritical`|Indicates that the allocation is critical to the execution of managed code in the process. This value is used during startup and when running finalizers. If memory cannot be allocated, the CLR cannot operate in the process. If the allocation fails, the CLR is effectively disabled. All subsequent calls into the CLR fail with HOST_E_CLRNOTAVAILABLE.| -|`eTaskCritical`|Indicates that the allocation is critical to running the task that has requested the allocation. If memory cannot be allocated, the CLR cannot guarantee that the task can be executed. In the event of failure, the CLR raises a on the physical operation system thread.| - -## Remarks - - The memory allocation methods defined in the [IHostMemoryManager](ihostmemorymanager-interface.md) and [IHostMAlloc](ihostmalloc-interface.md) interfaces take a parameter of this type. Depending upon the severity of a failure, a host can decide whether to fail the allocation request immediately or to wait until it can be satisfied. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - +Contains values that indicate the impact of a failure when a specific memory allocation has been requested but cannot be satisfied. + +## Syntax + +```cpp +typedef enum { + eTaskCritical = 0, + eAppDomainCritical = 1, + eProcessCritical = 2 +} EMemoryCriticalLevel; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`eAppDomainCritical`|Indicates that the allocation is critical for executing managed code in the domain that has requested the allocation. If memory cannot be allocated, the CLR cannot guarantee that the domain is still usable. The host decides what action to take when the allocation cannot be satisfied. It can instruct the CLR to abort the `AppDomain` automatically, or allow it to keep running by calling methods on [ICLRPolicyManager](iclrpolicymanager-interface.md).| +|`eProcessCritical`|Indicates that the allocation is critical to the execution of managed code in the process. This value is used during startup and when running finalizers. If memory cannot be allocated, the CLR cannot operate in the process. If the allocation fails, the CLR is effectively disabled. All subsequent calls into the CLR fail with HOST_E_CLRNOTAVAILABLE.| +|`eTaskCritical`|Indicates that the allocation is critical to running the task that has requested the allocation. If memory cannot be allocated, the CLR cannot guarantee that the task can be executed. In the event of failure, the CLR raises a on the physical operation system thread.| + +## Remarks + + The memory allocation methods defined in the [IHostMemoryManager](ihostmemorymanager-interface.md) and [IHostMAlloc](ihostmalloc-interface.md) interfaces take a parameter of this type. Depending upon the severity of a failure, a host can decide whether to fail the allocation request immediately or to wait until it can be satisfied. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [ICLRMemoryNotificationCallback Interface](iclrmemorynotificationcallback-interface.md) diff --git a/docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md b/docs/framework/unmanaged-api/hosting/epolicyaction-enumeration.md similarity index 65% rename from docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md rename to docs/framework/unmanaged-api/hosting/epolicyaction-enumeration.md index 28d40ff68a4b7..33607cf297922 100644 --- a/docs/core/unmanaged-api/hosting/epolicyaction-enumeration.md +++ b/docs/framework/unmanaged-api/hosting/epolicyaction-enumeration.md @@ -2,69 +2,70 @@ description: "Learn more about: EPolicyAction Enumeration" title: "EPolicyAction Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "EPolicyAction" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "EPolicyAction" -helpviewer_keywords: +helpviewer_keywords: - "EPolicyAction enumeration [.NET Framework hosting]" -topic_type: +ms.assetid: 72dd76ba-239e-45ac-9ded-318fb07d6c6d +topic_type: - "apiref" --- # EPolicyAction Enumeration -Describes the policy actions the host can set for operations described by [EClrOperation](eclroperation-enumeration.md) and failures described by [EClrFailure](eclrfailure-enumeration.md). +Describes the policy actions the host can set for operations described by [EClrOperation](eclroperation-enumeration.md) and failures described by [EClrFailure](eclrfailure-enumeration.md). + +## Syntax + +```cpp +typedef enum { + eNoAction, + eThrowException, + eAbortThread, + eRudeAbortThread, + eUnloadAppDomain, + eRudeUnloadAppDomain, + eExitProcess, + eFastExitProcess, + eRudeExitProcess, + eDisableRuntime +} EPolicyAction; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`eAbortThread`|Specifies that the common language runtime (CLR) should abort the thread gracefully. A graceful abort includes attempts to run all `finally` blocks, any `catch` blocks related to thread aborts, and finalizers.| +|`eDisableRuntime`|Specifies that the CLR should enter a disabled state. No further managed code can be executed in the affected process, and threads are blocked from entering the CLR.| +|`eExitProcess`|Specifies that the CLR should attempt a graceful exit of the process, including running finalizers and performing cleanup and logging operations.| +|`eFastExitProcess`|Specifies that the CLR should exit the process immediately, without running finalizers or performing cleanup and logging operations. However, notification is sent to the debugger.| +|`eNoAction`|Specifies that no action should be taken.| +|`eRudeAbortThread`|Specifies that the CLR should perform a rude thread abort. Only those `catch` and `finally` blocks marked with are executed.| +|`eRudeExitProcess`|Specifies that the CLR should exit the process without running finalizers or logging operations.| +|`eRudeUnloadAppDomain`|Specifies that the CLR should perform a rude unload of the . Only finalizers marked with are executed. Similarly, all threads with this in their stack receive a `ThreadAbortException`, but only those `catch` and `finally` blocks marked with are executed.| +|`eThrowException`|Specifies that an exception appropriate to the condition, such as out-of-memory, buffer overflow, and so forth, should be thrown.| +|`eUnloadAppDomain`|Specifies that the should be unloaded. The CLR attempts to run finalizers.| + +## Remarks -## Syntax - -```cpp -typedef enum { - eNoAction, - eThrowException, - eAbortThread, - eRudeAbortThread, - eUnloadAppDomain, - eRudeUnloadAppDomain, - eExitProcess, - eFastExitProcess, - eRudeExitProcess, - eDisableRuntime -} EPolicyAction; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`eAbortThread`|Specifies that the common language runtime (CLR) should abort the thread gracefully. A graceful abort includes attempts to run all `finally` blocks, any `catch` blocks related to thread aborts, and finalizers.| -|`eDisableRuntime`|Specifies that the CLR should enter a disabled state. No further managed code can be executed in the affected process, and threads are blocked from entering the CLR.| -|`eExitProcess`|Specifies that the CLR should attempt a graceful exit of the process, including running finalizers and performing cleanup and logging operations.| -|`eFastExitProcess`|Specifies that the CLR should exit the process immediately, without running finalizers or performing cleanup and logging operations. However, notification is sent to the debugger.| -|`eNoAction`|Specifies that no action should be taken.| -|`eRudeAbortThread`|Specifies that the CLR should perform a rude thread abort. Only those `catch` and `finally` blocks marked with are executed.| -|`eRudeExitProcess`|Specifies that the CLR should exit the process without running finalizers or logging operations.| -|`eRudeUnloadAppDomain`|Specifies that the CLR should perform a rude unload of the . Only finalizers marked with are executed. Similarly, all threads with this in their stack receive a `ThreadAbortException`, but only those `catch` and `finally` blocks marked with are executed.| -|`eThrowException`|Specifies that an exception appropriate to the condition, such as out-of-memory, buffer overflow, and so forth, should be thrown.| -|`eUnloadAppDomain`|Specifies that the should be unloaded. The CLR attempts to run finalizers.| - -## Remarks - - The host sets policy actions by calling methods of the [ICLRPolicyManager](iclrpolicymanager-interface.md) interface. For information about rude and graceful aborts, see the [EClrOperation](eclroperation-enumeration.md) enumeration. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 + The host sets policy actions by calling methods of the [ICLRPolicyManager](iclrpolicymanager-interface.md) interface. For information about rude and graceful aborts, see the [EClrOperation](eclroperation-enumeration.md) enumeration. + +## Requirements + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [EClrFailure Enumeration](eclrfailure-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md b/docs/framework/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md similarity index 52% rename from docs/core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md rename to docs/framework/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md index c534f08819799..a15c578301257 100644 --- a/docs/core/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md +++ b/docs/framework/unmanaged-api/hosting/esymbolreadingpolicy-enumeration.md @@ -2,55 +2,56 @@ description: "Learn more about: ESymbolReadingPolicy Enumeration" title: "ESymbolReadingPolicy Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "ESymbolReadingPolicy" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ESymbolReadingPolicy" -helpviewer_keywords: +helpviewer_keywords: - "ESymbolReadingPolicy enumeration [.NET Framework hosting]" -topic_type: +ms.assetid: 4dc6c80d-b694-480b-a378-d5b18420ce17 +topic_type: - "apiref" --- # ESymbolReadingPolicy Enumeration -Contains values that set the policy for reading program database (PDB) files. - -## Syntax - -```cpp -typedef enum { - eSymbolReadingNever, - eSymbolReadingAlways, - eSymbolReadingFullTrustOnly -} ESymbolReadingPolicy; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`eSymbolReadingAlways`|Specifies that the debugger should always read PDB files.| -|`eSymbolReadingFullTrustOnly`|Specifies that the debugger should read only PDB files that are associated with full-trust assemblies.| -|`eSymbolReadingNever`|Specifies that the debugger should never read PDB files.| - -## Remarks - - The `ESymbolReadingPolicy` enumeration is used with the [ICLRDebugManager::SetSymbolReadingPolicy](iclrdebugmanager-setsymbolreadingpolicy-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - +Contains values that set the policy for reading program database (PDB) files. + +## Syntax + +```cpp +typedef enum { + eSymbolReadingNever, + eSymbolReadingAlways, + eSymbolReadingFullTrustOnly +} ESymbolReadingPolicy; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`eSymbolReadingAlways`|Specifies that the debugger should always read PDB files.| +|`eSymbolReadingFullTrustOnly`|Specifies that the debugger should read only PDB files that are associated with full-trust assemblies.| +|`eSymbolReadingNever`|Specifies that the debugger should never read PDB files.| + +## Remarks + + The `ESymbolReadingPolicy` enumeration is used with the [ICLRDebugManager::SetSymbolReadingPolicy](iclrdebugmanager-setsymbolreadingpolicy-method.md) method. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/framework/unmanaged-api/hosting/etasktype-enumeration.md b/docs/framework/unmanaged-api/hosting/etasktype-enumeration.md new file mode 100644 index 0000000000000..1dfefef59fc79 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/etasktype-enumeration.md @@ -0,0 +1,69 @@ +--- +description: "Learn more about: ETaskType Enumeration" +title: "ETaskType Enumeration" +ms.date: "03/30/2017" +api_name: + - "ETaskType" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ETaskType" +helpviewer_keywords: + - "ETaskType enumeration [.NET Framework hosting]" +ms.assetid: aa527b31-89d4-41f2-ad6f-63b76950b7df +topic_type: + - "apiref" +--- +# ETaskType Enumeration + +Contains values that indicate the type of task that is represented by either an [ICLRTask](iclrtask-interface.md) or an [IHostTask](ihosttask-interface.md) interface. + +## Syntax + +```cpp +typedef enum ETaskType { + TT_DEBUGGERHELPER = 0x1, + TT_GC = 0x2, + TT_FINALIZER = 0x4, + TT_THREADPOOL_TIMER = 0x8, + TT_THREADPOOL_GATE = 0x10, + TT_THREADPOOL_WORKER = 0x20, + TT_THREADPOOL_IOCOMPLETION = 0x40, + TT_ADUNLOAD = 0x80, + TT_USER = 0x100, + TT_THREADPOOL_WAIT = 0x200, + TT_UNKNOWN = 0x80000000 +} ETaskType; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`TT_ADUNLOAD`|The interface represents an application domain unloading task.| +|`TT_DEBUGGERHELPER`|The interface represents a debugger helper task.| +|`TT_FINALIZER`|The interface represents a finalizer task.| +|`TT_GC`|The interface represents a garbage collection task.| +|`TT_THREADPOOL_GATE`|The interface represents a gate thread task.| +|`TT_THREADPOOL_IOCOMPLETION`|The interface represents an I/O thread task or a completion port thread task.| +|`TT_THREADPOOL_TIMER`|The interface represents a timer thread task.| +|`TT_THREADPOOL_WAIT`|The interface represents a wait thread task.| +|`TT_THREADPOOL_WORKER`|The interface represents a worker thread task.| +|`TT_UNKNOWN`|The task is unknown.| +|`TT_USER`|The interface represents a user task.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + +## See also + +- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md b/docs/framework/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md similarity index 54% rename from docs/core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md rename to docs/framework/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md index 87f8714b498d8..bda0d9c612152 100644 --- a/docs/core/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md +++ b/docs/framework/unmanaged-api/hosting/fexecuteinappdomaincallback-function-pointer.md @@ -2,50 +2,51 @@ description: "Learn more about: FExecuteInAppDomainCallback Function Pointer" title: "FExecuteInAppDomainCallback Function Pointer" ms.date: "03/30/2017" -api_name: +api_name: - "FExecuteInAppDomainCallback" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "FExecuteInAppDomainCallback" -helpviewer_keywords: +helpviewer_keywords: - "FExecuteInAppDomainCallback function pointer [.NET Framework hosting]" -topic_type: +ms.assetid: 2709f18f-3eee-497f-bc33-3ab7a485599b +topic_type: - "apiref" --- # FExecuteInAppDomainCallback Function Pointer -Points to a function that is called by the common language runtime (CLR) to execute managed code. - - This function pointer has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -typedef HRESULT (__stdcall *FExecuteInAppDomainCallback) ( - [in] void *cookie -); -``` - -## Parameters - - `cookie` - [in] A pointer to opaque caller-allocated memory that contains the managed code to be executed. - - The allocation and lifetime of this memory are controlled by the caller (that is, the CLR). This is not CLR managed-heap memory. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorWks.dll - - **.NET versions:** Available since .NET Framework 2.0 - +Points to a function that is called by the common language runtime (CLR) to execute managed code. + + This function pointer has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +typedef HRESULT (__stdcall *FExecuteInAppDomainCallback) ( + [in] void *cookie +); +``` + +## Parameters + + `cookie` + [in] A pointer to opaque caller-allocated memory that contains the managed code to be executed. + + The allocation and lifetime of this memory are controlled by the caller (that is, the CLR). This is not CLR managed-heap memory. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorWks.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md b/docs/framework/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md similarity index 54% rename from docs/core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md rename to docs/framework/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md index c056f342765bc..d9b8dcff456e3 100644 --- a/docs/core/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md +++ b/docs/framework/unmanaged-api/hosting/flockclrversioncallback-function-pointer.md @@ -2,45 +2,46 @@ description: "Learn more about: FLockClrVersionCallback Function Pointer" title: "FLockClrVersionCallback Function Pointer" ms.date: "03/30/2017" -api_name: +api_name: - "FLockClrVersionCallback" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "FLockClrVersionCallback" -helpviewer_keywords: +helpviewer_keywords: - "FLockClrVersionCallback function pointer [.NET Framework hosting]" -topic_type: +ms.assetid: 98a4762d-9ad2-45bd-9d03-39064a028b44 +topic_type: - "apiref" --- # FLockClrVersionCallback Function Pointer -Points to a function that the common language runtime (CLR) calls to indicate that initialization has either started or completed. - - This function pointer has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -typedef HRESULT (__stdcall *FLockClrVersionCallback) ( ); -``` - -## Remarks - - This function is implemented by the host. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorWks.dll - - **.NET versions:** Available since .NET Framework 2.0 - +Points to a function that the common language runtime (CLR) calls to indicate that initialization has either started or completed. + + This function pointer has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +typedef HRESULT (__stdcall *FLockClrVersionCallback) ( ); +``` + +## Remarks + + This function is implemented by the host. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorWks.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [LockClrVersion Function](lockclrversion-function.md) diff --git a/docs/core/unmanaged-api/hosting/getclridentitymanager-function.md b/docs/framework/unmanaged-api/hosting/getclridentitymanager-function.md similarity index 54% rename from docs/core/unmanaged-api/hosting/getclridentitymanager-function.md rename to docs/framework/unmanaged-api/hosting/getclridentitymanager-function.md index ea286aaa72e3e..d52b49f0b68d2 100644 --- a/docs/core/unmanaged-api/hosting/getclridentitymanager-function.md +++ b/docs/framework/unmanaged-api/hosting/getclridentitymanager-function.md @@ -2,56 +2,57 @@ description: "Learn more about: GetCLRIdentityManager Function" title: "GetCLRIdentityManager Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetCLRIdentityManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "GetCLRIdentityManager" -helpviewer_keywords: +helpviewer_keywords: - "GetCLRIdentityManager function [.NET Framework hosting]" -topic_type: +ms.assetid: 66eeca30-adb4-45f4-aff5-347564c95724 +topic_type: - "apiref" --- # GetCLRIdentityManager Function -Gets a pointer to an interface that allows the common language runtime (CLR) to manage identities. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -STDAPI GetCLRIdentityManager( - [in] REFIID riid, - [out] IUnknown **ppManager -); -``` - -## Parameters - - `riid` - [in] A `REFIID` (an interface identifier) that specifies which interface to get. This value must be either IID_ICLRAssemblyIdentityManager or IID_ICLRHostBindingPolicyManager. - - `ppManager` - [out] A pointer to the address of either an [ICLRAssemblyIdentityManager](iclrassemblyidentitymanager-interface.md) or an [ICLRHostBindingPolicyManager](iclrhostbindingpolicymanager-interface.md) object. - -## Remarks - - Call the [GetRealProcAddress](getrealprocaddress-function.md) function to get a pointer to the `GetCLRIdentityManager` function. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorWks.dll - - **.NET versions:** Available since .NET Framework 2.0 - +Gets a pointer to an interface that allows the common language runtime (CLR) to manage identities. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +STDAPI GetCLRIdentityManager( + [in] REFIID riid, + [out] IUnknown **ppManager +); +``` + +## Parameters + + `riid` + [in] A `REFIID` (an interface identifier) that specifies which interface to get. This value must be either IID_ICLRAssemblyIdentityManager or IID_ICLRHostBindingPolicyManager. + + `ppManager` + [out] A pointer to the address of either an [ICLRAssemblyIdentityManager](iclrassemblyidentitymanager-interface.md) or an [ICLRHostBindingPolicyManager](iclrhostbindingpolicymanager-interface.md) object. + +## Remarks + + Call the [GetRealProcAddress](getrealprocaddress-function.md) function to get a pointer to the `GetCLRIdentityManager` function. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorWks.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/getcorrequiredversion-function.md b/docs/framework/unmanaged-api/hosting/getcorrequiredversion-function.md new file mode 100644 index 0000000000000..daf3b134991b7 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/getcorrequiredversion-function.md @@ -0,0 +1,58 @@ +--- +description: "Learn more about: GetCORRequiredVersion Function" +title: "GetCORRequiredVersion Function" +ms.date: "03/30/2017" +api_name: + - "GetCORRequiredVersion" +api_location: + - "mscoree.dll" +api_type: + - "DLLExport" +f1_keywords: + - "GetCORRequiredVersion" +helpviewer_keywords: + - "GetCORRequiredVersion function [.NET Framework hosting]" +ms.assetid: 1588fe7b-c378-4f4b-9c4b-48647f1119cc +topic_type: + - "apiref" +--- +# GetCORRequiredVersion Function + +Gets the required common language runtime (CLR) version number. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT GetCORRequiredVersion ( + [out] LPWSTR pbuffer, + [in] DWORD cchBuffer, + [out] DWORD *dwLength +); +``` + +## Parameters + + `pbuffer` + [out] A buffer containing a string that specifies the version number. + + `cchBuffer` + [in] The size, in bytes, of the buffer. + + `dwLength` + [out] The number of bytes returned in the buffer. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + +## See also + +- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/getcorsystemdirectory-function.md b/docs/framework/unmanaged-api/hosting/getcorsystemdirectory-function.md similarity index 63% rename from docs/core/unmanaged-api/hosting/getcorsystemdirectory-function.md rename to docs/framework/unmanaged-api/hosting/getcorsystemdirectory-function.md index 020a6bbea7161..955735ce31d7b 100644 --- a/docs/core/unmanaged-api/hosting/getcorsystemdirectory-function.md +++ b/docs/framework/unmanaged-api/hosting/getcorsystemdirectory-function.md @@ -2,62 +2,63 @@ description: "Learn more about: GetCORSystemDirectory Function" title: "GetCORSystemDirectory Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetCORSystemDirectory" -api_location: +api_location: - "mscoree.dll" - "mscoreei.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "GetCORSystemDirectory" -helpviewer_keywords: +helpviewer_keywords: - "GetCORSystemDirectory function [.NET Framework hosting]" -topic_type: +ms.assetid: 3dcd16a7-dafc-4ca8-b5cd-20ffb37db91d +topic_type: - "apiref" --- # GetCORSystemDirectory Function -Returns the installation directory of the common language runtime (CLR) that is loaded into the process. The installation directory is fully qualified, for example, "c:\windows\microsoft.net\framework\v1.0.3705". - - This function is deprecated. It is superseded by the [ICLRRuntimeInfo::GetRuntimeDirectory](iclrruntimeinfo-getruntimedirectory-method.md) method provided in the .NET Framework 4. - -## Syntax - -```cpp +Returns the installation directory of the common language runtime (CLR) that is loaded into the process. The installation directory is fully qualified, for example, "c:\windows\microsoft.net\framework\v1.0.3705". + + This function is deprecated. It is superseded by the [ICLRRuntimeInfo::GetRuntimeDirectory](iclrruntimeinfo-getruntimedirectory-method.md) method provided in the .NET Framework 4. + +## Syntax + +```cpp HRESULT GetCORSystemDirectory ( [out] LPWSTR pbuffer, [in] DWORD cchBuffer, - [out] DWORD* dwlength + [out] DWORD* dwlength ); -``` - -## Parameters - - `pbuffer` - [out] A buffer in which the runtime returns a string that contains the fully qualified name of the installation directory for the runtime that is loaded into the process. If the runtime has not yet been loaded into the process, the function returns the appropriate directory information for the latest version of the runtime installed on the computer. - - `cchBuffer` - [in] The size, in bytes, of `pbuffer`. - - `dwLength` - [out] The number of characters returned in `pbuffer`. - -## Remarks - +``` + +## Parameters + + `pbuffer` + [out] A buffer in which the runtime returns a string that contains the fully qualified name of the installation directory for the runtime that is loaded into the process. If the runtime has not yet been loaded into the process, the function returns the appropriate directory information for the latest version of the runtime installed on the computer. + + `cchBuffer` + [in] The size, in bytes, of `pbuffer`. + + `dwLength` + [out] The number of characters returned in `pbuffer`. + +## Remarks + > [!CAUTION] -> Do not use this function in processes that are running version 4 of the CLR. If an earlier version of the CLR is installed on the computer, this function returns the installation directory for that version. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 1.0 - +> Do not use this function in processes that are running version 4 of the CLR. If an earlier version of the CLR is installed on the computer, this function returns the installation directory for that version. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/getcorversion-function.md b/docs/framework/unmanaged-api/hosting/getcorversion-function.md similarity index 66% rename from docs/core/unmanaged-api/hosting/getcorversion-function.md rename to docs/framework/unmanaged-api/hosting/getcorversion-function.md index 5714c97c8cee8..f5e66e9a53579 100644 --- a/docs/core/unmanaged-api/hosting/getcorversion-function.md +++ b/docs/framework/unmanaged-api/hosting/getcorversion-function.md @@ -18,41 +18,41 @@ topic_type: --- # GetCORVersion Function -Returns the version number of the common language runtime (CLR) that is running in the current process. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT GetCORVersion ( - [in] LPWSTR pbuffer, +Returns the version number of the common language runtime (CLR) that is running in the current process. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT GetCORVersion ( + [in] LPWSTR pbuffer, [in] DWORD cchBuffer, - [out] DWORD* dwlength + [out] DWORD* dwlength ); -``` - -## Parameters - - `pbuffer` - A pointer to a buffer in which the CLR returns a string specifying the version of the runtime that is currently loaded into the process. The returned string takes the same form as strings passed to [CorBindToRuntimeEx](corbindtoruntimeex-function.md), for example, "v1.0.1216". If the runtime has not yet been loaded into the process, the function returns the appropriate directory information for the latest version of the runtime installed on the computer. - - `cchBuffer` - The number of characters (`WCHAR`s) that can be held in `pbuffer`. - - `dwLength` - A pointer to the number of characters actually returned in `pbuffer`. If `pbuffer` is a null pointer, the runtime returns E_POINTER. If the number of characters is greater then the length of `pbuffer`, the runtime returns ERROR_INSUFFICIENT_BUFFER. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 1.0 - +``` + +## Parameters + + `pbuffer` + A pointer to a buffer in which the CLR returns a string specifying the version of the runtime that is currently loaded into the process. The returned string takes the same form as strings passed to [CorBindToRuntimeEx](corbindtoruntimeex-function.md), for example, "v1.0.1216". If the runtime has not yet been loaded into the process, the function returns the appropriate directory information for the latest version of the runtime installed on the computer. + + `cchBuffer` + The number of characters (`WCHAR`s) that can be held in `pbuffer`. + + `dwLength` + A pointer to the number of characters actually returned in `pbuffer`. If `pbuffer` is a null pointer, the runtime returns E_POINTER. If the number of characters is greater then the length of `pbuffer`, the runtime returns ERROR_INSUFFICIENT_BUFFER. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/getfileversion-function.md b/docs/framework/unmanaged-api/hosting/getfileversion-function.md new file mode 100644 index 0000000000000..6dd7f909f0930 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/getfileversion-function.md @@ -0,0 +1,60 @@ +--- +description: "Learn more about: GetFileVersion Function" +title: "GetFileVersion Function" +ms.date: "03/30/2017" +api_name: + - "GetFileVersion" +api_location: + - "mscoree.dll" +api_type: + - "DLLExport" +f1_keywords: + - "GetFileVersion" +helpviewer_keywords: + - "GetFileVersion function [.NET Framework hosting]" +ms.assetid: b3222c85-da88-4485-97d7-3a6ee3e8d358 +topic_type: + - "apiref" +--- +# GetFileVersion Function + +Gets the common language runtime (CLR) version information of the specified file, using the specified buffer. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT GetFileVersion ( + [in] LPCWSTR szFilename, + [in, out] LPWSTR szBuffer, + [in] DWORD cchBuffer, + [out] DWORD *dwLength +); +``` + +## Parameters + + `szFilename` + [in] The path of the file to be examined. + + `szBuffer` + [in, out] The buffer allocated for the version information that is returned. + + `cchBuffer` + [in] The size, in wide characters, of `szBuffer`. + + `dwLength` + [out] The size, in bytes, of the returned `szBuffer`. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **.NET Framework Versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] + +## See also + +- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/getrealprocaddress-function.md b/docs/framework/unmanaged-api/hosting/getrealprocaddress-function.md new file mode 100644 index 0000000000000..9ebeb1d8f9a52 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/getrealprocaddress-function.md @@ -0,0 +1,64 @@ +--- +description: "Learn more about: GetRealProcAddress Function" +title: "GetRealProcAddress Function" +ms.date: "03/30/2017" +api_name: + - "GetRealProcAddress" +api_location: + - "mscoree.dll" +api_type: + - "DLLExport" +f1_keywords: + - "GetRealProcAddress" +helpviewer_keywords: + - "GetRealProcAddress function [.NET Framework hosting]" +ms.assetid: f1f2fab1-400b-488f-95f2-d49c4fca3556 +topic_type: + - "apiref" +--- +# GetRealProcAddress Function + +Gets the address of the specified function that is exported from the latest installed version of the common language runtime (CLR). + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT GetRealProcAddress ( + [in] LPCSTR pwszProcName, + [out] VOID **ppv +); +``` + +## Parameters + + `pwszProcName` + [in] The name of the function. + + `ppv` + [out] The location that receives a pointer to the address of the function. + +## Return Value + + This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values defined in CorError.h. + +|Return code|Description| +|-----------------|-----------------| +|S_OK|The method completed successfully.| +|E_POINTER|`ppv` is not valid.| +|CLR_E_SHIM_RUNTIMEEXPORT|The function is not exported from the runtime.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + +## See also + +- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md b/docs/framework/unmanaged-api/hosting/getrequestedruntimeinfo-function.md similarity index 56% rename from docs/core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md rename to docs/framework/unmanaged-api/hosting/getrequestedruntimeinfo-function.md index e471c840228a2..fbafb3d896062 100644 --- a/docs/core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md +++ b/docs/framework/unmanaged-api/hosting/getrequestedruntimeinfo-function.md @@ -2,30 +2,31 @@ description: "Learn more about: GetRequestedRuntimeInfo Function" title: "GetRequestedRuntimeInfo Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetRequestedRuntimeInfo" -api_location: +api_location: - "mscoree.dll" - "mscoreei.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "GetRequestedRuntimeInfo" -helpviewer_keywords: +helpviewer_keywords: - "GetRequestedRuntimeInfo function [.NET Framework hosting]" -topic_type: +ms.assetid: 0dfd7cdc-c116-4e25-b56a-ac7b0378c942 +topic_type: - "apiref" --- # GetRequestedRuntimeInfo Function -Gets version and directory information about the common language runtime (CLR) requested by an application. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT GetRequestedRuntimeInfo ( +Gets version and directory information about the common language runtime (CLR) requested by an application. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT GetRequestedRuntimeInfo ( [in] LPCWSTR pExe, [in] LPCWSTR pwszVersion, [in] LPCWSTR pConfigurationFile, @@ -36,90 +37,90 @@ HRESULT GetRequestedRuntimeInfo ( [out] DWORD *dwDirectoryLength, [out] LPWSTR pVersion, [in] DWORD cchBuffer, - [out] DWORD *dwlength -); -``` - -## Parameters - - `pExe` - [in] The name of the application. - - `pwszVersion` - [in] A string specifying the version number of the runtime. - - `pConfigurationFile` - [in] The name of the configuration file that is associated with `pExe`. - - `startupFlags` - [in] One or more of the [STARTUP_FLAGS](startup-flags-enumeration.md) enumeration values. - - `runtimeInfoFlags` - [in] One or more of the [RUNTIME_INFO_FLAGS](runtime-info-flags-enumeration.md) enumeration values. - - `pDirectory` - [out] A buffer that contains the directory path to the runtime upon successful completion. - - `dwDirectory` - [in] The length of the directory buffer. - - `dwDirectoryLength` - [out] A pointer to the length of the directory path string. - - `pVersion` - [out] A buffer that contains the version number of the runtime upon successful completion. - - `cchBuffer` - [in] The length of the version string buffer. - - `dwlength` - [out] A pointer to the length of the version string. - -## Return Value - - This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values. - -|Return code|Description| -|-----------------|-----------------| -|S_OK|The method completed successfully.| -|ERROR_INSUFFICIENT_BUFFER|The directory buffer is not large enough to store the directory path.

- or -

The version buffer is not large enough to store the version string.| - -## Remarks - - The `GetRequestedRuntimeInfo` method returns run-time information about the version loaded into the process, which is not necessarily the latest version installed on the computer. - - In .NET Framework version 2.0, you can get information about the latest installed version by using the `GetRequestedRuntimeInfo` method as follows: - -- Specify the `pExe`, `pwszVersion`, and `pConfigurationFile` parameters as null. - -- Specify the RUNTIME_INFO_UPGRADE_VERSION flag in the `RUNTIME_INFO_FLAGS` enumerations for the `runtimeInfoFlags` parameter. - - The `GetRequestedRuntimeInfo` method does not return the latest CLR version in the following circumstances: - -- An application configuration file that specifies loading a particular CLR version exists. Note that the .NET Framework will use the configuration file even if you specify null for the `pConfigurationFile` parameter. - -- The [CorBindToRuntimeEx](corbindtoruntimeex-function.md) method was called specifying an earlier CLR version. - -- An application that was compiled for an earlier CLR version is currently running. - - For the `runtimeInfoFlags` parameter, you can specify only one of the architecture constants of the `RUNTIME_INFO_FLAGS` enumeration at a time: - -- RUNTIME_INFO_REQUEST_IA64 - -- RUNTIME_INFO_REQUEST_AMD64 - -- RUNTIME_INFO_REQUEST_X86 - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] - + [out] DWORD *dwlength +); +``` + +## Parameters + + `pExe` + [in] The name of the application. + + `pwszVersion` + [in] A string specifying the version number of the runtime. + + `pConfigurationFile` + [in] The name of the configuration file that is associated with `pExe`. + + `startupFlags` + [in] One or more of the [STARTUP_FLAGS](startup-flags-enumeration.md) enumeration values. + + `runtimeInfoFlags` + [in] One or more of the [RUNTIME_INFO_FLAGS](runtime-info-flags-enumeration.md) enumeration values. + + `pDirectory` + [out] A buffer that contains the directory path to the runtime upon successful completion. + + `dwDirectory` + [in] The length of the directory buffer. + + `dwDirectoryLength` + [out] A pointer to the length of the directory path string. + + `pVersion` + [out] A buffer that contains the version number of the runtime upon successful completion. + + `cchBuffer` + [in] The length of the version string buffer. + + `dwlength` + [out] A pointer to the length of the version string. + +## Return Value + + This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values. + +|Return code|Description| +|-----------------|-----------------| +|S_OK|The method completed successfully.| +|ERROR_INSUFFICIENT_BUFFER|The directory buffer is not large enough to store the directory path.

- or -

The version buffer is not large enough to store the version string.| + +## Remarks + + The `GetRequestedRuntimeInfo` method returns run-time information about the version loaded into the process, which is not necessarily the latest version installed on the computer. + + In .NET Framework version 2.0, you can get information about the latest installed version by using the `GetRequestedRuntimeInfo` method as follows: + +- Specify the `pExe`, `pwszVersion`, and `pConfigurationFile` parameters as null. + +- Specify the RUNTIME_INFO_UPGRADE_VERSION flag in the `RUNTIME_INFO_FLAGS` enumerations for the `runtimeInfoFlags` parameter. + + The `GetRequestedRuntimeInfo` method does not return the latest CLR version in the following circumstances: + +- An application configuration file that specifies loading a particular CLR version exists. Note that the .NET Framework will use the configuration file even if you specify null for the `pConfigurationFile` parameter. + +- The [CorBindToRuntimeEx](corbindtoruntimeex-function.md) method was called specifying an earlier CLR version. + +- An application that was compiled for an earlier CLR version is currently running. + + For the `runtimeInfoFlags` parameter, you can specify only one of the architecture constants of the `RUNTIME_INFO_FLAGS` enumeration at a time: + +- RUNTIME_INFO_REQUEST_IA64 + +- RUNTIME_INFO_REQUEST_AMD64 + +- RUNTIME_INFO_REQUEST_X86 + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] + ## See also - [GetRequestedRuntimeVersion Function](getrequestedruntimeversion-function.md) diff --git a/docs/core/unmanaged-api/hosting/getrequestedruntimeversion-function.md b/docs/framework/unmanaged-api/hosting/getrequestedruntimeversion-function.md similarity index 51% rename from docs/core/unmanaged-api/hosting/getrequestedruntimeversion-function.md rename to docs/framework/unmanaged-api/hosting/getrequestedruntimeversion-function.md index a6330c0f7c9f7..fb262435d6bf9 100644 --- a/docs/core/unmanaged-api/hosting/getrequestedruntimeversion-function.md +++ b/docs/framework/unmanaged-api/hosting/getrequestedruntimeversion-function.md @@ -2,71 +2,72 @@ description: "Learn more about: GetRequestedRuntimeVersion Function" title: "GetRequestedRuntimeVersion Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetRequestedRuntimeVersion" -api_location: +api_location: - "mscoree.dll" - "mscoreei.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "GetRequestedRuntimeVersion" -helpviewer_keywords: +helpviewer_keywords: - "GetRequestedRuntimeVersion function [.NET Framework hosting]" -topic_type: +ms.assetid: 82f596a4-483d-4509-b0c5-a84c53c3da1b +topic_type: - "apiref" --- # GetRequestedRuntimeVersion Function -Gets the version number of the common language runtime (CLR) requested by the specified application. If that version is not installed, gets the most recent version that is installed before the requested version. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT GetRequestedRuntimeVersion ( +Gets the version number of the common language runtime (CLR) requested by the specified application. If that version is not installed, gets the most recent version that is installed before the requested version. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT GetRequestedRuntimeVersion ( [in] LPWSTR pExe, [out] LPWSTR pVersion, [in] DWORD cchBuffer, - [out] DWORD *pdwLength -); -``` - -## Parameters - - `pExe` - [in] The name of the application. - - `pVersion` - [out] A buffer that contains the version number string upon successful completion. - - `cchBuffer` - [in] The length of the version buffer. - - `pdwLength` - [out] A pointer to the length of the version number string. - -## Return Value - - This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values. - -|Return code|Description| -|-----------------|-----------------| -|S_OK|The method completed successfully.| -|ERROR_INSUFFICIENT_BUFFER|The version buffer is not large enough to store the version string.| -|E_POINTER|`pdwLength` is null.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] - + [out] DWORD *pdwLength +); +``` + +## Parameters + + `pExe` + [in] The name of the application. + + `pVersion` + [out] A buffer that contains the version number string upon successful completion. + + `cchBuffer` + [in] The length of the version buffer. + + `pdwLength` + [out] A pointer to the length of the version number string. + +## Return Value + + This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values. + +|Return code|Description| +|-----------------|-----------------| +|S_OK|The method completed successfully.| +|ERROR_INSUFFICIENT_BUFFER|The version buffer is not large enough to store the version string.| +|E_POINTER|`pdwLength` is null.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] + ## See also - [GetRequestedRuntimeInfo Function](getrequestedruntimeinfo-function.md) diff --git a/docs/framework/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md b/docs/framework/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md new file mode 100644 index 0000000000000..c4ad8500dd6b9 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/getrequestedruntimeversionforclsid-function.md @@ -0,0 +1,78 @@ +--- +description: "Learn more about: GetRequestedRuntimeVersionForCLSID Function" +title: "GetRequestedRuntimeVersionForCLSID Function" +ms.date: "03/30/2017" +api_name: + - "GetRequestedRuntimeVersionForCLSID" +api_location: + - "mscoree.dll" +api_type: + - "DLLExport" +f1_keywords: + - "GetRequestedRuntimeVersionForCLSID" +helpviewer_keywords: + - "GetRequestedRuntimeVersionForCLSID function [.NET Framework hosting]" +ms.assetid: 5bb12f9a-0612-434b-b4ed-2db636a20bec +topic_type: + - "apiref" +--- +# GetRequestedRuntimeVersionForCLSID Function + +Gets the appropriate common language runtime (CLR) version information for the class with the specified `CLSID`. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT GetRequestedRuntimeVersionForCLSID ( + [in] REFCLSID rclsid, + [out] LPWSTR pVersion, + [in] DWORD cchBuffer, + [out] DWORD* dwLength, + [in] CLSID_RESOLUTION_FLAGS dwResolutionFlags +); +``` + +## Parameters + + `rclsid` + [in] The `CLSID` of the component. + + `pVersion` + [out] A buffer that contains the version number string upon successful completion. + + `cchBuffer` + [in] The size, in wide characters, of the `pVersion` buffer. + + `dwLength` + [out] The length, in bytes, of the returned buffer. + + `dwResolutionFlags` + [in] One of the CLSID_RESOLUTION_FLAGS values. The following values are supported: + +- CLSID_RESOLUTION_DEFAULT: (0x0) Specifies that default interop behavior should be used. + +- CLSID_RESOLUTION_REGISTERED: (0x1) Specifies that the registry should be searched and shim policy should be applied. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The function returned successfully.| +|E_INVALIDARG|One of the parameters has an invalid type or format.| +|ERROR_INSUFFICIENT_BUFFER|The `pVersion` buffer is not large enough to hold the entire version string.| +|REGDB_E_CLASSNOTREG|There is no class registered with the specified `CLSID`.| +|E_POINTER|`dwLength` is null, or `cchBuffer` is large enough to hold the version string, but `pVersion` is null.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **.NET Framework Versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] + +## See also + +- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/getversionfromprocess-function.md b/docs/framework/unmanaged-api/hosting/getversionfromprocess-function.md similarity index 54% rename from docs/core/unmanaged-api/hosting/getversionfromprocess-function.md rename to docs/framework/unmanaged-api/hosting/getversionfromprocess-function.md index 0b73cf56e547f..509ca65487ae5 100644 --- a/docs/core/unmanaged-api/hosting/getversionfromprocess-function.md +++ b/docs/framework/unmanaged-api/hosting/getversionfromprocess-function.md @@ -2,72 +2,73 @@ description: "Learn more about: GetVersionFromProcess Function" title: "GetVersionFromProcess Function" ms.date: "03/30/2017" -api_name: +api_name: - "GetVersionFromProcess" -api_location: +api_location: - "mscoree.dll" - "mscoreei.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "GetVersionFromProcess" -helpviewer_keywords: +helpviewer_keywords: - "GetVersionFromProcess function [.NET Framework hosting]" -topic_type: +ms.assetid: a9f7f824-64a1-408d-8607-91c7f19d21fe +topic_type: - "apiref" --- # GetVersionFromProcess Function -Gets the version number of the common language runtime (CLR) that is associated with the specified process handle. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT GetVersionFromProcess ( +Gets the version number of the common language runtime (CLR) that is associated with the specified process handle. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT GetVersionFromProcess ( [in] HANDLE hProcess, [out] LPWSTR pVersion, [in] DWORD cchBuffer, - [out] DWORD *dwLength -); -``` - -## Parameters - - `hProcess` - [in] A handle to a process. - - `pVersion` - [out] A buffer that contains the version number string upon successful completion of the method. - - `cchBuffer` - [in] The length of the version buffer. - - `pdwLength` - [out] A pointer to the length of the version number string. - -## Return Value - - This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values. - -|Return code|Description| -|-----------------|-----------------| -|S_OK|The method completed successfully.| -|E_INVALIDARG|`pVersion` is null and `cchBuffer` is not null, or vice versa.

-or-

`hProcess` is not a valid handle to a process.

-or-

The CLR is not loaded.| -|ERROR_INSUFFICIENT_BUFFER|`cchBuffer` is null or less than the length of the version string.| -|E_NOTIMPL|This method is not available on the Microsoft Windows 95, Microsoft Windows 98, or Microsoft Windows Millennium Edition operating system.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - + [out] DWORD *dwLength +); +``` + +## Parameters + + `hProcess` + [in] A handle to a process. + + `pVersion` + [out] A buffer that contains the version number string upon successful completion of the method. + + `cchBuffer` + [in] The length of the version buffer. + + `pdwLength` + [out] A pointer to the length of the version number string. + +## Return Value + + This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values. + +|Return code|Description| +|-----------------|-----------------| +|S_OK|The method completed successfully.| +|E_INVALIDARG|`pVersion` is null and `cchBuffer` is not null, or vice versa.

-or-

`hProcess` is not a valid handle to a process.

-or-

The CLR is not loaded.| +|ERROR_INSUFFICIENT_BUFFER|`cchBuffer` is null or less than the length of the version string.| +|E_NOTIMPL|This method is not available on the Microsoft Windows 95, Microsoft Windows 98, or Microsoft Windows Millennium Edition operating system.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [GetRequestedRuntimeInfo Function](getrequestedruntimeinfo-function.md) diff --git a/docs/framework/unmanaged-api/hosting/host-type-enumeration.md b/docs/framework/unmanaged-api/hosting/host-type-enumeration.md new file mode 100644 index 0000000000000..b9c656752ca68 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/host-type-enumeration.md @@ -0,0 +1,53 @@ +--- +description: "Learn more about: HOST_TYPE Enumeration" +title: "HOST_TYPE Enumeration" +ms.date: "03/30/2017" +api_name: + - "HOST_TYPE" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "HOST_TYPE" +helpviewer_keywords: + - "HOST_TYPE enumeration [.NET Framework hosting]" +ms.assetid: 51f848be-84c5-4036-9839-c762c576bbf5 +topic_type: + - "apiref" +--- +# HOST_TYPE Enumeration + +Contains values that specify the type of host that is launching an application. + +## Syntax + +```cpp +typedef enum { + HOST_TYPE_DEFAULT = 0x0, + HOST_TYPE_APPLAUNCH = 0x1, + HOST_TYPE_CORFLAG = 0x2 +} HOST_TYPE; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`HOST_TYPE_APPLAUNCH`|Launch the application from AppLaunch.exe.

Use this value for partially-trusted applications.| +|`HOST_TYPE_CORFLAG`|Launch the application directly. That is, launch the application from its own .exe file.

Use this value for fully-trusted applications.| +|`HOST_TYPE_DEFAULT`|Same as HOST_TYPE_APPLAUNCH.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + +## See also + +- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/hosting-coclasses.md b/docs/framework/unmanaged-api/hosting/hosting-coclasses.md similarity index 55% rename from docs/core/unmanaged-api/hosting/hosting-coclasses.md rename to docs/framework/unmanaged-api/hosting/hosting-coclasses.md index 01c08fb537625..d6dee8e980612 100644 --- a/docs/core/unmanaged-api/hosting/hosting-coclasses.md +++ b/docs/framework/unmanaged-api/hosting/hosting-coclasses.md @@ -2,35 +2,36 @@ description: "Learn more about: Hosting Coclasses" title: "Hosting Coclasses" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - "hosting coclasses [.NET Framework]" - "unmanaged coclasses [.NET Framework], hosting" - "coclasses [.NET Framework hosting]" +ms.assetid: e32d8667-58ee-4760-814f-d22963881622 --- # Hosting Coclasses -This section describes the unmanaged API coclasses that the hosting API uses. - -## In This Section - - [CLRRuntimeHost Coclass](clrruntimehost-coclass.md) - Provides interfaces for managing code execution by the runtime. - - [ComCallUnmarshal Coclass](comcallunmarshal-coclass.md) - Provides interfaces for managing the marshalling of interface pointers. - - [CorRuntimeHost Coclass](corruntimehost-coclass.md) - Provides interfaces for managing applications that are being executed by the common language runtime. - - [TypeNameFactory Coclass](typenamefactory-coclass.md) - Provides an interface for managing the deconstruction of a type name. - -## Related Sections - - [Hosting Interfaces](hosting-interfaces.md) - - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) - - [Hosting Enumerations](hosting-enumerations.md) - +This section describes the unmanaged API coclasses that the hosting API uses. + +## In This Section + + [CLRRuntimeHost Coclass](clrruntimehost-coclass.md) + Provides interfaces for managing code execution by the runtime. + + [ComCallUnmarshal Coclass](comcallunmarshal-coclass.md) + Provides interfaces for managing the marshalling of interface pointers. + + [CorRuntimeHost Coclass](corruntimehost-coclass.md) + Provides interfaces for managing applications that are being executed by the common language runtime. + + [TypeNameFactory Coclass](typenamefactory-coclass.md) + Provides an interface for managing the deconstruction of a type name. + +## Related Sections + + [Hosting Interfaces](hosting-interfaces.md) + + [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) + + [Hosting Enumerations](hosting-enumerations.md) + [Hosting Structures](hosting-structures.md) diff --git a/docs/core/unmanaged-api/hosting/hosting-enumerations.md b/docs/framework/unmanaged-api/hosting/hosting-enumerations.md similarity index 64% rename from docs/core/unmanaged-api/hosting/hosting-enumerations.md rename to docs/framework/unmanaged-api/hosting/hosting-enumerations.md index e9825f13ffddf..58327e64bb8e1 100644 --- a/docs/core/unmanaged-api/hosting/hosting-enumerations.md +++ b/docs/framework/unmanaged-api/hosting/hosting-enumerations.md @@ -2,113 +2,114 @@ description: "Learn more about: Hosting Enumerations" title: "Hosting Enumerations" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - "unmanaged enumerations [.NET Framework], hosting" - "enumerations [.NET Framework hosting]" - "hosting enumerations [.NET Framework]" +ms.assetid: e09131eb-1f7d-4f52-ae42-7393e9b62ef6 --- # Hosting Enumerations -This section describes the unmanaged enumerations that the hosting API uses. - -## In This Section - - [CLSID_RESOLUTION_FLAGS Enumeration](clsid-resolution-flags-enumeration.md) - Contains values that indicate how the common language runtime (CLR) should resolve a `CLSID`. - - [COR_GC_STAT_TYPES Enumeration](cor-gc-stat-types-enumeration.md) - Specifies the statistics to be recorded for a garbage collection. - - [COR_GC_THREAD_STATS_TYPES Enumeration](cor-gc-thread-stats-types-enumeration.md) - Indicates the garbage collection statistics for a thread. - - [EApiCategories Enumeration](eapicategories-enumeration.md) - Describes the categories of capabilities that the host can block from running in partially trusted code. - - [EBindPolicyLevels Enumeration](ebindpolicylevels-enumeration.md) - Provides flags that specify the level at which to apply or modify assembly policy. - - [ECLRAssemblyIdentityFlags Enumeration](eclrassemblyidentityflags-enumeration.md) - Indicates the type of an assembly's identity. - - [EClrEvent Enumeration](eclrevent-enumeration.md) - Describes the CLR events for which the host can register callbacks. - - [EClrFailure Enumeration](eclrfailure-enumeration.md) - Describes the set of failures for which a host can set policy actions. - - [EClrOperation Enumeration](eclroperation-enumeration.md) - Describes the set of operations for which a host can apply policy actions. - - [EClrUnhandledException Enumeration](eclrunhandledexception-enumeration.md) - Describes the available options for managing exceptions that are unhandled in user code. - - [EContextType Enumeration](econtexttype-enumeration.md) - Describes the security context of the currently executing thread. - - [ECustomDumpFlavor Enumeration](ecustomdumpflavor-enumeration.md) - Contains values that indicate which items to include in a custom subset of a heap dump when reporting errors. - - [ECustomDumpItemKind Enumeration](ecustomdumpitemkind-enumeration.md) - Reserved for future extension of the [CustomDumpItem Structure](customdumpitem-structure.md) structure. - - [EHostApplicationPolicy Enumeration](ehostapplicationpolicy-enumeration.md) - Indicates how to modify an [IHostAssemblyManager Interface](ihostassemblymanager-interface.md) interface object. This enumeration has been deprecated. - - [EHostBindingPolicyModifyFlags Enumeration](ehostbindingpolicymodifyflags-enumeration.md) - Allows the host to specify the type of redirection the CLR should perform when applying policy modifications from a source assembly to a target assembly. - - [EInitializeNewDomainFlags Enumeration](einitializenewdomainflags-enumeration.md) - Enables the host to provide the runtime with information about the initialization of an application domain. - - [EMemoryAvailable Enumeration](ememoryavailable-enumeration.md) - Contains values that indicate the amount of free physical memory on the computer. - - [EMemoryCriticalLevel Enumeration](ememorycriticallevel-enumeration.md) - Contains values that indicate the impact of a failure when a specific memory allocation has been requested but cannot be satisfied. - - [EPolicyAction Enumeration](epolicyaction-enumeration.md) - Describes the policy actions the host can set for operations described by [EClrOperation Enumeration](eclroperation-enumeration.md) and failures described by [EClrFailure Enumeration](eclrfailure-enumeration.md). - - [ESymbolReadingPolicy Enumeration](esymbolreadingpolicy-enumeration.md) - Contains values that set the policy for reading program database (PDB) files. - - [ETaskType Enumeration](etasktype-enumeration.md) - Contains values that indicate the kind of task represented by an [ICLRTask Interface](iclrtask-interface.md) or an [IHostTask Interface](ihosttask-interface.md) interface. - - [HOST_TYPE Enumeration](host-type-enumeration.md) - Contains values that specify the type of host that is launching an application. - - [MALLOC_TYPE Enumeration](malloc-type-enumeration.md) - Contains values that specify the characteristics of the memory that is being allocated. - - [METAHOST_CONFIG_FLAGS Enumeration](metahost-config-flags-enumeration.md) - Describes the possible flags returned in the `pdwConfigFlags` parameter of the [ICLRMetaHostPolicy::GetRequestedRuntime](iclrmetahostpolicy-getrequestedruntime-method.md) method. - - [METAHOST_POLICY_FLAGS Enumeration](metahost-policy-flags-enumeration.md) - Provides binding policies that are common to most runtime hosts. - - [RUNTIME_INFO_FLAGS Enumeration](runtime-info-flags-enumeration.md) - Contains values that indicate what information about the CLR should be returned. - - [StackOverflowType Enumeration](stackoverflowtype-enumeration.md) - Contains values that indicate the underlying cause of a stack overflow event. - - [STARTUP_FLAGS Enumeration](startup-flags-enumeration.md) - Contains values that indicate the startup behavior of the CLR. - - [ValidatorFlags Enumeration](validatorflags-enumeration.md) - Contains values that indicate the type of validation that should be performed in a call to [Validate Method](iclrvalidator-validate-method.md). - - [WAIT_OPTION Enumeration](wait-option-enumeration.md) - Indicates the action a host should take if an operation requested by the CLR blocks. - -## Related Sections - - [Hosting Coclasses](hosting-coclasses.md) - - [Hosting Interfaces](hosting-interfaces.md) - - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) - +This section describes the unmanaged enumerations that the hosting API uses. + +## In This Section + + [CLSID_RESOLUTION_FLAGS Enumeration](clsid-resolution-flags-enumeration.md) + Contains values that indicate how the common language runtime (CLR) should resolve a `CLSID`. + + [COR_GC_STAT_TYPES Enumeration](cor-gc-stat-types-enumeration.md) + Specifies the statistics to be recorded for a garbage collection. + + [COR_GC_THREAD_STATS_TYPES Enumeration](cor-gc-thread-stats-types-enumeration.md) + Indicates the garbage collection statistics for a thread. + + [EApiCategories Enumeration](eapicategories-enumeration.md) + Describes the categories of capabilities that the host can block from running in partially trusted code. + + [EBindPolicyLevels Enumeration](ebindpolicylevels-enumeration.md) + Provides flags that specify the level at which to apply or modify assembly policy. + + [ECLRAssemblyIdentityFlags Enumeration](eclrassemblyidentityflags-enumeration.md) + Indicates the type of an assembly's identity. + + [EClrEvent Enumeration](eclrevent-enumeration.md) + Describes the CLR events for which the host can register callbacks. + + [EClrFailure Enumeration](eclrfailure-enumeration.md) + Describes the set of failures for which a host can set policy actions. + + [EClrOperation Enumeration](eclroperation-enumeration.md) + Describes the set of operations for which a host can apply policy actions. + + [EClrUnhandledException Enumeration](eclrunhandledexception-enumeration.md) + Describes the available options for managing exceptions that are unhandled in user code. + + [EContextType Enumeration](econtexttype-enumeration.md) + Describes the security context of the currently executing thread. + + [ECustomDumpFlavor Enumeration](ecustomdumpflavor-enumeration.md) + Contains values that indicate which items to include in a custom subset of a heap dump when reporting errors. + + [ECustomDumpItemKind Enumeration](ecustomdumpitemkind-enumeration.md) + Reserved for future extension of the [CustomDumpItem Structure](customdumpitem-structure.md) structure. + + [EHostApplicationPolicy Enumeration](ehostapplicationpolicy-enumeration.md) + Indicates how to modify an [IHostAssemblyManager Interface](ihostassemblymanager-interface.md) interface object. This enumeration has been deprecated. + + [EHostBindingPolicyModifyFlags Enumeration](ehostbindingpolicymodifyflags-enumeration.md) + Allows the host to specify the type of redirection the CLR should perform when applying policy modifications from a source assembly to a target assembly. + + [EInitializeNewDomainFlags Enumeration](einitializenewdomainflags-enumeration.md) + Enables the host to provide the runtime with information about the initialization of an application domain. + + [EMemoryAvailable Enumeration](ememoryavailable-enumeration.md) + Contains values that indicate the amount of free physical memory on the computer. + + [EMemoryCriticalLevel Enumeration](ememorycriticallevel-enumeration.md) + Contains values that indicate the impact of a failure when a specific memory allocation has been requested but cannot be satisfied. + + [EPolicyAction Enumeration](epolicyaction-enumeration.md) + Describes the policy actions the host can set for operations described by [EClrOperation Enumeration](eclroperation-enumeration.md) and failures described by [EClrFailure Enumeration](eclrfailure-enumeration.md). + + [ESymbolReadingPolicy Enumeration](esymbolreadingpolicy-enumeration.md) + Contains values that set the policy for reading program database (PDB) files. + + [ETaskType Enumeration](etasktype-enumeration.md) + Contains values that indicate the kind of task represented by an [ICLRTask Interface](iclrtask-interface.md) or an [IHostTask Interface](ihosttask-interface.md) interface. + + [HOST_TYPE Enumeration](host-type-enumeration.md) + Contains values that specify the type of host that is launching an application. + + [MALLOC_TYPE Enumeration](malloc-type-enumeration.md) + Contains values that specify the characteristics of the memory that is being allocated. + + [METAHOST_CONFIG_FLAGS Enumeration](metahost-config-flags-enumeration.md) + Describes the possible flags returned in the `pdwConfigFlags` parameter of the [ICLRMetaHostPolicy::GetRequestedRuntime](iclrmetahostpolicy-getrequestedruntime-method.md) method. + + [METAHOST_POLICY_FLAGS Enumeration](metahost-policy-flags-enumeration.md) + Provides binding policies that are common to most runtime hosts. + + [RUNTIME_INFO_FLAGS Enumeration](runtime-info-flags-enumeration.md) + Contains values that indicate what information about the CLR should be returned. + + [StackOverflowType Enumeration](stackoverflowtype-enumeration.md) + Contains values that indicate the underlying cause of a stack overflow event. + + [STARTUP_FLAGS Enumeration](startup-flags-enumeration.md) + Contains values that indicate the startup behavior of the CLR. + + [ValidatorFlags Enumeration](validatorflags-enumeration.md) + Contains values that indicate the type of validation that should be performed in a call to [Validate Method](iclrvalidator-validate-method.md). + + [WAIT_OPTION Enumeration](wait-option-enumeration.md) + Indicates the action a host should take if an operation requested by the CLR blocks. + +## Related Sections + + [Hosting Coclasses](hosting-coclasses.md) + + [Hosting Interfaces](hosting-interfaces.md) + + [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) + [Hosting Structures](hosting-structures.md) diff --git a/docs/core/unmanaged-api/hosting/hosting-global-static-functions.md b/docs/framework/unmanaged-api/hosting/hosting-global-static-functions.md similarity index 60% rename from docs/core/unmanaged-api/hosting/hosting-global-static-functions.md rename to docs/framework/unmanaged-api/hosting/hosting-global-static-functions.md index 85c1ffc74d6dd..baaf3998fb295 100644 --- a/docs/core/unmanaged-api/hosting/hosting-global-static-functions.md +++ b/docs/framework/unmanaged-api/hosting/hosting-global-static-functions.md @@ -2,27 +2,28 @@ description: "Learn more about: Hosting Global Static Functions" title: "Hosting Global Static Functions" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - "global static functions [.NET Framework hosting]" - "hosting global static functions [.NET Framework]" - "unmanaged global static functions [.NET Framework], hosting" +ms.assetid: 4e4ad69d-9343-4f6a-aed8-fe0335a3b979 --- # Hosting Global Static Functions -This section describes the unmanaged hosting functions used by the .NET Framework hosting APIs. - -## In This Section - - [.NET Framework 4 Hosting Global Static Functions](net-framework-4-hosting-global-static-functions.md) - Describes the functions introduced in the .NET Framework 4. - - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) - Describes the functions introduced in the .NET Framework 1.1 and 2.0, which are deprecated in the .NET Framework 4. - -## Related Sections - - [Hosting Coclasses](hosting-coclasses.md) - - [Hosting Enumerations](hosting-enumerations.md) - +This section describes the unmanaged hosting functions used by the .NET Framework hosting APIs. + +## In This Section + + [.NET Framework 4 Hosting Global Static Functions](net-framework-4-hosting-global-static-functions.md) + Describes the functions introduced in the .NET Framework 4. + + [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) + Describes the functions introduced in the .NET Framework 1.1 and 2.0, which are deprecated in the .NET Framework 4. + +## Related Sections + + [Hosting Coclasses](hosting-coclasses.md) + + [Hosting Enumerations](hosting-enumerations.md) + [Hosting Structures](hosting-structures.md) diff --git a/docs/core/unmanaged-api/hosting/hosting-interfaces.md b/docs/framework/unmanaged-api/hosting/hosting-interfaces.md similarity index 67% rename from docs/core/unmanaged-api/hosting/hosting-interfaces.md rename to docs/framework/unmanaged-api/hosting/hosting-interfaces.md index 9011816aa2fb6..40a9468da337b 100644 --- a/docs/core/unmanaged-api/hosting/hosting-interfaces.md +++ b/docs/framework/unmanaged-api/hosting/hosting-interfaces.md @@ -2,42 +2,43 @@ description: "Learn more about: Hosting Interfaces" title: "Hosting Interfaces" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - "interfaces [.NET Framework hosting]" - "hosting interfaces [.NET Framework]" - "unmanaged interfaces [.NET Framework], hosting" +ms.assetid: cc64cb05-38da-418e-815a-daac8e8e26e5 --- # Hosting Interfaces -This section describes the interfaces that unmanaged hosts can use to integrate the common language runtime (CLR) into their applications. - - The .NET Framework version 2.0 hosting interfaces supersede the .NET Framework version 1.0 and 1.1 interfaces. There are significant differences between the two sets of interfaces. Mixing them could cause unexpected behavior and is not recommended. - - The .NET Framework versions 3.0 and 3.5 use the .NET Framework version 2.0 hosting interfaces, and do not introduce any hosting features. - +This section describes the interfaces that unmanaged hosts can use to integrate the common language runtime (CLR) into their applications. + + The .NET Framework version 2.0 hosting interfaces supersede the .NET Framework version 1.0 and 1.1 interfaces. There are significant differences between the two sets of interfaces. Mixing them could cause unexpected behavior and is not recommended. + + The .NET Framework versions 3.0 and 3.5 use the .NET Framework version 2.0 hosting interfaces, and do not introduce any hosting features. + The .NET Framework 4 hosting interfaces supersede the .NET Framework 2.0 interfaces. - -## In This Section - - [Deprecated CLR Hosting Interfaces and Coclasses](deprecated-clr-hosting-interfaces-and-coclasses.md) - Describes the hosting interfaces introduced in the .NET Framework versions 1.0 and 1.1. - - [CLR Hosting Interfaces](clr-hosting-interfaces.md) - Describes the hosting interfaces introduced in .NET Framework version 2.0. - - [CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5](clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md) - Describes the hosting interfaces introduced in the .NET Framework 4. - -## Related Sections - - [Hosting Coclasses](hosting-coclasses.md) - - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) - - [Hosting Enumerations](hosting-enumerations.md) - - [Hosting Structures](hosting-structures.md) - - [Hosting](index.md) - + +## In This Section + + [Deprecated CLR Hosting Interfaces and Coclasses](deprecated-clr-hosting-interfaces-and-coclasses.md) + Describes the hosting interfaces introduced in the .NET Framework versions 1.0 and 1.1. + + [CLR Hosting Interfaces](clr-hosting-interfaces.md) + Describes the hosting interfaces introduced in .NET Framework version 2.0. + + [CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5](clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md) + Describes the hosting interfaces introduced in the .NET Framework 4. + +## Related Sections + + [Hosting Coclasses](hosting-coclasses.md) + + [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) + + [Hosting Enumerations](hosting-enumerations.md) + + [Hosting Structures](hosting-structures.md) + + [Hosting](index.md) + [Runtime Hosts](/previous-versions/dotnet/netframework-4.0/a51xd4ze(v=vs.100)) diff --git a/docs/framework/unmanaged-api/hosting/hosting-structures.md b/docs/framework/unmanaged-api/hosting/hosting-structures.md new file mode 100644 index 0000000000000..48fa68db29eb0 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/hosting-structures.md @@ -0,0 +1,49 @@ +--- +description: "Learn more about: Hosting Structures" +title: "Hosting Structures" +ms.date: "03/30/2017" +helpviewer_keywords: + - "hosting structures [.NET Framework]" + - "unmanaged structures [.NET Framework], hosting" + - "structures [.NET Framework hosting]" +ms.assetid: 492e010f-7493-4134-9505-f7008ccdaae6 +--- +# Hosting Structures + +This section describes the unmanaged structures that the hosting API uses. + +## In This Section + + [AssemblyBindInfo Structure](assemblybindinfo-structure.md) + Provides detailed information about the referenced assembly. + + [BucketParameters Structure](bucketparameters-structure.md) + Stores the type name of an event and the parameters for the current exception that is associated with the event. + + [COR_GC_STATS Structure](cor-gc-stats-structure.md) + Provides statistics about the garbage collection mechanism of the common language runtime (CLR). + + [COR_GC_THREAD_STATS Structure](cor-gc-thread-stats-structure.md) + Contains per-thread statistics pertaining to garbage collection. + + [CustomDumpItem Structure](customdumpitem-structure.md) + Describes an item to be added to a custom dump in error reporting. + + [MDAInfo Structure](mdainfo-structure.md) + Provides details about the `Event_MDAFired` event, which triggers the creation of a managed debugging assistant (MDA). + + [ModuleBindInfo Structure](modulebindinfo-structure.md) + Provides detailed information about the referenced module and the assembly that contains it. + + [StackOverflowInfo Structure](stackoverflowinfo-structure.md) + Stores the type of overflow that occurred and information on the exception that was thrown due to the overflow. + +## Related Sections + + [Hosting Coclasses](hosting-coclasses.md) + + [Hosting Interfaces](hosting-interfaces.md) + + [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) + + [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md b/docs/framework/unmanaged-api/hosting/iactiononclrevent-interface.md similarity index 59% rename from docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md rename to docs/framework/unmanaged-api/hosting/iactiononclrevent-interface.md index a34cd774969a0..208df2d082cca 100644 --- a/docs/core/unmanaged-api/hosting/iactiononclrevent-interface.md +++ b/docs/framework/unmanaged-api/hosting/iactiononclrevent-interface.md @@ -2,39 +2,40 @@ description: "Learn more about: IActionOnCLREvent Interface" title: "IActionOnCLREvent Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IActionOnCLREvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IActionOnCLREvent" -helpviewer_keywords: +helpviewer_keywords: - "IActionOnCLREvent interface [.NET Framework hosting]" -topic_type: +ms.assetid: b5f9b41e-7301-429c-911f-21d5422292b3 +topic_type: - "apiref" --- # IActionOnCLREvent Interface -Provides the [IActionOnCLREvent::OnEvent](iactiononclrevent-onevent-method.md) method, which performs callbacks on events that have been registered by using a call to the [ICLROnEventManager::RegisterActionOnEvent](iclroneventmanager-registeractiononevent-method.md) method. - -## Methods - -|Method|Description| -|------------|-----------------| -|[OnEvent Method](iactiononclrevent-onevent-method.md)|Performs a callback for a registered event.| - -## 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 2.0 - +Provides the [IActionOnCLREvent::OnEvent](iactiononclrevent-onevent-method.md) method, which performs callbacks on events that have been registered by using a call to the [ICLROnEventManager::RegisterActionOnEvent](iclroneventmanager-registeractiononevent-method.md) method. + +## Methods + +|Method|Description| +|------------|-----------------| +|[OnEvent Method](iactiononclrevent-onevent-method.md)|Performs a callback for a registered event.| + +## 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 - [EClrEvent Enumeration](eclrevent-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md b/docs/framework/unmanaged-api/hosting/iactiononclrevent-onevent-method.md similarity index 60% rename from docs/core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md rename to docs/framework/unmanaged-api/hosting/iactiononclrevent-onevent-method.md index e78947a83c505..ea32f62c11012 100644 --- a/docs/core/unmanaged-api/hosting/iactiononclrevent-onevent-method.md +++ b/docs/framework/unmanaged-api/hosting/iactiononclrevent-onevent-method.md @@ -2,71 +2,72 @@ description: "Learn more about: IActionOnCLREvent::OnEvent Method" title: "IActionOnCLREvent::OnEvent Method" ms.date: "03/30/2017" -api_name: +api_name: - "IActionOnCLREvent.OnEvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IActionOnCLREvent::OnEvent" -helpviewer_keywords: +helpviewer_keywords: - "OnEvent method [.NET Framework hosting]" - "IActionOnCLREvent::OnEvent method [.NET Framework hosting]" -topic_type: +ms.assetid: 0970f10c-4304-4c12-91c0-83e51455afb4 +topic_type: - "apiref" --- # IActionOnCLREvent::OnEvent Method -Performs callbacks on events that have been registered by using a call to the [ICLROnEventManager::RegisterActionOnEvent](iclroneventmanager-registeractiononevent-method.md) method. - -## Syntax - -```cpp -HRESULT OnEvent ( - [in] EClrEvent event, - [in] PVOID data -); -``` - -## Parameters - - `event` - [in] One of the [EClrEvent](eclrevent-enumeration.md) values, which indicates the type of event. - - `data` - [in] A pointer to an object that contains details about `event`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`OnEvent` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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 cancelled 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 any hosting method return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The `data` parameter is a pointer to an object of unspecified type. If the `event` parameter is `Event_DomainUnload`, `data` is the numeric identifier for the that was unloaded. The host can take appropriate action using this identifier as a key. - - If `event` is `Event_MDAFired`, `data` is a pointer to an [MDAInfo](mdainfo-structure.md) instance that contains the message output from a Managed Debugging Assistant (MDA). MDAs are a feature of the CLR that help developers with debugging, by generating XML messages about events that are otherwise difficult to trap. Such messages can be especially useful in debugging transitions between managed and unmanaged code. For more information, see [Diagnosing Errors with Managed Debugging Assistants](../../../framework/debug-trace-profile/diagnosing-errors-with-managed-debugging-assistants.md). - -## 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 2.0 - +Performs callbacks on events that have been registered by using a call to the [ICLROnEventManager::RegisterActionOnEvent](iclroneventmanager-registeractiononevent-method.md) method. + +## Syntax + +```cpp +HRESULT OnEvent ( + [in] EClrEvent event, + [in] PVOID data +); +``` + +## Parameters + + `event` + [in] One of the [EClrEvent](eclrevent-enumeration.md) values, which indicates the type of event. + + `data` + [in] A pointer to an object that contains details about `event`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`OnEvent` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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 cancelled 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 any hosting method return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The `data` parameter is a pointer to an object of unspecified type. If the `event` parameter is `Event_DomainUnload`, `data` is the numeric identifier for the that was unloaded. The host can take appropriate action using this identifier as a key. + + If `event` is `Event_MDAFired`, `data` is a pointer to an [MDAInfo](mdainfo-structure.md) instance that contains the message output from a Managed Debugging Assistant (MDA). MDAs are a feature of the CLR that help developers with debugging, by generating XML messages about events that are otherwise difficult to trap. Such messages can be especially useful in debugging transitions between managed and unmanaged code. For more information, see [Diagnosing Errors with Managed Debugging Assistants](../../debug-trace-profile/diagnosing-errors-with-managed-debugging-assistants.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 -- [Diagnosing Errors with Managed Debugging Assistants](../../../framework/debug-trace-profile/diagnosing-errors-with-managed-debugging-assistants.md) +- [Diagnosing Errors with Managed Debugging Assistants](../../debug-trace-profile/diagnosing-errors-with-managed-debugging-assistants.md) - [EClrEvent Enumeration](eclrevent-enumeration.md) - [IActionOnCLREvent Interface](iactiononclrevent-interface.md) - [ICLRControl Interface](iclrcontrol-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/iapartmentcallback-docallback-method.md b/docs/framework/unmanaged-api/hosting/iapartmentcallback-docallback-method.md new file mode 100644 index 0000000000000..9411fd64bcad4 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iapartmentcallback-docallback-method.md @@ -0,0 +1,53 @@ +--- +description: "Learn more about: IApartmentCallback::DoCallback Method" +title: "IApartmentCallback::DoCallback Method" +ms.date: "03/30/2017" +api_name: + - "IApartmentCallback.DoCallback" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "DoCallback" +helpviewer_keywords: + - "IApartmentCallback::DoCallback method [.NET Framework hosting]" + - "DoCallback method [.NET Framework hosting]" +ms.assetid: 8edad30c-30ff-4bee-813c-75525a82fc93 +topic_type: + - "apiref" +--- +# IApartmentCallback::DoCallback Method + +Executes the specified function within an apartment. + +## Syntax + +```cpp +HRESULT _stdcall DoCallback( + [in] SIZE_T pFunc, + [in] SIZE_T pData +); +``` + +## Parameters + + `pFunc` + [in] A pointer to the function to be executed within the apartment. + + `pData` + [in] A pointer to the function's argument. + +## 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 + +- [IApartmentCallback Interface](iapartmentcallback-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/iapartmentcallback-interface.md b/docs/framework/unmanaged-api/hosting/iapartmentcallback-interface.md new file mode 100644 index 0000000000000..7363f73a8a367 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iapartmentcallback-interface.md @@ -0,0 +1,41 @@ +--- +description: "Learn more about: IApartmentCallback Interface" +title: "IApartmentCallback Interface" +ms.date: "03/30/2017" +api_name: + - "IApartmentCallback" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IApartmentCallback" +helpviewer_keywords: + - "IApartmentCallback interface [.NET Framework hosting]" +ms.assetid: 57c33c58-bf0b-4533-b569-e6a682d02cba +topic_type: + - "apiref" +--- +# IApartmentCallback Interface + +Provides methods for making callbacks within an apartment. An *apartment* is a logical container within a process for objects that share the same thread access requirements. + +## Methods + +|Method|Description| +|------------|-----------------| +|[DoCallback Method](iapartmentcallback-docallback-method.md)|Executes the specified function within an apartment.| + +## 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 + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md b/docs/framework/unmanaged-api/hosting/iappdomainbinding-interface.md similarity index 51% rename from docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md rename to docs/framework/unmanaged-api/hosting/iappdomainbinding-interface.md index 1f8663d848a97..1771a42db945c 100644 --- a/docs/core/unmanaged-api/hosting/iappdomainbinding-interface.md +++ b/docs/framework/unmanaged-api/hosting/iappdomainbinding-interface.md @@ -2,39 +2,40 @@ description: "Learn more about: IAppDomainBinding Interface" title: "IAppDomainBinding Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IAppDomainBinding" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IAppDomainBinding" -helpviewer_keywords: +helpviewer_keywords: - "IAppDomainBinding interface [.NET Framework hosting]" -topic_type: +ms.assetid: 368881ab-c4ea-4731-bf22-c596aac7c66c +topic_type: - "apiref" --- # IAppDomainBinding Interface -Provides a method that is called by the common language runtime (CLR) to notify the host application that an application domain has been created. - -## Methods - -|Method|Description| -|------------|-----------------| -|[OnAppDomain Method](iappdomainbinding-onappdomain-method.md)|Called by the common language runtime (CLR) to notify the host that an application domain has been created.| - -## 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 2.0 - +Provides a method that is called by the common language runtime (CLR) to notify the host application that an application domain has been created. + +## Methods + +|Method|Description| +|------------|-----------------| +|[OnAppDomain Method](iappdomainbinding-onappdomain-method.md)|Called by the common language runtime (CLR) to notify the host that an application domain has been created.| + +## 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 - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md b/docs/framework/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md new file mode 100644 index 0000000000000..5e240ac72b2ac --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iappdomainbinding-onappdomain-method.md @@ -0,0 +1,49 @@ +--- +description: "Learn more about: IAppDomainBinding::OnAppDomain Method" +title: "IAppDomainBinding::OnAppDomain Method" +ms.date: "03/30/2017" +api_name: + - "IAppDomainBinding.OnAppDomain" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "OnAppDomain" +helpviewer_keywords: + - "IAppDomainBinding::OnAppDomain method [.NET Framework hosting]" + - "OnAppDomain method [.NET Framework hosting]" +ms.assetid: b419dcc9-e8aa-484b-af0d-0f40358edb99 +topic_type: + - "apiref" +--- +# IAppDomainBinding::OnAppDomain Method + +Called by the common language runtime (CLR) to notify the host that an application domain has been created. + +## Syntax + +```cpp +HRESULT OnAppDomain ( + [in] IUnknown* pAppdomain +); +``` + +## Parameters + + `pAppdomain` + [in] A pointer to an [IUnknown](/cpp/atl/iunknown) interface object that represents the new application domain. + +## 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 + +- [IAppDomainBinding Interface](iappdomainbinding-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md b/docs/framework/unmanaged-api/hosting/iappdomainsetup-interface.md similarity index 72% rename from docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md rename to docs/framework/unmanaged-api/hosting/iappdomainsetup-interface.md index 2c51c065df2f8..e554df4dde1e8 100644 --- a/docs/core/unmanaged-api/hosting/iappdomainsetup-interface.md +++ b/docs/framework/unmanaged-api/hosting/iappdomainsetup-interface.md @@ -2,54 +2,55 @@ description: "Learn more about: IAppDomainSetup Interface" title: "IAppDomainSetup Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IAppDomainSetup" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IAppDomainSetup" -helpviewer_keywords: +helpviewer_keywords: - "IAppDomainSetup interface [.NET Framework hosting]" -topic_type: +ms.assetid: 1844da85-c031-40bf-bea4-1a3d12a36c8c +topic_type: - "apiref" --- # IAppDomainSetup Interface -Provides properties that allow the host to configure an type before calling the [ICorRuntimeHost::CreateDomainEx](icorruntimehost-createdomainex-method.md) method to create it. - -## Properties - -|Property|Description| -|--------------|-----------------| -||Gets or sets the name of the directory that contains the application.| -||Gets or sets the name of the application.| -||Gets or sets the name of an area specific to the application where files are shadow-copied.| -||Gets or sets the name of the configuration file for an application.| -||Gets or sets the name of the directory where dynamically generated files are stored and accessed.| -||Gets or sets the path to the license file that is associated with this domain.| -||Gets or sets the list of directories combined with the directory to probe for private assemblies.| -||Gets or sets a string value that includes or excludes from the search path for the application.| -||Gets or sets the names of the directories that contain assemblies to be shadow-copied.| -||Gets or sets a string that indicates whether shadow-copying is turned on or off. Valid values are "true" or "false".| - -## Remarks - - The `IAppDomainSetup` interface corresponds to the managed interface, which the type implements. See for detailed descriptions of its properties. - - `IAppDomainSetup` represents assembly binding information that can be added to an instance before its creation. For example, a host can set the property to establish a root directory, which the common language runtime (CLR) probes for managed assemblies. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v11plus](../../../../includes/net-current-v11plus-md.md)] - +Provides properties that allow the host to configure an type before calling the [ICorRuntimeHost::CreateDomainEx](icorruntimehost-createdomainex-method.md) method to create it. + +## Properties + +|Property|Description| +|--------------|-----------------| +||Gets or sets the name of the directory that contains the application.| +||Gets or sets the name of the application.| +||Gets or sets the name of an area specific to the application where files are shadow-copied.| +||Gets or sets the name of the configuration file for an application.| +||Gets or sets the name of the directory where dynamically generated files are stored and accessed.| +||Gets or sets the path to the license file that is associated with this domain.| +||Gets or sets the list of directories combined with the directory to probe for private assemblies.| +||Gets or sets a string value that includes or excludes from the search path for the application.| +||Gets or sets the names of the directories that contain assemblies to be shadow-copied.| +||Gets or sets a string that indicates whether shadow-copying is turned on or off. Valid values are "true" or "false".| + +## Remarks + + The `IAppDomainSetup` interface corresponds to the managed interface, which the type implements. See for detailed descriptions of its properties. + + `IAppDomainSetup` represents assembly binding information that can be added to an instance before its creation. For example, a host can set the property to establish a root directory, which the common language runtime (CLR) probes for managed assemblies. + +## 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_v11plus](../../../../includes/net-current-v11plus-md.md)] + ## See also - diff --git a/docs/core/unmanaged-api/hosting/icatalogservices-autodone-method.md b/docs/framework/unmanaged-api/hosting/icatalogservices-autodone-method.md similarity index 67% rename from docs/core/unmanaged-api/hosting/icatalogservices-autodone-method.md rename to docs/framework/unmanaged-api/hosting/icatalogservices-autodone-method.md index e957516fcb919..4387c7cbb8738 100644 --- a/docs/core/unmanaged-api/hosting/icatalogservices-autodone-method.md +++ b/docs/framework/unmanaged-api/hosting/icatalogservices-autodone-method.md @@ -2,30 +2,31 @@ description: "Learn more about: ICatalogServices::Autodone Method" title: "ICatalogServices::Autodone Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICatalogServices.Autodone" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "Autodone" -helpviewer_keywords: +helpviewer_keywords: - "ICatalogServices::Autodone method [.NET Framework hosting]" - "Autodone method [.NET Framework hosting]" -topic_type: +ms.assetid: 3002f051-7aaa-4669-9314-cbc65b3a1772 +topic_type: - "apiref" --- # ICatalogServices::Autodone Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT Autodone ( ); -``` - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT Autodone ( ); +``` + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/icatalogservices-interface.md b/docs/framework/unmanaged-api/hosting/icatalogservices-interface.md similarity index 59% rename from docs/core/unmanaged-api/hosting/icatalogservices-interface.md rename to docs/framework/unmanaged-api/hosting/icatalogservices-interface.md index ea93960219d2b..87c807c0d968b 100644 --- a/docs/core/unmanaged-api/hosting/icatalogservices-interface.md +++ b/docs/framework/unmanaged-api/hosting/icatalogservices-interface.md @@ -2,32 +2,33 @@ description: "Learn more about: ICatalogServices Interface" title: "ICatalogServices Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICatalogServices" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICatalogServices" -helpviewer_keywords: +helpviewer_keywords: - "ICatalogServices interface [.NET Framework hosting]" -topic_type: +ms.assetid: f0d7e49b-2394-4ae0-8820-1b64cae0cfe8 +topic_type: - "apiref" --- # ICatalogServices Interface -Provides methods for cataloging services. - - This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Autodone Method](icatalogservices-autodone-method.md)|Reserved for internal use only.| -|[NotAutodone Method](icatalogservices-notautodone-method.md)|Reserved for internal use only.| - +Provides methods for cataloging services. + + This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Autodone Method](icatalogservices-autodone-method.md)|Reserved for internal use only.| +|[NotAutodone Method](icatalogservices-notautodone-method.md)|Reserved for internal use only.| + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/icatalogservices-notautodone-method.md b/docs/framework/unmanaged-api/hosting/icatalogservices-notautodone-method.md similarity index 67% rename from docs/core/unmanaged-api/hosting/icatalogservices-notautodone-method.md rename to docs/framework/unmanaged-api/hosting/icatalogservices-notautodone-method.md index 37586b5097401..443cb06e298e0 100644 --- a/docs/core/unmanaged-api/hosting/icatalogservices-notautodone-method.md +++ b/docs/framework/unmanaged-api/hosting/icatalogservices-notautodone-method.md @@ -2,30 +2,31 @@ description: "Learn more about: ICatalogServices::NotAutodone Method" title: "ICatalogServices::NotAutodone Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICatalogServices.NotAutodone" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "NotAutodone" -helpviewer_keywords: +helpviewer_keywords: - "ICatalogServices::NotAutodone method [.NET Framework hosting]" - "NotAutodone method [.NET Framework hosting]" -topic_type: +ms.assetid: 86a09871-33e4-412c-aeb8-4d18f924595b +topic_type: - "apiref" --- # ICatalogServices::NotAutodone Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT NotAutodone ( ); -``` - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT NotAutodone ( ); +``` + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/iceefilegen-class.md b/docs/framework/unmanaged-api/hosting/iceefilegen-class.md new file mode 100644 index 0000000000000..67d5347f55a26 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iceefilegen-class.md @@ -0,0 +1,243 @@ +--- +description: "Learn more about: ICeeFileGen Class" +title: "ICeeFileGen Class" +ms.date: "03/30/2017" +api_name: + - "ICeeFileGen" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICeeFileGen" +helpviewer_keywords: + - "ICeeFileGen class [.NET Framework hosting]" +ms.assetid: 90368606-506e-40df-be1f-8d595159203f +topic_type: + - "apiref" +--- +# ICeeFileGen Class + +Provides functionality for creating a native portable executable (PE) file. The interface will typically be used by compilers to generate their compiled output executable. + +> [!NOTE] +> `ICeeFileGen` supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + This interface has been deprecated and will be removed in a future release. + +## Syntax + +```cpp +class ICeeFileGen { +public: + virtual HRESULT CreateCeeFile(HCEEFILE *ceeFile); + + virtual HRESULT EmitMetaData (HCEEFILE ceeFile, + IMetaDataEmit *emitter, mdScope scope); + + virtual HRESULT EmitLibraryName (HCEEFILE ceeFile, + IMetaDataEmit *emitter, mdScope scope); + + virtual HRESULT EmitMethod (); + + virtual HRESULT GetMethodRVA (HCEEFILE ceeFile, + ULONG codeOffset, ULONG *codeRVA); + + virtual HRESULT EmitSignature (); + + virtual HRESULT EmitString (HCEEFILE ceeFile, + __in LPWSTR strValue, ULONG *strRef); + + virtual HRESULT GenerateCeeFile (HCEEFILE ceeFile); + + virtual HRESULT SetOutputFileName (HCEEFILE ceeFile, + __in LPWSTR outputFileName); + + virtual HRESULT GetOutputFileName (HCEEFILE ceeFile, + __out LPWSTR *outputFileName); + + virtual HRESULT SetResourceFileName (HCEEFILE ceeFile, + __in LPWSTR resourceFileName); + + virtual HRESULT GetResourceFileName (HCEEFILE ceeFile, + __out LPWSTR *resourceFileName); + + virtual HRESULT SetImageBase(HCEEFILE ceeFile, size_t imageBase); + + virtual HRESULT SetSubsystem(HCEEFILE ceeFile, DWORD subsystem, + DWORD major, DWORD minor); + + virtual HRESULT SetEntryClassToken (); + + virtual HRESULT GetEntryClassToken (); + + virtual HRESULT SetEntryPointDescr (); + + virtual HRESULT GetEntryPointDescr (); + + virtual HRESULT SetEntryPointFlags (); + + virtual HRESULT GetEntryPointFlags (); + + virtual HRESULT SetDllSwitch (HCEEFILE ceeFile, BOOL dllSwitch); + + virtual HRESULT GetDllSwitch (HCEEFILE ceeFile, BOOL *dllSwitch); + + virtual HRESULT SetLibraryName (HCEEFILE ceeFile, + __in LPWSTR LibraryName); + + virtual HRESULT GetLibraryName (HCEEFILE ceeFile, + __out LPWSTR *LibraryName); + + virtual HRESULT SetLibraryGuid (HCEEFILE ceeFile, + __in LPWSTR LibraryGuid); + + virtual HRESULT DestroyCeeFile(HCEEFILE *ceeFile); + + virtual HRESULT GetSectionCreate (HCEEFILE ceeFile, + const char *name, DWORD flags, HCEESECTION *section); + + virtual HRESULT GetIlSection (HCEEFILE ceeFile, + HCEESECTION *section); + + virtual HRESULT GetRdataSection (HCEEFILE ceeFile, + HCEESECTION *section); + + virtual HRESULT GetSectionDataLen (HCEESECTION section, + ULONG *dataLen); + + virtual HRESULT GetSectionBlock (HCEESECTION section, ULONG len, + ULONG align=1, void **ppBytes=0); + + virtual HRESULT TruncateSection (HCEESECTION section, ULONG len); + + virtual HRESULT AddSectionReloc (HCEESECTION section, + ULONG offset, HCEESECTION relativeTo, + CeeSectionRelocType relocType); + + virtual HRESULT SetSectionDirectoryEntry (HCEESECTION section, + ULONG num); + + virtual HRESULT CreateSig (); + + virtual HRESULT AddSigArg (); + + virtual HRESULT SetSigReturnType (); + + virtual HRESULT SetSigCallingConvention (); + + virtual HRESULT DeleteSig (); + + virtual HRESULT SetEntryPoint (HCEEFILE ceeFile, + mdMethodDef method); + + virtual HRESULT GetEntryPoint (HCEEFILE ceeFile, + mdMethodDef *method); + + virtual HRESULT SetComImageFlags (HCEEFILE ceeFile, DWORD mask); + + virtual HRESULT GetComImageFlags (HCEEFILE ceeFile, DWORD *mask); + + virtual HRESULT GetIMapTokenIface(HCEEFILE ceeFile, + IMetaDataEmit *emitter, IUnknown **pIMapToken); + + virtual HRESULT SetDirectoryEntry (HCEEFILE ceeFile, + HCEESECTION section, ULONG num, ULONG size, ULONG offset = 0); + + virtual HRESULT EmitMetaDataEx (HCEEFILE ceeFile, + IMetaDataEmit *emitter); + + virtual HRESULT EmitLibraryNameEx (HCEEFILE ceeFile, + IMetaDataEmit *emitter); + + virtual HRESULT GetIMapTokenIfaceEx(HCEEFILE ceeFile, + IMetaDataEmit *emitter, IUnknown **pIMapToken); + + virtual HRESULT EmitMacroDefinitions(HCEEFILE ceeFile, + void *pData, DWORD cData); + + virtual HRESULT CreateCeeFileFromICeeGen(ICeeGen *pFromICeeGen, + HCEEFILE *ceeFile, DWORD createFlags = + ICEE_CREATE_FILE_PURE_IL); + + virtual HRESULT SetManifestEntry(HCEEFILE ceeFile, ULONG size, + ULONG offset); + + virtual HRESULT SetEnCRVABase(HCEEFILE ceeFile, ULONG dataBase, + ULONG rdataBase); + + virtual HRESULT GenerateCeeMemoryImage (HCEEFILE ceeFile, + void **ppImage); + + virtual HRESULT ComputeSectionOffset(HCEESECTION section, + __in char *ptr, unsigned *offset); + + virtual HRESULT ComputeOffset(HCEEFILE file, __in char *ptr, + HCEESECTION *pSection, unsigned *offset); + + virtual HRESULT GetCorHeader(HCEEFILE ceeFile, + IMAGE_COR20_HEADER **header); + + virtual HRESULT LinkCeeFile (HCEEFILE ceeFile); + + virtual HRESULT FixupCeeFile (HCEEFILE ceeFile); + + virtual HRESULT GetSectionRVA (HCEESECTION section, ULONG *rva); + + virtual HRESULT ComputeSectionPointer(HCEESECTION section, + ULONG offset, __out char **ptr); + + virtual HRESULT SetObjSwitch (HCEEFILE ceeFile, BOOL objSwitch); + + virtual HRESULT GetObjSwitch (HCEEFILE ceeFile, BOOL *objSwitch); + + virtual HRESULT SetVTableEntry(HCEEFILE ceeFile, ULONG size, + ULONG offset); + + virtual HRESULT SetStrongNameEntry(HCEEFILE ceeFile, ULONG size, + ULONG offset); + + virtual HRESULT EmitMetaDataAt (HCEEFILE ceeFile, + IMetaDataEmit *emitter, HCEESECTION section, DWORD offset, + BYTE* buffer, unsigned buffLen); + + virtual HRESULT GetFileTimeStamp (HCEEFILE ceeFile, + DWORD *pTimeStamp); + + virtual HRESULT AddNotificationHandler(HCEEFILE ceeFile, + IUnknown *pHandler); + + virtual HRESULT SetFileAlignment(HCEEFILE ceeFile, + ULONG fileAlignment); + + virtual HRESULT ClearComImageFlags (HCEEFILE ceeFile, DWORD mask); + + virtual HRESULT CreateCeeFileEx(HCEEFILE *ceeFile, + ULONG createFlags); + + virtual HRESULT SetImageBase64(HCEEFILE ceeFile, + ULONGLONG imageBase); + + virtual HRESULT GetHeaderInfo (HCEEFILE ceeFile, + PIMAGE_NT_HEADERS *ppNtHeaders, + PIMAGE_SECTION_HEADER *ppSections, ULONG *pNumSections); + + virtual HRESULT CreateCeeFileEx2(HCEEFILE *ceeFile, + ULONG createFlags, LPCWSTR seedFileName = NULL); + + virtual HRESULT SetVTableEntry64(HCEEFILE ceeFile, ULONG size, + void* ptr); +}; +``` + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** ICeeFileGen.h + + **.NET Framework Version:** 1.0 + +## See also + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentallocated-method.md b/docs/framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentallocated-method.md similarity index 52% rename from docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentallocated-method.md rename to docs/framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentallocated-method.md index 776d8e7ca4c00..51f5987eb836b 100644 --- a/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentallocated-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentallocated-method.md @@ -2,62 +2,63 @@ description: "Learn more about: ICLRAppDomainResourceMonitor::GetCurrentAllocated Method" title: "ICLRAppDomainResourceMonitor::GetCurrentAllocated Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAppDomainResourceMonitor.GetCurrentAllocated" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAppDomainResourceMonitor::GetCurrentAllocated" -helpviewer_keywords: +helpviewer_keywords: - "GetCurrentAllocated method [.NET Framework hosting]" - "ICLRAppDomainResourceMonitor::GetCurrentAllocated method [.NET Framework hosting]" -topic_type: +ms.assetid: 7bab209c-efd4-44c2-af30-61abab0ae2fc +topic_type: - "apiref" --- # ICLRAppDomainResourceMonitor::GetCurrentAllocated Method -Gets the total size, in bytes, of all memory allocations that have been made by the application domain since it was created, without subtracting memory that has been garbage-collected. - -## Syntax - -```cpp -HRESULT GetCurrentAllocated([in] DWORD dwAppDomainId, - [out] ULONGLONG* pBytesAllocated); -``` - -## Parameters - - `dwAppDomainId` - [in] The ID of the requested application domain. - - `pBytesAllocated` - [out] A pointer to the total size of all memory allocations. - -## 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.| -|COR_E_APPDOMAINUNLOADED|The application domain has been unloaded or does not exist.| - -## Remarks - - This method is the unmanaged equivalent of the managed property. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Gets the total size, in bytes, of all memory allocations that have been made by the application domain since it was created, without subtracting memory that has been garbage-collected. + +## Syntax + +```cpp +HRESULT GetCurrentAllocated([in] DWORD dwAppDomainId, + [out] ULONGLONG* pBytesAllocated); +``` + +## Parameters + + `dwAppDomainId` + [in] The ID of the requested application domain. + + `pBytesAllocated` + [out] A pointer to the total size of all memory allocations. + +## 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.| +|COR_E_APPDOMAINUNLOADED|The application domain has been unloaded or does not exist.| + +## Remarks + + This method is the unmanaged equivalent of the managed property. + +## 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 - [ICLRAppDomainResourceMonitor Interface](iclrappdomainresourcemonitor-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentcputime-method.md b/docs/framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentcputime-method.md similarity index 58% rename from docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentcputime-method.md rename to docs/framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentcputime-method.md index 69219dbe6eeac..57614463970d8 100644 --- a/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentcputime-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentcputime-method.md @@ -2,61 +2,62 @@ description: "Learn more about: ICLRAppDomainResourceMonitor::GetCurrentCpuTime Method" title: "ICLRAppDomainResourceMonitor::GetCurrentCpuTime Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAppDomainResourceMonitor.GetCurrentCpuTime" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAppDomainResourceMonitor::GetCurrentCpuTime" -helpviewer_keywords: +helpviewer_keywords: - "ICLRAppDomainResourceMonitor::GetCurrentCpuTime method [.NET Framework hosting]" - "GetCurrentCpuTime method [.NET Framework hosting]" -topic_type: +ms.assetid: ebc9cc33-fcd6-4cae-9ecb-ea21c51874e6 +topic_type: - "apiref" --- # ICLRAppDomainResourceMonitor::GetCurrentCpuTime Method -Gets the total processor time that has been used by all threads while executing in the current application domain, since the application domain was created. - -## Syntax - -```cpp -HRESULT GetCurrentCpuTime([in] DWORD dwAppDomainId, - [out] ULONGLONG* pMilliseconds); -``` - -## Parameters - - `dwAppDomainId` - [in] The ID of the requested application domain. - - `pMilliseconds` - [out] A pointer to the total processor time that has been used by all threads while executing in the current application domain since the application domain was created. This parameter can be `null`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method completed successfully.| -|COR_E_APPDOMAINUNLOADED|The application domain has been unloaded or does not exist.| -|E_FAIL|Application domain resource monitoring is not enabled.

-or-

All other failures.| - -## Remarks - - This method is the unmanaged equivalent of the managed property. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Gets the total processor time that has been used by all threads while executing in the current application domain, since the application domain was created. + +## Syntax + +```cpp +HRESULT GetCurrentCpuTime([in] DWORD dwAppDomainId, + [out] ULONGLONG* pMilliseconds); +``` + +## Parameters + + `dwAppDomainId` + [in] The ID of the requested application domain. + + `pMilliseconds` + [out] A pointer to the total processor time that has been used by all threads while executing in the current application domain since the application domain was created. This parameter can be `null`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method completed successfully.| +|COR_E_APPDOMAINUNLOADED|The application domain has been unloaded or does not exist.| +|E_FAIL|Application domain resource monitoring is not enabled.

-or-

All other failures.| + +## Remarks + + This method is the unmanaged equivalent of the managed property. + +## 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 - [ICLRAppDomainResourceMonitor Interface](iclrappdomainresourcemonitor-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md b/docs/framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md similarity index 64% rename from docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md rename to docs/framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md index f2a32c122e542..a126d280a8141 100644 --- a/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-getcurrentsurvived-method.md @@ -2,69 +2,70 @@ description: "Learn more about: ICLRAppDomainResourceMonitor::GetCurrentSurvived Method" title: "ICLRAppDomainResourceMonitor::GetCurrentSurvived Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAppDomainResourceMonitor.GetCurrentSurvived" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAppDomainResourceMonitor::GetCurrentSurvived" -helpviewer_keywords: +helpviewer_keywords: - "ICLRAppDomainResourceMonitor::GetCurrentSurvived method [.NET Framework hosting]" - "GetCurrentSurvived method [.NET Framework hosting]" -topic_type: +ms.assetid: 392e9009-40ef-40e3-ad4d-7ce93a989e78 +topic_type: - "apiref" --- # ICLRAppDomainResourceMonitor::GetCurrentSurvived Method -Gets the number of bytes that survived the last full, blocking garbage collection and that are referenced by the current application domain. - -## Syntax - -```cpp -HRESULT STDMETHODCALLTYPE GetCurrentSurvived( - [in] DWORD dwAppDomainId, - [out] ULONGLONG *pAppDomainBytesSurvived, - [out] ULONGLONG *pTotalBytesSurvived); -``` - -## Parameters - - `dwAppDomainId` - [in] The ID of the requested application domain. - - `pAppDomainBytesSurvived` - [out] A pointer to the number of bytes that survived after the last garbage collection that are held by this application domain. After a full collection, this number is accurate and complete. After an ephemeral collection, this number is potentially incomplete. This parameter can be `null`. - - `pRuntimeBytesSurvived` - [out] A pointer to the total number of bytes that survived from the last garbage collection. After a full collection, this number represents the number of the bytes that are held in managed heaps. After an ephemeral collection, this number represents the number of bytes that are held live in ephemeral generations. This parameter can be `null`. - -## 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.| -|COR_E_APPDOMAINUNLOADED|The application domain has been unloaded or does not exist.| - -## Remarks - - Statistics are updated only after a full, blocking garbage collection; that is, a collection that includes all generations and that stops the application while collection occurs. For example, the method overload performs a full, blocking collection. Concurrent garbage collection occurs in the background and does not block the application. - - The `GetCurrentSurvived` method is the unmanaged equivalent of the managed property. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Gets the number of bytes that survived the last full, blocking garbage collection and that are referenced by the current application domain. + +## Syntax + +```cpp +HRESULT STDMETHODCALLTYPE GetCurrentSurvived( + [in] DWORD dwAppDomainId, + [out] ULONGLONG *pAppDomainBytesSurvived, + [out] ULONGLONG *pTotalBytesSurvived); +``` + +## Parameters + + `dwAppDomainId` + [in] The ID of the requested application domain. + + `pAppDomainBytesSurvived` + [out] A pointer to the number of bytes that survived after the last garbage collection that are held by this application domain. After a full collection, this number is accurate and complete. After an ephemeral collection, this number is potentially incomplete. This parameter can be `null`. + + `pRuntimeBytesSurvived` + [out] A pointer to the total number of bytes that survived from the last garbage collection. After a full collection, this number represents the number of the bytes that are held in managed heaps. After an ephemeral collection, this number represents the number of bytes that are held live in ephemeral generations. This parameter can be `null`. + +## 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.| +|COR_E_APPDOMAINUNLOADED|The application domain has been unloaded or does not exist.| + +## Remarks + + Statistics are updated only after a full, blocking garbage collection; that is, a collection that includes all generations and that stops the application while collection occurs. For example, the method overload performs a full, blocking collection. Concurrent garbage collection occurs in the background and does not block the application. + + The `GetCurrentSurvived` method is the unmanaged equivalent of the managed property. + +## 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 - [ICLRAppDomainResourceMonitor Interface](iclrappdomainresourcemonitor-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md b/docs/framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md similarity index 62% rename from docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md rename to docs/framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md index dd0e6647a9a57..f8f9f50d47d78 100644 --- a/docs/core/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrappdomainresourcemonitor-interface.md @@ -2,58 +2,59 @@ description: "Learn more about: ICLRAppDomainResourceMonitor Interface" title: "ICLRAppDomainResourceMonitor Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAppDomainResourceMonitor" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAppDomainResourceMonitor" -helpviewer_keywords: +helpviewer_keywords: - "ICLRAppDomainResourceMonitor interface [.NET Framework hosting]" -topic_type: +ms.assetid: 72fa83a1-8997-41d7-b355-ab177a24a303 +topic_type: - "apiref" --- # ICLRAppDomainResourceMonitor Interface -Provides methods that inspect an application domain's memory and CPU usage. - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetCurrentAllocated Method](iclrappdomainresourcemonitor-getcurrentallocated-method.md)|Gets the total size, in bytes, of all memory allocations that have been made by the application domain since it was created, without subtracting memory that has been garbage-collected.| -|[GetCurrentSurvived Method](iclrappdomainresourcemonitor-getcurrentsurvived-method.md)|Gets the number of bytes that survived the last full, blocking garbage collection and that are referenced by the current application domain.| -|[GetCurrentCpuTime Method](iclrappdomainresourcemonitor-getcurrentcputime-method.md)|Gets the total processor time that has been used by all threads while executing in the current application domain, since the application domain was created.| - -## Remarks - - The `ICLRAppDomainResourceMonitor` interface provides functionality that is similar to the following managed properties: - -- - -- - -- - -- - -- - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Provides methods that inspect an application domain's memory and CPU usage. + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetCurrentAllocated Method](iclrappdomainresourcemonitor-getcurrentallocated-method.md)|Gets the total size, in bytes, of all memory allocations that have been made by the application domain since it was created, without subtracting memory that has been garbage-collected.| +|[GetCurrentSurvived Method](iclrappdomainresourcemonitor-getcurrentsurvived-method.md)|Gets the number of bytes that survived the last full, blocking garbage collection and that are referenced by the current application domain.| +|[GetCurrentCpuTime Method](iclrappdomainresourcemonitor-getcurrentcputime-method.md)|Gets the total processor time that has been used by all threads while executing in the current application domain, since the application domain was created.| + +## Remarks + + The `ICLRAppDomainResourceMonitor` interface provides functionality that is similar to the following managed properties: + +- + +- + +- + +- + +- + +## 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 -- [\ Element](../../../framework/configure-apps/file-schema/runtime/appdomainresourcemonitoring-element.md) +- [\ Element](../../configure-apps/file-schema/runtime/appdomainresourcemonitoring-element.md) - [Application Domain Resource Monitoring](../../../standard/garbage-collection/app-domain-resource-monitoring.md) - [Hosting Interfaces](hosting-interfaces.md) - [Hosting](index.md) diff --git a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromfile-method.md b/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromfile-method.md similarity index 56% rename from docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromfile-method.md rename to docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromfile-method.md index 6737ad436a08f..54e7e7a6ccc4a 100644 --- a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromfile-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromfile-method.md @@ -2,76 +2,77 @@ description: "Learn more about: ICLRAssemblyIdentityManager::GetBindingIdentityFromFile Method" title: "ICLRAssemblyIdentityManager::GetBindingIdentityFromFile Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAssemblyIdentityManager.GetBindingIdentityFromFile" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAssemblyIdentityManager::GetBindingIdentityFromFile" -helpviewer_keywords: +helpviewer_keywords: - "GetBindingIdentityFromFile method [.NET Framework hosting]" - "ICLRAssemblyIdentityManager::GetBindingIdentifyFromFile method [.NET Framework hosting]" -topic_type: +ms.assetid: 7797562d-7b4c-4bd9-8b93-f35e0e2869e4 +topic_type: - "apiref" --- # ICLRAssemblyIdentityManager::GetBindingIdentityFromFile Method -Gets the assembly identity binding data for the assembly at the specified file path. - -## Syntax - -```cpp -HRESULT GetBindingIdentityFromFile( - [in] LPCWSTR pwzFilePath, - [in] DWORD dwFlags, - [out, size_is(*pcchBufferSize)] LPWSTR pwzBuffer, - [in, out] DWORD *pcchBufferSize -); -``` - -## Parameters - - `pwzFilePath` - [in] The path to the file to be evaluated. - - `dwFlags` - [in] A value of the [ECLRAssemblyIdentityFlags](eclrassemblyidentityflags-enumeration.md) enumeration that indicates an assembly's identity type. Provided for future extensibility. CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT is the only value that the common language runtime (CLR) version 2.0 supports. - - `pwzBuffer` - [out] A buffer containing the opaque assembly identity data. - - `pcchBufferSize` - [in, out] A pointer to the size of `pwzBuffer`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method returned successfully.| -|E_INVALIDARG|The supplied `pwzFilePath` is null.| -|ERROR_INSUFFICIENT_BUFFER|The size of `pwzBuffer` is too small.| -|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.| - -## Remarks - - `GetBindingIdentityFromFile` is typically called twice. The first call supplies a null value for `pwzBuffer`, and the method returns the appropriate size in `pcchBufferSize`. The second call supplies an appropriately allocated buffer, and the method returns with the actual buffer data upon completion. - -## 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 2.0 - +Gets the assembly identity binding data for the assembly at the specified file path. + +## Syntax + +```cpp +HRESULT GetBindingIdentityFromFile( + [in] LPCWSTR pwzFilePath, + [in] DWORD dwFlags, + [out, size_is(*pcchBufferSize)] LPWSTR pwzBuffer, + [in, out] DWORD *pcchBufferSize +); +``` + +## Parameters + + `pwzFilePath` + [in] The path to the file to be evaluated. + + `dwFlags` + [in] A value of the [ECLRAssemblyIdentityFlags](eclrassemblyidentityflags-enumeration.md) enumeration that indicates an assembly's identity type. Provided for future extensibility. CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT is the only value that the common language runtime (CLR) version 2.0 supports. + + `pwzBuffer` + [out] A buffer containing the opaque assembly identity data. + + `pcchBufferSize` + [in, out] A pointer to the size of `pwzBuffer`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method returned successfully.| +|E_INVALIDARG|The supplied `pwzFilePath` is null.| +|ERROR_INSUFFICIENT_BUFFER|The size of `pwzBuffer` is too small.| +|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.| + +## Remarks + + `GetBindingIdentityFromFile` is typically called twice. The first call supplies a null value for `pwzBuffer`, and the method returns the appropriate size in `pcchBufferSize`. The second call supplies an appropriately allocated buffer, and the method returns with the actual buffer data upon completion. + +## 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 - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromstream-method.md b/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromstream-method.md similarity index 51% rename from docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromstream-method.md rename to docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromstream-method.md index 9e789506477b4..2ed6564f2fe42 100644 --- a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromstream-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getbindingidentityfromstream-method.md @@ -2,72 +2,73 @@ description: "Learn more about: ICLRAssemblyIdentityManager::GetBindingIdentityFromStream Method" title: "ICLRAssemblyIdentityManager::GetBindingIdentityFromStream Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAssemblyIdentityManager.GetBindingIdentityFromStream" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAssemblyIdentityManager::GetBindingIdentityFromStream" -helpviewer_keywords: +helpviewer_keywords: - "GetBindingIdentityFromStream method [.NET Framework hosting]" - "ICLRAssemblyIdentityManager::GetBindingIdentityFromStream method [.NET Framework hosting]" -topic_type: +ms.assetid: 40123b30-a589-46b3-95d3-af7b2b0baa05 +topic_type: - "apiref" --- # ICLRAssemblyIdentityManager::GetBindingIdentityFromStream Method -Gets the canonical assembly identity data for the assembly in the specified stream. - -## Syntax - -```cpp -HRESULT GetBindingIdentityFromStream ( - [in] IStream *pStream, - [in] DWORD dwFlags, - [out, size_is(*pcchBufferSize)] LPWSTR pwzBuffer, - [in, out] DWORD *pcchBufferSize -); -``` - -## Parameters - - `pStream` - [in] The assembly stream to be evaluated. - - `dwFlags` - [in] Provided for future extensibility. CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT is the only value that the current version of the common language runtime (CLR) supports. - - `pwzBuffer` - [out] A buffer containing the opaque assembly identity data. - - `pcchBufferSize` - [in, out] The size of `pwzBuffer`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method returned successfully.| -|E_INVALIDARG|The supplied `pStream` is null.| -|ERROR_INSUFFICIENT_BUFFER|The size of `pwzBuffer` is too small.| -|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.| - -## 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 2.0 - +Gets the canonical assembly identity data for the assembly in the specified stream. + +## Syntax + +```cpp +HRESULT GetBindingIdentityFromStream ( + [in] IStream *pStream, + [in] DWORD dwFlags, + [out, size_is(*pcchBufferSize)] LPWSTR pwzBuffer, + [in, out] DWORD *pcchBufferSize +); +``` + +## Parameters + + `pStream` + [in] The assembly stream to be evaluated. + + `dwFlags` + [in] Provided for future extensibility. CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT is the only value that the current version of the common language runtime (CLR) supports. + + `pwzBuffer` + [out] A buffer containing the opaque assembly identity data. + + `pcchBufferSize` + [in, out] The size of `pwzBuffer`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method returned successfully.| +|E_INVALIDARG|The supplied `pStream` is null.| +|ERROR_INSUFFICIENT_BUFFER|The size of `pwzBuffer` is too small.| +|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.| + +## 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 - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md b/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md similarity index 55% rename from docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md rename to docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md index 01fca6c4ff8ff..203fed81fe9fc 100644 --- a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md @@ -2,66 +2,67 @@ description: "Learn more about: ICLRAssemblyIdentityManager::GetCLRAssemblyReferenceList Method" title: "ICLRAssemblyIdentityManager::GetCLRAssemblyReferenceList Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAssemblyIdentityManager.GetCLRAssemblyReferenceList" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAssemblyIdentityManager::GetCLRAssemblyReferenceList" -helpviewer_keywords: +helpviewer_keywords: - "GetClrAssemblyReferenceList method [.NET Framework hosting]" - "ICLRAssemblyIdentityManager::GetCLRAssemblyReferenceList method [.NET Framework hosting]" -topic_type: +ms.assetid: cb5ffae5-287b-4a87-9ca8-7ce3ae0601b7 +topic_type: - "apiref" --- # ICLRAssemblyIdentityManager::GetCLRAssemblyReferenceList Method -Gets an interface pointer to an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) instance from the supplied list of partial assembly identities. - -## Syntax - -```cpp -HRESULT GetCLRAssemblyReferenceList ( - [in] LPCWSTR *ppwzAssemblyReferences, - [in] DWORD dwNumOfReferences, - [out] ICLRAssemblyReferenceList **ppReferenceList -); -``` - -## Parameters - - `ppwzAssemblyReferences` - [in] An array of null-terminated strings in the form "name, property=value..." that specify a list of partial assembly identities. - - `dwNumOfReferences` - [in] The number of items in `ppwzAssemblyReferences`. - - `ppReferenceList` - [out] An interface pointer to an `ICLRAssemblyReferenceList` object that contains the assembly identity data for the list of assemblies specified in `ppwzAssemblyReferences`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| - -## 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 2.0 - +Gets an interface pointer to an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) instance from the supplied list of partial assembly identities. + +## Syntax + +```cpp +HRESULT GetCLRAssemblyReferenceList ( + [in] LPCWSTR *ppwzAssemblyReferences, + [in] DWORD dwNumOfReferences, + [out] ICLRAssemblyReferenceList **ppReferenceList +); +``` + +## Parameters + + `ppwzAssemblyReferences` + [in] An array of null-terminated strings in the form "name, property=value..." that specify a list of partial assembly identities. + + `dwNumOfReferences` + [in] The number of items in `ppwzAssemblyReferences`. + + `ppReferenceList` + [out] An interface pointer to an `ICLRAssemblyReferenceList` object that contains the assembly identity data for the list of assemblies specified in `ppwzAssemblyReferences`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| + +## 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 - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md b/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md similarity index 61% rename from docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md rename to docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md index de42f8419303a..8cead8b8b3d28 100644 --- a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md @@ -2,70 +2,71 @@ description: "Learn more about: ICLRAssemblyIdentityManager::GetProbingAssembliesFromReference Method" title: "ICLRAssemblyIdentityManager::GetProbingAssembliesFromReference Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAssemblyIdentityManager.GetProbingAssembliesFromReference" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAssemblyIdentityManager::GetProbingAssembliesFromReference" -helpviewer_keywords: +helpviewer_keywords: - "ICLRAssemblyIdentityManager::GetProbingAssembliesFromReference method [.NET Framework hosting]" - "GetProbingAssembliesFromReference method [.NET Framework hosting]" -topic_type: +ms.assetid: aec05744-e8d4-44c6-b4a8-e583229ac34e +topic_type: - "apiref" --- # ICLRAssemblyIdentityManager::GetProbingAssembliesFromReference Method -Gets an [ICLRProbingAssemblyEnum](iclrprobingassemblyenum-interface.md) enumerator for the assembly identities referenced by the assembly with the specified identity type. - -## Syntax - -```cpp -HRESULT GetProbingAssembliesFromReference ( - [in] DWORD dwMachineType, - [in] DWORD dwFlags, - [in] LPCWSTR pwzReferenceIdentity, - [out] ICLRProbingAssemblyEnum **ppProbingAssemblyEnum -); -``` - -## Parameters - - `dwMachineType` - [in] A valid value that specifies the processor architecture, as defined in WinNT.h. - - `dwFlags` - [in] Provided for future extensibility. CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT is the only value that the current version of the common language runtime (CLR) supports. - - `pwzReferenceIdentity` - [in] An opaque assembly binding identity, typically returned from a call to the [ICLRAssemblyIdentityManager::GetBindingIdentityFromFile](iclrassemblyidentitymanager-getbindingidentityfromfile-method.md) or [ICLRAssemblyIdentityManager::GetBindingIdentityFromStream](iclrassemblyidentitymanager-getbindingidentityfromstream-method.md) method. - - `ppProbingAssemblyEnum` - [out] An interface pointer to an `ICLRProbingAssemblyEnum` enumerator that contains references to the assemblies referenced by the assembly identified by `pwzReferenceIdentity`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method 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.| - -## 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 2.0 - +Gets an [ICLRProbingAssemblyEnum](iclrprobingassemblyenum-interface.md) enumerator for the assembly identities referenced by the assembly with the specified identity type. + +## Syntax + +```cpp +HRESULT GetProbingAssembliesFromReference ( + [in] DWORD dwMachineType, + [in] DWORD dwFlags, + [in] LPCWSTR pwzReferenceIdentity, + [out] ICLRProbingAssemblyEnum **ppProbingAssemblyEnum +); +``` + +## Parameters + + `dwMachineType` + [in] A valid value that specifies the processor architecture, as defined in WinNT.h. + + `dwFlags` + [in] Provided for future extensibility. CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT is the only value that the current version of the common language runtime (CLR) supports. + + `pwzReferenceIdentity` + [in] An opaque assembly binding identity, typically returned from a call to the [ICLRAssemblyIdentityManager::GetBindingIdentityFromFile](iclrassemblyidentitymanager-getbindingidentityfromfile-method.md) or [ICLRAssemblyIdentityManager::GetBindingIdentityFromStream](iclrassemblyidentitymanager-getbindingidentityfromstream-method.md) method. + + `ppProbingAssemblyEnum` + [out] An interface pointer to an `ICLRProbingAssemblyEnum` enumerator that contains references to the assemblies referenced by the assembly identified by `pwzReferenceIdentity`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method 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.| + +## 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 - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md b/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md similarity index 58% rename from docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md rename to docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md index 9f3993893740d..e5bd878fa2c00 100644 --- a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md @@ -2,74 +2,75 @@ description: "Learn more about: ICLRAssemblyIdentityManager::GetReferencedAssembliesFromFile Method" title: "ICLRAssemblyIdentityManager::GetReferencedAssembliesFromFile Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAssemblyIdentityManager.GetReferencedAssembliesFromFile" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAssemblyIdentityManager::GetReferencedAssembliesFromFile" -helpviewer_keywords: +helpviewer_keywords: - "ICLRAssemblyIdentityManager::GetReferenceAssembliesFromFile method [.NET Framework hosting]" - "GetReferenceAssembliesFromFile method [.NET Framework hosting]" -topic_type: +ms.assetid: eed63d31-d977-4c7d-9443-f9d37a2a7d81 +topic_type: - "apiref" --- # ICLRAssemblyIdentityManager::GetReferencedAssembliesFromFile Method -Gets an [ICLRReferenceAssemblyEnum](iclrreferenceassemblyenum-interface.md) instance that contains a list of assemblies referenced by the assembly at the specified file path. - -## Syntax - -```cpp -HRESULT GetReferencedAssembliesFromFile ( - [in] LPCWSTR pwzFilePath, - [in] DWORD dwFlags, - [in] ICLRAssemblyReferenceList *pExcludeAssembliesList, - [out] ICLRReferenceAssemblyEnum **ppReferenceEnum -); -``` - -## Parameters - - `pwzFilePath` - [in] The path to the assembly to be evaluated. - - `dwFlags` - [in] Provided for future extensibility. CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT is the only value that the current version of the common language runtime (CLR) supports. - - `pExcludeAssembliesList` - [in] A pointer to an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) object that represents assemblies that should be excluded from `ppReferenceEnum`. - - `ppReferenceEnum` - [out] A pointer to the address of an `ICLRReferenceAssemblyEnum` object that contains assembly identity data for the assemblies referenced by the assembly at `pwzFilePath`, excluding the assemblies represented by `pExcludeAssembliesList`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method 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.| - -## Remarks - - The caller can choose to exclude a set of known assembly references from the returned list. This set is defined by the `pExcludeAssembliesList` parameter. - -## 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 2.0 - +Gets an [ICLRReferenceAssemblyEnum](iclrreferenceassemblyenum-interface.md) instance that contains a list of assemblies referenced by the assembly at the specified file path. + +## Syntax + +```cpp +HRESULT GetReferencedAssembliesFromFile ( + [in] LPCWSTR pwzFilePath, + [in] DWORD dwFlags, + [in] ICLRAssemblyReferenceList *pExcludeAssembliesList, + [out] ICLRReferenceAssemblyEnum **ppReferenceEnum +); +``` + +## Parameters + + `pwzFilePath` + [in] The path to the assembly to be evaluated. + + `dwFlags` + [in] Provided for future extensibility. CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT is the only value that the current version of the common language runtime (CLR) supports. + + `pExcludeAssembliesList` + [in] A pointer to an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) object that represents assemblies that should be excluded from `ppReferenceEnum`. + + `ppReferenceEnum` + [out] A pointer to the address of an `ICLRReferenceAssemblyEnum` object that contains assembly identity data for the assemblies referenced by the assembly at `pwzFilePath`, excluding the assemblies represented by `pExcludeAssembliesList`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method 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.| + +## Remarks + + The caller can choose to exclude a set of known assembly references from the returned list. This set is defined by the `pExcludeAssembliesList` parameter. + +## 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 - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md b/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md similarity index 61% rename from docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md rename to docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md index 90f95fcacb3cd..f83446be0d5bd 100644 --- a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md @@ -2,74 +2,75 @@ description: "Learn more about: ICLRAssemblyIdentityManager::GetReferencedAssembliesFromStream Method" title: "ICLRAssemblyIdentityManager::GetReferencedAssembliesFromStream Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAssemblyIdentityManager.GetReferencedAssembliesFromStream" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAssemblyIdentityManager::GetReferencedAssembliesFromStream" -helpviewer_keywords: +helpviewer_keywords: - "ICLRAssemblyIdentityManager::GetReferencedAssembliesFromStream method [.NET Framework hosting]" - "GetReferencedAssembliesFromStream method [.NET Framework hosting]" -topic_type: +ms.assetid: fe9849c1-c3fc-477b-a31f-e8619f5516f5 +topic_type: - "apiref" --- # ICLRAssemblyIdentityManager::GetReferencedAssembliesFromStream Method -Gets a pointer to an [ICLRReferenceAssemblyEnum](iclrreferenceassemblyenum-interface.md) object that contains assembly identity data for the assemblies referenced by the assembly in the specified stream. - -## Syntax - -```cpp -HRESULT GetReferencedAssembliesFromStream ( - [in] IStream *pStream, - [in] DWORD dwFlags, - [in] ICLRAssemblyReferenceList *pExcludeAssembliesList, - [out] ICLRReferenceAssemblyEnum **ppReferenceEnum -); -``` - -## Parameters - - `pStream` - [in] An interface pointer to an `IStream` containing the assembly to be evaluated. - - `dwFlags` - [in] Provided for future extensibility. CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT is the only value that the current version of the common language runtime (CLR) supports. - - `pExcludeAssembliesList` - [in] A pointer to an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) object that contains assembly identity data for the assemblies to be excluded from `ppReferenceEnum`. - - `ppReferenceEnum` - [out] A pointer to the address of an `ICLRReferenceAssemblyEnum` object that contains assembly identity data for the assemblies referenced by the assembly in `pStream`, excluding the assemblies in `pExcludeAssembliesList`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method 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.| - -## Remarks - - The caller can choose to exclude a set of known assembly references from the returned list. This set is defined by `pExcludeAssembliesList`. - -## 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 2.0 - +Gets a pointer to an [ICLRReferenceAssemblyEnum](iclrreferenceassemblyenum-interface.md) object that contains assembly identity data for the assemblies referenced by the assembly in the specified stream. + +## Syntax + +```cpp +HRESULT GetReferencedAssembliesFromStream ( + [in] IStream *pStream, + [in] DWORD dwFlags, + [in] ICLRAssemblyReferenceList *pExcludeAssembliesList, + [out] ICLRReferenceAssemblyEnum **ppReferenceEnum +); +``` + +## Parameters + + `pStream` + [in] An interface pointer to an `IStream` containing the assembly to be evaluated. + + `dwFlags` + [in] Provided for future extensibility. CLR_ASSEMBLY_IDENTITY_FLAGS_DEFAULT is the only value that the current version of the common language runtime (CLR) supports. + + `pExcludeAssembliesList` + [in] A pointer to an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) object that contains assembly identity data for the assemblies to be excluded from `ppReferenceEnum`. + + `ppReferenceEnum` + [out] A pointer to the address of an `ICLRReferenceAssemblyEnum` object that contains assembly identity data for the assemblies referenced by the assembly in `pStream`, excluding the assemblies in `pExcludeAssembliesList`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method 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.| + +## Remarks + + The caller can choose to exclude a set of known assembly references from the returned list. This set is defined by `pExcludeAssembliesList`. + +## 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 - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-interface.md b/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-interface.md similarity index 68% rename from docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-interface.md rename to docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-interface.md index aac31b2b160dc..4bb89b4d13605 100644 --- a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-interface.md @@ -2,49 +2,50 @@ description: "Learn more about: ICLRAssemblyIdentityManager Interface" title: "ICLRAssemblyIdentityManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAssemblyIdentityManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAssemblyIdentityManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLRAssemblyIdentityManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: 6a81c6fe-cc22-4062-ae27-d6eeee03a7b9 +topic_type: - "apiref" --- # ICLRAssemblyIdentityManager Interface -Provides methods that support communication between the host and the common language runtime (CLR) about assemblies. - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetBindingIdentityFromFile Method](iclrassemblyidentitymanager-getbindingidentityfromfile-method.md)|Gets the assembly identity binding data for the assembly at the specified file path.| -|[GetBindingIdentityFromStream Method](iclrassemblyidentitymanager-getbindingidentityfromstream-method.md)|Gets the canonical assembly identity data for the assembly in the specified stream.| -|[GetCLRAssemblyReferenceList Method](iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md)|Gets an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) instance from the supplied list of partial assembly identities.| -|[GetProbingAssembliesFromReference Method](iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md)|Gets an [ICLRProbingAssemblyEnum](iclrprobingassemblyenum-interface.md) enumerator for the assembly identities referenced by the assembly with the specified identity.| -|[GetReferencedAssembliesFromFile Method](iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md)|Gets an [ICLRReferenceAssemblyEnum](iclrreferenceassemblyenum-interface.md) instance that contains a list of assemblies referenced by the assembly at the specified file path.| -|[GetReferencedAssembliesFromStream Method](iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md)|Gets a pointer to an `ICLRReferenceAssemblyEnum` object that contains assembly identity data for the assemblies referenced by the assembly in the specified stream.| -|[IsStronglyNamed Method](iclrassemblyidentitymanager-isstronglynamed-method.md)|Gets a value that indicates whether the specified assembly is strongly named.| - -## Remarks - - Use `ICLRAssemblyIdentityManager` to get instances of `ICLRAssemblyReferenceList` and to enumerate assembly identities. - -## 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 2.0 - +Provides methods that support communication between the host and the common language runtime (CLR) about assemblies. + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetBindingIdentityFromFile Method](iclrassemblyidentitymanager-getbindingidentityfromfile-method.md)|Gets the assembly identity binding data for the assembly at the specified file path.| +|[GetBindingIdentityFromStream Method](iclrassemblyidentitymanager-getbindingidentityfromstream-method.md)|Gets the canonical assembly identity data for the assembly in the specified stream.| +|[GetCLRAssemblyReferenceList Method](iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md)|Gets an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) instance from the supplied list of partial assembly identities.| +|[GetProbingAssembliesFromReference Method](iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md)|Gets an [ICLRProbingAssemblyEnum](iclrprobingassemblyenum-interface.md) enumerator for the assembly identities referenced by the assembly with the specified identity.| +|[GetReferencedAssembliesFromFile Method](iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md)|Gets an [ICLRReferenceAssemblyEnum](iclrreferenceassemblyenum-interface.md) instance that contains a list of assemblies referenced by the assembly at the specified file path.| +|[GetReferencedAssembliesFromStream Method](iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md)|Gets a pointer to an `ICLRReferenceAssemblyEnum` object that contains assembly identity data for the assemblies referenced by the assembly in the specified stream.| +|[IsStronglyNamed Method](iclrassemblyidentitymanager-isstronglynamed-method.md)|Gets a value that indicates whether the specified assembly is strongly named.| + +## Remarks + + Use `ICLRAssemblyIdentityManager` to get instances of `ICLRAssemblyReferenceList` and to enumerate assembly identities. + +## 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 - [ICLRAssemblyReferenceList Interface](iclrassemblyreferencelist-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-isstronglynamed-method.md b/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-isstronglynamed-method.md similarity index 52% rename from docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-isstronglynamed-method.md rename to docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-isstronglynamed-method.md index 8b02bfda5adad..4a32d6b20052c 100644 --- a/docs/core/unmanaged-api/hosting/iclrassemblyidentitymanager-isstronglynamed-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrassemblyidentitymanager-isstronglynamed-method.md @@ -2,62 +2,63 @@ description: "Learn more about: ICLRAssemblyIdentityManager::IsStronglyNamed Method" title: "ICLRAssemblyIdentityManager::IsStronglyNamed Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAssemblyIdentityManager.IsStronglyNamed" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAssemblyIdentityManager::IsStronglyNamed" -helpviewer_keywords: +helpviewer_keywords: - "IsStronglyNamed method [.NET Framework hosting]" - "ICLRAssemblyIdentityManager::IsStronglyNamed method [.NET Framework hosting]" -topic_type: +ms.assetid: 954bd386-2076-4d00-9d46-38c728aa9cab +topic_type: - "apiref" --- # ICLRAssemblyIdentityManager::IsStronglyNamed Method -Gets a value that indicates whether the specified assembly is strongly named. +Gets a value that indicates whether the specified assembly is strongly named. + +## Syntax + +```cpp +RESULT IsStronglyNamed ( + [in] LPCWSTR pwzAssemblyIdentity, + [out] BOOL *pbIsStronglyNamed +); +``` + +## Parameters -## Syntax - -```cpp -RESULT IsStronglyNamed ( - [in] LPCWSTR pwzAssemblyIdentity, - [out] BOOL *pbIsStronglyNamed -); -``` - -## Parameters - - `pwzAssemblyIdentity` - [in] The opaque canonical assembly identity data of the assembly to be evaluated. - - `pbIsStronglyNamed` - [out] `true`, if the assembly referenced by the `pwzAssemblyIdentity` parameter is strongly named; otherwise, `false`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| - -## 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 2.0 + `pwzAssemblyIdentity` + [in] The opaque canonical assembly identity data of the assembly to be evaluated. + + `pbIsStronglyNamed` + [out] `true`, if the assembly referenced by the `pwzAssemblyIdentity` parameter is strongly named; otherwise, `false`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| + +## 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 - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-interface.md b/docs/framework/unmanaged-api/hosting/iclrassemblyreferencelist-interface.md similarity index 66% rename from docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-interface.md rename to docs/framework/unmanaged-api/hosting/iclrassemblyreferencelist-interface.md index a4dd921025057..c3ec370a36d19 100644 --- a/docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrassemblyreferencelist-interface.md @@ -2,44 +2,45 @@ description: "Learn more about: ICLRAssemblyReferenceList Interface" title: "ICLRAssemblyReferenceList Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAssemblyReferenceList" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAssemblyReferenceList" -helpviewer_keywords: +helpviewer_keywords: - "ICLRAssemblyReferenceList interface [.NET Framework hosting]" -topic_type: +ms.assetid: 5f890fdf-d22a-429e-a35f-135273d1a636 +topic_type: - "apiref" --- # ICLRAssemblyReferenceList Interface -Manages a list of assemblies that are loaded by the common language runtime (CLR) and not by the host. - -## Methods - -|Method|Description| -|------------|-----------------| -|[IsAssemblyReferenceInList Method](iclrassemblyreferencelist-isassemblyreferenceinlist-method.md)|Gets a value that indicates whether the supplied pointer references an assembly in the list.| -|[IsStringAssemblyReferenceInList Method](iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md)|Gets a value that indicates whether the supplied name matches the name of an assembly in the list.| - -## Remarks - - Call the [ICLRAssemblyIdentityManager::GetCLRAssemblyReferenceList](iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md) method to get a pointer to an instance of `ICLRAssemblyReferenceList`. - -## 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 2.0 - +Manages a list of assemblies that are loaded by the common language runtime (CLR) and not by the host. + +## Methods + +|Method|Description| +|------------|-----------------| +|[IsAssemblyReferenceInList Method](iclrassemblyreferencelist-isassemblyreferenceinlist-method.md)|Gets a value that indicates whether the supplied pointer references an assembly in the list.| +|[IsStringAssemblyReferenceInList Method](iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md)|Gets a value that indicates whether the supplied name matches the name of an assembly in the list.| + +## Remarks + + Call the [ICLRAssemblyIdentityManager::GetCLRAssemblyReferenceList](iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md) method to get a pointer to an instance of `ICLRAssemblyReferenceList`. + +## 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 - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-isassemblyreferenceinlist-method.md b/docs/framework/unmanaged-api/hosting/iclrassemblyreferencelist-isassemblyreferenceinlist-method.md similarity index 60% rename from docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-isassemblyreferenceinlist-method.md rename to docs/framework/unmanaged-api/hosting/iclrassemblyreferencelist-isassemblyreferenceinlist-method.md index a71ff44219b5d..bf5aa33ac93a0 100644 --- a/docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-isassemblyreferenceinlist-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrassemblyreferencelist-isassemblyreferenceinlist-method.md @@ -2,55 +2,56 @@ description: "Learn more about: ICLRAssemblyReferenceList::IsAssemblyReferenceInList Method" title: "ICLRAssemblyReferenceList::IsAssemblyReferenceInList Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAssemblyReferenceList.IsAssemblyReferenceInList" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAssemblyReferenceList::IsAssemblyReferenceInList" -helpviewer_keywords: +helpviewer_keywords: - "ICLRAssemblyReferenceList::IsAssemblyReferenceInList method [.NET Framework hosting]" - "IsAssemblyReferenceInList method [.NET Framework hosting]" -topic_type: +ms.assetid: 8a570813-21be-407e-92a6-7ae8de3bc728 +topic_type: - "apiref" --- # ICLRAssemblyReferenceList::IsAssemblyReferenceInList Method -Gets a value that indicates whether the supplied pointer refers to an assembly in the list. - -## Syntax - -```cpp -HRESULT IsAssemblyReferenceInList ( - [in] IUnknown *pName -); -``` - -## Parameters - - `pName` - [in] An interface pointer to the assembly for which to search. Valid values are of type `IAssemblyName` or `IReferenceIdentity`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The string appears in the list.| -|S_FALSE|The string does not appear in the list.| -|E_FAIL|An unknown catastrophic failure occurred. After a method returns E_FAIL, the common language runtime is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## 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 2.0 - +Gets a value that indicates whether the supplied pointer refers to an assembly in the list. + +## Syntax + +```cpp +HRESULT IsAssemblyReferenceInList ( + [in] IUnknown *pName +); +``` + +## Parameters + + `pName` + [in] An interface pointer to the assembly for which to search. Valid values are of type `IAssemblyName` or `IReferenceIdentity`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The string appears in the list.| +|S_FALSE|The string does not appear in the list.| +|E_FAIL|An unknown catastrophic failure occurred. After a method returns E_FAIL, the common language runtime is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md b/docs/framework/unmanaged-api/hosting/iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md similarity index 56% rename from docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md rename to docs/framework/unmanaged-api/hosting/iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md index a23fbe5f99740..3ba96fbbb188e 100644 --- a/docs/core/unmanaged-api/hosting/iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md @@ -2,55 +2,56 @@ description: "Learn more about: ICLRAssemblyReferenceList::IsStringAssemblyReferenceInList Method" title: "ICLRAssemblyReferenceList::IsStringAssemblyReferenceInList Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRAssemblyReferenceList.IsStringAssemblyReferenceInList" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRAssemblyReferenceList::IsStringAssemblyReferenceInList" -helpviewer_keywords: +helpviewer_keywords: - "ICLRAssemblyReferenceList::IsStringAssemblyReferenceInList method [.NET Framework hosting]" - "IsStringAssemblyReferenceInList method [.NET Framework hosting]" -topic_type: +ms.assetid: e6121cc3-2f11-42c7-bdae-47808581ff71 +topic_type: - "apiref" --- # ICLRAssemblyReferenceList::IsStringAssemblyReferenceInList Method -Gets a value that indicates whether the supplied name matches the name of an assembly in the list. - -## Syntax - -```cpp -HRESULT IsStringAssemblyReferenceInList ( - [in] LPCWSTR pwzAssemblyName -); -``` - -## Parameters - - `pwzAssemblyName` - [in] The name of the assembly for which to search. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The string appears in the list.| -|S_FALSE|The string does not appear in the list.| -|E_FAIL|An unknown catastrophic failure occurred. After a method returns E_FAIL, the common language runtime is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## 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 2.0 - +Gets a value that indicates whether the supplied name matches the name of an assembly in the list. + +## Syntax + +```cpp +HRESULT IsStringAssemblyReferenceInList ( + [in] LPCWSTR pwzAssemblyName +); +``` + +## Parameters + + `pwzAssemblyName` + [in] The name of the assembly for which to search. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The string appears in the list.| +|S_FALSE|The string does not appear in the list.| +|E_FAIL|An unknown catastrophic failure occurred. After a method returns E_FAIL, the common language runtime is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrcontrol-getclrmanager-method.md b/docs/framework/unmanaged-api/hosting/iclrcontrol-getclrmanager-method.md similarity index 55% rename from docs/core/unmanaged-api/hosting/iclrcontrol-getclrmanager-method.md rename to docs/framework/unmanaged-api/hosting/iclrcontrol-getclrmanager-method.md index 55fff00d08d0c..5248af7fed0b5 100644 --- a/docs/core/unmanaged-api/hosting/iclrcontrol-getclrmanager-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrcontrol-getclrmanager-method.md @@ -2,77 +2,78 @@ description: "Learn more about: ICLRControl::GetCLRManager Method" title: "ICLRControl::GetCLRManager Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRControl.GetCLRManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRControl::GetCLRManager" -helpviewer_keywords: +helpviewer_keywords: - "GetCLRManager method [.NET Framework hosting]" - "ICLRControl::GetCLRManager method [.NET Framework hosting]" -topic_type: +ms.assetid: 8a11bfa4-cbb0-4082-82b5-f9fba66c93f5 +topic_type: - "apiref" --- # ICLRControl::GetCLRManager Method -Gets an interface pointer to an instance of any of the manager types the host can use to configure the common language runtime (CLR). - -## Syntax - -```cpp -HRESULT GetCLRManager ( - [in] REFIID riid, - [out] void **ppObject -); -``` - -## Parameters - - `riid` - [in] The `IID` of the manager type to return. The following `IID` values are supported. - -- IID_ICLRDebugManager: Specifies that `ppObject` will be of type [ICLRDebugManager](iclrdebugmanager-interface.md). - -- IID_ICLRErrorReportingManager: Specifies that `ppObject` will be of type [ICLRErrorReportingManager](iclrerrorreportingmanager-interface.md). - -- IID_ICLRGCManager: Specifies that `ppObject` will be of type [ICLRGCManager](iclrgcmanager-interface.md). - -- IID_ICLRHostProtectionManager: Specifies that `ppObject` will be of type [ICLRHostProtectionManager](iclrhostprotectionmanager-interface.md). - -- IID_ICLROnEventManager: Specifies that `ppObject` will be of type [ICLROnEventManager](iclroneventmanager-interface.md). - -- IID_ICLRPolicyManager: Specifies that `ppObject` will be of type [ICLRPolicyManager](iclrpolicymanager-interface.md). - -- IID_ICLRTaskManager: Specifies that `ppObject` will be of type [ICLRTaskManager](iclrtaskmanager-interface.md). - - `ppObject` - [out] An interface pointer to the requested manager, or null, if an invalid manager type was requested. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOINTERFACE|The interface type is not supported.| - -## 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 2.0 - +Gets an interface pointer to an instance of any of the manager types the host can use to configure the common language runtime (CLR). + +## Syntax + +```cpp +HRESULT GetCLRManager ( + [in] REFIID riid, + [out] void **ppObject +); +``` + +## Parameters + + `riid` + [in] The `IID` of the manager type to return. The following `IID` values are supported. + +- IID_ICLRDebugManager: Specifies that `ppObject` will be of type [ICLRDebugManager](iclrdebugmanager-interface.md). + +- IID_ICLRErrorReportingManager: Specifies that `ppObject` will be of type [ICLRErrorReportingManager](iclrerrorreportingmanager-interface.md). + +- IID_ICLRGCManager: Specifies that `ppObject` will be of type [ICLRGCManager](iclrgcmanager-interface.md). + +- IID_ICLRHostProtectionManager: Specifies that `ppObject` will be of type [ICLRHostProtectionManager](iclrhostprotectionmanager-interface.md). + +- IID_ICLROnEventManager: Specifies that `ppObject` will be of type [ICLROnEventManager](iclroneventmanager-interface.md). + +- IID_ICLRPolicyManager: Specifies that `ppObject` will be of type [ICLRPolicyManager](iclrpolicymanager-interface.md). + +- IID_ICLRTaskManager: Specifies that `ppObject` will be of type [ICLRTaskManager](iclrtaskmanager-interface.md). + + `ppObject` + [out] An interface pointer to the requested manager, or null, if an invalid manager type was requested. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOINTERFACE|The interface type is not supported.| + +## 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 - [ICLRControl Interface](iclrcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrcontrol-interface.md b/docs/framework/unmanaged-api/hosting/iclrcontrol-interface.md similarity index 63% rename from docs/core/unmanaged-api/hosting/iclrcontrol-interface.md rename to docs/framework/unmanaged-api/hosting/iclrcontrol-interface.md index 6ec2ff8f91f9e..8beef192b7a10 100644 --- a/docs/core/unmanaged-api/hosting/iclrcontrol-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrcontrol-interface.md @@ -2,40 +2,41 @@ description: "Learn more about: ICLRControl Interface" title: "ICLRControl Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRControl" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRControl" -helpviewer_keywords: +helpviewer_keywords: - "ICLRControl interface [.NET Framework hosting]" -topic_type: +ms.assetid: a24fd905-1fa6-45a0-ad65-e9e2ee58861e +topic_type: - "apiref" --- # ICLRControl Interface -Provides methods that allow a host to get references to, and configure aspects of, the common language runtime (CLR). - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetCLRManager Method](iclrcontrol-getclrmanager-method.md)|Gets an interface pointer to an instance of any of the manager types the host can use to configure the CLR.| -|[SetAppDomainManagerType Method](iclrcontrol-setappdomainmanagertype-method.md)|Sets a type derived from as the type for application domain managers.| - -## 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 2.0 - +Provides methods that allow a host to get references to, and configure aspects of, the common language runtime (CLR). + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetCLRManager Method](iclrcontrol-getclrmanager-method.md)|Gets an interface pointer to an instance of any of the manager types the host can use to configure the CLR.| +|[SetAppDomainManagerType Method](iclrcontrol-setappdomainmanagertype-method.md)|Sets a type derived from as the type for application domain managers.| + +## 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 - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.md b/docs/framework/unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.md similarity index 52% rename from docs/core/unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.md rename to docs/framework/unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.md index a0829aa6a9c1a..4654d9690178c 100644 --- a/docs/core/unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.md @@ -2,62 +2,63 @@ description: "Learn more about: ICLRControl::SetAppDomainManagerType Method" title: "ICLRControl::SetAppDomainManagerType Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRControl.SetAppDomainManagerType" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRControl::SetAppDomainManagerType" -helpviewer_keywords: +helpviewer_keywords: - "SetAppDomainManagerType method, ICLRControl interface [.NET Framework hosting]" - "ICLRControl::SetAppDomainManagerType method [.NET Framework hosting]" -topic_type: +ms.assetid: ec57828b-2aad-496d-a35a-e45d4bd7fe77 +topic_type: - "apiref" --- # ICLRControl::SetAppDomainManagerType Method -Sets a type derived from as the type for application domain managers. +Sets a type derived from as the type for application domain managers. + +## Syntax + +```cpp +HRESULT SetAppDomainManagerType ( + [in] LPCWSTR pwzAppDomainManagerAssembly, + [in] LPCWSTR pwzAppDomainManagerType +); +``` + +## Parameters -## Syntax - -```cpp -HRESULT SetAppDomainManagerType ( - [in] LPCWSTR pwzAppDomainManagerAssembly, - [in] LPCWSTR pwzAppDomainManagerType -); -``` - -## Parameters - - `pwzAppDomainManagerAssembly` - [in] The name of the assembly in which the requested type derived from is implemented. - - `pwzAppDomainManagerType` - [in] The name of the type implemented in the `pwzAppDomainManagerAssembly` parameter that implements the capabilities of . - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## 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 2.0 + `pwzAppDomainManagerAssembly` + [in] The name of the assembly in which the requested type derived from is implemented. + + `pwzAppDomainManagerType` + [in] The name of the type implemented in the `pwzAppDomainManagerAssembly` parameter that implements the capabilities of . + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 - [ICLRControl Interface](iclrcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrdebugmanager-beginconnection-method.md b/docs/framework/unmanaged-api/hosting/iclrdebugmanager-beginconnection-method.md similarity index 64% rename from docs/core/unmanaged-api/hosting/iclrdebugmanager-beginconnection-method.md rename to docs/framework/unmanaged-api/hosting/iclrdebugmanager-beginconnection-method.md index 3838987ba7f71..3ec344fdf65af 100644 --- a/docs/core/unmanaged-api/hosting/iclrdebugmanager-beginconnection-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrdebugmanager-beginconnection-method.md @@ -2,71 +2,72 @@ description: "Learn more about: ICLRDebugManager::BeginConnection Method" title: "ICLRDebugManager::BeginConnection Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRDebugManager.BeginConnection" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRDebugManager::BeginConnection" -helpviewer_keywords: +helpviewer_keywords: - "ICLRDebugManager::BeginConnection method [.NET Framework hosting]" - "BeginConnection method [.NET Framework hosting]" -topic_type: +ms.assetid: bdd98146-ff4d-4150-a264-a4c1a32d31f3 +topic_type: - "apiref" --- # ICLRDebugManager::BeginConnection Method -Establishes a new connection between the host and the debugger to associate a list of tasks with an identifier and a friendly name. - -## Syntax - -```cpp -HRESULT BeginConnection ( - [in] CONNID dwConnectionId, - [in, string] wchar_t* szConnectionName -); -``` - -## Parameters - - `dwConnectionId` - [in] An identifier to associate with the list of common language runtime (CLR) tasks. - - `szConnectionName` - [in] A friendly name to associate with the list of CLR tasks. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`BeginConnection` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_INVALIDARG|`dwConnectionId` was zero, or `BeginConnection` was already called using this `dwConnectionId` value, or `szConnectionName` was null.| -|E_OUTOFMEMORY|Not enough memory could be allocated to hold the list of tasks associated with this connection.| - -## Remarks - - [ICLRDebugManager](iclrdebugmanager-interface.md) provides three methods, `BeginConnection`, [SetConnectionTasks](iclrdebugmanager-setconnectiontasks-method.md), and [EndConnection](iclrdebugmanager-endconnection-method.md), for associating task lists with identifiers and friendly names. - +Establishes a new connection between the host and the debugger to associate a list of tasks with an identifier and a friendly name. + +## Syntax + +```cpp +HRESULT BeginConnection ( + [in] CONNID dwConnectionId, + [in, string] wchar_t* szConnectionName +); +``` + +## Parameters + + `dwConnectionId` + [in] An identifier to associate with the list of common language runtime (CLR) tasks. + + `szConnectionName` + [in] A friendly name to associate with the list of CLR tasks. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`BeginConnection` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_INVALIDARG|`dwConnectionId` was zero, or `BeginConnection` was already called using this `dwConnectionId` value, or `szConnectionName` was null.| +|E_OUTOFMEMORY|Not enough memory could be allocated to hold the list of tasks associated with this connection.| + +## Remarks + + [ICLRDebugManager](iclrdebugmanager-interface.md) provides three methods, `BeginConnection`, [SetConnectionTasks](iclrdebugmanager-setconnectiontasks-method.md), and [EndConnection](iclrdebugmanager-endconnection-method.md), for associating task lists with identifiers and friendly names. + > [!IMPORTANT] -> These three methods must be called in a specific order for each set of tasks. `BeginConnection` is called first to establish a new connection. `SetConnectionTasks` is called next to provide the set of tasks to be associated with that connection. `EndConnection` is called last to remove the association between the task list and the identifier and friendly name.However, calls for different connections can be nested. - -## 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 2.0 - +> These three methods must be called in a specific order for each set of tasks. `BeginConnection` is called first to establish a new connection. `SetConnectionTasks` is called next to provide the set of tasks to be associated with that connection. `EndConnection` is called last to remove the association between the task list and the identifier and friendly name.However, calls for different connections can be nested. + +## 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 - [ICLRControl Interface](iclrcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrdebugmanager-endconnection-method.md b/docs/framework/unmanaged-api/hosting/iclrdebugmanager-endconnection-method.md similarity index 64% rename from docs/core/unmanaged-api/hosting/iclrdebugmanager-endconnection-method.md rename to docs/framework/unmanaged-api/hosting/iclrdebugmanager-endconnection-method.md index 6c1e516e815bd..80de40b4c536e 100644 --- a/docs/core/unmanaged-api/hosting/iclrdebugmanager-endconnection-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrdebugmanager-endconnection-method.md @@ -2,66 +2,67 @@ description: "Learn more about: ICLRDebugManager::EndConnection Method" title: "ICLRDebugManager::EndConnection Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRDebugManager.EndConnection" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRDebugManager::EndConnection" -helpviewer_keywords: +helpviewer_keywords: - "ICLRDebugManager::EndConnection method [.NET Framework hosting]" - "EndConnection method [.NET Framework hosting]" -topic_type: +ms.assetid: 89dc7363-2f29-4eb2-8f23-fccdda6a76a6 +topic_type: - "apiref" --- # ICLRDebugManager::EndConnection Method -Removes the association between a list of tasks and an identifier and a friendly name. - -## Syntax - -```cpp -HRESULT EndConnection ( - [in] CONNID dwConnectionId -); -``` - -## Parameters - - `dwConnectionId` - [in] The host-specific identifier for the connection and the associated list of common language runtime (CLR) tasks. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`EndConnection` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_INVALIDARG|[BeginConnection](iclrdebugmanager-beginconnection-method.md) was never called using `dwConnectionId`, or `dwConnectionId` was zero.| - -## Remarks - - [ICLRDebugManager](iclrdebugmanager-interface.md) provides three methods, `BeginConnection`, [SetConnectionTasks](iclrdebugmanager-setconnectiontasks-method.md), and `EndConnection`, for associating task lists with identifiers and friendly names. - +Removes the association between a list of tasks and an identifier and a friendly name. + +## Syntax + +```cpp +HRESULT EndConnection ( + [in] CONNID dwConnectionId +); +``` + +## Parameters + + `dwConnectionId` + [in] The host-specific identifier for the connection and the associated list of common language runtime (CLR) tasks. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`EndConnection` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_INVALIDARG|[BeginConnection](iclrdebugmanager-beginconnection-method.md) was never called using `dwConnectionId`, or `dwConnectionId` was zero.| + +## Remarks + + [ICLRDebugManager](iclrdebugmanager-interface.md) provides three methods, `BeginConnection`, [SetConnectionTasks](iclrdebugmanager-setconnectiontasks-method.md), and `EndConnection`, for associating task lists with identifiers and friendly names. + > [!IMPORTANT] -> These three methods must be called in a specific order for each set of tasks. `BeginConnection` is called first to establish a new connection. `SetConnectionTasks` is called next to provide the set of tasks to be associated with that connection. `EndConnection` is called last to remove the association between the task list and the identifier and friendly name.However, calls for different connections can be nested. - -## 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 2.0 - +> These three methods must be called in a specific order for each set of tasks. `BeginConnection` is called first to establish a new connection. `SetConnectionTasks` is called next to provide the set of tasks to be associated with that connection. `EndConnection` is called last to remove the association between the task list and the identifier and friendly name.However, calls for different connections can be nested. + +## 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 - [ICLRControl Interface](iclrcontrol-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrdebugmanager-getdacl-method.md b/docs/framework/unmanaged-api/hosting/iclrdebugmanager-getdacl-method.md new file mode 100644 index 0000000000000..13767b629e18d --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrdebugmanager-getdacl-method.md @@ -0,0 +1,58 @@ +--- +description: "Learn more about: ICLRDebugManager::GetDacl Method" +title: "ICLRDebugManager::GetDacl Method" +ms.date: "03/30/2017" +api_name: + - "ICLRDebugManager.GetDacl" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRDebugManager::GetDacl" +helpviewer_keywords: + - "GetDacl method [.NET Framework hosting]" + - "ICLRDebugManager::GetDacl method [.NET Framework hosting]" +ms.assetid: 7115e920-aaff-440a-824e-39497139c6f6 +topic_type: + - "apiref" +--- +# ICLRDebugManager::GetDacl Method + +This method is not implemented. + +## Syntax + +```cpp +HRESULT GetDacl ( + [out] PACL* ppacl +); +``` + +## Parameters + + `ppacl` + [out] An interface pointer to the Access Control List (ACL). + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|E_NOTIMPL|The method is not implemented.| + +## 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 + +- [ICLRControl Interface](iclrcontrol-interface.md) +- [ICLRDebugManager Interface](iclrdebugmanager-interface.md) +- [SetDacl Method](iclrdebugmanager-setdacl-method.md) +- [IHostControl Interface](ihostcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrdebugmanager-interface.md b/docs/framework/unmanaged-api/hosting/iclrdebugmanager-interface.md similarity index 68% rename from docs/core/unmanaged-api/hosting/iclrdebugmanager-interface.md rename to docs/framework/unmanaged-api/hosting/iclrdebugmanager-interface.md index c3e4177a8b51d..4cda607603c3f 100644 --- a/docs/core/unmanaged-api/hosting/iclrdebugmanager-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrdebugmanager-interface.md @@ -2,54 +2,55 @@ description: "Learn more about: ICLRDebugManager Interface" title: "ICLRDebugManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRDebugManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRDebugManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLRDebugManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: e835062c-c7d6-4945-8a44-2de7ebf3928e +topic_type: - "apiref" --- # ICLRDebugManager Interface -Provides methods that allow a host to associate a set of tasks with an identifier and a friendly name. - -## Methods - -|Method|Description| -|------------|-----------------| -|[BeginConnection Method](iclrdebugmanager-beginconnection-method.md)|Establishes a new connection between the host and the debugger to associate tasks with an identifier and a friendly name.| -|[EndConnection Method](iclrdebugmanager-endconnection-method.md)|Removes the association between a list of tasks and an identifier and a friendly name.| -|[GetDacl Method](iclrdebugmanager-getdacl-method.md)|This method is not implemented.| -|[IsDebuggerAttached Method](iclrdebugmanager-isdebuggerattached-method.md)|Gets a value that indicates whether a debugger is attached to the process.| -|[SetConnectionTasks Method](iclrdebugmanager-setconnectiontasks-method.md)|Associates a list of [ICLRTask](iclrtask-interface.md) instances with an identifier and a friendly name.| -|[SetDacl Method](iclrdebugmanager-setdacl-method.md)|This method is not implemented.| -|[SetSymbolReadingPolicy Method](iclrdebugmanager-setsymbolreadingpolicy-method.md)|Sets the policy for reading program database (PDB) files. The policy determines whether information about line numbers and files is included in call stacks.| - -## Remarks - - In debugging scenarios, a host might want to group tasks according to its own programming logic. For example, a grouping would allow a developer to see only the tasks required by the developer's APIs, instead of seeing every task running in the process. `ICLRDebugManager` allows the host to implement this kind of grouping. - +Provides methods that allow a host to associate a set of tasks with an identifier and a friendly name. + +## Methods + +|Method|Description| +|------------|-----------------| +|[BeginConnection Method](iclrdebugmanager-beginconnection-method.md)|Establishes a new connection between the host and the debugger to associate tasks with an identifier and a friendly name.| +|[EndConnection Method](iclrdebugmanager-endconnection-method.md)|Removes the association between a list of tasks and an identifier and a friendly name.| +|[GetDacl Method](iclrdebugmanager-getdacl-method.md)|This method is not implemented.| +|[IsDebuggerAttached Method](iclrdebugmanager-isdebuggerattached-method.md)|Gets a value that indicates whether a debugger is attached to the process.| +|[SetConnectionTasks Method](iclrdebugmanager-setconnectiontasks-method.md)|Associates a list of [ICLRTask](iclrtask-interface.md) instances with an identifier and a friendly name.| +|[SetDacl Method](iclrdebugmanager-setdacl-method.md)|This method is not implemented.| +|[SetSymbolReadingPolicy Method](iclrdebugmanager-setsymbolreadingpolicy-method.md)|Sets the policy for reading program database (PDB) files. The policy determines whether information about line numbers and files is included in call stacks.| + +## Remarks + + In debugging scenarios, a host might want to group tasks according to its own programming logic. For example, a grouping would allow a developer to see only the tasks required by the developer's APIs, instead of seeing every task running in the process. `ICLRDebugManager` allows the host to implement this kind of grouping. + > [!IMPORTANT] -> Three `ICLRDebugManager` methods, `BeginConnection`, `SetConnectionTasks` and `EndConnection`, are dependent upon each other. They must be called in the given order to work as expected. - - The grouping, and the identifiers and friendly names that the host assigns to the grouping, have no meaning for the common language runtime (CLR). The CLR merely passes the information along to the debugger. - -## 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 2.0 - +> Three `ICLRDebugManager` methods, `BeginConnection`, `SetConnectionTasks` and `EndConnection`, are dependent upon each other. They must be called in the given order to work as expected. + + The grouping, and the identifiers and friendly names that the host assigns to the grouping, have no meaning for the common language runtime (CLR). The CLR merely passes the information along to the debugger. + +## 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 - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/iclrdebugmanager-isdebuggerattached-method.md b/docs/framework/unmanaged-api/hosting/iclrdebugmanager-isdebuggerattached-method.md similarity index 55% rename from docs/core/unmanaged-api/hosting/iclrdebugmanager-isdebuggerattached-method.md rename to docs/framework/unmanaged-api/hosting/iclrdebugmanager-isdebuggerattached-method.md index 6996de167c3af..6618e376834b4 100644 --- a/docs/core/unmanaged-api/hosting/iclrdebugmanager-isdebuggerattached-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrdebugmanager-isdebuggerattached-method.md @@ -2,62 +2,63 @@ description: "Learn more about: ICLRDebugManager::IsDebuggerAttached Method" title: "ICLRDebugManager::IsDebuggerAttached Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRDebugManager.IsDebuggerAttached" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRDebugManager::IsDebuggerAttached" -helpviewer_keywords: +helpviewer_keywords: - "IsDebuggerAttached method, ICLRDebugManager interface [.NET Framework hosting]" - "ICLRDebugManager::IsDebuggerAttached method [.NET Framework hosting]" -topic_type: +ms.assetid: 2f105fe0-f52d-49c5-bda5-583fb27e3aa6 +topic_type: - "apiref" --- # ICLRDebugManager::IsDebuggerAttached Method -Gets a value that indicates whether a debugger is attached to the process. - -## Syntax - -```cpp -HRESULT IsDebuggerAttached ( - [out] BOOL *pbAttached -); -``` - -## Parameters - - `pbAttached` - [out] `true` if a debugger is attached to the process; otherwise, `false`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`IsDebuggerAttached` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `IsDebuggerAttached` allows the host to query the CLR to determine whether a debugger is attached to the process. - -## 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 2.0 - +Gets a value that indicates whether a debugger is attached to the process. + +## Syntax + +```cpp +HRESULT IsDebuggerAttached ( + [out] BOOL *pbAttached +); +``` + +## Parameters + + `pbAttached` + [out] `true` if a debugger is attached to the process; otherwise, `false`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`IsDebuggerAttached` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `IsDebuggerAttached` allows the host to query the CLR to determine whether a debugger is attached to the process. + +## 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 - [ICLRControl Interface](iclrcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrdebugmanager-setconnectiontasks-method.md b/docs/framework/unmanaged-api/hosting/iclrdebugmanager-setconnectiontasks-method.md similarity index 64% rename from docs/core/unmanaged-api/hosting/iclrdebugmanager-setconnectiontasks-method.md rename to docs/framework/unmanaged-api/hosting/iclrdebugmanager-setconnectiontasks-method.md index 1e41a41a1a692..69f2d3c45b90e 100644 --- a/docs/core/unmanaged-api/hosting/iclrdebugmanager-setconnectiontasks-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrdebugmanager-setconnectiontasks-method.md @@ -2,74 +2,75 @@ description: "Learn more about: ICLRDebugManager::SetConnectionTasks Method" title: "ICLRDebugManager::SetConnectionTasks Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRDebugManager.SetConnectionTasks" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRDebugManager::SetConnectionTasks" -helpviewer_keywords: +helpviewer_keywords: - "SetConnectionTasks method [.NET Framework hosting]" - "ICLRDebugManager::SetConnectionTasks method [.NET Framework hosting]" -topic_type: +ms.assetid: b38bbc9a-872c-41a9-b8c3-ca011d25456a +topic_type: - "apiref" --- # ICLRDebugManager::SetConnectionTasks Method -Associates a list of [ICLRTask](iclrtask-interface.md) instances with an identifier and a friendly name. - -## Syntax - -```cpp -HRESULT SetConnectionTasks ( - [in] CONNID id, - [in] DWORD dwCount, - [in, size_is(dwCount)] ICLRTask **ppCLRTask -); -``` - -## Parameters - - `id` - [in] The host-specific identifier for the connection with which to associate the `ppCLRTask` array. - - `dwCount` - [in] The number of members of `ppCLRTask`. This number must be greater than zero. - - `ppCLRTask` - [in] An array of `ICLRTask` pointers to associate with the connection identified by `id`. This array must contain at least one member. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetConnectionTasks` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_INVALIDARG|[BeginConnection](iclrdebugmanager-beginconnection-method.md) has not been called using this value of `id`, or `dwCount` or `id` is zero, or one of the elements of `ppCLRTask` is null.| - -## Remarks - - [ICLRDebugManager](iclrdebugmanager-interface.md) provides three methods, `BeginConnection`, `SetConnectionTasks`, and [EndConnection](iclrdebugmanager-endconnection-method.md), for associating task lists with identifiers and friendly names. - +Associates a list of [ICLRTask](iclrtask-interface.md) instances with an identifier and a friendly name. + +## Syntax + +```cpp +HRESULT SetConnectionTasks ( + [in] CONNID id, + [in] DWORD dwCount, + [in, size_is(dwCount)] ICLRTask **ppCLRTask +); +``` + +## Parameters + + `id` + [in] The host-specific identifier for the connection with which to associate the `ppCLRTask` array. + + `dwCount` + [in] The number of members of `ppCLRTask`. This number must be greater than zero. + + `ppCLRTask` + [in] An array of `ICLRTask` pointers to associate with the connection identified by `id`. This array must contain at least one member. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetConnectionTasks` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_INVALIDARG|[BeginConnection](iclrdebugmanager-beginconnection-method.md) has not been called using this value of `id`, or `dwCount` or `id` is zero, or one of the elements of `ppCLRTask` is null.| + +## Remarks + + [ICLRDebugManager](iclrdebugmanager-interface.md) provides three methods, `BeginConnection`, `SetConnectionTasks`, and [EndConnection](iclrdebugmanager-endconnection-method.md), for associating task lists with identifiers and friendly names. + > [!IMPORTANT] -> These three methods must be called in a specific order for each set of tasks. `BeginConnection` is called first to establish a new connection. `SetConnectionTasks` is called next to provide the set of tasks to be associated with that connection. `EndConnection` is called last to remove the association between the task list and the identifier and friendly name.However, calls for different connections can be nested. - -## 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 2.0 - +> These three methods must be called in a specific order for each set of tasks. `BeginConnection` is called first to establish a new connection. `SetConnectionTasks` is called next to provide the set of tasks to be associated with that connection. `EndConnection` is called last to remove the association between the task list and the identifier and friendly name.However, calls for different connections can be nested. + +## 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 - [ICLRControl Interface](iclrcontrol-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrdebugmanager-setdacl-method.md b/docs/framework/unmanaged-api/hosting/iclrdebugmanager-setdacl-method.md new file mode 100644 index 0000000000000..68a81663669be --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrdebugmanager-setdacl-method.md @@ -0,0 +1,58 @@ +--- +description: "Learn more about: ICLRDebugManager::SetDacl Method" +title: "ICLRDebugManager::SetDacl Method" +ms.date: "03/30/2017" +api_name: + - "ICLRDebugManager.SetDacl" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRDebugManager::SetDacl" +helpviewer_keywords: + - "SetDacl method [.NET Framework hosting]" + - "ICLRDebugManager::SetDacl method [.NET Framework hosting]" +ms.assetid: 52f4af3f-e02b-4c20-9fd9-e8e4f4d6fc31 +topic_type: + - "apiref" +--- +# ICLRDebugManager::SetDacl Method + +This method is not implemented. + +## Syntax + +```cpp +HRESULT SetDacl ( + [in] PACL pacl +); +``` + +## Parameters + + `pacl` + [in] A pointer to the Access Control List (ACL). + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|E_NOTIMPL|The method is not implemented.| + +## 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 + +- [ICLRControl Interface](iclrcontrol-interface.md) +- [ICLRDebugManager Interface](iclrdebugmanager-interface.md) +- [GetDacl Method](iclrdebugmanager-getdacl-method.md) +- [IHostControl Interface](ihostcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrdebugmanager-setsymbolreadingpolicy-method.md b/docs/framework/unmanaged-api/hosting/iclrdebugmanager-setsymbolreadingpolicy-method.md similarity index 56% rename from docs/core/unmanaged-api/hosting/iclrdebugmanager-setsymbolreadingpolicy-method.md rename to docs/framework/unmanaged-api/hosting/iclrdebugmanager-setsymbolreadingpolicy-method.md index f2601dda0f079..5de01934a8f7c 100644 --- a/docs/core/unmanaged-api/hosting/iclrdebugmanager-setsymbolreadingpolicy-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrdebugmanager-setsymbolreadingpolicy-method.md @@ -2,56 +2,57 @@ description: "Learn more about: ICLRDebugManager::SetSymbolReadingPolicy Method" title: "ICLRDebugManager::SetSymbolReadingPolicy Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRDebugManager.SetSymbolReadingPolicy" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRDebugManager::SetSymbolReadingPolicy" -helpviewer_keywords: +helpviewer_keywords: - "ICLRDebugManager, SetSymbolREadingPolicy method" - "SetSymbolReadingPolicy method [.NET Framework hosting]" - "ICLRDebugManager::SetSymbolReadingPolicy method [.NET Framework hosting]" -topic_type: +ms.assetid: bd921fa2-d377-4d79-acfc-64c38d4dcae9 +topic_type: - "apiref" --- # ICLRDebugManager::SetSymbolReadingPolicy Method -Sets the policy for reading program database (PDB) files. The policy determines whether information about line numbers and files is included in call stacks. - -## Syntax - -```cpp -HRESULT SetSymbolReadingPolicy ( - [in] ESymbolReadingPolicy policy -); -``` - -## Parameters - - `policy` - [in] A member of the [ESymbolReadingPolicy](esymbolreadingpolicy-enumeration.md) enumeration. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetSymbolReadingPolicy` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| -|E_FAIL|An unknown catastrophic failure occurred. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## 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 2.0 - +Sets the policy for reading program database (PDB) files. The policy determines whether information about line numbers and files is included in call stacks. + +## Syntax + +```cpp +HRESULT SetSymbolReadingPolicy ( + [in] ESymbolReadingPolicy policy +); +``` + +## Parameters + + `policy` + [in] A member of the [ESymbolReadingPolicy](esymbolreadingpolicy-enumeration.md) enumeration. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetSymbolReadingPolicy` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| +|E_FAIL|An unknown catastrophic failure occurred. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 - [ICLRDebugManager Interface](iclrdebugmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrdomainmanager-interface.md b/docs/framework/unmanaged-api/hosting/iclrdomainmanager-interface.md similarity index 58% rename from docs/core/unmanaged-api/hosting/iclrdomainmanager-interface.md rename to docs/framework/unmanaged-api/hosting/iclrdomainmanager-interface.md index d22b31c11b353..d556a3c09c1a8 100644 --- a/docs/core/unmanaged-api/hosting/iclrdomainmanager-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrdomainmanager-interface.md @@ -2,42 +2,43 @@ description: "Learn more about: ICLRDomainManager Interface" title: "ICLRDomainManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRDomainManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRDomainManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLRDomainManager interface [.NET Framework hosting]" +ms.assetid: f08b2390-d872-4521-a815-e9c237c4c45d --- # ICLRDomainManager Interface -Enables the host to specify the application domain manager that will be used to initialize the default application domain, and to specify initialization properties. - -## Methods - -|Method|Description| -|------------|-----------------| -|[SetAppDomainManagerType Method](iclrdomainmanager-setappdomainmanagertype-method.md)|Specifies the type, derived from the class, of the application domain manager that will be used to initialize the default application domain.| -|[SetPropertiesForDefaultAppDomain Method](iclrdomainmanager-setpropertiesfordefaultappdomain-method.md)|Sets properties that will be used to initialize the default application domain.| - -## Remarks - - To get an instance of this interface, call the [ICLRControl::GetCLRManager](iclrcontrol-getclrmanager-method.md) method with the manager type IID `IID_ICLRDomainManager`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Enables the host to specify the application domain manager that will be used to initialize the default application domain, and to specify initialization properties. + +## Methods + +|Method|Description| +|------------|-----------------| +|[SetAppDomainManagerType Method](iclrdomainmanager-setappdomainmanagertype-method.md)|Specifies the type, derived from the class, of the application domain manager that will be used to initialize the default application domain.| +|[SetPropertiesForDefaultAppDomain Method](iclrdomainmanager-setpropertiesfordefaultappdomain-method.md)|Sets properties that will be used to initialize the default application domain.| + +## Remarks + + To get an instance of this interface, call the [ICLRControl::GetCLRManager](iclrcontrol-getclrmanager-method.md) method with the manager type IID `IID_ICLRDomainManager`. + +## 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/core/unmanaged-api/hosting/iclrdomainmanager-setappdomainmanagertype-method.md b/docs/framework/unmanaged-api/hosting/iclrdomainmanager-setappdomainmanagertype-method.md similarity index 64% rename from docs/core/unmanaged-api/hosting/iclrdomainmanager-setappdomainmanagertype-method.md rename to docs/framework/unmanaged-api/hosting/iclrdomainmanager-setappdomainmanagertype-method.md index 640b8baa92d8e..28bc8df6ac1ff 100644 --- a/docs/core/unmanaged-api/hosting/iclrdomainmanager-setappdomainmanagertype-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrdomainmanager-setappdomainmanagertype-method.md @@ -2,71 +2,72 @@ description: "Learn more about: ICLRDomainManager::SetAppDomainManagerType Method" title: "ICLRDomainManager::SetAppDomainManagerType Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRDomainManager.SetAppDomainManagerType" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRDomainManager::SetAppDomainManagerType" -helpviewer_keywords: +helpviewer_keywords: - "SetAppDomainManagerType method, ICLRDomainManager interface [.NET Framework hosting]" - "ICLRDomainManager::SetAppDomainManagerType method [.NET Framework hosting]" +ms.assetid: ee91abb0-cb74-41dd-927b-e117fb8ffdf4 --- # ICLRDomainManager::SetAppDomainManagerType Method -Specifies the type, derived from the class, of the application domain manager that will be used to initialize the default application domain. - -## Syntax - -```cpp -HRESULT SetAppDomainManagerType( - [in] LPCWSTR wszAppDomainManagerAssembly, - [in] LPCWSTR wszAppDomainManagerType, - [in] EInitializeNewDomainFlags dwInitializeDomainFlags -); -``` - -## Parameters - - `wszAppDomainManagerAssembly` - [in] The display name of the assembly that contains the application domain manager type; for example: "AdMgrExample, Version=1.0.0.0, Culture=neutral, PublicKeyToken=6856bccf150f00b3". - - `wszAppDomainManagerType` - [in] The type name of the application domain manager, including the namespace. - - `dwInitializeDomainFlags` - [in] A combination of [EInitializeNewDomainFlags](einitializenewdomainflags-enumeration.md) enumeration values that provide information about the application domain manager. - -## 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.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| - -## Remarks - - Currently, the only defined value for `dwInitializeDomainFlags` is `eInitializeNewDomainFlags_NoSecurityChanges`, which tells the common language runtime (CLR) that the application domain manager will not modify security settings during the execution of the method. This allows the CLR to optimize the loading of assemblies that have the conditional (APTCA) attribute. This can result in a significant improvement in startup time if the transitive closure of this set of assemblies is large. - +Specifies the type, derived from the class, of the application domain manager that will be used to initialize the default application domain. + +## Syntax + +```cpp +HRESULT SetAppDomainManagerType( + [in] LPCWSTR wszAppDomainManagerAssembly, + [in] LPCWSTR wszAppDomainManagerType, + [in] EInitializeNewDomainFlags dwInitializeDomainFlags +); +``` + +## Parameters + + `wszAppDomainManagerAssembly` + [in] The display name of the assembly that contains the application domain manager type; for example: "AdMgrExample, Version=1.0.0.0, Culture=neutral, PublicKeyToken=6856bccf150f00b3". + + `wszAppDomainManagerType` + [in] The type name of the application domain manager, including the namespace. + + `dwInitializeDomainFlags` + [in] A combination of [EInitializeNewDomainFlags](einitializenewdomainflags-enumeration.md) enumeration values that provide information about the application domain manager. + +## 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.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| + +## Remarks + + Currently, the only defined value for `dwInitializeDomainFlags` is `eInitializeNewDomainFlags_NoSecurityChanges`, which tells the common language runtime (CLR) that the application domain manager will not modify security settings during the execution of the method. This allows the CLR to optimize the loading of assemblies that have the conditional (APTCA) attribute. This can result in a significant improvement in startup time if the transitive closure of this set of assemblies is large. + > [!IMPORTANT] -> If the host specifies `eInitializeNewDomainFlags_NoSecurityChanges` for the application domain manager, an is thrown if any attempt is made to modify the security of the application domain. - - Calling the [ICLRControl::SetAppDomainManagerType](iclrcontrol-setappdomainmanagertype-method.md)method is equivalent to calling `ICLRDomainManager::SetAppDomainManagerType` with `eInitializeNewDomainFlags_None`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +> If the host specifies `eInitializeNewDomainFlags_NoSecurityChanges` for the application domain manager, an is thrown if any attempt is made to modify the security of the application domain. + + Calling the [ICLRControl::SetAppDomainManagerType](iclrcontrol-setappdomainmanagertype-method.md)method is equivalent to calling `ICLRDomainManager::SetAppDomainManagerType` with `eInitializeNewDomainFlags_None`. + +## 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](index.md) diff --git a/docs/core/unmanaged-api/hosting/iclrdomainmanager-setpropertiesfordefaultappdomain-method.md b/docs/framework/unmanaged-api/hosting/iclrdomainmanager-setpropertiesfordefaultappdomain-method.md similarity index 60% rename from docs/core/unmanaged-api/hosting/iclrdomainmanager-setpropertiesfordefaultappdomain-method.md rename to docs/framework/unmanaged-api/hosting/iclrdomainmanager-setpropertiesfordefaultappdomain-method.md index dff9f11a49c3d..2ec49578def6b 100644 --- a/docs/core/unmanaged-api/hosting/iclrdomainmanager-setpropertiesfordefaultappdomain-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrdomainmanager-setpropertiesfordefaultappdomain-method.md @@ -2,66 +2,67 @@ description: "Learn more about: ICLRDomainManager::SetPropertiesForDefaultAppDomain Method" title: "ICLRDomainManager::SetPropertiesForDefaultAppDomain Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRDomainManager.SetPropertiesForDefaultAppDomain" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRDomainManager::SetPropertiesForDefaultAppDomain" -helpviewer_keywords: +helpviewer_keywords: - "ICLRDomainManager::SetPropertiesForDefaultAppDomain method [.NET Framework hosting]" - "SetPropertiesForDefaultAppDomain method [.NET Framework hosting]" +ms.assetid: 43e61c4b-c435-45ec-9ef6-c68403aa4200 --- # ICLRDomainManager::SetPropertiesForDefaultAppDomain Method -Sets properties that will be used to initialize the default application domain. - -## Syntax - -```cpp -HRESULT SetPropertiesForDefaultAppDomain( - [in] DWORD nProperties, - [in] LPCWSTR *pwszPropertyNames, - [in] LPCWSTR *pwszPropertyValues -); -``` - -## Parameters - - `nProperties` - [in] The number of entries in `pwszPropertyNames` and `pwszPropertyValues`. - - `pwszPropertyNames` - [in] An array of property names, or null if there are no properties. Currently, the only property name that is recognized by this method is "PARTIAL_TRUST_VISIBLE_ASSEMBLIES". - - `pwszPropertyValues` - [in] An array of property values, or null if there are no properties. - -## 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.| -|HRESULT_FROM_WIN32(ERROR_UNKNOWN_PROPERTY)|`pwszPropertyNames` includes a property name that is not recognized by this method.| - -## Remarks - - The property value for "PARTIAL_TRUST_VISIBLE_ASSEMBLIES" is a list of assemblies that have the conditional (APTCA) attribute with the flag, which are to be made visible to partially trusted callers in the default application domain. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Sets properties that will be used to initialize the default application domain. + +## Syntax + +```cpp +HRESULT SetPropertiesForDefaultAppDomain( + [in] DWORD nProperties, + [in] LPCWSTR *pwszPropertyNames, + [in] LPCWSTR *pwszPropertyValues +); +``` + +## Parameters + + `nProperties` + [in] The number of entries in `pwszPropertyNames` and `pwszPropertyValues`. + + `pwszPropertyNames` + [in] An array of property names, or null if there are no properties. Currently, the only property name that is recognized by this method is "PARTIAL_TRUST_VISIBLE_ASSEMBLIES". + + `pwszPropertyValues` + [in] An array of property values, or null if there are no properties. + +## 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.| +|HRESULT_FROM_WIN32(ERROR_UNKNOWN_PROPERTY)|`pwszPropertyNames` includes a property name that is not recognized by this method.| + +## Remarks + + The property value for "PARTIAL_TRUST_VISIBLE_ASSEMBLIES" is a list of assemblies that have the conditional (APTCA) attribute with the flag, which are to be made visible to partially trusted callers in the default application domain. + +## 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](index.md) diff --git a/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-begincustomdump-method.md b/docs/framework/unmanaged-api/hosting/iclrerrorreportingmanager-begincustomdump-method.md similarity index 58% rename from docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-begincustomdump-method.md rename to docs/framework/unmanaged-api/hosting/iclrerrorreportingmanager-begincustomdump-method.md index 352d16d1b3cd1..b12c3662537b9 100644 --- a/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-begincustomdump-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrerrorreportingmanager-begincustomdump-method.md @@ -2,77 +2,78 @@ description: "Learn more about: ICLRErrorReportingManager::BeginCustomDump Method" title: "ICLRErrorReportingManager::BeginCustomDump Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRErrorReportingManager.BeginCustomDump" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRErrorReportingManager::BeginCustomDump" -helpviewer_keywords: +helpviewer_keywords: - "ICLRErrorReportingManager::BeginCustomDump method [.NET Framework hosting]" - "BeginCustomDump method" -topic_type: +ms.assetid: 93424a87-ba13-4fa1-b4dc-69d44437b7ae +topic_type: - "apiref" --- # ICLRErrorReportingManager::BeginCustomDump Method -Specifies the configuration of custom heap dumps for error reporting. - -## Syntax - -```cpp -HRESULT BeginCustomDump ( - [in] ECustomDumpFlavor dwFlavor, - [in] DWORD dwNumItems, - [in, size_is(dwNumItems), length_is(dwNumItems)] CustomDumpItem items[], - DWORD dwReserved -); -``` - -## Parameters - - `dwFlavor` - [in] A [ECustomDumpFlavor](ecustomdumpflavor-enumeration.md) value that indicates the kind of heap dump upon which to build the custom heap dump. - - `dwNumItems` - [in] The length of the `items` array. If `dwFlavor` is not DUMP_FLAVOR_Mini, `dwNumItems` should be zero. - - `items` - [in] An array of [CustomDumpItem](customdumpitem-structure.md) instances, specifying the items to add to the mini-dump. If `dwFlavor` is not DUMP_FLAVOR_Mini, `items` should be null. - - `dwReserved` - [in] Reserved for future use. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The `BeginCustomDump` method sets custom heap dump configuration. The [EndCustomDump](iclrerrorreportingmanager-endcustomdump-method.md) method clears the custom heap dump configuration and frees any associated state. It should be called after the custom heap dump is complete. - +Specifies the configuration of custom heap dumps for error reporting. + +## Syntax + +```cpp +HRESULT BeginCustomDump ( + [in] ECustomDumpFlavor dwFlavor, + [in] DWORD dwNumItems, + [in, size_is(dwNumItems), length_is(dwNumItems)] CustomDumpItem items[], + DWORD dwReserved +); +``` + +## Parameters + + `dwFlavor` + [in] A [ECustomDumpFlavor](ecustomdumpflavor-enumeration.md) value that indicates the kind of heap dump upon which to build the custom heap dump. + + `dwNumItems` + [in] The length of the `items` array. If `dwFlavor` is not DUMP_FLAVOR_Mini, `dwNumItems` should be zero. + + `items` + [in] An array of [CustomDumpItem](customdumpitem-structure.md) instances, specifying the items to add to the mini-dump. If `dwFlavor` is not DUMP_FLAVOR_Mini, `items` should be null. + + `dwReserved` + [in] Reserved for future use. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The `BeginCustomDump` method sets custom heap dump configuration. The [EndCustomDump](iclrerrorreportingmanager-endcustomdump-method.md) method clears the custom heap dump configuration and frees any associated state. It should be called after the custom heap dump is complete. + > [!IMPORTANT] -> Failure to call `EndCustomDump` causes memory to leak. - -## 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 2.0 - +> Failure to call `EndCustomDump` causes memory to leak. + +## 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 - [CustomDumpItem Structure](customdumpitem-structure.md) diff --git a/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-endcustomdump-method.md b/docs/framework/unmanaged-api/hosting/iclrerrorreportingmanager-endcustomdump-method.md similarity index 61% rename from docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-endcustomdump-method.md rename to docs/framework/unmanaged-api/hosting/iclrerrorreportingmanager-endcustomdump-method.md index 4d2f489cddce9..387b60d78dcfa 100644 --- a/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-endcustomdump-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrerrorreportingmanager-endcustomdump-method.md @@ -2,58 +2,59 @@ description: "Learn more about: ICLRErrorReportingManager::EndCustomDump Method" title: "ICLRErrorReportingManager::EndCustomDump Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRErrorReportingManager.EndCustomDump" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRErrorReportingManager::EndCustomDump" -helpviewer_keywords: +helpviewer_keywords: - "ICLRErrorReportingManager::EndCustomDump method [.NET Framework hosting]" - "EndCustomDump method [.NET Framework hosting]" -topic_type: +ms.assetid: 88a5da04-8729-4108-82c4-af206a7d483e +topic_type: - "apiref" --- # ICLRErrorReportingManager::EndCustomDump Method -Removes the custom stack dump configuration that was specified in an earlier call to the [ICLRErrorReportingManager::BeginCustomDump](iclrerrorreportingmanager-begincustomdump-method.md) method. - -## Syntax - -```cpp -HRESULT EndCustomDump (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`EndCustomDump` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The `EndCustomDump` method clears the custom stack dump configuration set by an earlier call to the `BeginCustomDump` method and frees any associated state. It should be called after the custom stack dump is complete. - +Removes the custom stack dump configuration that was specified in an earlier call to the [ICLRErrorReportingManager::BeginCustomDump](iclrerrorreportingmanager-begincustomdump-method.md) method. + +## Syntax + +```cpp +HRESULT EndCustomDump (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`EndCustomDump` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The `EndCustomDump` method clears the custom stack dump configuration set by an earlier call to the `BeginCustomDump` method and frees any associated state. It should be called after the custom stack dump is complete. + > [!IMPORTANT] -> Failure to call `EndCustomDump` causes memory to leak. - -## 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 2.0 - +> Failure to call `EndCustomDump` causes memory to leak. + +## 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 - [CustomDumpItem Structure](customdumpitem-structure.md) diff --git a/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md b/docs/framework/unmanaged-api/hosting/iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md similarity index 60% rename from docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md rename to docs/framework/unmanaged-api/hosting/iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md index a348c9a74a56d..db4d706bb6d5e 100644 --- a/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md @@ -2,49 +2,50 @@ description: "Learn more about: ICLRErrorReportingManager::GetBucketParametersForCurrentException Method" title: "ICLRErrorReportingManager::GetBucketParametersForCurrentException Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRErrorReportingManager.GetBucketParametersForCurrentException" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRErrorReportingManager::GetBucketParametersForCurrentException" -helpviewer_keywords: +helpviewer_keywords: - "ICLRErrorReportingManager::GetBucketParametersForCurrentException method [.NET Framework hosting]" - "GetBucketParametersForCurrentException method [.NET Framework hosting]" -topic_type: +ms.assetid: a13ec8a6-8e18-4acb-8054-77f5b1a0e0b9 +topic_type: - "apiref" --- # ICLRErrorReportingManager::GetBucketParametersForCurrentException Method -Gets the Watson bucket for the current exception on the calling thread. - - A *bucket* is a collection of error data that is related to the same code defect. *Watson* refers to a set of technologies for collecting and analyzing data that is associated with an exception. - -## Syntax - -```cpp -HRESULT GetBucketParametersForCurrentException( - [out] BucketParameters *pParams -); -``` - -## Parameters - - `pParams` - [out] A pointer to a [BucketParameters](bucketparameters-structure.md) structure that contains error data for the exception. - -## 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 2.0 - +Gets the Watson bucket for the current exception on the calling thread. + + A *bucket* is a collection of error data that is related to the same code defect. *Watson* refers to a set of technologies for collecting and analyzing data that is associated with an exception. + +## Syntax + +```cpp +HRESULT GetBucketParametersForCurrentException( + [out] BucketParameters *pParams +); +``` + +## Parameters + + `pParams` + [out] A pointer to a [BucketParameters](bucketparameters-structure.md) structure that contains error data for the exception. + +## 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 - [ICLRErrorReportingManager Interface](iclrerrorreportingmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-interface.md b/docs/framework/unmanaged-api/hosting/iclrerrorreportingmanager-interface.md similarity index 61% rename from docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-interface.md rename to docs/framework/unmanaged-api/hosting/iclrerrorreportingmanager-interface.md index f96dd84cbc666..e1bee740a5f78 100644 --- a/docs/core/unmanaged-api/hosting/iclrerrorreportingmanager-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrerrorreportingmanager-interface.md @@ -2,48 +2,49 @@ description: "Learn more about: ICLRErrorReportingManager Interface" title: "ICLRErrorReportingManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRErrorReportingManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRErrorReportingManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLRErrorReportingManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: ea8af0d5-4133-4472-8a1f-50570d7e85fa +topic_type: - "apiref" --- # ICLRErrorReportingManager Interface -Provides methods that allow the host to configure custom stack dumps for error reporting. - -## Methods - -|Method|Description| -|------------|-----------------| -|[BeginCustomDump Method](iclrerrorreportingmanager-begincustomdump-method.md)|Specifies the configuration of custom stack dumps for error reporting.| -|[EndCustomDump Method](iclrerrorreportingmanager-endcustomdump-method.md)|Clears the custom stack dump configuration that was set by an earlier call to `BeginCustomDump`.| -|[GetBucketParametersForCurrentException Method](iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md)|Gets the Watson bucket for the current exception on the calling thread.| - -## Remarks - - The `BeginCustomDump` method sets custom stack dump configuration. The `EndCustomDump` method clears the custom stack dump configuration and frees any associated state. It should be called after the custom dump is complete. - +Provides methods that allow the host to configure custom stack dumps for error reporting. + +## Methods + +|Method|Description| +|------------|-----------------| +|[BeginCustomDump Method](iclrerrorreportingmanager-begincustomdump-method.md)|Specifies the configuration of custom stack dumps for error reporting.| +|[EndCustomDump Method](iclrerrorreportingmanager-endcustomdump-method.md)|Clears the custom stack dump configuration that was set by an earlier call to `BeginCustomDump`.| +|[GetBucketParametersForCurrentException Method](iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md)|Gets the Watson bucket for the current exception on the calling thread.| + +## Remarks + + The `BeginCustomDump` method sets custom stack dump configuration. The `EndCustomDump` method clears the custom stack dump configuration and frees any associated state. It should be called after the custom dump is complete. + > [!IMPORTANT] -> Failure to call `EndCustomDump` causes memory to leak. - -## 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 2.0 - +> Failure to call `EndCustomDump` causes memory to leak. + +## 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 - [ECustomDumpItemKind Enumeration](ecustomdumpitemkind-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager-collect-method.md b/docs/framework/unmanaged-api/hosting/iclrgcmanager-collect-method.md similarity index 55% rename from docs/core/unmanaged-api/hosting/iclrgcmanager-collect-method.md rename to docs/framework/unmanaged-api/hosting/iclrgcmanager-collect-method.md index 8facdacbdb98d..7518578b22747 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager-collect-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrgcmanager-collect-method.md @@ -2,62 +2,63 @@ description: "Learn more about: ICLRGCManager::Collect Method" title: "ICLRGCManager::Collect Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRGCManager.Collect" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRGCManager::Collect" -helpviewer_keywords: +helpviewer_keywords: - "ICLRGCManager::Collect method [.NET Framework hosting]" - "Collect method, ICLRGCManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: 0c6cbbea-c27c-4695-bda3-17c1910d8ddb +topic_type: - "apiref" --- # ICLRGCManager::Collect Method -Forces a garbage collection for the specified generation. - -## Syntax - -```cpp -HRESULT Collect ( - [in] LONG Generation -); -``` - -## Parameters - - `Generation` - [in] The generation to collect. A value of -1 forces a collection of all generations. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Collect` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The `Collect` method forces the CLR's garbage collector to perform a collection regardless of its current state. - -## 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 2.0 - +Forces a garbage collection for the specified generation. + +## Syntax + +```cpp +HRESULT Collect ( + [in] LONG Generation +); +``` + +## Parameters + + `Generation` + [in] The generation to collect. A value of -1 forces a collection of all generations. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Collect` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The `Collect` method forces the CLR's garbage collector to perform a collection regardless of its current state. + +## 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 - [Automatic Memory Management](../../../standard/automatic-memory-management.md) diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager-getstats-method.md b/docs/framework/unmanaged-api/hosting/iclrgcmanager-getstats-method.md similarity index 57% rename from docs/core/unmanaged-api/hosting/iclrgcmanager-getstats-method.md rename to docs/framework/unmanaged-api/hosting/iclrgcmanager-getstats-method.md index 0f2516ef35bb1..5eb00d81799e7 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager-getstats-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrgcmanager-getstats-method.md @@ -2,72 +2,73 @@ description: "Learn more about: ICLRGCManager::GetStats Method" title: "ICLRGCManager::GetStats Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRGCManager.GetStats" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRGCManager::GetStats" -helpviewer_keywords: +helpviewer_keywords: - "GetStats method, ICLRGCManager interface [.NET Framework hosting]" - "ICLRGCManager::GetStats method [.NET Framework hosting]" -topic_type: +ms.assetid: ce259d1d-cd81-4490-a7a1-0d0ea0804872 +topic_type: - "apiref" --- # ICLRGCManager::GetStats Method -Gets a set of current statistics about the common language runtime's garbage collection system. - -## Syntax - -```cpp -HRESULT GetStats ( - [in, out] COR_GC_STATS *pStats -); -``` - -## Parameters - - `pStats` - [in, out] A [COR_GC_STATS](cor-gc-stats-structure.md) instance that contains the requested statistics. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetStats` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR calculates and returns only those statistics that are specified by the `Flags` field of `pStats`. - - Set the `Flags` field to one or more values of the [COR_GC_STAT_TYPES](cor-gc-stat-types-enumeration.md) enumeration to specify which statistics in the [COR_GC_STATS](cor-gc-stats-structure.md) structure are to be set. - - An example of the usage is as follows: - -```cpp -COR_GC_STATS GCStats; -GCStats.Flags = COR_GC_COUNTS | COR_GC_MEMORYUSAGE; -pCLRGCManager->GetStats(&GCStats); -``` - -## 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 2.0 - +Gets a set of current statistics about the common language runtime's garbage collection system. + +## Syntax + +```cpp +HRESULT GetStats ( + [in, out] COR_GC_STATS *pStats +); +``` + +## Parameters + + `pStats` + [in, out] A [COR_GC_STATS](cor-gc-stats-structure.md) instance that contains the requested statistics. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetStats` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR calculates and returns only those statistics that are specified by the `Flags` field of `pStats`. + + Set the `Flags` field to one or more values of the [COR_GC_STAT_TYPES](cor-gc-stat-types-enumeration.md) enumeration to specify which statistics in the [COR_GC_STATS](cor-gc-stats-structure.md) structure are to be set. + + An example of the usage is as follows: + +```cpp +COR_GC_STATS GCStats; +GCStats.Flags = COR_GC_COUNTS | COR_GC_MEMORYUSAGE; +pCLRGCManager->GetStats(&GCStats); +``` + +## 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 - [Automatic Memory Management](../../../standard/automatic-memory-management.md) diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md b/docs/framework/unmanaged-api/hosting/iclrgcmanager-interface.md similarity index 64% rename from docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md rename to docs/framework/unmanaged-api/hosting/iclrgcmanager-interface.md index c7151d4ffcc01..1e3434ba2062a 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrgcmanager-interface.md @@ -2,48 +2,49 @@ description: "Learn more about: ICLRGCManager Interface" title: "ICLRGCManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRGCManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRGCManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLRGCManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: fb511c9b-3fe4-41b0-822a-6ba4a079d1f5 +topic_type: - "apiref" --- # ICLRGCManager Interface -Provides methods that allow a host to interact with the common language runtime's garbage collection system. - +Provides methods that allow a host to interact with the common language runtime's garbage collection system. + > [!NOTE] -> Starting with .NET Framework 4.5, you can use the [ICLRGCManager2::SetGCStartupLimitsEx](iclrgcmanager2-setgcstartuplimitsex-method.md) method to set the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0 to values greater than the `DWORD` limit that is imposed by the [SetGCStartupLimits](iclrgcmanager-setgcstartuplimits-method.md) method. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Collect Method](iclrgcmanager-collect-method.md)|Forces a garbage collection for the specified generation.| -|[GetStats Method](iclrgcmanager-getstats-method.md)|Gets a set of current statistics about the garbage collection system.| -|[SetGCStartupLimits Method](iclrgcmanager-setgcstartuplimits-method.md)|Sets the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0.| - -## Remarks - - The common language runtime (CLR) implements its garbage collection mechanism with the managed type. For more information about the garbage collection system, see [Garbage Collection](../../../standard/garbage-collection/index.md). - -## 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 2.0 - +> Starting with .NET Framework 4.5, you can use the [ICLRGCManager2::SetGCStartupLimitsEx](iclrgcmanager2-setgcstartuplimitsex-method.md) method to set the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0 to values greater than the `DWORD` limit that is imposed by the [SetGCStartupLimits](iclrgcmanager-setgcstartuplimits-method.md) method. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Collect Method](iclrgcmanager-collect-method.md)|Forces a garbage collection for the specified generation.| +|[GetStats Method](iclrgcmanager-getstats-method.md)|Gets a set of current statistics about the garbage collection system.| +|[SetGCStartupLimits Method](iclrgcmanager-setgcstartuplimits-method.md)|Sets the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0.| + +## Remarks + + The common language runtime (CLR) implements its garbage collection mechanism with the managed type. For more information about the garbage collection system, see [Garbage Collection](../../../standard/garbage-collection/index.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 - [Automatic Memory Management](../../../standard/automatic-memory-management.md) diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md b/docs/framework/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md similarity index 54% rename from docs/core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md rename to docs/framework/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md index b2401db9f0b29..fa0e2f4599767 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrgcmanager-setgcstartuplimits-method.md @@ -2,73 +2,74 @@ description: "Learn more about: ICLRGCManager::SetGCStartupLimits Method" title: "ICLRGCManager::SetGCStartupLimits Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRGCManager.SetGCStartupLimits" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRGCManager::SetGCStartupLimits" -helpviewer_keywords: +helpviewer_keywords: - "SetGCStartupLimits method, ICLRGCManager interface [.NET Framework hosting]" - "ICLRGCManager::SetGCStartupLimits method [.NET Framework hosting]" -topic_type: +ms.assetid: 1c8d9959-95b5-4131-be4a-556d97774014 +topic_type: - "apiref" --- # ICLRGCManager::SetGCStartupLimits Method -Sets the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0. - +Sets the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0. + > [!IMPORTANT] -> Starting with .NET Framework 4.5, you can set segment size and maximum generation 0 size to values greater than `DWORD` by using the [ICLRGCManager2::SetGCStartupLimitsEx](iclrgcmanager2-setgcstartuplimitsex-method.md) method. - -## Syntax - -```cpp -HRESULT SetGCStartupLimits ( +> Starting with .NET Framework 4.5, you can set segment size and maximum generation 0 size to values greater than `DWORD` by using the [ICLRGCManager2::SetGCStartupLimitsEx](iclrgcmanager2-setgcstartuplimitsex-method.md) method. + +## Syntax + +```cpp +HRESULT SetGCStartupLimits ( [in] DWORD SegmentSize, - [in] DWORD MaxGen0Size -); -``` - -## Parameters - - `SegmentSize` - [in] The specified size of a garbage collection segment. - - The minimum segment size is 4 MB. Segments can be increased in increments of 1 MB or larger. - - `MaxGen0Size` - [in] The specified maximum size for generation 0. - - The minimum generation 0 size is 64 KB. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetGCStartupLimits` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The values that `SetGCStartupLimits` sets can be specified only once. Later calls to `SetGCStartupLimits` are ignored. - -## 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 2.0 - + [in] DWORD MaxGen0Size +); +``` + +## Parameters + + `SegmentSize` + [in] The specified size of a garbage collection segment. + + The minimum segment size is 4 MB. Segments can be increased in increments of 1 MB or larger. + + `MaxGen0Size` + [in] The specified maximum size for generation 0. + + The minimum generation 0 size is 64 KB. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetGCStartupLimits` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The values that `SetGCStartupLimits` sets can be specified only once. Later calls to `SetGCStartupLimits` are ignored. + +## 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 - [Automatic Memory Management](../../../standard/automatic-memory-management.md) diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md b/docs/framework/unmanaged-api/hosting/iclrgcmanager2-interface.md similarity index 61% rename from docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md rename to docs/framework/unmanaged-api/hosting/iclrgcmanager2-interface.md index fa49a97d4da2a..9681bc2892dc7 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager2-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrgcmanager2-interface.md @@ -2,45 +2,46 @@ description: "Learn more about: ICLRGCManager2 Interface" title: "ICLRGCManager2 Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRGCManager2" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRGCManager2" -helpviewer_keywords: +helpviewer_keywords: - "ICLRGCManager2 interface [.NET Framework hosting]" -topic_type: +ms.assetid: 4b5ffd7b-9ad7-41cd-9bba-34030ae3da7e +topic_type: - "apiref" --- # ICLRGCManager2 Interface -Provides methods that allow a host to interact with the common language runtime's garbage collection system. - -## Methods - -|Method|Description| -|------------|-----------------| -|[SetGCStartupLimitsEx Method](iclrgcmanager2-setgcstartuplimitsex-method.md)|Sets the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0. Enables generation 0 and segment sizes larger than `DWORD`.| - -## Remarks - - This interface inherits from the [ICLRGCManager Interface](iclrgcmanager-interface.md). - - The common language runtime (CLR) implements its garbage collection mechanism with the managed type. For more information about the garbage collection system, see [Garbage Collection](../../../standard/garbage-collection/index.md). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] - +Provides methods that allow a host to interact with the common language runtime's garbage collection system. + +## Methods + +|Method|Description| +|------------|-----------------| +|[SetGCStartupLimitsEx Method](iclrgcmanager2-setgcstartuplimitsex-method.md)|Sets the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0. Enables generation 0 and segment sizes larger than `DWORD`.| + +## Remarks + + This interface inherits from the [ICLRGCManager Interface](iclrgcmanager-interface.md). + + The common language runtime (CLR) implements its garbage collection mechanism with the managed type. For more information about the garbage collection system, see [Garbage Collection](../../../standard/garbage-collection/index.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_v45plus](../../../../includes/net-current-v45plus-md.md)] + ## See also - [Automatic Memory Management](../../../standard/automatic-memory-management.md) diff --git a/docs/core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md b/docs/framework/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md similarity index 54% rename from docs/core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md rename to docs/framework/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md index 1f7ae466ef03f..9d8e1ece92928 100644 --- a/docs/core/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrgcmanager2-setgcstartuplimitsex-method.md @@ -2,72 +2,73 @@ description: "Learn more about: ICLRGCManager2::SetGCStartupLimitsEx Method" title: "ICLRGCManager2::SetGCStartupLimitsEx Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRGCManager2.SetGCStartupLimitsEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRGCManager2::SetCLRGCStartupLimitsEx" -helpviewer_keywords: +helpviewer_keywords: - "ICLRGCManager2::SetGCStartupLimitsEx method [.NET Framework hosting]" - "SetGCStartupLimitsEx method, ICLRGCManager2 interface [.NET Framework hosting]" -topic_type: +ms.assetid: 6c3a08a9-5d65-48d4-8bbf-2a86ed7d356a +topic_type: - "apiref" --- # ICLRGCManager2::SetGCStartupLimitsEx Method -Sets the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0. - -## Syntax - -```cpp -HRESULT SetGCStartupLimitsEx ( +Sets the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0. + +## Syntax + +```cpp +HRESULT SetGCStartupLimitsEx ( [in] SIZE_T SegmentSize, - [in] SIZE_T MaxGen0Size -); -``` - -## Parameters - - `SegmentSize` - [in] The specified size of a garbage collection segment. - - The minimum segment size is 4 MB. Segments can be increased in increments of 1 MB or larger. - - `MaxGen0Size` - [in] The specified maximum size for generation 0. - - The minimum generation 0 size is 64 KB. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetGCStartupLimitsEx` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The values that `SetGCStartupLimitsEx` sets can be specified only before the host is started. Later calls to `SetGCStartupLimitsEx` are ignored. - - To set either parameter without affecting the other, specify 0 (zero) for the parameter you don't want to change. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] - + [in] SIZE_T MaxGen0Size +); +``` + +## Parameters + + `SegmentSize` + [in] The specified size of a garbage collection segment. + + The minimum segment size is 4 MB. Segments can be increased in increments of 1 MB or larger. + + `MaxGen0Size` + [in] The specified maximum size for generation 0. + + The minimum generation 0 size is 64 KB. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetGCStartupLimitsEx` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The values that `SetGCStartupLimitsEx` sets can be specified only before the host is started. Later calls to `SetGCStartupLimitsEx` are ignored. + + To set either parameter without affecting the other, specify 0 (zero) for the parameter you don't want to change. + +## 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_v45plus](../../../../includes/net-current-v45plus-md.md)] + ## See also - [Automatic Memory Management](../../../standard/automatic-memory-management.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md b/docs/framework/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md new file mode 100644 index 0000000000000..8c72e0eba30a8 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrhostbindingpolicymanager-evaluatepolicy-method.md @@ -0,0 +1,86 @@ +--- +description: "Learn more about: ICLRHostBindingPolicyManager::EvaluatePolicy Method" +title: "ICLRHostBindingPolicyManager::EvaluatePolicy Method" +ms.date: "03/30/2017" +api_name: + - "ICLRHostBindingPolicyManager.EvaluatePolicy" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRHostBindingPolicyManager::EvaluatePolicy" +helpviewer_keywords: + - "ICLRHostBindingPolicyManager::EvaluatePolicy method [.NET Framework hosting]" + - "EvaluatePolicy method [.NET Framework hosting]" +ms.assetid: 3a3a9446-7a4e-4836-9b27-5c536c15993d +topic_type: + - "apiref" +--- +# ICLRHostBindingPolicyManager::EvaluatePolicy Method + +Evaluates binding policy on behalf of the host. + +## Syntax + +```cpp +HRESULT EvaluatePolicy ( + [in] LPCWSTR pwzReferenceIdentity, + [in] BYTE *pbApplicationPolicy, + [in] DWORD cbAppPolicySize, + [out, size_is(*pcchPostPolicyReferenceIdentity)] LPWSTR pwzPostPolicyReferenceIdentity, + [in, out] DWORD *pcchPostPolicyReferenceIdentity, + [out] DWORD *pdwPoliciesApplied +); +``` + +## Parameters + + `pwzReferenceIdentity` + [in] A reference to the assembly before the policy evaluation. + + `pbApplicationPolicy` + [in] A pointer to a buffer that contains the policy data. + + `cbAppPolicySize` + [in] The size of the `pbApplicationPolicy` buffer. + + `pwzPostPolicyReferenceIdentity` + [out] A reference to the assembly after the evaluation of the new policy data. + + `pcchPostPolicyReferenceIdentity` + [in, out] A pointer to the size of the assembly identity reference buffer after the evaluation of the new policy data. + + `pdwPoliciesApplied` + [out] A pointer to a logical OR combination of [EBindPolicyLevels](ebindpolicylevels-enumeration.md) values, indicating which policies have been applied. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The evaluation completed successfully.| +|E_INVALIDARG|Either `pwzReferenceIdentity` or `pbApplicationPolicy` is a null reference.| +|ERROR_INSUFFICIENT_BUFFER|`cbAppPolicySize` is too small.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The `EvaluatePolicy` method allows the host to influence binding policy to maintain host-specific assembly versioning requirements. The policy engine itself remains inside the CLR. + +## 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 + +- [ICLRHostBindingPolicyManager Interface](iclrhostbindingpolicymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md b/docs/framework/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md similarity index 62% rename from docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md rename to docs/framework/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md index 62bb9b61f041b..35149f9cd0d51 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrhostbindingpolicymanager-interface.md @@ -2,40 +2,41 @@ description: "Learn more about: ICLRHostBindingPolicyManager Interface" title: "ICLRHostBindingPolicyManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRHostBindingPolicyManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRHostBindingPolicyManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLRHostBindingPolicyManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: f9da168b-366b-4b2b-bdb9-330b6bad5a6b +topic_type: - "apiref" --- # ICLRHostBindingPolicyManager Interface -Provides methods for the host to evaluate current binding policy and communicate policy changes for a specified assembly. - -## Methods - -|Method|Description| -|------------|-----------------| -|[EvaluatePolicy Method](iclrhostbindingpolicymanager-evaluatepolicy-method.md)|Evaluates binding policy on behalf of the host.| -|[ModifyApplicationPolicy Method](iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md)|Modifies the binding policy for the specified assembly, and creates a new version of the policy.| - -## 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 2.0 - +Provides methods for the host to evaluate current binding policy and communicate policy changes for a specified assembly. + +## Methods + +|Method|Description| +|------------|-----------------| +|[EvaluatePolicy Method](iclrhostbindingpolicymanager-evaluatepolicy-method.md)|Evaluates binding policy on behalf of the host.| +|[ModifyApplicationPolicy Method](iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md)|Modifies the binding policy for the specified assembly, and creates a new version of the policy.| + +## 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 - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md b/docs/framework/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md similarity index 54% rename from docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md rename to docs/framework/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md index 79cc34935afcf..4d445cad05b2e 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md @@ -2,88 +2,89 @@ description: "Learn more about: ICLRHostBindingPolicyManager::ModifyApplicationPolicy Method" title: "ICLRHostBindingPolicyManager::ModifyApplicationPolicy Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRHostBindingPolicyManager.ModifyApplicationPolicy" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRHostBindingPolicyManager::ModifyApplicationPolicy" -helpviewer_keywords: +helpviewer_keywords: - "ICLRHostBindingPolicyManager::ModifyApplicationPolicy method [.NET Framework hosting]" - "ModifyApplicationPolicy method [.NET Framework hosting]" -topic_type: +ms.assetid: d82d633e-cce6-427c-8b02-8227e34e12ba +topic_type: - "apiref" --- # ICLRHostBindingPolicyManager::ModifyApplicationPolicy Method -Modifies the binding policy for the specified assembly, and creates a new version of the policy. - -## Syntax - -```cpp -HRESULT ModifyApplicationPolicy ( +Modifies the binding policy for the specified assembly, and creates a new version of the policy. + +## Syntax + +```cpp +HRESULT ModifyApplicationPolicy ( [in] LPCWSTR pwzSourceAssemblyIdentity, - [in] LPCWSTR pwzTargetAssemblyIdentity, - [in] BYTE *pbApplicationPolicy, - [in] DWORD cbAppPolicySize, - [in] DWORD dwPolicyModifyFlags, + [in] LPCWSTR pwzTargetAssemblyIdentity, + [in] BYTE *pbApplicationPolicy, + [in] DWORD cbAppPolicySize, + [in] DWORD dwPolicyModifyFlags, [out, size_is(*pcbNewAppPolicySize)] BYTE *pbNewApplicationPolicy, - [in, out] DWORD *pcbNewAppPolicySize -); -``` - -## Parameters - - `pwzSourceAssemblyIdentity` - [in] The identity of the assembly to modify. - - `pwzTargetAssemblyIdentity` - [in] The new identity of the modified assembly. - - `pbApplicationPolicy` - [in] A pointer to a buffer that contains the binding policy data for the assembly to modify. - - `cbAppPolicySize` - [in] The size of the binding policy to be replaced. - - `dwPolicyModifyFlags` - [in] A logical OR combination of [EHostBindingPolicyModifyFlags](ehostbindingpolicymodifyflags-enumeration.md) values, indicating control of redirection. - - `pbNewApplicationPolicy` - [out] A pointer to a buffer that contains the new binding policy data. - - `pcbNewAppPolicySize` - [in, out] A pointer to the size of the new binding policy buffer. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The policy was modified successfully.| -|E_INVALIDARG|`pwzSourceAssemblyIdentity` or `pwzTargetAssemblyIdentity` was a null reference.| -|ERROR_INSUFFICIENT_BUFFER|`pbNewApplicationPolicy` is too small.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The `ModifyApplicationPolicy` method can be called twice. The first call should supply a null value for the `pbNewApplicationPolicy` parameter. This call will return with the necessary value for `pcbNewAppPolicySize`. The second call should supply this value for `pcbNewAppPolicySize`, and point to a buffer of that size for `pbNewApplicationPolicy`. - -## 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 2.0 - + [in, out] DWORD *pcbNewAppPolicySize +); +``` + +## Parameters + + `pwzSourceAssemblyIdentity` + [in] The identity of the assembly to modify. + + `pwzTargetAssemblyIdentity` + [in] The new identity of the modified assembly. + + `pbApplicationPolicy` + [in] A pointer to a buffer that contains the binding policy data for the assembly to modify. + + `cbAppPolicySize` + [in] The size of the binding policy to be replaced. + + `dwPolicyModifyFlags` + [in] A logical OR combination of [EHostBindingPolicyModifyFlags](ehostbindingpolicymodifyflags-enumeration.md) values, indicating control of redirection. + + `pbNewApplicationPolicy` + [out] A pointer to a buffer that contains the new binding policy data. + + `pcbNewAppPolicySize` + [in, out] A pointer to the size of the new binding policy buffer. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The policy was modified successfully.| +|E_INVALIDARG|`pwzSourceAssemblyIdentity` or `pwzTargetAssemblyIdentity` was a null reference.| +|ERROR_INSUFFICIENT_BUFFER|`pbNewApplicationPolicy` is too small.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The `ModifyApplicationPolicy` method can be called twice. The first call should supply a null value for the `pbNewApplicationPolicy` parameter. This call will return with the necessary value for `pcbNewAppPolicySize`. The second call should supply this value for `pcbNewAppPolicySize`, and point to a buffer of that size for `pbNewApplicationPolicy`. + +## 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 - [ICLRHostBindingPolicyManager Interface](iclrhostbindingpolicymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md b/docs/framework/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md similarity index 59% rename from docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md rename to docs/framework/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md index 258eb87f637cb..542e476346a5c 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrhostprotectionmanager-interface.md @@ -2,40 +2,41 @@ description: "Learn more about: ICLRHostProtectionManager Interface" title: "ICLRHostProtectionManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRHostProtectionManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRHostProtectionManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLRHostProtectionManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: ce2770ae-23d0-45d9-8bcf-46504ac5020e +topic_type: - "apiref" --- # ICLRHostProtectionManager Interface -Enables the host to block specific managed classes, methods, properties, and fields from running in partially trusted code. - -## Methods - -|Method|Description| -|------------|-----------------| -|[SetEagerSerializeGrantSets](iclrhostprotectionmanager-seteagerserializegrantsets-method.md)|Provides a guarantee that certain rare race conditions that can cause fatal common language runtime (CLR) errors will never arise.| -|[SetProtectedCategories Method](iclrhostprotectionmanager-setprotectedcategories-method.md)|Specifies the categories of managed types and members that should be blocked from running in partially trusted code.| - -## 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 2.0 - +Enables the host to block specific managed classes, methods, properties, and fields from running in partially trusted code. + +## Methods + +|Method|Description| +|------------|-----------------| +|[SetEagerSerializeGrantSets](iclrhostprotectionmanager-seteagerserializegrantsets-method.md)|Provides a guarantee that certain rare race conditions that can cause fatal common language runtime (CLR) errors will never arise.| +|[SetProtectedCategories Method](iclrhostprotectionmanager-setprotectedcategories-method.md)|Specifies the categories of managed types and members that should be blocked from running in partially trusted code.| + +## 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 - [EApiCategories Enumeration](eapicategories-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md b/docs/framework/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md similarity index 56% rename from docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md rename to docs/framework/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md index 45e77b2f31fbe..ed88817ca18e7 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrhostprotectionmanager-seteagerserializegrantsets-method.md @@ -2,51 +2,52 @@ description: "Learn more about: ICLRHostProtectionManager::SetEagerSerializeGrantSets Method" title: "ICLRHostProtectionManager::SetEagerSerializeGrantSets Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRHostProtectionManager.SetEagerSerializeGrantSets" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRHostProtectionManager::SetEagerSerializeGrantSets" -helpviewer_keywords: +helpviewer_keywords: - "SetEagerSerializeGrantSets method [.NET Framework hosting]" - "ICLRHostProtectionManager::SetEagerSerializeGrantSets method [.NET Framework hosting]" -topic_type: +ms.assetid: d6158360-22b1-4ace-ad85-d830b9964783 +topic_type: - "apiref" --- # ICLRHostProtectionManager::SetEagerSerializeGrantSets Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT SetEagerSerializeGrantSets (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetEagerSerializeGrantSets` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## 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 2.0 - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT SetEagerSerializeGrantSets (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetEagerSerializeGrantSets` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 - [ICLRControl Interface](iclrcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md b/docs/framework/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md similarity index 67% rename from docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md rename to docs/framework/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md index 96ff997fae5f3..2ea84c486fe31 100644 --- a/docs/core/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrhostprotectionmanager-setprotectedcategories-method.md @@ -2,62 +2,63 @@ description: "Learn more about: ICLRHostProtectionManager::SetProtectedCategories Method" title: "ICLRHostProtectionManager::SetProtectedCategories Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRHostProtectionManager.SetProtectedCategories" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRHostProtectionManager::SetProtectedCategories" -helpviewer_keywords: +helpviewer_keywords: - "SetProtectedCategories method [.NET Framework hosting]" - "ICLRHostProtectionManager::SetProtectedCategories method [.NET Framework hosting]" -topic_type: +ms.assetid: fa21dc7b-5da7-440b-b59e-9180e5181f9d +topic_type: - "apiref" --- # ICLRHostProtectionManager::SetProtectedCategories Method -Specifies which categories of managed types and members should be blocked from running in partially trusted code. - -## Syntax - -```cpp -HRESULT SetProtectedCategories ( - [in] EApiCategories categories -); -``` - -## Parameters - - `categories` - [in] A combination of [EApiCategories](eapicategories-enumeration.md) values, indicating which categories of managed types and members should be blocked from running in partially trusted code. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetProtectedCategories` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - Each `EApiCategories` value refers to a list of managed types and members. The `EApiCategories` enumeration and the `SetProtectedCategories` method are directly related to the managed class, which is used to mark managed types and members that expose capabilities corresponding to the categories described by `EApiCategories`. For more information, see and the enumeration, which directly corresponds to `EApiCategories`. - -## 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 2.0 - +Specifies which categories of managed types and members should be blocked from running in partially trusted code. + +## Syntax + +```cpp +HRESULT SetProtectedCategories ( + [in] EApiCategories categories +); +``` + +## Parameters + + `categories` + [in] A combination of [EApiCategories](eapicategories-enumeration.md) values, indicating which categories of managed types and members should be blocked from running in partially trusted code. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetProtectedCategories` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + Each `EApiCategories` value refers to a list of managed types and members. The `EApiCategories` enumeration and the `SetProtectedCategories` method are directly related to the managed class, which is used to mark managed types and members that expose capabilities corresponding to the categories described by `EApiCategories`. For more information, see and the enumeration, which directly corresponds to `EApiCategories`. + +## 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 - diff --git a/docs/core/unmanaged-api/hosting/iclriocompletionmanager-interface.md b/docs/framework/unmanaged-api/hosting/iclriocompletionmanager-interface.md similarity index 63% rename from docs/core/unmanaged-api/hosting/iclriocompletionmanager-interface.md rename to docs/framework/unmanaged-api/hosting/iclriocompletionmanager-interface.md index 7d9526d47fe52..c47bcccee8381 100644 --- a/docs/core/unmanaged-api/hosting/iclriocompletionmanager-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclriocompletionmanager-interface.md @@ -2,43 +2,44 @@ description: "Learn more about: ICLRIoCompletionManager Interface" title: "ICLRIoCompletionManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRIoCompletionManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRIoCompletionManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLRIoCompletionManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: c6c3ace6-e5e7-4450-8cc5-a9a48208c493 +topic_type: - "apiref" --- # ICLRIoCompletionManager Interface -Implements a callback method that allows the host to notify the common language runtime (CLR) of the status of specified I/O requests. - -## Methods - -|Method|Description| -|------------|-----------------| -|[OnComplete Method](iclriocompletionmanager-oncomplete-method.md)|Notifies the CLR of the status of an I/O request that was made by using a call to the [IHostIoCompletionManager::Bind](ihostiocompletionmanager-bind-method.md) method.| - -## Remarks - - The host implements the I/O completion abstraction by using the [IHostIoCompletionManager](ihostiocompletionmanager-interface.md) interface. The CLR makes I/O requests through this interface, and the host notifies the runtime of the outcome of such requests by using the `ICLRIoCompletionManager` interface. - -## 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 2.0 - +Implements a callback method that allows the host to notify the common language runtime (CLR) of the status of specified I/O requests. + +## Methods + +|Method|Description| +|------------|-----------------| +|[OnComplete Method](iclriocompletionmanager-oncomplete-method.md)|Notifies the CLR of the status of an I/O request that was made by using a call to the [IHostIoCompletionManager::Bind](ihostiocompletionmanager-bind-method.md) method.| + +## Remarks + + The host implements the I/O completion abstraction by using the [IHostIoCompletionManager](ihostiocompletionmanager-interface.md) interface. The CLR makes I/O requests through this interface, and the host notifies the runtime of the outcome of such requests by using the `ICLRIoCompletionManager` interface. + +## 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 - [IHostIoCompletionManager Interface](ihostiocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md b/docs/framework/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md rename to docs/framework/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md index 9c201e72c15d3..3472f782f7191 100644 --- a/docs/core/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md +++ b/docs/framework/unmanaged-api/hosting/iclriocompletionmanager-oncomplete-method.md @@ -2,76 +2,77 @@ description: "Learn more about: ICLRIoCompletionManager::OnComplete Method" title: "ICLRIoCompletionManager::OnComplete Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRIoCompletionManager.OnComplete" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRIoCompletionManager::OnComplete" -helpviewer_keywords: +helpviewer_keywords: - "OnComplete method [.NET Framework hosting]" - "ICLRIoCompletionManager::OnComplete method [.NET Framework hosting]" -topic_type: +ms.assetid: 003f6974-9727-4322-bed5-e330d1224d0b +topic_type: - "apiref" --- # ICLRIoCompletionManager::OnComplete Method -Notifies the common language runtime (CLR) of the status of an I/O request that was made by using a call to the [IHostIoCompletionManager::Bind](ihostiocompletionmanager-bind-method.md) method. - -## Syntax - -```cpp -HRESULT OnComplete ( - [in] DWORD dwErrorCode, - [in] DWORD NumberOfBytesTransferred, - [in] void* pvOverlapped -); -``` - -## Parameters - - `dwErrorCode` - [in] An HRESULT value that indicates the status of the bind operation. - -- S_OK indicates that the operation completed successfully. - -- HOST_E_INTERRUPTED indicates that the call terminated before completion. - -- E_FAIL indicates that an unknown, unrecoverable, catastrophic failure occurred. - - `NumberOfBytesTransferred` - [in] The number of bytes transferred during the processing of the I/O request. - - `pvOverlapped` - [in] A pointer to the `OVERLAPPED` structure that was passed to the call to the `IHostIoCompletionManager::Bind` method. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`OnComplete` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - If the host implements an I/O completion abstraction, the CLR makes I/O requests through the host by using methods of [IHostIoCompletionManager](ihostiocompletionmanager-interface.md). The host then calls the `OnComplete` method to notify the runtime of the outcome of such requests. - -## 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 2.0 - +Notifies the common language runtime (CLR) of the status of an I/O request that was made by using a call to the [IHostIoCompletionManager::Bind](ihostiocompletionmanager-bind-method.md) method. + +## Syntax + +```cpp +HRESULT OnComplete ( + [in] DWORD dwErrorCode, + [in] DWORD NumberOfBytesTransferred, + [in] void* pvOverlapped +); +``` + +## Parameters + + `dwErrorCode` + [in] An HRESULT value that indicates the status of the bind operation. + +- S_OK indicates that the operation completed successfully. + +- HOST_E_INTERRUPTED indicates that the call terminated before completion. + +- E_FAIL indicates that an unknown, unrecoverable, catastrophic failure occurred. + + `NumberOfBytesTransferred` + [in] The number of bytes transferred during the processing of the I/O request. + + `pvOverlapped` + [in] A pointer to the `OVERLAPPED` structure that was passed to the call to the `IHostIoCompletionManager::Bind` method. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`OnComplete` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + If the host implements an I/O completion abstraction, the CLR makes I/O requests through the host by using methods of [IHostIoCompletionManager](ihostiocompletionmanager-interface.md). The host then calls the `OnComplete` method to notify the runtime of the outcome of such requests. + +## 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 - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md b/docs/framework/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md similarity index 56% rename from docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md rename to docs/framework/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md index 0479eda5aa45b..6abc883d099a5 100644 --- a/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrmemorynotificationcallback-interface.md @@ -2,43 +2,44 @@ description: "Learn more about: ICLRMemoryNotificationCallback Interface" title: "ICLRMemoryNotificationCallback Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRMemoryNotificationCallback" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRMemoryNotificationCallback" -helpviewer_keywords: +helpviewer_keywords: - "ICLRMemoryNotificationCallback interface [.NET Framework hosting]" -topic_type: +ms.assetid: 873639e2-4837-4568-83b3-4493e67e4174 +topic_type: - "apiref" --- # ICLRMemoryNotificationCallback Interface -Allows the host to report memory pressure conditions using an approach similar to that of the Win32 `CreateMemoryResourceNotification` function. - -## Methods - -|Method|Description| -|------------|-----------------| -|[OnMemoryNotification Method](iclrmemorynotificationcallback-onmemorynotification-method.md)|Notifies the common language runtime (CLR) of the memory load on the computer.| - -## Remarks - - The host uses the `ICLRMemoryNotificationCallback` interface to request that the CLR free memory resources. - -## 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 2.0 - +Allows the host to report memory pressure conditions using an approach similar to that of the Win32 `CreateMemoryResourceNotification` function. + +## Methods + +|Method|Description| +|------------|-----------------| +|[OnMemoryNotification Method](iclrmemorynotificationcallback-onmemorynotification-method.md)|Notifies the common language runtime (CLR) of the memory load on the computer.| + +## Remarks + + The host uses the `ICLRMemoryNotificationCallback` interface to request that the CLR free memory resources. + +## 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 - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md b/docs/framework/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md similarity index 63% rename from docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md rename to docs/framework/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md index a50c2cfd3ea8d..7093a1f5b9c64 100644 --- a/docs/core/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrmemorynotificationcallback-onmemorynotification-method.md @@ -2,65 +2,66 @@ description: "Learn more about: ICLRMemoryNotificationCallback::OnMemoryNotification Method" title: "ICLRMemoryNotificationCallback::OnMemoryNotification Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRMemoryNotificationCallback.OnMemoryNotification" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRMemoryNotificationCallback::OnMemoryNotification" -helpviewer_keywords: +helpviewer_keywords: - "ICLRMemoryNotificationCallback::OnMemoryNotification method [.NET Framework hosting]" - "OnMemoryNotification method [.NET Framework hosting]" -topic_type: +ms.assetid: 5612a44d-56cc-4f34-af31-8c9809ba9431 +topic_type: - "apiref" --- # ICLRMemoryNotificationCallback::OnMemoryNotification Method -Notifies the common language runtime (CLR) of the memory load on the computer. - -## Syntax - -```cpp -HRESULT OnMemoryNotification ( - [in] EMemoryAvailable eMemoryAvailable -); -``` - -## Parameters - - `eMemoryAvailable` - [in] One of the [EMemoryAvailable](ememoryavailable-enumeration.md) values, indicating the memory pressure the computer is currently experiencing. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`OnMemoryNotification` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR registers a callback to `OnMemoryNotification` by using a call to the [IHostMemoryManager::RegisterMemoryNotificationCallback](ihostmemorymanager-registermemorynotificationcallback-method.md) method. The runtime uses the information returned in the callback to free additional memory when the host reports that memory resources are running low. - +Notifies the common language runtime (CLR) of the memory load on the computer. + +## Syntax + +```cpp +HRESULT OnMemoryNotification ( + [in] EMemoryAvailable eMemoryAvailable +); +``` + +## Parameters + + `eMemoryAvailable` + [in] One of the [EMemoryAvailable](ememoryavailable-enumeration.md) values, indicating the memory pressure the computer is currently experiencing. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`OnMemoryNotification` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR registers a callback to `OnMemoryNotification` by using a call to the [IHostMemoryManager::RegisterMemoryNotificationCallback](ihostmemorymanager-registermemorynotificationcallback-method.md) method. The runtime uses the information returned in the callback to free additional memory when the host reports that memory resources are running low. + > [!NOTE] -> Calls to `OnMemoryNotification` never block. They always return immediately. - -## 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 2.0 - +> Calls to `OnMemoryNotification` never block. They always return immediately. + +## 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 - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md b/docs/framework/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md new file mode 100644 index 0000000000000..06189c6791235 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrmetahost-enumerateinstalledruntimes-method.md @@ -0,0 +1,58 @@ +--- +description: "Learn more about: ICLRMetaHost::EnumerateInstalledRuntimes Method" +title: "ICLRMetaHost::EnumerateInstalledRuntimes Method" +ms.date: "03/30/2017" +api_name: + - "ICLRMetaHost.EnumerateInstalledRuntimes" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRMetaHost::EnumerateInstalledRuntimes" +helpviewer_keywords: + - "ICLRMetaHost::EnumerateInstalledRuntimes method [.NET Framework hosting]" + - "EnumerateInstalledRuntimes method [.NET Framework hosting]" +ms.assetid: 9e359384-0d3d-451c-807e-5d7fcebf2be7 +topic_type: + - "apiref" +--- +# ICLRMetaHost::EnumerateInstalledRuntimes Method + +Returns an enumeration that contains a valid [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface for each version of the common language runtime (CLR) that is installed on a computer. + +## Syntax + +```cpp +HRESULT EnumerateInstalledRuntimes ( + [out, retval] IEnumUnknown **ppEnumerator); +``` + +## Parameters + + `ppEnumerator` + [out] An enumeration of [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interfaces corresponding to each version of the CLR that is installed on the computer. + +## 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|`ppEnumerator` is null.| + +## 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 + +- [ICLRMetaHost Interface](iclrmetahost-interface.md) +- [Hosting](index.md) diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md b/docs/framework/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md similarity index 54% rename from docs/core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md rename to docs/framework/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md index f9b25765de6b0..879ed8a875f22 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrmetahost-enumerateloadedruntimes-method.md @@ -2,64 +2,65 @@ description: "Learn more about: ICLRMetaHost::EnumerateLoadedRuntimes Method" title: "ICLRMetaHost::EnumerateLoadedRuntimes Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRMetaHost.EnumerateLoadedRuntimes" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRMetaHost::EnumerateLoadedRuntimes" -helpviewer_keywords: +helpviewer_keywords: - "EnumerateLoadedRuntimes method [.NET Framework hosting]" - "ICLRMetaHost::EnumerateLoadedRuntimes method [.NET Framework hosting]" -topic_type: +ms.assetid: 22fc0a3f-dce4-4766-9a3c-9fab15f4b4ca +topic_type: - "apiref" --- # ICLRMetaHost::EnumerateLoadedRuntimes Method -Returns an enumeration that includes a valid [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface pointer for each version of the common language runtime (CLR) that is loaded in a given process. This method supersedes the [GetVersionFromProcess](getversionfromprocess-function.md) function. - -## Syntax - -```cpp -HRESULT EnumerateLoadedRuntimes ( - [in] HANDLE hndProcess, - [out, retval] IEnumUnknown **ppEnumerator -); -``` - -## Parameters - - `hndProcess` - [in] The handle of the process to inspect for loaded runtimes. - - `ppEnumerator` - [out] An enumeration of [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interfaces corresponding to each CLR that is loaded by the process. - -## 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|`ppEnumerator` is null.| - -## Remarks - - This method is lists all loaded runtimes, even if they were loaded with deprecated functions such as [CorBindToRuntime](corbindtoruntime-function.md). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Returns an enumeration that includes a valid [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface pointer for each version of the common language runtime (CLR) that is loaded in a given process. This method supersedes the [GetVersionFromProcess](getversionfromprocess-function.md) function. + +## Syntax + +```cpp +HRESULT EnumerateLoadedRuntimes ( + [in] HANDLE hndProcess, + [out, retval] IEnumUnknown **ppEnumerator +); +``` + +## Parameters + + `hndProcess` + [in] The handle of the process to inspect for loaded runtimes. + + `ppEnumerator` + [out] An enumeration of [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interfaces corresponding to each CLR that is loaded by the process. + +## 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|`ppEnumerator` is null.| + +## Remarks + + This method is lists all loaded runtimes, even if they were loaded with deprecated functions such as [CorBindToRuntime](corbindtoruntime-function.md). + +## 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 - [ICLRMetaHost Interface](iclrmetahost-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md b/docs/framework/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md new file mode 100644 index 0000000000000..f87caae04a184 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrmetahost-exitprocess-method.md @@ -0,0 +1,55 @@ +--- +description: "Learn more about: ICLRMetaHost::ExitProcess Method" +title: "ICLRMetaHost::ExitProcess Method" +ms.date: "03/30/2017" +api_name: + - "ICLRMetaHost.ExitProcess" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRMetaHost::ExitProcess" +helpviewer_keywords: + - "ICLRMetaHost::ExitProcess method [.NET Framework hosting]" + - "ExitProcess method, ICLRMetaHost interface [.NET Framework hosting]" +ms.assetid: b4df98cc-4e4e-407b-b8f4-e0076afef3a4 +topic_type: + - "apiref" +--- +# ICLRMetaHost::ExitProcess Method + +Attempts to shut down all loaded runtimes gracefully and then terminates the process. Supersedes the [CorExitProcess](corexitprocess-function.md) function. + +## Syntax + +```cpp +HRESULT ExitProcess ( + [in] INT32 iExitCode); +``` + +## Parameters + + `iExitCode` + [in] The exit code for the process. + +## Return Value + + This method never returns, so its return value is undefined. + +## Remarks + +## 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 + +- [ICLRMetaHost Interface](iclrmetahost-interface.md) +- [Hosting](index.md) diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md b/docs/framework/unmanaged-api/hosting/iclrmetahost-getruntime-method.md similarity index 62% rename from docs/core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md rename to docs/framework/unmanaged-api/hosting/iclrmetahost-getruntime-method.md index 7ea076b68261c..23b0457950a2d 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrmetahost-getruntime-method.md @@ -2,73 +2,74 @@ description: "Learn more about: ICLRMetaHost::GetRuntime Method" title: "ICLRMetaHost::GetRuntime Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRMetaHost.GetRuntime" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRMetaHost::GetRuntime" -helpviewer_keywords: +helpviewer_keywords: - "GetRuntime method [.NET Framework hosting]" - "ICLRMetaHost::GetRuntime method [.NET Framework hosting]" -topic_type: +ms.assetid: a10749f1-ab91-47cf-982f-d8ccd2e81bd2 +topic_type: - "apiref" --- # ICLRMetaHost::GetRuntime Method -Gets the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface that corresponds to a particular version of the common language runtime (CLR). This method supersedes the [CorBindToRuntimeEx](corbindtoruntimeex-function.md) function used with the [STARTUP_LOADER_SAFEMODE](startup-flags-enumeration.md) flag. - -## Syntax - -```cpp -HRESULT GetRuntime ( - [in] LPCWSTR pwzVersion, - [in] REFIID riid, - [out,iid_is(riid), retval] LPVOID *ppRuntime -); -``` - -## Parameters - - `pwzVersion` - [in] The .NET Framework compilation version stored in the metadata, in the format "v*A*.*B*[.*X*]". *A*, *B*, and *X* are decimal numbers that correspond to the major version, the minor version, and the build number. - +Gets the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface that corresponds to a particular version of the common language runtime (CLR). This method supersedes the [CorBindToRuntimeEx](corbindtoruntimeex-function.md) function used with the [STARTUP_LOADER_SAFEMODE](startup-flags-enumeration.md) flag. + +## Syntax + +```cpp +HRESULT GetRuntime ( + [in] LPCWSTR pwzVersion, + [in] REFIID riid, + [out,iid_is(riid), retval] LPVOID *ppRuntime +); +``` + +## Parameters + + `pwzVersion` + [in] The .NET Framework compilation version stored in the metadata, in the format "v*A*.*B*[.*X*]". *A*, *B*, and *X* are decimal numbers that correspond to the major version, the minor version, and the build number. + > [!NOTE] -> This parameter must match the directory name for the .NET Framework version, as it appears under C:\Windows\Microsoft.NET\Framework or C:\Windows\Microsoft.NET\Framework64. - - Example values are "v1.0.3705", "v1.1.4322", "v2.0.50727", and "v4.0.*X*", where *X* depends on the build number installed. The "v" prefix is required. - - `riid` - [in] The identifier for the desired interface. Currently, the only valid value for this parameter is IID_ICLRRuntimeInfo. - - `ppRuntime` - [out] A pointer to the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface that corresponds to the requested runtime. - -## 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|`pwzVersion` or `ppRuntime` is null.| - -## Remarks - - This method interacts consistently with legacy interfaces such as the [ICorRuntimeHost](icorruntimehost-interface.md) interface and legacy functions such as the deprecated `CorBindTo*` functions (see [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) in the .NET Framework 2.0 hosting API). That is, runtimes that are loaded with the legacy API are visible to the new API, and runtimes that are loaded with the new API are visible to the legacy API. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +> This parameter must match the directory name for the .NET Framework version, as it appears under C:\Windows\Microsoft.NET\Framework or C:\Windows\Microsoft.NET\Framework64. + + Example values are "v1.0.3705", "v1.1.4322", "v2.0.50727", and "v4.0.*X*", where *X* depends on the build number installed. The "v" prefix is required. + + `riid` + [in] The identifier for the desired interface. Currently, the only valid value for this parameter is IID_ICLRRuntimeInfo. + + `ppRuntime` + [out] A pointer to the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface that corresponds to the requested runtime. + +## 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|`pwzVersion` or `ppRuntime` is null.| + +## Remarks + + This method interacts consistently with legacy interfaces such as the [ICorRuntimeHost](icorruntimehost-interface.md) interface and legacy functions such as the deprecated `CorBindTo*` functions (see [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) in the .NET Framework 2.0 hosting API). That is, runtimes that are loaded with the legacy API are visible to the new API, and runtimes that are loaded with the new API are visible to the legacy API. + +## 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 - [ICLRMetaHost Interface](iclrmetahost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md b/docs/framework/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md similarity index 52% rename from docs/core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md rename to docs/framework/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md index fcc7682cc3cc7..719207f82e8dc 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrmetahost-getversionfromfile-method.md @@ -2,70 +2,71 @@ description: "Learn more about: ICLRMetaHost::GetVersionFromFile Method" title: "ICLRMetaHost::GetVersionFromFile Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRMetaHost.GetVersionFromFile" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRMetaHost::GetVersionFromFile" -helpviewer_keywords: +helpviewer_keywords: - "ICLRMetaHost::GetVersionFromFile method [.NET Framework hosting]" - "GetVersionFromFile method [.NET Framework hosting]" -topic_type: +ms.assetid: 55bb3eb4-f665-42fc-973c-465567570e82 +topic_type: - "apiref" --- # ICLRMetaHost::GetVersionFromFile Method -Gets an assembly's original .NET Framework compilation version (stored in the metadata), given its file path. This method supersedes the [GetFileVersion](getfileversion-function.md) function. - -## Syntax - -```cpp -HRESULT GetVersionFromFile ( - [in] LPCWSTR pwzFilePath, - [out, size_is(*pcchBuffer)] LPWSTR pwzBuffer, - [in, out] DWORD *pcchBuffer); -); -``` - -## Parameters - - `pwzFilePath` - [in] The complete assembly file path. - - `pwzbuffer` - [out] The .NET Framework compilation version stored in the metadata, in the format "v*A*.*B*[.*X*]". *A*, *B*, and *X* are decimal numbers that correspond to the major version, the minor version, and the build number. The length of this string is limited to MAX_PATH. - +Gets an assembly's original .NET Framework compilation version (stored in the metadata), given its file path. This method supersedes the [GetFileVersion](getfileversion-function.md) function. + +## Syntax + +```cpp +HRESULT GetVersionFromFile ( + [in] LPCWSTR pwzFilePath, + [out, size_is(*pcchBuffer)] LPWSTR pwzBuffer, + [in, out] DWORD *pcchBuffer); +); +``` + +## Parameters + + `pwzFilePath` + [in] The complete assembly file path. + + `pwzbuffer` + [out] The .NET Framework compilation version stored in the metadata, in the format "v*A*.*B*[.*X*]". *A*, *B*, and *X* are decimal numbers that correspond to the major version, the minor version, and the build number. The length of this string is limited to MAX_PATH. + > [!NOTE] -> This output matches the directory name for the .NET Framework version, as it appears under C:\Windows\Microsoft.NET\Framework. - - Example values are "v1.0.3705", "v1.1.4322", "v2.0.50727", and "v4.0.*X*", where *X* depends on the build number installed. Note that the "v" prefix is required. - - `pcchBuffer` - [in, out] The size of `pwzbuffer` to avoid buffer overruns. - -## 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|`pwzbuffer` or `pcchBuffer` is null.| -|HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)|The buffer is too small.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +> This output matches the directory name for the .NET Framework version, as it appears under C:\Windows\Microsoft.NET\Framework. + + Example values are "v1.0.3705", "v1.1.4322", "v2.0.50727", and "v4.0.*X*", where *X* depends on the build number installed. Note that the "v" prefix is required. + + `pcchBuffer` + [in, out] The size of `pwzbuffer` to avoid buffer overruns. + +## 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|`pwzbuffer` or `pcchBuffer` is null.| +|HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)|The buffer is too small.| + +## 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 - [ICLRMetaHost Interface](iclrmetahost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-interface.md b/docs/framework/unmanaged-api/hosting/iclrmetahost-interface.md similarity index 67% rename from docs/core/unmanaged-api/hosting/iclrmetahost-interface.md rename to docs/framework/unmanaged-api/hosting/iclrmetahost-interface.md index 93b28f9c4be14..4aab578cdebae 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrmetahost-interface.md @@ -2,55 +2,56 @@ description: "Learn more about: ICLRMetaHost Interface" title: "ICLRMetaHost Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRMetaHost" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRMetaHost" -helpviewer_keywords: +helpviewer_keywords: - "ICLRMetaHost interface [.NET Framework hosting]" -topic_type: +ms.assetid: c627fcdd-fc4f-4b1c-8e91-df8536f627d8 +topic_type: - "apiref" --- # ICLRMetaHost Interface -Provides methods that return a specific version of the common language runtime (CLR) based on its version number, list all installed CLRs, list all runtimes that are loaded in a specified process, discover the CLR version used to compile an assembly, exit a process with a clean runtime shutdown, and query legacy API binding. - -## Methods - -|Method|Description| -|------------|-----------------| -|[EnumerateInstalledRuntimes Method](iclrmetahost-enumerateinstalledruntimes-method.md)|Returns an enumeration that contains a valid [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface pointer for each CLR version that is installed on a computer.| -|[EnumerateLoadedRuntimes Method](iclrmetahost-enumerateloadedruntimes-method.md)|Returns an enumeration that contains a valid [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface pointer for each CLR that is loaded in a given process. This method supersedes [GetVersionFromProcess](getversionfromprocess-function.md).| -|[ExitProcess Method](iclrmetahost-exitprocess-method.md)|Attempts to shut down all loaded runtimes gracefully and then terminates the process. Supersedes the [CorExitProcess](corexitprocess-function.md) function.| -|[GetRuntime Method](iclrmetahost-getruntime-method.md)|Gets the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface that corresponds to a particular CLR version. This method supersedes the [CorBindToRuntimeEx](corbindtoruntimeex-function.md) function used with the [STARTUP_LOADER_SAFEMODE](startup-flags-enumeration.md) flag.| -|[GetVersionFromFile Method](iclrmetahost-getversionfromfile-method.md)|Gets the assembly's original .NET Framework compilation version (stored in the metadata), given its file path. This method supersedes [GetFileVersion](getfileversion-function.md).| -|[QueryLegacyV2RuntimeBinding Method](iclrmetahost-querylegacyv2runtimebinding-method.md)|Returns an interface that represents a runtime to which legacy activation policy has been bound, for example by using the `useLegacyV2RuntimeActivationPolicy` attribute on the [\ Element](../../../framework/configure-apps/file-schema/startup/startup-element.md) configuration file entry, by direct use of the legacy activation APIs, or by calling the [ICLRRuntimeInfo::BindAsLegacyV2Runtime](iclrruntimeinfo-bindaslegacyv2runtime-method.md) method.| -|[RequestRuntimeLoadedNotification Method](iclrmetahost-requestruntimeloadednotification-method.md)|Guarantees a callback to the specified function pointer when a CLR version is first loaded, but not yet started. This method supersedes [LockClrVersion](lockclrversion-function.md)| - -## Remarks - - The only way to get an instance of this interface is by calling the [CLRCreateInstance](clrcreateinstance-function.md) function as follows: - -```cpp -ICLRMetaHost *pMetaHost = NULL; -HRESULT hr = CLRCreateInstance(CLSID_CLRMetaHost, - IID_ICLRMetaHost, (LPVOID*)&pMetaHost); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Provides methods that return a specific version of the common language runtime (CLR) based on its version number, list all installed CLRs, list all runtimes that are loaded in a specified process, discover the CLR version used to compile an assembly, exit a process with a clean runtime shutdown, and query legacy API binding. + +## Methods + +|Method|Description| +|------------|-----------------| +|[EnumerateInstalledRuntimes Method](iclrmetahost-enumerateinstalledruntimes-method.md)|Returns an enumeration that contains a valid [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface pointer for each CLR version that is installed on a computer.| +|[EnumerateLoadedRuntimes Method](iclrmetahost-enumerateloadedruntimes-method.md)|Returns an enumeration that contains a valid [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface pointer for each CLR that is loaded in a given process. This method supersedes [GetVersionFromProcess](getversionfromprocess-function.md).| +|[ExitProcess Method](iclrmetahost-exitprocess-method.md)|Attempts to shut down all loaded runtimes gracefully and then terminates the process. Supersedes the [CorExitProcess](corexitprocess-function.md) function.| +|[GetRuntime Method](iclrmetahost-getruntime-method.md)|Gets the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface that corresponds to a particular CLR version. This method supersedes the [CorBindToRuntimeEx](corbindtoruntimeex-function.md) function used with the [STARTUP_LOADER_SAFEMODE](startup-flags-enumeration.md) flag.| +|[GetVersionFromFile Method](iclrmetahost-getversionfromfile-method.md)|Gets the assembly's original .NET Framework compilation version (stored in the metadata), given its file path. This method supersedes [GetFileVersion](getfileversion-function.md).| +|[QueryLegacyV2RuntimeBinding Method](iclrmetahost-querylegacyv2runtimebinding-method.md)|Returns an interface that represents a runtime to which legacy activation policy has been bound, for example by using the `useLegacyV2RuntimeActivationPolicy` attribute on the [\ Element](../../configure-apps/file-schema/startup/startup-element.md) configuration file entry, by direct use of the legacy activation APIs, or by calling the [ICLRRuntimeInfo::BindAsLegacyV2Runtime](iclrruntimeinfo-bindaslegacyv2runtime-method.md) method.| +|[RequestRuntimeLoadedNotification Method](iclrmetahost-requestruntimeloadednotification-method.md)|Guarantees a callback to the specified function pointer when a CLR version is first loaded, but not yet started. This method supersedes [LockClrVersion](lockclrversion-function.md)| + +## Remarks + + The only way to get an instance of this interface is by calling the [CLRCreateInstance](clrcreateinstance-function.md) function as follows: + +```cpp +ICLRMetaHost *pMetaHost = NULL; +HRESULT hr = CLRCreateInstance(CLSID_CLRMetaHost, + IID_ICLRMetaHost, (LPVOID*)&pMetaHost); +``` + +## 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/core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md b/docs/framework/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md similarity index 54% rename from docs/core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md rename to docs/framework/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md index 6fba601d74307..d3fcf10076862 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrmetahost-querylegacyv2runtimebinding-method.md @@ -2,62 +2,63 @@ description: "Learn more about: ICLRMetaHost::QueryLegacyV2RuntimeBinding Method" title: "ICLRMetaHost::QueryLegacyV2RuntimeBinding Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRMetaHost.RequestRuntimeLoadedNotification" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRMetaHost::QueryLegacyV2RuntimeBinding" -helpviewer_keywords: +helpviewer_keywords: - "QueryLegacyV2RuntimeBinding method [.NET Framework hosting]" - "ICLRMetaHost::QueryLegacyV2RuntimeBinding method [.NET Framework hosting]" -topic_type: +ms.assetid: 9929817e-acc9-40b7-960c-598664e04b60 +topic_type: - "apiref" --- # ICLRMetaHost::QueryLegacyV2RuntimeBinding Method -Returns an interface that represents a runtime to which legacy activation policy has been bound, for example, by using the `useLegacyV2RuntimeActivationPolicy` attribute on the [\ element](../../../framework/configure-apps/file-schema/startup/startup-element.md) configuration file entry, by direct use of the legacy activation APIs, or by calling the [ICLRRuntimeInfo::BindAsLegacyV2Runtime](iclrruntimeinfo-bindaslegacyv2runtime-method.md) method. - -## Syntax - -```cpp -HRESULT QueryLegacyV2RuntimeBinding ( - [in] REFIID riid, - [out, iid_is(riid), retval] LPVOID *ppUnk); -``` - -## Parameters - - `riid` - [in] Required.Currently the only valid value for this parameter is `IID_ICLRRuntimeInfo`. - - `ppUnk` - [out] Required. When this method returns, contains a pointer to the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface that represents a runtime that has been bound to legacy activation policy. - -## 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 and returned a runtime that was bound to legacy activation policy.| -|S_FALSE|The method completed successfully, but a legacy runtime has not yet been bound.| -|E_NOINTERFACE|The method found a runtime that was bound to legacy activation policy, but `riid` is not supported by that runtime.| - -## Remarks - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Returns an interface that represents a runtime to which legacy activation policy has been bound, for example, by using the `useLegacyV2RuntimeActivationPolicy` attribute on the [\ element](../../configure-apps/file-schema/startup/startup-element.md) configuration file entry, by direct use of the legacy activation APIs, or by calling the [ICLRRuntimeInfo::BindAsLegacyV2Runtime](iclrruntimeinfo-bindaslegacyv2runtime-method.md) method. + +## Syntax + +```cpp +HRESULT QueryLegacyV2RuntimeBinding ( + [in] REFIID riid, + [out, iid_is(riid), retval] LPVOID *ppUnk); +``` + +## Parameters + + `riid` + [in] Required.Currently the only valid value for this parameter is `IID_ICLRRuntimeInfo`. + + `ppUnk` + [out] Required. When this method returns, contains a pointer to the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface that represents a runtime that has been bound to legacy activation policy. + +## 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 and returned a runtime that was bound to legacy activation policy.| +|S_FALSE|The method completed successfully, but a legacy runtime has not yet been bound.| +|E_NOINTERFACE|The method found a runtime that was bound to legacy activation policy, but `riid` is not supported by that runtime.| + +## Remarks + +## 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 - [ICLRMetaHost Interface](iclrmetahost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md b/docs/framework/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md similarity index 53% rename from docs/core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md rename to docs/framework/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md index eb0207f962bfd..13729e2ce2dd9 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrmetahost-requestruntimeloadednotification-method.md @@ -2,99 +2,100 @@ description: "Learn more about: ICLRMetaHost::RequestRuntimeLoadedNotification Method" title: "ICLRMetaHost::RequestRuntimeLoadedNotification Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRMetaHost.RequestRuntimeLoadedNotification" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRMetaHost::RequestRuntimeLoadedNotification" -helpviewer_keywords: +helpviewer_keywords: - "RequestRuntimeLoadedNotification method [.NET Framework hosting]" - "ICLRMetaHost::RequestRuntimeLoadedNotification method [.NET Framework hosting]" -topic_type: +ms.assetid: 0d5ccc4d-0193-41f5-af54-45d7b70d5321 +topic_type: - "apiref" --- # ICLRMetaHost::RequestRuntimeLoadedNotification Method -Provides a callback function that is guaranteed to be called when a common language runtime (CLR) version is first loaded, but not yet started. This method supersedes the [LockClrVersion](lockclrversion-function.md) function. - -## Syntax - -```cpp -HRESULT RequestRuntimeLoadedNotification ( - [in] RuntimeLoadedCallbackFnPtr pCallbackFunction); -``` - -## Parameters - - `pCallbackFunction` - [in] The callback function that is invoked when a new runtime has been loaded. - -## 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|`pCallbackFunction` is null.| - -## Remarks - - The callback works in the following way: - -- The callback is invoked only when a runtime is loaded for the first time. - -- The callback is not invoked for reentrant loads of the same runtime. - -- For non-reentrant runtime loads, calls to the callback function are serialized. - - The callback function has the following prototype: - -```cpp -typedef void (__stdcall *RuntimeLoadedCallbackFnPtr)( - ICLRRuntimeInfo *pRuntimeInfo, - CallbackThreadSetFnPtr pfnCallbackThreadSet, - CallbackThreadUnsetFnPtr pfnCallbackThreadUnset); -``` - - The callback function prototypes are as follows: - -- `pfnCallbackThreadSet`: - - ```cpp - typedef HRESULT (__stdcall *CallbackThreadSetFnPtr)(); - ``` - -- `pfnCallbackThreadUnset`: - - ```cpp - typedef HRESULT (__stdcall *CallbackThreadUnsetFnPtr)(); - ``` - - If the host intends to load or cause another runtime to be loaded in a reentrant manner, the `pfnCallbackThreadSet` and `pfnCallbackThreadUnset` parameters that are provided in the callback function must be used in the following way: - -- `pfnCallbackThreadSet` must be called by the thread that might cause a runtime load before such a load is attempted. - -- `pfnCallbackThreadUnset` must be called when the thread will no longer cause such a runtime load (and before returning from the initial callback). - -- `pfnCallbackThreadSet` and `pfnCallbackThreadUnset` are both non-reentrant. - +Provides a callback function that is guaranteed to be called when a common language runtime (CLR) version is first loaded, but not yet started. This method supersedes the [LockClrVersion](lockclrversion-function.md) function. + +## Syntax + +```cpp +HRESULT RequestRuntimeLoadedNotification ( + [in] RuntimeLoadedCallbackFnPtr pCallbackFunction); +``` + +## Parameters + + `pCallbackFunction` + [in] The callback function that is invoked when a new runtime has been loaded. + +## 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|`pCallbackFunction` is null.| + +## Remarks + + The callback works in the following way: + +- The callback is invoked only when a runtime is loaded for the first time. + +- The callback is not invoked for reentrant loads of the same runtime. + +- For non-reentrant runtime loads, calls to the callback function are serialized. + + The callback function has the following prototype: + +```cpp +typedef void (__stdcall *RuntimeLoadedCallbackFnPtr)( + ICLRRuntimeInfo *pRuntimeInfo, + CallbackThreadSetFnPtr pfnCallbackThreadSet, + CallbackThreadUnsetFnPtr pfnCallbackThreadUnset); +``` + + The callback function prototypes are as follows: + +- `pfnCallbackThreadSet`: + + ```cpp + typedef HRESULT (__stdcall *CallbackThreadSetFnPtr)(); + ``` + +- `pfnCallbackThreadUnset`: + + ```cpp + typedef HRESULT (__stdcall *CallbackThreadUnsetFnPtr)(); + ``` + + If the host intends to load or cause another runtime to be loaded in a reentrant manner, the `pfnCallbackThreadSet` and `pfnCallbackThreadUnset` parameters that are provided in the callback function must be used in the following way: + +- `pfnCallbackThreadSet` must be called by the thread that might cause a runtime load before such a load is attempted. + +- `pfnCallbackThreadUnset` must be called when the thread will no longer cause such a runtime load (and before returning from the initial callback). + +- `pfnCallbackThreadSet` and `pfnCallbackThreadUnset` are both non-reentrant. + > [!NOTE] -> Host applications must not call `pfnCallbackThreadSet` and `pfnCallbackThreadUnset` outside the scope of the `pCallbackFunction` parameter. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +> Host applications must not call `pfnCallbackThreadSet` and `pfnCallbackThreadUnset` outside the scope of the `pCallbackFunction` parameter. + +## 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 - [ICLRMetaHost Interface](iclrmetahost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md b/docs/framework/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md similarity index 90% rename from docs/core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md rename to docs/framework/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md index 700dd4e653765..7056b85fde9fd 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md @@ -13,6 +13,7 @@ f1_keywords: helpviewer_keywords: - "GetRequestedRuntime method [.NET Framework hosting]" - "ICLRMetaHostPolicy::GetRequestedRuntime method [.NET Framework hosting]" +ms.assetid: 59ec1832-9cc1-4b5c-983d-03407e51de56 topic_type: - "apiref" --- @@ -48,7 +49,7 @@ HRESULT GetRequestedRuntime( |`pcchVersion`|[in, out] Required. Specifies the expected size of `pwzVersion` as input, to avoid buffer overruns. If `pwzVersion` is null, `pcchVersion` contains the expected size of `pwzVersion` when `GetRequestedRuntime` returns, to allow pre-allocation; otherwise, `pcchVersion` contains the number of characters written to `pwzVersion`.| |`pwzImageVersion`|[out] Optional. When `GetRequestedRuntime` returns, contains the CLR version corresponding to the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface that is returned.| |`pcchImageVersion`|[in, out] Optional. Specifies the size of `pwzImageVersion` as input to avoid buffer overruns. If `pwzImageVersion` is null, `pcchImageVersion` contains the required size of `pwzImageVersion` when `GetRequestedRuntime` returns, to allow pre-allocation.| -|`pdwConfigFlags`|[out] Optional. If `GetRequestedRuntime` uses a configuration file during the binding process, when it returns, `pdwConfigFlags` contains a [METAHOST_CONFIG_FLAGS](metahost-config-flags-enumeration.md) value that indicates whether the [\](../../../framework/configure-apps/file-schema/startup/startup-element.md) element has the `useLegacyV2RuntimeActivationPolicy` attribute set, and the value of the attribute. Apply the [METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_MASK](metahost-config-flags-enumeration.md) mask to `pdwConfigFlags` to get the values relevant to `useLegacyV2RuntimeActivationPolicy`.| +|`pdwConfigFlags`|[out] Optional. If `GetRequestedRuntime` uses a configuration file during the binding process, when it returns, `pdwConfigFlags` contains a [METAHOST_CONFIG_FLAGS](metahost-config-flags-enumeration.md) value that indicates whether the [\](../../configure-apps/file-schema/startup/startup-element.md) element has the `useLegacyV2RuntimeActivationPolicy` attribute set, and the value of the attribute. Apply the [METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_MASK](metahost-config-flags-enumeration.md) mask to `pdwConfigFlags` to get the values relevant to `useLegacyV2RuntimeActivationPolicy`.| |`riid`|[in] Specifies the interface identifier IID_ICLRRuntimeInfo for the requested [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface.| |`ppRuntime`|[out] When `GetRequestedRuntime` returns, contains a pointer to the corresponding [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface.| @@ -78,13 +79,13 @@ This method returns the following specific HRESULTs as well as HRESULT errors th ## Requirements -**Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../get-started/system-requirements.md). **Header:** MetaHost.h **Library:** Included as a resource in MSCorEE.dll -**.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] +**.NET Framework Versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] ## See also diff --git a/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md b/docs/framework/unmanaged-api/hosting/iclrmetahostpolicy-interface.md similarity index 65% rename from docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md rename to docs/framework/unmanaged-api/hosting/iclrmetahostpolicy-interface.md index 37259c3672086..77fe3dc9f0be5 100644 --- a/docs/core/unmanaged-api/hosting/iclrmetahostpolicy-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrmetahostpolicy-interface.md @@ -2,54 +2,55 @@ description: "Learn more about: ICLRMetaHostPolicy Interface" title: "ICLRMetaHostPolicy Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRMetaHostPolicy" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRMetaHostPolicy" -helpviewer_keywords: +helpviewer_keywords: - "ICLRMetaHostPolicy interface [.NET Framework hosting]" -topic_type: +ms.assetid: 1bdeccb6-0698-4c97-ad69-eae2b69e59f1 +topic_type: - "apiref" --- # ICLRMetaHostPolicy Interface -Provides the [GetRequestedRuntime](iclrmetahostpolicy-getrequestedruntime-method.md) method, which returns a pointer to a common language runtime (CLR) interface based on a policy criteria, managed assembly, version and configuration file. - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetRequestedRuntime Method](iclrmetahostpolicy-getrequestedruntime-method.md)|Provides a preferred CLR interface based on a policy criteria, managed assembly, version, and configuration file.| - -## Remarks - - You can get a reference to this interface by calling the [CLRCreateInstance](clrcreateinstance-function.md) function as shown in the following code: - -```cpp -ICLRMetaHostPolicy *pMetaHostPolicy = NULL; -HRESULT hr = CLRCreateInstance(CLSID_CLRMetaHostPolicy, - IID_ICLRMetaHostPolicy, (LPVOID*)&pMetaHostPolicy); -``` - +Provides the [GetRequestedRuntime](iclrmetahostpolicy-getrequestedruntime-method.md) method, which returns a pointer to a common language runtime (CLR) interface based on a policy criteria, managed assembly, version and configuration file. + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetRequestedRuntime Method](iclrmetahostpolicy-getrequestedruntime-method.md)|Provides a preferred CLR interface based on a policy criteria, managed assembly, version, and configuration file.| + +## Remarks + + You can get a reference to this interface by calling the [CLRCreateInstance](clrcreateinstance-function.md) function as shown in the following code: + +```cpp +ICLRMetaHostPolicy *pMetaHostPolicy = NULL; +HRESULT hr = CLRCreateInstance(CLSID_CLRMetaHostPolicy, + IID_ICLRMetaHostPolicy, (LPVOID*)&pMetaHostPolicy); +``` + > [!NOTE] -> This interface does not actually load or activate the CLR, but simply returns the preferred CLR version based on the available versions that are installed or loaded. - - The .NET Framework 4 hosting API consolidates policies so that hosts with specific needs may use basic functionality without incurring unintended penalties. For example, many of the MSCorEE.dll exports will bind to a specific CLR, although a method might not logically require it. The [METAHOST_POLICY_FLAGS](metahost-policy-flags-enumeration.md) enumeration provides binding policies that are common to the majority of hosts. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +> This interface does not actually load or activate the CLR, but simply returns the preferred CLR version based on the available versions that are installed or loaded. + + The .NET Framework 4 hosting API consolidates policies so that hosts with specific needs may use basic functionality without incurring unintended penalties. For example, many of the MSCorEE.dll exports will bind to a specific CLR, although a method might not logically require it. The [METAHOST_POLICY_FLAGS](metahost-policy-flags-enumeration.md) enumeration provides binding policies that are common to the majority of hosts. + +## 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 - [CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5](clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md) diff --git a/docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md b/docs/framework/unmanaged-api/hosting/iclroneventmanager-interface.md similarity index 60% rename from docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md rename to docs/framework/unmanaged-api/hosting/iclroneventmanager-interface.md index 7b2657391e65f..9cc53d8741961 100644 --- a/docs/core/unmanaged-api/hosting/iclroneventmanager-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclroneventmanager-interface.md @@ -2,47 +2,48 @@ description: "Learn more about: ICLROnEventManager Interface" title: "ICLROnEventManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLROnEventManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLROnEventManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLROnEventManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: 9e15a0c1-8ab6-43d0-ae28-6ec7a4edd913 +topic_type: - "apiref" --- # ICLROnEventManager Interface -Provides methods that allow the host to register and unregister callbacks for common language runtime (CLR) events. - -## Methods - -|Method|Description| -|------------|-----------------| -|[RegisterActionOnEvent Method](iclroneventmanager-registeractiononevent-method.md)|Registers a callback pointer for the specified event.| -|[UnregisterActionOnEvent Method](iclroneventmanager-unregisteractiononevent-method.md)|Unregisters a previously registered callback pointer for the specified event.| - -## Remarks - - To register and unregister event callbacks, the host gets a reference to `ICLROnEventManager` by calling the [ICLRControl::GetCLRManager](iclrcontrol-getclrmanager-method.md) method. - +Provides methods that allow the host to register and unregister callbacks for common language runtime (CLR) events. + +## Methods + +|Method|Description| +|------------|-----------------| +|[RegisterActionOnEvent Method](iclroneventmanager-registeractiononevent-method.md)|Registers a callback pointer for the specified event.| +|[UnregisterActionOnEvent Method](iclroneventmanager-unregisteractiononevent-method.md)|Unregisters a previously registered callback pointer for the specified event.| + +## Remarks + + To register and unregister event callbacks, the host gets a reference to `ICLROnEventManager` by calling the [ICLRControl::GetCLRManager](iclrcontrol-getclrmanager-method.md) method. + > [!NOTE] -> The events described by [EClrEvent](eclrevent-enumeration.md) can be fired more than once and from different threads to signal an unload or the disabling of the CLR. - -## 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 2.0 - +> The events described by [EClrEvent](eclrevent-enumeration.md) can be fired more than once and from different threads to signal an unload or the disabling of the CLR. + +## 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 - [EClrEvent Enumeration](eclrevent-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md b/docs/framework/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md rename to docs/framework/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md index 170c9e3938949..209e6277284e5 100644 --- a/docs/core/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md +++ b/docs/framework/unmanaged-api/hosting/iclroneventmanager-registeractiononevent-method.md @@ -2,69 +2,70 @@ description: "Learn more about: ICLROnEventManager::RegisterActionOnEvent Method" title: "ICLROnEventManager::RegisterActionOnEvent Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLROnEventManager.RegisterActionOnEvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLROnEventManager::RegisterActionOnEvent" -helpviewer_keywords: +helpviewer_keywords: - "ICLROnEventManager::RegisterActionOnEvent method [.NET Framework hosting]" - "RegisterActionOnEvent method [.NET Framework hosting]" -topic_type: +ms.assetid: b944cf49-918d-4c4e-993b-77d097a52550 +topic_type: - "apiref" --- # ICLROnEventManager::RegisterActionOnEvent Method -Registers a callback pointer for the specified event. - -## Syntax - -```cpp -HRESULT RegisterActionOnEvent ( - [in] EClrEvent event, - [in] IActionOnCLREvent *pAction -); -``` - -## Parameters - - `event` - [in] One of the [EClrEvent](eclrevent-enumeration.md) values, indicating the event for which to register the callback pointer described by `pAction`. - - `pAction` - [in] A pointer to an [IActionOnCLREvent](iactiononclrevent-interface.md) object that is called when the registered event fires. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`RegisterActionOnEvent` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The host can register callbacks for either or both of the two event types described by `EClrEvent`. The host gets the `ICLROnEventManager` interface by calling the [ICLRControl::GetCLRManager](iclrcontrol-getclrmanager-method.md) method. - +Registers a callback pointer for the specified event. + +## Syntax + +```cpp +HRESULT RegisterActionOnEvent ( + [in] EClrEvent event, + [in] IActionOnCLREvent *pAction +); +``` + +## Parameters + + `event` + [in] One of the [EClrEvent](eclrevent-enumeration.md) values, indicating the event for which to register the callback pointer described by `pAction`. + + `pAction` + [in] A pointer to an [IActionOnCLREvent](iactiononclrevent-interface.md) object that is called when the registered event fires. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`RegisterActionOnEvent` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The host can register callbacks for either or both of the two event types described by `EClrEvent`. The host gets the `ICLROnEventManager` interface by calling the [ICLRControl::GetCLRManager](iclrcontrol-getclrmanager-method.md) method. + > [!NOTE] -> The events that `RegisterActionOnEvent` registers can be fired more than once and from different threads to signal an unload or the disabling of the CLR. - -## 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 2.0 - +> The events that `RegisterActionOnEvent` registers can be fired more than once and from different threads to signal an unload or the disabling of the CLR. + +## 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 - [EClrEvent Enumeration](eclrevent-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md b/docs/framework/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md rename to docs/framework/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md index 4340df6e03e67..e46f20c30a2c4 100644 --- a/docs/core/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md +++ b/docs/framework/unmanaged-api/hosting/iclroneventmanager-unregisteractiononevent-method.md @@ -2,62 +2,63 @@ description: "Learn more about: ICLROnEventManager::UnregisterActionOnEvent Method" title: "ICLROnEventManager::UnregisterActionOnEvent Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLROnEventManager.UnregisterActionOnEvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLROnEventManager::UnregisterActionOnEvent" -helpviewer_keywords: +helpviewer_keywords: - "UnRegisterActionOnEvent method [.NET Framework hosting]" - "ICLROnEventManager::UnRegisterActionOnEvent method [.NET Framework hosting]" -topic_type: +ms.assetid: 4c02ec37-cdf0-46b2-890e-235092741236 +topic_type: - "apiref" --- # ICLROnEventManager::UnregisterActionOnEvent Method -Unregisters a previously registered callback pointer for the specified event. +Unregisters a previously registered callback pointer for the specified event. + +## Syntax + +```cpp +HRESULT UnregisterActionOnEvent ( + [in] EClrEvent event, + [in] IActionOnCLREvent *pAction +); +``` + +## Parameters -## Syntax - -```cpp -HRESULT UnregisterActionOnEvent ( - [in] EClrEvent event, - [in] IActionOnCLREvent *pAction -); -``` - -## Parameters - - `event` - [in] One of the [EClrEvent](eclrevent-enumeration.md) values, indicating the event for which to unregister the callback pointer described by `pAction`. - - `pAction` - [in] A pointer to an [IActionOnCLREvent](iactiononclrevent-interface.md) object that was passed as a parameter to the [RegisterActionOnEvent](iclroneventmanager-registeractiononevent-method.md) method. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`UnregisterActionOnEvent` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## 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 2.0 + `event` + [in] One of the [EClrEvent](eclrevent-enumeration.md) values, indicating the event for which to unregister the callback pointer described by `pAction`. + + `pAction` + [in] A pointer to an [IActionOnCLREvent](iactiononclrevent-interface.md) object that was passed as a parameter to the [RegisterActionOnEvent](iclroneventmanager-registeractiononevent-method.md) method. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`UnregisterActionOnEvent` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 - [EClrEvent Enumeration](eclrevent-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md b/docs/framework/unmanaged-api/hosting/iclrpolicymanager-interface.md similarity index 62% rename from docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md rename to docs/framework/unmanaged-api/hosting/iclrpolicymanager-interface.md index 46b96b13d8b26..a74c938610bfa 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrpolicymanager-interface.md @@ -2,44 +2,45 @@ description: "Learn more about: ICLRPolicyManager Interface" title: "ICLRPolicyManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRPolicyManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRPolicyManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLRPolicyManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: 5c834aa1-f2db-408a-b230-c7bec093d364 +topic_type: - "apiref" --- # ICLRPolicyManager Interface -Provides methods that allow the host to specify policy actions to be taken in the event of failures and timeouts. - -## Methods - -|Method|Description| -|------------|-----------------| -|[SetActionOnFailure Method](iclrpolicymanager-setactiononfailure-method.md)|Specifies the policy action the common language runtime (CLR) should take when the specified failure occurs.| -|[SetActionOnTimeout Method](iclrpolicymanager-setactionontimeout-method.md)|Specifies the policy action the CLR should take when the specified operation times out.| -|[SetDefaultAction Method](iclrpolicymanager-setdefaultaction-method.md)|Specifies the policy action the CLR should take when the specified operation occurs.| -|[SetTimeout Method](iclrpolicymanager-settimeout-method.md)|Sets a timeout value for the specified operation.| -|[SetTimeoutAndAction Method](iclrpolicymanager-settimeoutandaction-method.md)|Sets a timeout value for the specified operation, and specifies the policy action the CLR should take when the operation occurs.| -|[SetUnhandledExceptionPolicy Method](iclrpolicymanager-setunhandledexceptionpolicy-method.md)|Specifies the behavior of the CLR when an unhandled exception occurs.| - -## 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 2.0 - +Provides methods that allow the host to specify policy actions to be taken in the event of failures and timeouts. + +## Methods + +|Method|Description| +|------------|-----------------| +|[SetActionOnFailure Method](iclrpolicymanager-setactiononfailure-method.md)|Specifies the policy action the common language runtime (CLR) should take when the specified failure occurs.| +|[SetActionOnTimeout Method](iclrpolicymanager-setactionontimeout-method.md)|Specifies the policy action the CLR should take when the specified operation times out.| +|[SetDefaultAction Method](iclrpolicymanager-setdefaultaction-method.md)|Specifies the policy action the CLR should take when the specified operation occurs.| +|[SetTimeout Method](iclrpolicymanager-settimeout-method.md)|Sets a timeout value for the specified operation.| +|[SetTimeoutAndAction Method](iclrpolicymanager-settimeoutandaction-method.md)|Sets a timeout value for the specified operation, and specifies the policy action the CLR should take when the operation occurs.| +|[SetUnhandledExceptionPolicy Method](iclrpolicymanager-setunhandledexceptionpolicy-method.md)|Specifies the behavior of the CLR when an unhandled exception occurs.| + +## 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 - [EClrFailure Enumeration](eclrfailure-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md b/docs/framework/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md similarity index 87% rename from docs/core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md rename to docs/framework/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md index d7440346aa835..cb08463cddbba 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrpolicymanager-setactiononfailure-method.md @@ -2,43 +2,44 @@ description: "Learn more about: ICLRPolicyManager::SetActionOnFailure Method" title: "ICLRPolicyManager::SetActionOnFailure Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRPolicyManager.SetActionOnFailure" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRPolicyManager::SetActionOnFailure" -helpviewer_keywords: +helpviewer_keywords: - "SetActionOnFailure method [.NET Framework hosting]" - "ICLRPolicyManager::SetActionOnFailure method [.NET Framework hosting]" -topic_type: +ms.assetid: 4664033f-db97-4388-b988-2ec470796e58 +topic_type: - "apiref" --- # ICLRPolicyManager::SetActionOnFailure Method -Specifies the policy action the common language runtime (CLR) should take when the specified failure occurs. - -## Syntax - -```cpp -HRESULT SetActionOnFailure ( - [in] EClrFailure failure, - [in] EPolicyAction action -); -``` - -## Parameters - - `failure` - [in] One of the [EClrFailure](eclrfailure-enumeration.md) values, indicating the type of failure for which to take action. - - `action` - [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the action to be taken when a failure occurs. For a list of supported values, see the Remarks section. - -## Return Value - +Specifies the policy action the common language runtime (CLR) should take when the specified failure occurs. + +## Syntax + +```cpp +HRESULT SetActionOnFailure ( + [in] EClrFailure failure, + [in] EPolicyAction action +); +``` + +## Parameters + + `failure` + [in] One of the [EClrFailure](eclrfailure-enumeration.md) values, indicating the type of failure for which to take action. + + `action` + [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the action to be taken when a failure occurs. For a list of supported values, see the Remarks section. + +## Return Value + | HRESULT | Description | | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | S_OK | `SetActionOnFailure` returned successfully. | @@ -48,11 +49,11 @@ HRESULT SetActionOnFailure ( | HOST_E_ABANDONED | An event was canceled while a blocked thread or fiber was waiting on it. | | E_FAIL | An unknown catastrophic failure occurred. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE. | | E_INVALIDARG | A policy action cannot be set for the specified operation, or an invalid policy action was specified for the operation. | - -## Remarks + +## Remarks By default, the CLR throws an exception when it fails to allocate a resource such as memory. `SetActionOnFailure` allows the host to override this behavior by specifying the policy action to take upon failure. The following table shows the combinations of [EClrFailure](eclrfailure-enumeration.md) (columns) and [EPolicyAction](epolicyaction-enumeration.md) (rows) values that are supported. - + | | `FAIL_NonCriticalResource` | `FAIL_CriticalResource` | `FAIL_FatalRuntime` | `FAIL_OrphanedLock` | `FAIL_StackOverflow` | `FAIL_AccessViolation` | `FAIL_CodeContract` | | -------------------------- | -------------------------- | ----------------------- | ------------------- | ------------------- | -------------------- | ---------------------- | ------------------- | | **`eNoAction`** | X | X | | | | N/A | | @@ -65,17 +66,17 @@ HRESULT SetActionOnFailure ( | **`eFastExitProcess`** | X | X | | X | X | N/A | | | **`eRudeExitProcess`** | X | X | X | X | X | N/A | | | **`eDisableRuntime`** | X | X | X | X | X | N/A | | - -## 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 2.0 - + +## 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 - [EClrFailure Enumeration](eclrfailure-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md b/docs/framework/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md similarity index 61% rename from docs/core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md rename to docs/framework/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md index 75ad097656c35..30e8d493818ea 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrpolicymanager-setactionontimeout-method.md @@ -2,83 +2,84 @@ description: "Learn more about: ICLRPolicyManager::SetActionOnTimeout Method" title: "ICLRPolicyManager::SetActionOnTimeout Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRPolicyManager.SetActionOnTimeout" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRPolicyManager::SetActionOnTimeout" -helpviewer_keywords: +helpviewer_keywords: - "SetActionOnTimeout method [.NET Framework hosting]" - "ICLRPolicyManager::SetActionOnTimeout method [.NET Framework hosting]" -topic_type: +ms.assetid: 38439fa1-2b99-4fa8-a6ec-08afc0f83b9c +topic_type: - "apiref" --- # ICLRPolicyManager::SetActionOnTimeout Method -Specifies the policy action the common language runtime (CLR) should take when the specified operation times out. - -## Syntax - -```cpp -HRESULT SetActionOnTimeout ( - [in] EClrOperation operation, - [in] EPolicyAction action -); -``` - -## Parameters - - `operation` - [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the operation for which to specify the timeout action. The following values are supported: - -- OPR_AppDomainUnload - -- OPR_ProcessExit - -- OPR_ThreadRudeAbortInCriticalRegion - -- OPR_ThreadRudeAbortInNonCriticalRegion - - `action` - [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the policy action to be taken when the operation times out. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetActionOnTimeout` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_INVALIDARG|A timeout cannot be set for the specified `operation`, or an invalid value was supplied for `operation`.| - -## Remarks - - The timeout value can be either the default timeout set by the CLR, or a value specified by the host in a call to the [ICLRPolicyManager::SetTimeout](iclrpolicymanager-settimeout-method.md) method. - - Not all policy action values can be specified as the timeout behavior for CLR operations. `SetActionOnTimeout` is typically used only to escalate behavior. For example, a host can specify that thread aborts be turned into rude thread aborts, but cannot specify the opposite. The table below describes the valid `action` values for valid `operation` values. - -|Value for `operation`|Valid values for `action`| -|---------------------------|-------------------------------| -|OPR_ThreadRudeAbortInNonCriticalRegion

OPR_ThreadRudeAbortInCriticalRegion|- eRudeAbortThread
- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| -|OPR_AppDomainUnload|- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| -|OPR_ProcessExit|- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| - -## 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 2.0 - +Specifies the policy action the common language runtime (CLR) should take when the specified operation times out. + +## Syntax + +```cpp +HRESULT SetActionOnTimeout ( + [in] EClrOperation operation, + [in] EPolicyAction action +); +``` + +## Parameters + + `operation` + [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the operation for which to specify the timeout action. The following values are supported: + +- OPR_AppDomainUnload + +- OPR_ProcessExit + +- OPR_ThreadRudeAbortInCriticalRegion + +- OPR_ThreadRudeAbortInNonCriticalRegion + + `action` + [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the policy action to be taken when the operation times out. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetActionOnTimeout` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_INVALIDARG|A timeout cannot be set for the specified `operation`, or an invalid value was supplied for `operation`.| + +## Remarks + + The timeout value can be either the default timeout set by the CLR, or a value specified by the host in a call to the [ICLRPolicyManager::SetTimeout](iclrpolicymanager-settimeout-method.md) method. + + Not all policy action values can be specified as the timeout behavior for CLR operations. `SetActionOnTimeout` is typically used only to escalate behavior. For example, a host can specify that thread aborts be turned into rude thread aborts, but cannot specify the opposite. The table below describes the valid `action` values for valid `operation` values. + +|Value for `operation`|Valid values for `action`| +|---------------------------|-------------------------------| +|OPR_ThreadRudeAbortInNonCriticalRegion

OPR_ThreadRudeAbortInCriticalRegion|- eRudeAbortThread
- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| +|OPR_AppDomainUnload|- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| +|OPR_ProcessExit|- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| + +## 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 - [EClrOperation Enumeration](eclroperation-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md b/docs/framework/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md similarity index 64% rename from docs/core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md rename to docs/framework/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md index 6c23bd17a5aa4..4e1f6d16c8063 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrpolicymanager-setdefaultaction-method.md @@ -2,76 +2,77 @@ description: "Learn more about: ICLRPolicyManager::SetDefaultAction Method" title: "ICLRPolicyManager::SetDefaultAction Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRPolicyManager.SetDefaultAction" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRPolicyManager::SetDefaultAction" -helpviewer_keywords: +helpviewer_keywords: - "SetDefaultAction method [.NET Framework hosting]" - "ICLRPolicyManager::SetDefaultAction method [.NET Framework hosting]" -topic_type: +ms.assetid: f9411e7a-27df-451f-9f6c-d643d6a7a7ce +topic_type: - "apiref" --- # ICLRPolicyManager::SetDefaultAction Method -Specifies the policy action the common language runtime (CLR) should take when the specified operation occurs. - -## Syntax - -```cpp -HRESULT SetDefaultAction ( - [in] EClrOperation operation, - [in] EPolicyAction action -); -``` - -## Parameters - - `operation` - [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the action for which CLR behavior should be customized. - - `action` - [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the policy action the CLR should take when `operation` occurs. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetDefaultAction` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_INVALIDARG|An invalid `action` was specified for the `operation`, or an invalid value was supplied for `operation`.| - -## Remarks - - Not all policy action values can be specified as the default behavior for CLR operations. `SetDefaultAction` can typically be used only to escalate behavior. For example, a host can specify that thread aborts be turned into rude thread aborts, but cannot specify the opposite. The table below describes the valid `action` values for each possible `operation` value. - -|Value for `operation`|Valid values for `action`| -|---------------------------|-------------------------------| -|OPR_ThreadAbort|- eAbortThread
- eRudeAbortThread
- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| -|OPR_ThreadRudeAbortInNonCriticalRegion

OPR_ThreadRudeAbortInCriticalRegion|- eRudeAbortThread
- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| -|OPR_AppDomainUnload|- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| -|OPR_AppDomainRudeUnload|- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| -|OPR_ProcessExit|- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| -|OPR_FinalizerRun|- eNoAction
- eAbortThread
- eRudeAbortThread
- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| - -## 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 2.0 - +Specifies the policy action the common language runtime (CLR) should take when the specified operation occurs. + +## Syntax + +```cpp +HRESULT SetDefaultAction ( + [in] EClrOperation operation, + [in] EPolicyAction action +); +``` + +## Parameters + + `operation` + [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the action for which CLR behavior should be customized. + + `action` + [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the policy action the CLR should take when `operation` occurs. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetDefaultAction` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_INVALIDARG|An invalid `action` was specified for the `operation`, or an invalid value was supplied for `operation`.| + +## Remarks + + Not all policy action values can be specified as the default behavior for CLR operations. `SetDefaultAction` can typically be used only to escalate behavior. For example, a host can specify that thread aborts be turned into rude thread aborts, but cannot specify the opposite. The table below describes the valid `action` values for each possible `operation` value. + +|Value for `operation`|Valid values for `action`| +|---------------------------|-------------------------------| +|OPR_ThreadAbort|- eAbortThread
- eRudeAbortThread
- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| +|OPR_ThreadRudeAbortInNonCriticalRegion

OPR_ThreadRudeAbortInCriticalRegion|- eRudeAbortThread
- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| +|OPR_AppDomainUnload|- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| +|OPR_AppDomainRudeUnload|- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| +|OPR_ProcessExit|- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| +|OPR_FinalizerRun|- eNoAction
- eAbortThread
- eRudeAbortThread
- eUnloadAppDomain
- eRudeUnloadAppDomain
- eExitProcess
- eFastExitProcess
- eRudeExitProcess
- eDisableRuntime| + +## 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 - [EClrOperation Enumeration](eclroperation-enumeration.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md b/docs/framework/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md new file mode 100644 index 0000000000000..c9e4b0efd9d2a --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrpolicymanager-settimeout-method.md @@ -0,0 +1,75 @@ +--- +description: "Learn more about: ICLRPolicyManager::SetTimeout Method" +title: "ICLRPolicyManager::SetTimeout Method" +ms.date: "03/30/2017" +api_name: + - "ICLRPolicyManager.SetTimeout" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRPolicyManager::SetTimeout" +helpviewer_keywords: + - "SetTimeout method [.NET Framework hosting]" + - "ICLRPolicyManager::SetTimeout method [.NET Framework hosting]" +ms.assetid: 954404fd-d52d-4e68-b582-8692f3a5f608 +topic_type: + - "apiref" +--- +# ICLRPolicyManager::SetTimeout Method + +Sets a timeout value for the specified operation. + +## Syntax + +```cpp +HRESULT SetTimeout ( + [in] EClrOperation operation, + [in] DWORD dsMilliseconds +); +``` + +## Parameters + + `operation` + [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the common language runtime (CLR) operation for which to set a timeout. The following values are supported: + +- OPR_AppDomainUnload + +- OPR_ProcessExit + +- OPR_ThreadRudeAbortInCriticalRegion + +- OPR_ThreadRudeAbortInNonCriticalRegion + + `dwMilliseconds` + [in] The new timeout value, in milliseconds. A value of INFINITE causes the operation never to time out. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetTimeout` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_INVALIDARG|A timeout cannot be set for the specified `operation`, or an invalid value was supplied for `operation`.| + +## 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 + +- [EClrOperation Enumeration](eclroperation-enumeration.md) +- [ICLRControl Interface](iclrcontrol-interface.md) +- [ICLRPolicyManager Interface](iclrpolicymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md b/docs/framework/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md rename to docs/framework/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md index 2b175ac93547a..fba0204b0aaf7 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrpolicymanager-settimeoutandaction-method.md @@ -2,82 +2,83 @@ description: "Learn more about: ICLRPolicyManager::SetTimeoutAndAction Method" title: "ICLRPolicyManager::SetTimeoutAndAction Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRPolicyManager.SetTimeoutAndAction" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRPolicyManager::SetTimeoutAndAction" -helpviewer_keywords: +helpviewer_keywords: - "ICLRPolicyManager::SetTimeoutAndAction method [.NET Framework hosting]" - "SetTimeoutAndAction method [.NET Framework hosting]" -topic_type: +ms.assetid: 60454f91-d855-4ddf-bb6d-60a02f5eabab +topic_type: - "apiref" --- # ICLRPolicyManager::SetTimeoutAndAction Method -Sets a timeout value for the specified operation, and specifies the policy action the common language runtime (CLR) should take when the operation occurs. - -## Syntax - -```cpp -HRESULT SetTimeoutAndAction ( - [in] EClrOperation operation, - [in] DWORD dwMilliseconds, - [in] EPolicyAction action -); -``` - -## Parameters - - `operation` - [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the operation for which to set the timeout and policy `action`. The following values are supported: - -- OPR_AppDomainUnload - -- OPR_ProcessExit - -- OPR_ThreadRudeAbortInCriticalRegion - -- OPR_ThreadRudeAbortInNonCriticalRegion - - `dwMilliseconds` - [in] The new timeout value, in milliseconds. A value of INFINITE causes `operation` never to time out. - - `action` - [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the policy action that the CLR should take when `operation` occurs. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetTimeoutAndAction` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_INVALIDARG|A timeout cannot be set for the specified `operation`, or an invalid value was supplied for `action`.| - -## Remarks - - `SetTimeoutAndAction` encapsulates the capabilities of the [ICLRPolicyManager::SetTimeout](iclrpolicymanager-settimeout-method.md) and [ICLRPolicyManager::SetActionOnTimeout](iclrpolicymanager-setactionontimeout-method.md) methods, and can be called in place of sequential calls to these two methods. - +Sets a timeout value for the specified operation, and specifies the policy action the common language runtime (CLR) should take when the operation occurs. + +## Syntax + +```cpp +HRESULT SetTimeoutAndAction ( + [in] EClrOperation operation, + [in] DWORD dwMilliseconds, + [in] EPolicyAction action +); +``` + +## Parameters + + `operation` + [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the operation for which to set the timeout and policy `action`. The following values are supported: + +- OPR_AppDomainUnload + +- OPR_ProcessExit + +- OPR_ThreadRudeAbortInCriticalRegion + +- OPR_ThreadRudeAbortInNonCriticalRegion + + `dwMilliseconds` + [in] The new timeout value, in milliseconds. A value of INFINITE causes `operation` never to time out. + + `action` + [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the policy action that the CLR should take when `operation` occurs. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetTimeoutAndAction` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_INVALIDARG|A timeout cannot be set for the specified `operation`, or an invalid value was supplied for `action`.| + +## Remarks + + `SetTimeoutAndAction` encapsulates the capabilities of the [ICLRPolicyManager::SetTimeout](iclrpolicymanager-settimeout-method.md) and [ICLRPolicyManager::SetActionOnTimeout](iclrpolicymanager-setactionontimeout-method.md) methods, and can be called in place of sequential calls to these two methods. + > [!IMPORTANT] -> Not all policy action values can be specified as the timeout behavior for CLR operations. See the Remarks sections of the topics for these two methods for valid values. - -## 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 2.0 - +> Not all policy action values can be specified as the timeout behavior for CLR operations. See the Remarks sections of the topics for these two methods for valid values. + +## 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 - [EClrOperation Enumeration](eclroperation-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md b/docs/framework/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md similarity index 60% rename from docs/core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md rename to docs/framework/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md index c05e17be7898a..9de11895438a7 100644 --- a/docs/core/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrpolicymanager-setunhandledexceptionpolicy-method.md @@ -2,62 +2,63 @@ description: "Learn more about: ICLRPolicyManager::SetUnhandledExceptionPolicy Method" title: "ICLRPolicyManager::SetUnhandledExceptionPolicy Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRPolicyManager.SetUnhandledExceptionPolicy" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRPolicyManager::SetUnhandledExceptionPolicy" -helpviewer_keywords: +helpviewer_keywords: - "ICLRPolicyManager::SetUnhandledExceptionPolicy method [.NET Framework hosting]" - "SetUnhandledExceptionPolicy method [.NET Framework hosting]" -topic_type: +ms.assetid: 5268480e-280a-4931-b7a3-dc3ffdf7f78f +topic_type: - "apiref" --- # ICLRPolicyManager::SetUnhandledExceptionPolicy Method -Specifies the behavior of the common language runtime (CLR) when an unhandled exception occurs. - -## Syntax - -```cpp -HRESULT SetUnhandledExceptionPolicy ( - [in] EClrUnhandledExceptionPolicy policy -); -``` - -## Parameters - - `policy` - [in] One of the [EClrUnhandledException](eclrunhandledexception-enumeration.md) values, indicating whether the behavior is set by the CLR or the host. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetUnhandledExceptionPolicy` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - By default, the CLR is the final handler for all unhandled exceptions, and its default behavior is to tear down the process. The host can change this behavior by setting the `policy` value to eHostDeterminedPolicy. This value allows the host to implement its own default behavior, as with earlier versions of the CLR. - -## 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 2.0 - +Specifies the behavior of the common language runtime (CLR) when an unhandled exception occurs. + +## Syntax + +```cpp +HRESULT SetUnhandledExceptionPolicy ( + [in] EClrUnhandledExceptionPolicy policy +); +``` + +## Parameters + + `policy` + [in] One of the [EClrUnhandledException](eclrunhandledexception-enumeration.md) values, indicating whether the behavior is set by the CLR or the host. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetUnhandledExceptionPolicy` 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. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + By default, the CLR is the final handler for all unhandled exceptions, and its default behavior is to tear down the process. The host can change this behavior by setting the `policy` value to eHostDeterminedPolicy. This value allows the host to implement its own default behavior, as with earlier versions of the CLR. + +## 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 - [EClrUnhandledException Enumeration](eclrunhandledexception-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md b/docs/framework/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md similarity index 91% rename from docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md rename to docs/framework/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md index 8531a7986a426..423f93c02a248 100644 --- a/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrprobingassemblyenum-get-method.md @@ -13,6 +13,7 @@ f1_keywords: helpviewer_keywords: - "Get method, ICLRProbingAssemblyEnum interface [.NET Framework hosting]" - "ICLRProbingAssemblyEnum::Get method [.NET Framework hosting]" +ms.assetid: fdb67a77-782f-44cf-a8a1-b75999b0f3c8 topic_type: - "apiref" --- @@ -62,13 +63,13 @@ HRESULT Get ( ## Requirements - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). **Header:** MSCorEE.h **Library:** Included as a resource in MSCorEE.dll - **.NET versions:** Available since .NET Framework 2.0 + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] ## See also diff --git a/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md b/docs/framework/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md similarity index 61% rename from docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md rename to docs/framework/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md index db4b31ced334e..2de9d5d8246df 100644 --- a/docs/core/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrprobingassemblyenum-interface.md @@ -2,43 +2,44 @@ description: "Learn more about: ICLRProbingAssemblyEnum Interface" title: "ICLRProbingAssemblyEnum Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRProbingAssemblyEnum" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRProbingAssemblyEnum" -helpviewer_keywords: +helpviewer_keywords: - "ICLRProbingAssemblyEnum interface [.NET Framework hosting]" -topic_type: +ms.assetid: e7d3ccab-b0f0-4872-8935-0ed72920171b +topic_type: - "apiref" --- # ICLRProbingAssemblyEnum Interface -Provides methods that enable the host to get the probing identities of an assembly by using the assembly's identity information that is internal to the common language runtime (CLR), without needing to create or understand that identity. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Get Method](iclrprobingassemblyenum-get-method.md)|Gets the assembly identity at the specified index.| - -## Remarks - - Methods such as [ICLRAssemblyIdentityManager::GetProbingAssembliesFromReference](iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md) return an `ICLRProbingAssemblyEnum` instance. - -## 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 2.0 - +Provides methods that enable the host to get the probing identities of an assembly by using the assembly's identity information that is internal to the common language runtime (CLR), without needing to create or understand that identity. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Get Method](iclrprobingassemblyenum-get-method.md)|Gets the assembly identity at the specified index.| + +## Remarks + + Methods such as [ICLRAssemblyIdentityManager::GetProbingAssembliesFromReference](iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md) return an `ICLRProbingAssemblyEnum` instance. + +## 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 - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md b/docs/framework/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md new file mode 100644 index 0000000000000..a88de2907cc6e --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrreferenceassemblyenum-get-method.md @@ -0,0 +1,75 @@ +--- +description: "Learn more about: ICLRReferenceAssemblyEnum::Get Method" +title: "ICLRReferenceAssemblyEnum::Get Method" +ms.date: "03/30/2017" +api_name: + - "ICLRReferenceAssemblyEnum.Get" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRReferenceAssemblyEnum::Get" +helpviewer_keywords: + - "ICLRReferenceAssemblyEnum::Get method [.NET Framework hosting]" + - "Get method, ICLRReferenceAssemblyEnum interface [.NET Framework hosting]" +ms.assetid: f21c1612-9c5d-4abc-a337-577086d29c17 +topic_type: + - "apiref" +--- +# ICLRReferenceAssemblyEnum::Get Method + +Gets the assembly identity at the supplied index. + +## Syntax + +```cpp +HRESULT Get ( + [in] DWORD dwIndex, + [out, size_is(*pcchBufferSize)] LPWSTR pwzBuffer, + [in, out] DWORD *pcchBufferSize +); +``` + +## Parameters + + `dwIndex` + [in] The zero-based index of the assembly identity to return. + + `pwzBuffer` + [out] A buffer containing the assembly identity data. + + `pcchBufferSize` + [in, out] The size of the `pwzBuffer` buffer. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Get` returned successfully.| +|ERROR_INSUFFICIENT_BUFFER|`pwzBuffer` is too small.| +|ERROR_NO_MORE_ITEMS|The enumeration contains no more items.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| + +## Remarks + + `Get` is typically called twice. The first call supplies a null value for `pwzBuffer`, and sets `pcchBufferSize` to the size appropriate for `pwzBuffer`. The second call supplies an appropriately sized `pwzBuffer`, and contains the canonical assembly identity data upon completion. + +## 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 + +- [ICLRAssemblyReferenceList Interface](iclrassemblyreferencelist-interface.md) +- [ICLRReferenceAssemblyEnum Interface](iclrreferenceassemblyenum-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md b/docs/framework/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md similarity index 57% rename from docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md rename to docs/framework/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md index 09e323435aa1f..1393f288268b8 100644 --- a/docs/core/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrreferenceassemblyenum-interface.md @@ -2,39 +2,40 @@ description: "Learn more about: ICLRReferenceAssemblyEnum Interface" title: "ICLRReferenceAssemblyEnum Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRReferenceAssemblyEnum" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRReferenceAssemblyEnum" -helpviewer_keywords: +helpviewer_keywords: - "ICLRReferenceAssemblyEnum interface [.NET Framework hosting]" -topic_type: +ms.assetid: 8adbf092-c3ba-4bee-b25b-0de6e43a4ce5 +topic_type: - "apiref" --- # ICLRReferenceAssemblyEnum Interface -Provides methods that allow the host to manipulate the set of assemblies referenced by a file or stream using assembly identity data that is internal to the common language runtime (CLR), without needing to create or understand those identities. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Get Method](iclrreferenceassemblyenum-get-method.md)|Gets the assembly identity at the supplied index.| - -## 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 2.0 - +Provides methods that allow the host to manipulate the set of assemblies referenced by a file or stream using assembly identity data that is internal to the common language runtime (CLR), without needing to create or understand those identities. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Get Method](iclrreferenceassemblyenum-get-method.md)|Gets the assembly identity at the supplied index.| + +## 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 - [ICLRAssemblyIdentityManager Interface](iclrassemblyidentitymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md similarity index 62% rename from docs/core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md rename to docs/framework/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md index eb9ddbfaad99b..d1d4c7fd913a2 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrruntimehost-executeapplication-method.md @@ -2,87 +2,88 @@ description: "Learn more about: ICLRRuntimeHost::ExecuteApplication Method" title: "ICLRRuntimeHost::ExecuteApplication Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeHost.ExecuteApplication" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeHost::ExecuteApplication" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeHost::ExecuteApplication method [.NET Framework hosting]" - "ExecuteApplication method [.NET Framework hosting]" -topic_type: +ms.assetid: 5f28cc4e-7176-4e00-aa1f-58ae6ee52fe4 +topic_type: - "apiref" --- # ICLRRuntimeHost::ExecuteApplication Method -Used in manifest-based ClickOnce deployment scenarios to specify the application to be activated in a new domain. For more information about these scenarios, see [ClickOnce Security and Deployment](/visualstudio/deployment/clickonce-security-and-deployment). - -## Syntax - -```cpp -HRESULT ExecuteApplication( - [in] LPCWSTR pwzAppFullName, - [in] DWORD dwManifestPaths, - [in] LPCWSTR *ppwzManifestPaths, - [in] DWORD dwActivationData, - [in] LPCWSTR *ppwzActivationData, - [out] int *pReturnValue -); -``` - -## Parameters - - `pwzAppFullName` - [in] The full name of the application, as defined for . - - `dwManifestPaths` - [in] The number of strings contained in the `ppwzManifestPaths` array. - - `ppwzManifestPaths` - [in] Optional. A string array that contains manifest paths for the application. - - `dwActivationData` - [in] The number of strings contained in the `ppwzActivationData` array. - - `ppwzActivationData` - [in] Optional. A string array that contains the application's activation data, such as the query string portion of the URL for applications deployed over the Web. - - `pReturnValue` - [out] The value returned from the entry point of the application. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`ExecuteApplication` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| - -## Remarks - - `ExecuteApplication` is used to activate ClickOnce applications in a newly created application domain. - - The `pReturnValue` output parameter is set to the value returned by the application. If you supply a value of null for `pReturnValue`, `ExecuteApplication` does not fail, but it does not return a value. - +Used in manifest-based ClickOnce deployment scenarios to specify the application to be activated in a new domain. For more information about these scenarios, see [ClickOnce Security and Deployment](/visualstudio/deployment/clickonce-security-and-deployment). + +## Syntax + +```cpp +HRESULT ExecuteApplication( + [in] LPCWSTR pwzAppFullName, + [in] DWORD dwManifestPaths, + [in] LPCWSTR *ppwzManifestPaths, + [in] DWORD dwActivationData, + [in] LPCWSTR *ppwzActivationData, + [out] int *pReturnValue +); +``` + +## Parameters + + `pwzAppFullName` + [in] The full name of the application, as defined for . + + `dwManifestPaths` + [in] The number of strings contained in the `ppwzManifestPaths` array. + + `ppwzManifestPaths` + [in] Optional. A string array that contains manifest paths for the application. + + `dwActivationData` + [in] The number of strings contained in the `ppwzActivationData` array. + + `ppwzActivationData` + [in] Optional. A string array that contains the application's activation data, such as the query string portion of the URL for applications deployed over the Web. + + `pReturnValue` + [out] The value returned from the entry point of the application. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`ExecuteApplication` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| + +## Remarks + + `ExecuteApplication` is used to activate ClickOnce applications in a newly created application domain. + + The `pReturnValue` output parameter is set to the value returned by the application. If you supply a value of null for `pReturnValue`, `ExecuteApplication` does not fail, but it does not return a value. + > [!IMPORTANT] -> Do not call the [Start Method](iclrruntimehost-start-method.md) method before calling the `ExecuteApplication` method to activate a manifest-based application. If the `Start` method is called first, the `ExecuteApplication` method call will fail. - -## 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 2.0 - +> Do not call the [Start Method](iclrruntimehost-start-method.md) method before calling the `ExecuteApplication` method to activate a manifest-based application. If the `Start` method is called first, the `ExecuteApplication` method call will fail. + +## 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 - diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md rename to docs/framework/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md index 36d9dc8239c87..cae5694d7c317 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrruntimehost-executeinappdomain-method.md @@ -2,70 +2,71 @@ description: "Learn more about: ICLRRuntimeHost::ExecuteInAppDomain Method" title: "ICLRRuntimeHost::ExecuteInAppDomain Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeHost.ExecuteInAppDomain" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeHost::ExecuteInAppDomain" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeHost::ExecuteInAppDomain method [.NET Framework hosting]" - "ExecuteInAppDomain method [.NET Framework hosting]" -topic_type: +ms.assetid: e2b0e2db-3fae-4b56-844e-d30a125a660c +topic_type: - "apiref" --- # ICLRRuntimeHost::ExecuteInAppDomain Method -Specifies the in which to execute the specified managed code. - -## Syntax - -```cpp -HRESULT ExecuteInAppDomain( +Specifies the in which to execute the specified managed code. + +## Syntax + +```cpp +HRESULT ExecuteInAppDomain( [in] DWORD AppDomainId, [in] FExecuteInDomainCallback pCallback, - [in] void* cookie -); -``` - -## Parameters - - `AppDomainId` - [in] The numeric ID of the in which to execute the specified method. - - `pCallback` - [in] A pointer to the function to execute within the specified . - - `cookie` - [in] A pointer to opaque caller-allocated memory. This parameter is passed by the common language runtime (CLR) to the domain callback. It is not runtime-managed heap memory; both the allocation and lifetime of this memory are controlled by the caller. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`ExecuteInAppDomain` 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.| - -## Remarks - - `ExecuteInAppDomain` allows the host to exercise control over which managed the specified managed method should be executed in. You can get the value of an application domain's identifier, which corresponds to the value of the property, by calling [GetCurrentAppDomainId Method](iclrruntimehost-getcurrentappdomainid-method.md). - -## 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 2.0 - + [in] void* cookie +); +``` + +## Parameters + + `AppDomainId` + [in] The numeric ID of the in which to execute the specified method. + + `pCallback` + [in] A pointer to the function to execute within the specified . + + `cookie` + [in] A pointer to opaque caller-allocated memory. This parameter is passed by the common language runtime (CLR) to the domain callback. It is not runtime-managed heap memory; both the allocation and lifetime of this memory are controlled by the caller. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`ExecuteInAppDomain` 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.| + +## Remarks + + `ExecuteInAppDomain` allows the host to exercise control over which managed the specified managed method should be executed in. You can get the value of an application domain's identifier, which corresponds to the value of the property, by calling [GetCurrentAppDomainId Method](iclrruntimehost-getcurrentappdomainid-method.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/iclrruntimehost-executeindefaultappdomain-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md new file mode 100644 index 0000000000000..b9eb15bfdd611 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrruntimehost-executeindefaultappdomain-method.md @@ -0,0 +1,86 @@ +--- +description: "Learn more about: ICLRRuntimeHost::ExecuteInDefaultAppDomain Method" +title: "ICLRRuntimeHost::ExecuteInDefaultAppDomain Method" +ms.date: "03/30/2017" +api_name: + - "ICLRRuntimeHost.ExecuteInDefaultAppDomain" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRRuntimeHost::ExecuteInDefaultAppDomain" +helpviewer_keywords: + - "ICLRRuntimeHost::ExecuteInDefaultAppDomain method [.NET Framework hosting]" + - "ExecuteInDefaultAppDomain method [.NET Framework hosting]" +ms.assetid: 30b5cf9a-a762-4bd4-be12-d6c1442b78b1 +topic_type: + - "apiref" +--- +# ICLRRuntimeHost::ExecuteInDefaultAppDomain Method + +Calls the specified method of the specified type in the specified managed assembly. + +## Syntax + +```cpp +HRESULT ExecuteInDefaultAppDomain ( + [in] LPCWSTR pwzAssemblyPath, + [in] LPCWSTR pwzTypeName, + [in] LPCWSTR pwzMethodName, + [in] LPCWSTR pwzArgument, + [out] DWORD *pReturnValue +); +``` + +## Parameters + + `pwzAssemblyPath` + [in] The path to the that defines the whose method is to be invoked. + + `pwzTypeName` + [in] The name of the that defines the method to invoke. + + `pwzMethodName` + [in] The name of the method to invoke. + + `pwzArgument` + [in] The string parameter to pass to the method. + + `pReturnValue` + [out] The integer value returned by the invoked method. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`ExecuteInDefaultAppDomain` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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 CRL is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The invoked method must have the following signature: + +```cpp +static int pwzMethodName (String pwzArgument) +``` + + where `pwzMethodName` represents the name of the invoked method, and `pwzArgument` represents the string value passed as a parameter to that method. If the HRESULT value is set to S_OK, `pReturnValue` is set to the integer value returned by the invoked method. Otherwise, `pReturnValue` is not set. + +## 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/core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md similarity index 55% rename from docs/core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md rename to docs/framework/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md index 167dd80414642..140a6a89c9f71 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrruntimehost-getclrcontrol-method.md @@ -2,63 +2,64 @@ description: "Learn more about: ICLRRuntimeHost::GetCLRControl Method" title: "ICLRRuntimeHost::GetCLRControl Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeHost.GetCLRControl" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeHost::GetCLRControl" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeHost::GetCLRControl method [.NET Framework hosting]" - "GetCLRControl method [.NET Framework hosting]" -topic_type: +ms.assetid: e47e3655-efd5-4572-a1dc-50c69bf2a468 +topic_type: - "apiref" --- # ICLRRuntimeHost::GetCLRControl Method -Gets an interface pointer of type [ICLRControl Interface](iclrcontrol-interface.md) that hosts can use to customize aspects of the common language runtime (CLR). - -## Syntax - -```cpp -HRESULT GetCLRControl( - [out] ICLRControl** pCLRControl -); -``` - -## Parameters - - `pCLRControl` - [out] An interface pointer of type [ICLRControl Interface](iclrcontrol-interface.md) that enables hosts to configure additional aspects of the CLR. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetCLRControl` 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.| -|HOST_E_INVALIDOPERATION|The CLR has already started.| - -## Remarks - - `ICLRControl` provides the [GetCLRManager Method](iclrcontrol-getclrmanager-method.md) method, which enables the host to get an interface pointer to one of the manager types. - -## 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 2.0 - +Gets an interface pointer of type [ICLRControl Interface](iclrcontrol-interface.md) that hosts can use to customize aspects of the common language runtime (CLR). + +## Syntax + +```cpp +HRESULT GetCLRControl( + [out] ICLRControl** pCLRControl +); +``` + +## Parameters + + `pCLRControl` + [out] An interface pointer of type [ICLRControl Interface](iclrcontrol-interface.md) that enables hosts to configure additional aspects of the CLR. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetCLRControl` 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.| +|HOST_E_INVALIDOPERATION|The CLR has already started.| + +## Remarks + + `ICLRControl` provides the [GetCLRManager Method](iclrcontrol-getclrmanager-method.md) method, which enables the host to get an interface pointer to one of the manager types. + +## 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 - [ICLRControl Interface](iclrcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md similarity index 54% rename from docs/core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md rename to docs/framework/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md index ad765a2086294..5b264fb645967 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrruntimehost-getcurrentappdomainid-method.md @@ -2,62 +2,63 @@ description: "Learn more about: ICLRRuntimeHost::GetCurrentAppDomainId Method" title: "ICLRRuntimeHost::GetCurrentAppDomainId Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeHost.GetCurrentAppDomainId" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeHost::GetCurrentAppDomainId" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeHost::GetCurrentAppDomainId method [.NET Framework hosting]" - "GetCurrentAppDomainId method [.NET Framework hosting]" -topic_type: +ms.assetid: 33800475-7815-4976-8aca-a1038761a2ef +topic_type: - "apiref" --- # ICLRRuntimeHost::GetCurrentAppDomainId Method -Gets the numeric identifier of the that is currently executing. - -## Syntax - -```cpp -HRESULT GetCurrentAppDomainId( - [out] DWORD* pdwAppDomainId -); -``` - -## Parameters - - `pdwAppDomainId` - [out] The numeric identifier of the that is currently executing. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetCurrentAppDomainId` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| - -## Remarks - - The `pdwAppDomainId` parameter is set to the value of the property of the in which the current thread is executing. - -## 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 2.0 - +Gets the numeric identifier of the that is currently executing. + +## Syntax + +```cpp +HRESULT GetCurrentAppDomainId( + [out] DWORD* pdwAppDomainId +); +``` + +## Parameters + + `pdwAppDomainId` + [out] The numeric identifier of the that is currently executing. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetCurrentAppDomainId` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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.| + +## Remarks + + The `pdwAppDomainId` parameter is set to the value of the property of the in which the current thread is executing. + +## 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 - diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md b/docs/framework/unmanaged-api/hosting/iclrruntimehost-interface.md similarity index 71% rename from docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md rename to docs/framework/unmanaged-api/hosting/iclrruntimehost-interface.md index 910063ceaec7a..6a0d977d95acb 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrruntimehost-interface.md @@ -2,58 +2,59 @@ description: "Learn more about: ICLRRuntimeHost Interface" title: "ICLRRuntimeHost Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeHost" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeHost" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeHost interface [.NET Framework hosting]" -topic_type: +ms.assetid: cb0c5f65-3791-47bc-b833-2f84f4101ba5 +topic_type: - "apiref" --- # ICLRRuntimeHost Interface -Provides functionality similar to that of the [ICorRuntimeHost](icorruntimehost-interface.md) interface provided in the .NET Framework version 1, with the following changes: - -- The addition of the [SetHostControl](iclrruntimehost-sethostcontrol-method.md) method to set the host control interface. - -- The omission of some methods provided by `ICorRuntimeHost`. - -## Methods - -|Method|Description| -|------------|-----------------| -|[ExecuteApplication Method](iclrruntimehost-executeapplication-method.md)|Used in manifest-based ClickOnce deployment scenarios to specify the application to be activated in a new domain.| -|[ExecuteInAppDomain Method](iclrruntimehost-executeinappdomain-method.md)|Specifies the in which to execute the specified managed code.| -|[ExecuteInDefaultAppDomain Method](iclrruntimehost-executeindefaultappdomain-method.md)|Invokes the specified method of the specified type in the specified assembly.| -|[GetCLRControl Method](iclrruntimehost-getclrcontrol-method.md)|Gets an interface pointer of type [ICLRControl](iclrcontrol-interface.md) that hosts can use to customize aspects of the common language runtime (CLR).| -|[GetCurrentAppDomainId Method](iclrruntimehost-getcurrentappdomainid-method.md)|Gets the numeric identifier of the that is currently executing.| -|[SetHostControl Method](iclrruntimehost-sethostcontrol-method.md)|Sets the host control interface. You must call `SetHostControl` before calling `Start`.| -|[Start Method](iclrruntimehost-start-method.md)|Initializes the CLR into a process.| -|[Stop Method](iclrruntimehost-stop-method.md)|Stops the execution of code by the runtime.| -|[UnloadAppDomain Method](iclrruntimehost-unloadappdomain-method.md)|Unloads the that corresponds to the specified numeric identifier.| - -## Remarks - - Starting with the .NET Framework 4, use the [ICLRMetaHost](iclrmetahost-interface.md) interface to get a pointer to the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface, and then call the [ICLRRuntimeInfo::GetInterface](iclrruntimeinfo-getinterface-method.md) method to get a pointer to `ICLRRuntimeHost`. In earlier versions of the .NET Framework, the host gets a pointer to an `ICLRRuntimeHost` instance by calling [CorBindToRuntimeEx](corbindtoruntimeex-function.md) or [CorBindToCurrentRuntime](corbindtocurrentruntime-function.md). To provide implementations of any of the technologies provided in .NET Framework version 2.0, you must use `ICLRRuntimeHost` instead of `ICorRuntimeHost`. +Provides functionality similar to that of the [ICorRuntimeHost](icorruntimehost-interface.md) interface provided in the .NET Framework version 1, with the following changes: + +- The addition of the [SetHostControl](iclrruntimehost-sethostcontrol-method.md) method to set the host control interface. + +- The omission of some methods provided by `ICorRuntimeHost`. + +## Methods + +|Method|Description| +|------------|-----------------| +|[ExecuteApplication Method](iclrruntimehost-executeapplication-method.md)|Used in manifest-based ClickOnce deployment scenarios to specify the application to be activated in a new domain.| +|[ExecuteInAppDomain Method](iclrruntimehost-executeinappdomain-method.md)|Specifies the in which to execute the specified managed code.| +|[ExecuteInDefaultAppDomain Method](iclrruntimehost-executeindefaultappdomain-method.md)|Invokes the specified method of the specified type in the specified assembly.| +|[GetCLRControl Method](iclrruntimehost-getclrcontrol-method.md)|Gets an interface pointer of type [ICLRControl](iclrcontrol-interface.md) that hosts can use to customize aspects of the common language runtime (CLR).| +|[GetCurrentAppDomainId Method](iclrruntimehost-getcurrentappdomainid-method.md)|Gets the numeric identifier of the that is currently executing.| +|[SetHostControl Method](iclrruntimehost-sethostcontrol-method.md)|Sets the host control interface. You must call `SetHostControl` before calling `Start`.| +|[Start Method](iclrruntimehost-start-method.md)|Initializes the CLR into a process.| +|[Stop Method](iclrruntimehost-stop-method.md)|Stops the execution of code by the runtime.| +|[UnloadAppDomain Method](iclrruntimehost-unloadappdomain-method.md)|Unloads the that corresponds to the specified numeric identifier.| + +## Remarks + Starting with the .NET Framework 4, use the [ICLRMetaHost](iclrmetahost-interface.md) interface to get a pointer to the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface, and then call the [ICLRRuntimeInfo::GetInterface](iclrruntimeinfo-getinterface-method.md) method to get a pointer to `ICLRRuntimeHost`. In earlier versions of the .NET Framework, the host gets a pointer to an `ICLRRuntimeHost` instance by calling [CorBindToRuntimeEx](corbindtoruntimeex-function.md) or [CorBindToCurrentRuntime](corbindtocurrentruntime-function.md). To provide implementations of any of the technologies provided in .NET Framework version 2.0, you must use `ICLRRuntimeHost` instead of `ICorRuntimeHost`. + > [!IMPORTANT] -> Do not call the [Start](iclrruntimehost-start-method.md) method before calling the [ExecuteApplication](iclrruntimehost-executeapplication-method.md) method to activate a manifest-based application. If the `Start` method is called first, the `ExecuteApplication` method call will fail. - -## 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 2.0 +> Do not call the [Start](iclrruntimehost-start-method.md) method before calling the [ExecuteApplication](iclrruntimehost-executeapplication-method.md) method to activate a manifest-based application. If the `Start` method is called first, the `ExecuteApplication` method call will fail. + +## 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 - [CorBindToCurrentRuntime Function](corbindtocurrentruntime-function.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md similarity index 58% rename from docs/core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md rename to docs/framework/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md index 19d78b0982ea5..a08755177023a 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrruntimehost-sethostcontrol-method.md @@ -2,63 +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]" -topic_type: +ms.assetid: 6136be87-e631-4756-81ed-74b66581bad4 +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](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - +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)] + ## See also - [ICLRRuntimeHost Interface](iclrruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimehost-start-method.md similarity index 53% rename from docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md rename to docs/framework/unmanaged-api/hosting/iclrruntimehost-start-method.md index 2167871d70efc..ea6b86bb5f30e 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-start-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrruntimehost-start-method.md @@ -2,55 +2,56 @@ description: "Learn more about: ICLRRuntimeHost::Start Method" title: "ICLRRuntimeHost::Start Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeHost.Start" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeHost::Start" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeHost::Start method [.NET Framework hosting]" - "Start method, ICLRRuntimeHost interface [.NET Framework hosting]" -topic_type: +ms.assetid: c0a6dce5-0a8d-42e8-808b-6ca14df9d289 +topic_type: - "apiref" --- # ICLRRuntimeHost::Start Method -Initializes the common language runtime (CLR) into a process. - -## Syntax - -```cpp -HRESULT Start(); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Start` 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.| - -## Remarks - - In many scenarios it is not necessary to call `Start`, because the runtime will initialize itself automatically upon the first request to run managed code. You can, however, use `Start` to specify exactly when the runtime should be initialized. - -## 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 2.0 - +Initializes the common language runtime (CLR) into a process. + +## Syntax + +```cpp +HRESULT Start(); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Start` 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.| + +## Remarks + + In many scenarios it is not necessary to call `Start`, because the runtime will initialize itself automatically upon the first request to run managed code. You can, however, use `Start` to specify exactly when the runtime should be initialized. + +## 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 - diff --git a/docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimehost-stop-method.md similarity index 55% rename from docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md rename to docs/framework/unmanaged-api/hosting/iclrruntimehost-stop-method.md index ea77c1052600f..763a74f2ee6ad 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-stop-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrruntimehost-stop-method.md @@ -2,54 +2,55 @@ description: "Learn more about: ICLRRuntimeHost::Stop Method" title: "ICLRRuntimeHost::Stop Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeHost.Stop" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeHost::Stop" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeHost::Stop method [.NET Framework hosting]" - "Stop method, ICLRRuntimeHost interface [.NET Framework hosting]" -topic_type: +ms.assetid: b8fd7daf-8f8d-4ad7-92ae-019db244cec1 +topic_type: - "apiref" --- # ICLRRuntimeHost::Stop Method -Stops the execution of code by the common language runtime (CLR). - +Stops the execution of code by the common language runtime (CLR). + > [!IMPORTANT] -> This method does not release resources to the host, unload application domains, or destroy threads. You must terminate the process to release these resources. - -## Syntax - -```cpp -HRESULT Stop(); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Stop` 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.| - -## 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 2.0 - +> This method does not release resources to the host, unload application domains, or destroy threads. You must terminate the process to release these resources. + +## Syntax + +```cpp +HRESULT Stop(); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Stop` 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.| + +## 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/core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md similarity index 56% rename from docs/core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md rename to docs/framework/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md index 5c08f21ab5ef4..7b0c227d61f63 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrruntimehost-unloadappdomain-method.md @@ -2,66 +2,67 @@ description: "Learn more about: ICLRRuntimeHost::UnloadAppDomain Method" title: "ICLRRuntimeHost::UnloadAppDomain Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeHost.UnloadAppDomain" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeHost::UnloadAppDomain" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeHost::UnloadAppDomain method [.NET Framework hosting]" - "UnloadAppDomain method [.NET Framework hosting]" -topic_type: +ms.assetid: 571912bc-3429-4ff8-8eb2-ea993ffbd901 +topic_type: - "apiref" --- # ICLRRuntimeHost::UnloadAppDomain Method -Unloads the managed that corresponds to the specified numeric identifier. - -## Syntax - -```cpp -HRESULT UnloadAppDomain( - [in] DWORD dwAppDomainId - [in] BOOL fWaitUntilDone -); -``` - -## Parameters - - `dwAppDomainId` - [in] The numeric identifier of the application domain to unload. - - `fWaitUntilDone` - [in] `true` to indicate that the common language runtime( CLR) must wait until it has finished executing the application's current thread before attempting to unload the application domain. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`UnloadAppDomain` 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.| - -## Remarks - - You can get the numeric identifier of the application domain in which the current thread is executing by calling [GetCurrentAppDomainId](iclrruntimehost-getcurrentappdomainid-method.md). This identifier corresponds to the property of the managed type. - -## 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 2.0 - +Unloads the managed that corresponds to the specified numeric identifier. + +## Syntax + +```cpp +HRESULT UnloadAppDomain( + [in] DWORD dwAppDomainId + [in] BOOL fWaitUntilDone +); +``` + +## Parameters + + `dwAppDomainId` + [in] The numeric identifier of the application domain to unload. + + `fWaitUntilDone` + [in] `true` to indicate that the common language runtime( CLR) must wait until it has finished executing the application's current thread before attempting to unload the application domain. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`UnloadAppDomain` 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.| + +## Remarks + + You can get the numeric identifier of the application domain in which the current thread is executing by calling [GetCurrentAppDomainId](iclrruntimehost-getcurrentappdomainid-method.md). This identifier corresponds to the property of the managed type. + +## 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-bindaslegacyv2runtime-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md new file mode 100644 index 0000000000000..a69824369b18a --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-bindaslegacyv2runtime-method.md @@ -0,0 +1,58 @@ +--- +description: "Learn more about: ICLRRuntimeInfo::BindAsLegacyV2Runtime Method" +title: "ICLRRuntimeInfo::BindAsLegacyV2Runtime Method" +ms.date: "03/30/2017" +api_name: + - "ICLRRuntimeInfo.BindAsLegacyV2Runtime" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRRuntimeInfo::BindAsLegacyV2Runtime" +helpviewer_keywords: + - "ICLRRuntimeInfo::BindAsLegacyV2Runtime method [.NET Framework hosting]" + - "BindAsLegacyV2Runtime method [.NET Framework hosting]" +ms.assetid: 65fd55ac-4a24-4479-9384-a2e8013bfb2b +topic_type: + - "apiref" +--- +# ICLRRuntimeInfo::BindAsLegacyV2Runtime Method + +Binds the current runtime for all legacy common language runtime (CLR) version 2 activation policy decisions. + +## Syntax + +```cpp +HRESULT BindAsLegacyV2Runtime (); +``` + +## Return Value + + This method returns the following specific HRESULTs: + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|Either binding succeeded, or this runtime was already bound as the legacy CLR version 2 activation policy runtime.| +|CLR_E_SHIM_LEGACYRUNTIMEALREADYBOUND|A different runtime was already bound to the legacy CLR version 2 activation policy.| + +## Remarks + + If the current runtime is already bound for all legacy CLR version 2 activation policy decisions (for example, by using the `useLegacyV2RuntimeActivationPolicy` attribute on the [\ element](../../configure-apps/file-schema/startup/startup-element.md) in the configuration file), this method does not return an error result; instead, the result is S_OK, just as it would be if the method had successfully bound legacy activation policy. + +## 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) +- [Hosting Interfaces](hosting-interfaces.md) +- [Hosting](index.md) +- [\ Element](../../configure-apps/file-schema/startup/startup-element.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md similarity index 55% rename from docs/core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md rename to docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md index 3d25b2983712e..0019cbf1daaf2 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getdefaultstartupflags-method.md @@ -2,66 +2,67 @@ description: "Learn more about: ICLRRuntimeInfo::GetDefaultStartupFlags Method" title: "ICLRRuntimeInfo::GetDefaultStartupFlags Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeInfo.GetDefaultStartupFlags" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeInfo::GetDefaultStartupFlags" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeInfo::GetDefaultStartupFlags method [.NET Framework hosting]" - "GetDefaultStartupFlags method [.NET Framework hosting]" -topic_type: +ms.assetid: 35c2173e-3b0b-4b2a-950d-e0a01c6df052 +topic_type: - "apiref" --- # ICLRRuntimeInfo::GetDefaultStartupFlags Method -Gets the startup flags and host configuration file that will be used to start the runtime. - -## Syntax - -```cpp -HRESULT GetDefaultStartupFlags( - [out] DWORD *pdwStartupFlags, - [out, size_is(*pcchHostConfigFile)] LPWSTR pwzHostConfigFile, - [in, out] DWORD *pcchHostConfigFile); -``` - -## Parameters - - `pdwStartupFlags` - [out] A pointer to the host startup flags that are currently set. - - `pwzHostConfigFile` - [out] A pointer to the directory path of the current host configuration file. - - `pcchHostConfigFile` - [in, out] On input, the size of `pwzHostConfigFile`, to avoid buffer overruns. If `pwzHostConfigFile` is null, the method returns the required size of `pwzHostConfigFile` for pre-allocation. - -## Return Value - - This method returns the following specific HRESULT as well as HRESULT errors that indicate method failure. - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method completed successfully.| - -## Remarks - - This method returns the default flag values (`STARTUP_CONCURRENT_GC` and `NULL`), or the values provided by a previous call to the [ICLRRuntimeInfo::SetDefaultStartupFlags method](iclrruntimeinfo-setdefaultstartupflags-method.md), or the values set by any of the `CorBind*` methods if they are bound to this runtime. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Gets the startup flags and host configuration file that will be used to start the runtime. + +## Syntax + +```cpp +HRESULT GetDefaultStartupFlags( + [out] DWORD *pdwStartupFlags, + [out, size_is(*pcchHostConfigFile)] LPWSTR pwzHostConfigFile, + [in, out] DWORD *pcchHostConfigFile); +``` + +## Parameters + + `pdwStartupFlags` + [out] A pointer to the host startup flags that are currently set. + + `pwzHostConfigFile` + [out] A pointer to the directory path of the current host configuration file. + + `pcchHostConfigFile` + [in, out] On input, the size of `pwzHostConfigFile`, to avoid buffer overruns. If `pwzHostConfigFile` is null, the method returns the required size of `pwzHostConfigFile` for pre-allocation. + +## Return Value + + This method returns the following specific HRESULT as well as HRESULT errors that indicate method failure. + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method completed successfully.| + +## Remarks + + This method returns the default flag values (`STARTUP_CONCURRENT_GC` and `NULL`), or the values provided by a previous call to the [ICLRRuntimeInfo::SetDefaultStartupFlags method](iclrruntimeinfo-setdefaultstartupflags-method.md), or the values set by any of the `CorBind*` methods if they are bound to this runtime. + +## 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-getinterface-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md new file mode 100644 index 0000000000000..ebde545d9275e --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getinterface-method.md @@ -0,0 +1,87 @@ +--- +description: "Learn more about: ICLRRuntimeInfo::GetInterface Method" +title: "ICLRRuntimeInfo::GetInterface Method" +ms.date: "03/30/2017" +api_name: + - "ICLRRuntimeInfo.GetInterface" +api_location: + - "mscordbi.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRRuntimeInfo::GetInterface" +helpviewer_keywords: + - "GetInterface method [.NET Framework hosting]" + - "ICLRRuntimeInfo::GetInterface method [.NET Framework hosting]" +ms.assetid: cc7b0e5b-48c3-4509-8ebb-611ddb1f7ec2 +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| +|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)] + +## See also + +- [ICLRRuntimeInfo Interface](iclrruntimeinfo-interface.md) +- [Hosting Interfaces](hosting-interfaces.md) +- [Hosting](index.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md new file mode 100644 index 0000000000000..8ea6e3a07b2fc --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getprocaddress-method.md @@ -0,0 +1,70 @@ +--- +description: "Learn more about: ICLRRuntimeInfo::GetProcAddress Method" +title: "ICLRRuntimeInfo::GetProcAddress Method" +ms.date: "03/30/2017" +api_name: + - "ICLRRuntimeInfo.GetProcAddress" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRRuntimeInfo::GetProcAddress" +helpviewer_keywords: + - "GetProcAddress method [.NET Framework hosting]" + - "ICLRRuntimeInfo::GetProcAddress method [.NET Framework hosting]" +ms.assetid: a7732bfc-689a-4926-88fd-4f81e6f9ed78 +topic_type: + - "apiref" +--- +# ICLRRuntimeInfo::GetProcAddress Method + +Gets the address of a specified function that was exported from the common language runtime (CLR) associated with this interface. + + This method supersedes the [GetRealProcAddress](getrealprocaddress-function.md) function. + +## Syntax + +```cpp +HRESULT GetProcAddress( + [in] LPCSTR pszProcName, + [out, retval] LPVOID *ppProc); +``` + +## Parameters + + `pszProcName` + [in] The name of the exported function. + + `ppProc` + [out] The address of the exported function. + +## 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|`pszProcName` or `ppProc` is null.| +|CLR_E_SHIM_RUNTIMEEXPORT|The specified function is not an exported function.| + +## Remarks + + This method causes the CLR to be loaded but not initialized. + +## 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) +- [Hosting Interfaces](hosting-interfaces.md) +- [Hosting](index.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md similarity index 51% rename from docs/core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md rename to docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md index d5dad26cf1499..d2bac28c02bbb 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getruntimedirectory-method.md @@ -2,63 +2,64 @@ description: "Learn more about: ICLRRuntimeInfo::GetRuntimeDirectory Method" title: "ICLRRuntimeInfo::GetRuntimeDirectory Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeInfo.GetRuntimeDirectory" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeInfo::GetRuntimeDirectory" -helpviewer_keywords: +helpviewer_keywords: - "GetRuntimeDirectory method [.NET Framework hosting]" - "ICLRRuntimeInfo::GetRuntimeDirectory method [.NET Framework hosting]" -topic_type: +ms.assetid: 4401546e-4d48-453f-a1fb-b2ebda54df5c +topic_type: - "apiref" --- # ICLRRuntimeInfo::GetRuntimeDirectory Method -Gets the installation directory of the common language runtime (CLR) associated with this interface. - - This method supersedes the [GetCORSystemDirectory](getcorsystemdirectory-function.md) function provided in the .NET Framework versions 2.0, 3.0, and 3.5. - -## Syntax - -```cpp -HRESULT GetRuntimeDirectory( -[out, size_is(*pcchBuffer)] LPWSTR pwzBuffer, -[in, out] DWORD *pcchBuffer); -``` - -## Parameters - - `pwzBuffer` - [out] Returns the CLR installation directory. The installation path is fully qualified; for example, "c:\windows\microsoft.net\framework\v1.0.3705\\". - - `pchBuffer` - [in, out] Specifies the size of `pwzBuffer` to avoid buffer overruns. If `pwzBuffer` is null, `pchBuffer` returns the required size of `pwzBuffer`. - -## 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|`pwzBuffer` or `pchBuffer` is null.| - -## Remarks - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Gets the installation directory of the common language runtime (CLR) associated with this interface. + + This method supersedes the [GetCORSystemDirectory](getcorsystemdirectory-function.md) function provided in the .NET Framework versions 2.0, 3.0, and 3.5. + +## Syntax + +```cpp +HRESULT GetRuntimeDirectory( +[out, size_is(*pcchBuffer)] LPWSTR pwzBuffer, +[in, out] DWORD *pcchBuffer); +``` + +## Parameters + + `pwzBuffer` + [out] Returns the CLR installation directory. The installation path is fully qualified; for example, "c:\windows\microsoft.net\framework\v1.0.3705\\". + + `pchBuffer` + [in, out] Specifies the size of `pwzBuffer` to avoid buffer overruns. If `pwzBuffer` is null, `pchBuffer` returns the required size of `pwzBuffer`. + +## 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|`pwzBuffer` or `pchBuffer` is null.| + +## Remarks + +## 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/core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md similarity index 61% rename from docs/core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md rename to docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md index bc68f4bd7c7b6..d43eacac6048d 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-getversionstring-method.md @@ -2,70 +2,71 @@ description: "Learn more about: ICLRRuntimeInfo::GetVersionString Method" title: "ICLRRuntimeInfo::GetVersionString Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeInfo.GetVersionString" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeInfo::GetVersionString" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeInfo::GetVersionString method [.NET Framework hosting]" - "GetVersionString method, ICLRRuntimeInfo interface [.NET Framework hosting]" -topic_type: +ms.assetid: 98b097ef-2276-4dd9-8551-b03c972e8179 +topic_type: - "apiref" --- # ICLRRuntimeInfo::GetVersionString Method -Gets common language runtime (CLR) version information associated with a given [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface. - - This method supersedes the following functions: - -- [GetRequestedRuntimeInfo](getrequestedruntimeinfo-function.md) - -- [GetRequestedRuntimeVersion](getrequestedruntimeversion-function.md) - -## Syntax - -```cpp -HRESULT GetVersionString( - [out, size_is(*pcchBuffer)] LPWSTR pwzBuffer, - [in, out] DWORD *pcchBuffer); -``` - -## Parameters - - `pwzBuffer` - [out] The .NET Framework compilation version in the format "v*A*.*B*[.*X*]". *A*, *B*, and *X* are decimal numbers that correspond to the major version, the minor version, and the build number. *X* is optional. If *X* is not present, there is no trailing period. - +Gets common language runtime (CLR) version information associated with a given [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface. + + This method supersedes the following functions: + +- [GetRequestedRuntimeInfo](getrequestedruntimeinfo-function.md) + +- [GetRequestedRuntimeVersion](getrequestedruntimeversion-function.md) + +## Syntax + +```cpp +HRESULT GetVersionString( + [out, size_is(*pcchBuffer)] LPWSTR pwzBuffer, + [in, out] DWORD *pcchBuffer); +``` + +## Parameters + + `pwzBuffer` + [out] The .NET Framework compilation version in the format "v*A*.*B*[.*X*]". *A*, *B*, and *X* are decimal numbers that correspond to the major version, the minor version, and the build number. *X* is optional. If *X* is not present, there is no trailing period. + > [!NOTE] -> This parameter must match the directory name for the .NET Framework version, as it appears under C:\Windows\Microsoft.NET\Framework. - - Example values are "v1.0.3705", "v1.1.4322", "v2.0.50727", and "v4.0.*x*", where *x* depends on the build number installed. Note that the "v" prefix is mandatory. - - `pchBuffer` - [in, out] Specifies the size of `pwzBuffer` to avoid buffer overruns. If `pwzBuffer` is `null`, `pchBuffer` returns the required size of `pwzBuffer` to allow preallocation. - -## 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|`pwzBuffer` or `pchBuffer` is null.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +> This parameter must match the directory name for the .NET Framework version, as it appears under C:\Windows\Microsoft.NET\Framework. + + Example values are "v1.0.3705", "v1.1.4322", "v2.0.50727", and "v4.0.*x*", where *x* depends on the build number installed. Note that the "v" prefix is mandatory. + + `pchBuffer` + [in, out] Specifies the size of `pwzBuffer` to avoid buffer overruns. If `pwzBuffer` is `null`, `pchBuffer` returns the required size of `pwzBuffer` to allow preallocation. + +## 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|`pwzBuffer` or `pchBuffer` is null.| + +## 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/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-interface.md similarity index 76% rename from docs/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md rename to docs/framework/unmanaged-api/hosting/iclrruntimeinfo-interface.md index 74de2f210f43f..c874877bbf132 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-interface.md @@ -2,50 +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]" -topic_type: +ms.assetid: 287e5ede-b3a7-4ef8-a756-4fca3f285a82 +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](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET 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](../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/core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md similarity index 57% rename from docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md rename to docs/framework/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md index eaf9162c17918..13c0c7ba34274 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-isloadable-method.md @@ -2,61 +2,62 @@ description: "Learn more about: ICLRRuntimeInfo::IsLoadable Method" title: "ICLRRuntimeInfo::IsLoadable Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeInfo.IsLoadable" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeInfo::IsLoadable" -helpviewer_keywords: +helpviewer_keywords: - "IsLoadable method [.NET Framework hosting]" - "ICLRRuntimeInfo::IsLoadable method [.NET Framework hosting]" -topic_type: +ms.assetid: 205ca53b-e78e-49b2-9a46-2a7823e96b8c +topic_type: - "apiref" --- # ICLRRuntimeInfo::IsLoadable Method -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. - -## Syntax - -```cpp -HRESULT IsLoadable( - [out, retval] BOOL *pbLoadable); -``` - -## Parameters - - `pbLoadable` - [out] `true` if this runtime could be loaded into the current process; otherwise, `false`. - -## 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|`pbLoadable` is null.| - -## Remarks - - If another runtime is already loaded into the process, and the runtime associated with this interface can be loaded for in-process side-by-side execution, `pbLoadable` returns `true`. If the two runtimes cannot run side-by-side in-process, `pbLoadable` returns `false`. For example, the common language runtime (CLR) version 4 can run side-by-side in the same process with CLR version 2.0 or CLR version 1.1. However, CLR version 1.1 and CLR version 2.0 cannot run side-by-side in-process. - - If no runtimes are loaded into the process, this method always returns `true`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.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. + +## Syntax + +```cpp +HRESULT IsLoadable( + [out, retval] BOOL *pbLoadable); +``` + +## Parameters + + `pbLoadable` + [out] `true` if this runtime could be loaded into the current process; otherwise, `false`. + +## 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|`pbLoadable` is null.| + +## Remarks + + If another runtime is already loaded into the process, and the runtime associated with this interface can be loaded for in-process side-by-side execution, `pbLoadable` returns `true`. If the two runtimes cannot run side-by-side in-process, `pbLoadable` returns `false`. For example, the common language runtime (CLR) version 4 can run side-by-side in the same process with CLR version 2.0 or CLR version 1.1. However, CLR version 1.1 and CLR version 2.0 cannot run side-by-side in-process. + + If no runtimes are loaded into the process, this method always returns `true`. + +## 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/core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md similarity index 60% rename from docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md rename to docs/framework/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md index e765395ce09f7..98325107f3a82 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-isloaded-method.md @@ -2,73 +2,74 @@ description: "Learn more about: ICLRRuntimeInfo::IsLoaded Method" title: "ICLRRuntimeInfo::IsLoaded Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeInfo.IsLoaded" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeInfo::IsLoaded" -helpviewer_keywords: +helpviewer_keywords: - "IsLoaded method [.NET Framework hosting]" - "ICLRRuntimeInfo::IsLoaded method [.NET Framework hosting]" -topic_type: +ms.assetid: fdc5a3a7-71ff-4025-99a1-59e4ee0bfe1b +topic_type: - "apiref" --- # ICLRRuntimeInfo::IsLoaded Method -Indicates whether the common language runtime (CLR) associated with the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface is loaded into a process. A runtime can be loaded without also being started. - -## Syntax - -```cpp -HRESULT IsLoaded( -[in] HANDLE hndProcess, -[out, retval] BOOL *pbLoaded); -``` - -## Parameters - - `hndProcess` - [in] A handle to the process. - - `pbLoaded` - [out] `true` if the CLR is loaded into the process; otherwise, `false`. - -## 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|`pbLoaded` is null.| - -## Remarks - - This method is backward-compatible with the following functions and interfaces: - -- [ICorRuntimeHost](icorruntimehost-interface.md) interface (in the .NET Framework version 1 hosting API). - -- [ICLRRuntimeHost](iclrruntimehost-interface.md) interface (in the .NET Framework 2.0 hosting API). - -- Deprecated `CorBindTo*` functions (see [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) in the .NET Framework 2.0 hosting API). - - A host may call one of the deprecated `CorBindTo*` functions, such as the [CorBindToRuntime](corbindtoruntime-function.md) function, to instantiate a specific version of the CLR. The host could then call the [ICLRMetaHost::GetRuntime](iclrmetahost-getruntime-method.md) method and specify the same version number to obtain a [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface. - - If the host then calls the `IsLoaded` method on the returned [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface, `pbLoaded` returns `true`; otherwise, it returns `false`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Indicates whether the common language runtime (CLR) associated with the [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface is loaded into a process. A runtime can be loaded without also being started. + +## Syntax + +```cpp +HRESULT IsLoaded( +[in] HANDLE hndProcess, +[out, retval] BOOL *pbLoaded); +``` + +## Parameters + + `hndProcess` + [in] A handle to the process. + + `pbLoaded` + [out] `true` if the CLR is loaded into the process; otherwise, `false`. + +## 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|`pbLoaded` is null.| + +## Remarks + + This method is backward-compatible with the following functions and interfaces: + +- [ICorRuntimeHost](icorruntimehost-interface.md) interface (in the .NET Framework version 1 hosting API). + +- [ICLRRuntimeHost](iclrruntimehost-interface.md) interface (in the .NET Framework 2.0 hosting API). + +- Deprecated `CorBindTo*` functions (see [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) in the .NET Framework 2.0 hosting API). + + A host may call one of the deprecated `CorBindTo*` functions, such as the [CorBindToRuntime](corbindtoruntime-function.md) function, to instantiate a specific version of the CLR. The host could then call the [ICLRMetaHost::GetRuntime](iclrmetahost-getruntime-method.md) method and specify the same version number to obtain a [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface. + + If the host then calls the `IsLoaded` method on the returned [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface, `pbLoaded` returns `true`; otherwise, it returns `false`. + +## 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-isstarted-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md new file mode 100644 index 0000000000000..e38eb8ba3dcc1 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-isstarted-method.md @@ -0,0 +1,65 @@ +--- +description: "Learn more about: ICLRRuntimeInfo::IsStarted Method" +title: "ICLRRuntimeInfo::IsStarted Method" +ms.date: "03/30/2017" +api_name: + - "ICLRRuntimeInfo.IsStarted" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRRuntimeInfo::IsStarted" +helpviewer_keywords: + - "IsStarted method [.NET Framework hosting]" + - "ICLRRuntimeInfo::IsStarted method [.NET Framework hosting]" +ms.assetid: ef6f2662-323b-4534-aa82-6d1afb7b9309 +--- +# ICLRRuntimeInfo::IsStarted Method + +Indicates whether the runtime has been started (that is, whether the [ICLRRuntimeHost::Start method](iclrruntimehost-start-method.md) has been called and has succeeded). + +## Syntax + +```cpp +HRESULT IsStarted( + [out] BOOL *pbStarted, + [out] DWORD *pdwStartupFlags); +``` + +## Parameters + + `pbStarted` + [out] `true` if this runtime is started; otherwise, `false`. + + `pdwStartupFlags` + [out] Returns the flags that were used to start the runtime. + +## 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_NOTIMPL|The common language runtime (CLR) version is earlier than the CLR version in the .NET Framework 4.| + +## Remarks + + This method does not work with CLR versions earlier than the CLR version in the .NET Framework 4. + +## 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) +- [Hosting Interfaces](hosting-interfaces.md) +- [Hosting](index.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md new file mode 100644 index 0000000000000..b6cec93e2e597 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-loaderrorstring-method.md @@ -0,0 +1,78 @@ +--- +description: "Learn more about: ICLRRuntimeInfo::LoadErrorString Method" +title: "ICLRRuntimeInfo::LoadErrorString Method" +ms.date: "03/30/2017" +api_name: + - "ICLRRuntimeInfo.LoadErrorString" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRRuntimeInfo::LoadErrorString" +helpviewer_keywords: + - "ICLRRuntimeInfo::LoadErrorString method [.NET Framework hosting]" + - "LoadErrorString method [.NET Framework hosting]" +ms.assetid: 52c543ab-9ef5-4ee7-b836-c0ffc35cd45b +topic_type: + - "apiref" +--- +# ICLRRuntimeInfo::LoadErrorString Method + +Translates an HRESULT value into an appropriate error message for the specified culture. + + This method supersedes the following functions: + +- [LoadStringRC](loadstringrc-function.md) + +- [LoadStringRCEx](loadstringrcex-function.md) + +## Syntax + +```cpp +HRESULT LoadErrorString( + [in] UINT iResourceID, + [out, size_is(*pcchBuffer)] LPWSTR pwzBuffer, + [in, out] DWORD *pcchBuffer, + [in, lcid] LONG iLocaleID); +``` + +## Parameters + + `iResourceID` + [in] The HRESULT to translate. + + `pwzBuffer` + [out] The message string associated with the given HRESULT. + + `pcchBuffer` + [in, out] The size of `pwzbuffer` to avoid buffer overruns. If `pwzbuffer` is null, `pcchBuffer` provides the expected size of `pwzbuffer` to allow preallocation. + + `iLocaleID` + [in] The culture identifier. To use the default culture, you must specify -1. + +## 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|`pcchBuffer` is null.| +|E_INVALIDARG|`pwzBuffer` is null.| + +## 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) +- [Hosting Interfaces](hosting-interfaces.md) +- [Hosting](index.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md new file mode 100644 index 0000000000000..8eaccd8dc9fb4 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-loadlibrary-method.md @@ -0,0 +1,70 @@ +--- +description: "Learn more about: ICLRRuntimeInfo::LoadLibrary Method" +title: "ICLRRuntimeInfo::LoadLibrary Method" +ms.date: "03/30/2017" +api_name: + - "ICLRRuntimeInfo.LoadLibrary" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRRuntimeInfo::LoadLibrary" +helpviewer_keywords: + - "ICLRRuntimeInfo::LoadLibrary method [.NET Framework hosting]" + - "LoadLibrary method [.NET Framework hosting]" +ms.assetid: 4517ada3-4417-4ac5-a150-73da7a87c686 +topic_type: + - "apiref" +--- +# ICLRRuntimeInfo::LoadLibrary Method + +Loads a .NET Framework library from the common language runtime (CLR) represented by an [ICLRRuntimeInfo](iclrruntimeinfo-interface.md) interface. + + This method supersedes the [LoadLibraryShim](loadlibraryshim-function.md) function. + +## Syntax + +```cpp +HRESULT LoadLibrary( + [in] LPCWSTR pwzDllName, + [out, retval] HMODULE *phndModule); +``` + +## Parameters + + `pwzDllName` + [in] The name of the assembly to be loaded. + + `phndModule` + [out] A handle to the loaded assembly. + +## 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|`pwzDllName` or `phndModule` is null.| +|E_OUTOFMEMORY|Not enough memory is available to handle the request.| + +## Remarks + + This method only loads DLLs included in the .NET Framework redistributable package. It can not load user-generated assemblies. + +## 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) +- [Hosting Interfaces](hosting-interfaces.md) +- [Hosting](index.md) diff --git a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md similarity index 57% rename from docs/core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md rename to docs/framework/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md index db5b91bfeec60..ae74865958f44 100644 --- a/docs/core/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrruntimeinfo-setdefaultstartupflags-method.md @@ -2,62 +2,63 @@ description: "Learn more about: ICLRRuntimeInfo::SetDefaultStartupFlags Method" title: "ICLRRuntimeInfo::SetDefaultStartupFlags Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRRuntimeInfo.SetDefaultStartupFlags" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRRuntimeInfo::SetDefaultStartupFlags" -helpviewer_keywords: +helpviewer_keywords: - "ICLRRuntimeInfo::SetDefaultStartupFlags method [.NET Framework hosting]" - "SetDefaultStartupFlags method [.NET Framework hosting]" -topic_type: +ms.assetid: 98ae174f-bff0-48f1-9e05-6cb63b451824 +topic_type: - "apiref" --- # ICLRRuntimeInfo::SetDefaultStartupFlags Method -Sets the startup flags and the host configuration file that will be used to start the runtime. This method supersedes the use of the `startupFlags` parameter in the [CorBindToRuntimeEx](corbindtoruntimeex-function.md) and [CorBindToRuntimeHost](corbindtoruntimehost-function.md) functions. - -## Syntax - -```cpp -HRESULT SetDefaultStartupFlags( - [in] DWORD dwStartupFlags, - [in] LPCWSTR pwzHostConfigFile); -``` - -## Parameters - - `dwStartupFlags` - [in] The host startup flags to set. Use the same flags as with the [CorBindToRuntimeEx](corbindtoruntimeex-function.md) and [CorBindToRuntimeHost](corbindtoruntimehost-function.md) functions. - - `pwzHostConfigFile` - [in] The directory path of the host configuration file to set. - -## Return Value - - This method returns the following specific HRESULT as well as HRESULT errors that indicate method failure. - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method completed successfully.| - -## Remarks - - A multithreaded host should synchronize calls to this method. Otherwise, thread A might call the `SetStartupFlags` method after thread B completes a call to `SetStartupFlags` and before thread B starts the runtime. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Sets the startup flags and the host configuration file that will be used to start the runtime. This method supersedes the use of the `startupFlags` parameter in the [CorBindToRuntimeEx](corbindtoruntimeex-function.md) and [CorBindToRuntimeHost](corbindtoruntimehost-function.md) functions. + +## Syntax + +```cpp +HRESULT SetDefaultStartupFlags( + [in] DWORD dwStartupFlags, + [in] LPCWSTR pwzHostConfigFile); +``` + +## Parameters + + `dwStartupFlags` + [in] The host startup flags to set. Use the same flags as with the [CorBindToRuntimeEx](corbindtoruntimeex-function.md) and [CorBindToRuntimeHost](corbindtoruntimehost-function.md) functions. + + `pwzHostConfigFile` + [in] The directory path of the host configuration file to set. + +## Return Value + + This method returns the following specific HRESULT as well as HRESULT errors that indicate method failure. + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method completed successfully.| + +## Remarks + + A multithreaded host should synchronize calls to this method. Otherwise, thread A might call the `SetStartupFlags` method after thread B completes a call to `SetStartupFlags` and before thread B starts the runtime. + +## 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/iclrstrongname-gethashfromassemblyfile-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md new file mode 100644 index 0000000000000..4dcb1c50ec156 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfile-method.md @@ -0,0 +1,70 @@ +--- +description: "Learn more about: ICLRStrongName::GetHashFromAssemblyFile Method" +title: "ICLRStrongName::GetHashFromAssemblyFile Method" +ms.date: "03/30/2017" +api_name: + - "ICLRStrongName.GetHashFromAssemblyFile" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRStrongName::GetHashFromAssemblyFile" +helpviewer_keywords: + - "ICLRStrongName::GetHashFromAssemblyFile method [.NET Framework hosting]" + - "GetHashFromAssemblyFile method, ICLRStrongName interface [.NET Framework hosting]" +ms.assetid: 0b67ea03-d474-4605-acaa-57455790250c +topic_type: + - "apiref" +--- +# ICLRStrongName::GetHashFromAssemblyFile Method + +Gets a hash of the specified assembly file, using the specified hash algorithm. + +## Syntax + +```cpp +HRESULT GetHashFromAssemblyFile ( + [in] LPCSTR szFilePath, + [in, out] unsigned int *piHashAlg, + [out] BYTE *pbHash, + [in] DWORD cchHash, + [out] DWORD *pchHash +); +``` + +## Parameters + + `szFilePath` + [in] The path to the file to be hashed. + + `piHashAlg` + [in, out] A constant that specifies the hash algorithm. Use zero for the default hash algorithm. + + `pbHash` + [out] The returned hash buffer. + + `cchHash` + [in] The requested maximum size of `pbHash`. + + `pchHash` + [out] The returned size, in bytes, of `pbHash`. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## 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 + +- [GetHashFromAssemblyFileW Method](iclrstrongname-gethashfromassemblyfilew-method.md) +- [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md new file mode 100644 index 0000000000000..2106c425080b5 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromassemblyfilew-method.md @@ -0,0 +1,70 @@ +--- +description: "Learn more about: ICLRStrongName::GetHashFromAssemblyFileW Method" +title: "ICLRStrongName::GetHashFromAssemblyFileW Method" +ms.date: "03/30/2017" +api_name: + - "ICLRStrongName.GetHashFromAssemblyFileW" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRStrongName::GetHashFromAssemblyFileW" +helpviewer_keywords: + - "ICLRStrongName::GetHashFromAssemblyFileW method [.NET Framework hosting]" + - "GetHashFromAssemblyFileW method, ICLRStrongName interface [.NET Framework hosting]" +ms.assetid: 5d0b44a2-5a14-44a2-9a0e-e8682fd4e106 +topic_type: + - "apiref" +--- +# ICLRStrongName::GetHashFromAssemblyFileW Method + +Generates a hash over the contents of the file specified by a Unicode string. + +## Syntax + +```cpp +HRESULT GetHashFromAssemblyFileW ( + [in] LPCWSTR wszFilePath, + [in, out] unsigned int *piHashAlg, + [out] BYTE *pbHash, + [in] DWORD cchHash, + [out] DWORD *pchHash +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the file to be hashed. This parameter must be a Unicode string. + + `piHashAlg` + [in, out] A constant that specifies the hash algorithm. Use zero for the default hash algorithm. + + `pbHash` + [out] The returned hash buffer. + + `cchHash` + [in] The requested maximum size of `pbHash`. + + `pchHash` + [out] The returned size, in bytes, of `pbHash`. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## 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 + +- [GetHashFromAssemblyFile Method](iclrstrongname-gethashfromassemblyfile-method.md) +- [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md new file mode 100644 index 0000000000000..012b1ca2c8f32 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromblob-method.md @@ -0,0 +1,73 @@ +--- +description: "Learn more about: ICLRStrongName::GetHashFromBlob Method" +title: "ICLRStrongName::GetHashFromBlob Method" +ms.date: "03/30/2017" +api_name: + - "ICLRStrongName.GetHashFromBlob" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRStrongName::GetHashFromBlob" +helpviewer_keywords: + - "ICLRStrongName::GetHashFromBlob method [.NET Framework hosting]" + - "GetHashFromBlob method, ICLRStrongName interface [.NET Framework hosting]" +ms.assetid: f91d0f89-f356-49ac-aafb-50fad963c13d +topic_type: + - "apiref" +--- +# ICLRStrongName::GetHashFromBlob Method + +Gets a hash of the assembly at the specified memory address, using the specified hash algorithm. + +## Syntax + +```cpp +HRESULT GetHashFromBlob ( + [in] BYTE *pbBlob, + [in] DWORD cchBlob, + [in, out] unsigned int *piHashAlg, + [out] BYTE *pbHash, + [in] DWORD cchHash, + [out] DWORD *pchHash +); +``` + +## Parameters + + `pbBlob` + [in] A pointer to the address of the memory block to be hashed. + + `cchBlob` + [in] The length, in bytes, of the memory block. + + `piHashAlg` + [in, out] A constant that specifies the hash algorithm. Use zero for the default algorithm. + + `pbHash` + [out] The returned hash buffer. + + `cchHash` + [in] The requested maximum size of `pbHash`. + + `pchHash` + [out] The size, in bytes, of the returned `pbHash`. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## 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 + +- [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md new file mode 100644 index 0000000000000..17b1c3842383f --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromfile-method.md @@ -0,0 +1,74 @@ +--- +description: "Learn more about: ICLRStrongName::GetHashFromFile Method" +title: "ICLRStrongName::GetHashFromFile Method" +ms.date: "03/30/2017" +api_name: + - "ICLRStrongName.GetHashFromFile" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRStrongName::GetHashFromFile" +helpviewer_keywords: + - "ICLRStrongName::GetHashFromFile method [.NET Framework hosting]" + - "GetHashFromFile method, ICLRStrongName interface [.NET Framework hosting]" +ms.assetid: 9e50480a-8ada-4044-b2a5-97bb14ed3525 +topic_type: + - "apiref" +--- +# ICLRStrongName::GetHashFromFile Method + +Generates a hash over the contents of the specified file. + +## Syntax + +```cpp +HRESULT GetHashFromFile ( + [in] LPCSTR szFilePath, + [in, out] unsigned int *piHashAlg, + [out] BYTE *pbHash, + [in] DWORD cchHash, + [out] DWORD *pchHash +); +``` + +## Parameters + + `szFilePath` + [in] The name of the file to hash. + + `piHashAlg` + [in, out] The algorithm to use when generating the hash. Valid algorithms are those defined by the Win32 CryptoAPI. If `piHashAlg` is set to 0, the default algorithm CALG_SHA-1 is used. + + `pbHash` + [out] A byte array containing the generated hash. + + `cchHash` + [in] The maximum size of the buffer that `pbHash` points to. + + `pchHash` + [out] The size, in bytes, of the returned `pbHash`. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + This method is the same as the [ICLRStrongName::GetHashFromFileW](iclrstrongname-gethashfromfilew-method.md) method, except that the file name specification is ANSI instead of Unicode. + +## 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 + +- [GetHashFromFileW Method](iclrstrongname-gethashfromfilew-method.md) +- [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md new file mode 100644 index 0000000000000..66a29a7d9eaf0 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromfilew-method.md @@ -0,0 +1,74 @@ +--- +description: "Learn more about: ICLRStrongName::GetHashFromFileW Method" +title: "ICLRStrongName::GetHashFromFileW Method" +ms.date: "03/30/2017" +api_name: + - "ICLRStrongName.GetHashFromFileW" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRStrongName::GetHashFromFileW" +helpviewer_keywords: + - "GetHashFromFileW method, ICLRStrongName interface [.NET Framework hosting]" + - "ICLRStrongName::GetHashFromFileW method [.NET Framework hosting]" +ms.assetid: c6ff45fc-905d-4c6e-b00c-97c6c7c55d99 +topic_type: + - "apiref" +--- +# ICLRStrongName::GetHashFromFileW Method + +Generates a hash over the contents of the file specified by a Unicode string. + +## Syntax + +```cpp +HRESULT GetHashFromFileW ( + [in] LPCWSTR wszFilePath, + [in, out] unsigned int *piHashAlg, + [out] BYTE *pbHash, + [in] DWORD cchHash, + [out] DWORD *pchHash +); +``` + +## Parameters + + `wszFilePath` + [in] The Unicode name of the file to hash. + + `piHashAlg` + [in, out] The algorithm to use when generating the hash. Valid algorithms are those defined by the Win32 CryptoAPI. If `piHashAlg` is set to 0, the default algorithm CALG_SHA-1 is used. + + `pbHash` + [out] A byte array containing the generated hash. + + `cchHash` + [in] The maximum size of the buffer pointed to by `pbHash`. + + `pchHash` + [out] The size, in bytes, of `pbHash`. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + This method is the same as the [ICLRStrongName::GetHashFromFile](iclrstrongname-gethashfromfile-method.md) method, except that the file name specification is Unicode instead of ANSI. + +## 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 + +- [GetHashFromFile Method](iclrstrongname-gethashfromfile-method.md) +- [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md new file mode 100644 index 0000000000000..c3bf534c1c821 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md @@ -0,0 +1,70 @@ +--- +description: "Learn more about: ICLRStrongName::GetHashFromHandle Method" +title: "ICLRStrongName::GetHashFromHandle Method" +ms.date: "03/30/2017" +api_name: + - "ICLRStrongName.GetHashFromHandle" + - "ICLRStrongName.StrongNameCompareAssemblies" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRStrongName::GetHashFromHandle" +helpviewer_keywords: + - "GetHashFromHandle method, ICLRStrongName interface [.NET Framework hosting]" + - "ICLRStrongName::GetHashFromHandle method [.NET Framework hosting]" +ms.assetid: 3bedbb7d-3cdd-4175-b370-10ae734062db +topic_type: + - "apiref" +--- +# ICLRStrongName::GetHashFromHandle Method + +Generates a hash over the contents of the file that has the specified file handle, using the specified hash algorithm. + +## Syntax + +```cpp +HRESULT GetHashFromHandle ( + [in] HANDLE hFile, + [in, out] unsigned int *piHashAlg, + [out] BYTE *pbHash, + [in] DWORD cchHash, + [out] DWORD *pchHash +); +``` + +## Parameters + + `hFile` + [in] The handle of the file to be hashed. + + `piHashAlg` + [in, out] A constant that specifies the hash algorithm. Use zero for the default algorithm. + + `pbHash` + [out] The returned hash buffer. + + `cchHash` + [in] The requested maximum size of `pbHash`. + + `pchHash` + [out] The size, in bytes, of the returned `pbHash`. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## 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 + +- [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-interface.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-interface.md similarity index 75% rename from docs/core/unmanaged-api/hosting/iclrstrongname-interface.md rename to docs/framework/unmanaged-api/hosting/iclrstrongname-interface.md index ff9034c149b5c..cb54ecb2e915d 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-interface.md @@ -2,67 +2,68 @@ description: "Learn more about: ICLRStrongName Interface" title: "ICLRStrongName Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName interface [.NET Framework hosting]" -topic_type: +ms.assetid: 2fac66fd-6b3b-4dbd-8baf-86038bd85526 +topic_type: - "apiref" --- # ICLRStrongName Interface -Provides basic global static functions for signing assemblies with strong names. All `ICLRStrongName` methods return standard COM HRESULTs. +Provides basic global static functions for signing assemblies with strong names. All `ICLRStrongName` methods return standard COM HRESULTs. + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetHashFromAssemblyFile Method](iclrstrongname-gethashfromassemblyfile-method.md)|Gets a hash of the specified assembly file, using the specified hash algorithm.| +|[GetHashFromAssemblyFileW Method](iclrstrongname-gethashfromassemblyfilew-method.md)|Gets a hash of the assembly file specified as a Unicode string, using the specified hash algorithm.| +|[GetHashFromBlob Method](iclrstrongname-gethashfromblob-method.md)|Gets a hash of the assembly at the specified memory address, using the specified hash algorithm.| +|[GetHashFromFile Method](iclrstrongname-gethashfromfile-method.md)|Generates a hash over the contents of the specified file.| +|[GetHashFromFileW Method](iclrstrongname-gethashfromfilew-method.md)|Generates a hash over the contents of the file specified by a Unicode string.| +|[GetHashFromHandle Method](iclrstrongname-gethashfromhandle-method.md)|Generates a hash over the contents of the file with the specified file handle, using the specified hash algorithm.| +|[StrongNameCompareAssemblies Method](iclrstrongname-strongnamecompareassemblies-method.md)|Determines whether two assemblies differ only by their strong name signatures.| +|[StrongNameFreeBuffer Method](iclrstrongname-strongnamefreebuffer-method.md)|Frees memory that was allocated with a previous call to a strong name method such as [StrongNameGetPublicKey](iclrstrongname-strongnamegetpublickey-method.md), [StrongNameTokenFromPublicKey](iclrstrongname-strongnametokenfrompublickey-method.md), or [StrongNameSignatureGeneration](iclrstrongname-strongnamesignaturegeneration-method.md).| +|[StrongNameGetBlob Method](iclrstrongname-strongnamegetblob-method.md)|Fills the specified buffer with the binary representation of the executable file at the specified address.| +|[StrongNameGetBlobFromImage Method](iclrstrongname-strongnamegetblobfromimage-method.md)|Gets a binary representation of the assembly image at the specified memory address.| +|[StrongNameGetPublicKey Method](iclrstrongname-strongnamegetpublickey-method.md)|Gets the public key from a private/public key pair.| +|[StrongNameHashSize Method](iclrstrongname-strongnamehashsize-method.md)|Gets the buffer size required for a hash, using the specified hash algorithm.| +|[StrongNameKeyDelete Method](iclrstrongname-strongnamekeydelete-method.md)|Deletes the specified key container.| +|[StrongNameKeyGen Method](iclrstrongname-strongnamekeygen-method.md)|Creates a new public/private key pair for strong name use.| +|[StrongNameKeyGenEx Method](iclrstrongname-strongnamekeygenex-method.md)|Generates a new public/private key pair with the specified key size for strong name use.| +|[StrongNameKeyInstall Method](iclrstrongname-strongnamekeyinstall-method.md)|Imports a public/private key pair into a container.| +|[StrongNameSignatureGeneration Method](iclrstrongname-strongnamesignaturegeneration-method.md)|Generates a strong name signature for the specified assembly.| +|[StrongNameSignatureGenerationEx Method](iclrstrongname-strongnamesignaturegenerationex-method.md)|Generates a strong name signature for the specified assembly, based on the specified flags.| +|[StrongNameSignatureSize Method](iclrstrongname-strongnamesignaturesize-method.md)|Returns the size of the strong name signature.| +|[StrongNameSignatureVerification Method](iclrstrongname-strongnamesignatureverification-method.md)|Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature, which is verified according to the specified flags.| +|[StrongNameSignatureVerificationEx Method](iclrstrongname-strongnamesignatureverificationex-method.md)|Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature.| +|[StrongNameSignatureVerificationFromImage Method](iclrstrongname-strongnamesignatureverificationfromimage-method.md)|Verifies that an assembly that has already been mapped to memory is valid for the associated public key.| +|[StrongNameTokenFromAssembly Method](iclrstrongname-strongnametokenfromassembly-method.md)|Creates a strong name token from the specified assembly file.| +|[StrongNameTokenFromAssemblyEx Method](iclrstrongname-strongnametokenfromassemblyex-method.md)|Creates a strong name token from the specified assembly file, and returns the public key.| +|[StrongNameTokenFromPublicKey Method](iclrstrongname-strongnametokenfrompublickey-method.md)|Gets a token representing a public key.| + +## Remarks -## Methods - -|Method|Description| -|------------|-----------------| -|[GetHashFromAssemblyFile Method](iclrstrongname-gethashfromassemblyfile-method.md)|Gets a hash of the specified assembly file, using the specified hash algorithm.| -|[GetHashFromAssemblyFileW Method](iclrstrongname-gethashfromassemblyfilew-method.md)|Gets a hash of the assembly file specified as a Unicode string, using the specified hash algorithm.| -|[GetHashFromBlob Method](iclrstrongname-gethashfromblob-method.md)|Gets a hash of the assembly at the specified memory address, using the specified hash algorithm.| -|[GetHashFromFile Method](iclrstrongname-gethashfromfile-method.md)|Generates a hash over the contents of the specified file.| -|[GetHashFromFileW Method](iclrstrongname-gethashfromfilew-method.md)|Generates a hash over the contents of the file specified by a Unicode string.| -|[GetHashFromHandle Method](iclrstrongname-gethashfromhandle-method.md)|Generates a hash over the contents of the file with the specified file handle, using the specified hash algorithm.| -|[StrongNameCompareAssemblies Method](iclrstrongname-strongnamecompareassemblies-method.md)|Determines whether two assemblies differ only by their strong name signatures.| -|[StrongNameFreeBuffer Method](iclrstrongname-strongnamefreebuffer-method.md)|Frees memory that was allocated with a previous call to a strong name method such as [StrongNameGetPublicKey](iclrstrongname-strongnamegetpublickey-method.md), [StrongNameTokenFromPublicKey](iclrstrongname-strongnametokenfrompublickey-method.md), or [StrongNameSignatureGeneration](iclrstrongname-strongnamesignaturegeneration-method.md).| -|[StrongNameGetBlob Method](iclrstrongname-strongnamegetblob-method.md)|Fills the specified buffer with the binary representation of the executable file at the specified address.| -|[StrongNameGetBlobFromImage Method](iclrstrongname-strongnamegetblobfromimage-method.md)|Gets a binary representation of the assembly image at the specified memory address.| -|[StrongNameGetPublicKey Method](iclrstrongname-strongnamegetpublickey-method.md)|Gets the public key from a private/public key pair.| -|[StrongNameHashSize Method](iclrstrongname-strongnamehashsize-method.md)|Gets the buffer size required for a hash, using the specified hash algorithm.| -|[StrongNameKeyDelete Method](iclrstrongname-strongnamekeydelete-method.md)|Deletes the specified key container.| -|[StrongNameKeyGen Method](iclrstrongname-strongnamekeygen-method.md)|Creates a new public/private key pair for strong name use.| -|[StrongNameKeyGenEx Method](iclrstrongname-strongnamekeygenex-method.md)|Generates a new public/private key pair with the specified key size for strong name use.| -|[StrongNameKeyInstall Method](iclrstrongname-strongnamekeyinstall-method.md)|Imports a public/private key pair into a container.| -|[StrongNameSignatureGeneration Method](iclrstrongname-strongnamesignaturegeneration-method.md)|Generates a strong name signature for the specified assembly.| -|[StrongNameSignatureGenerationEx Method](iclrstrongname-strongnamesignaturegenerationex-method.md)|Generates a strong name signature for the specified assembly, based on the specified flags.| -|[StrongNameSignatureSize Method](iclrstrongname-strongnamesignaturesize-method.md)|Returns the size of the strong name signature.| -|[StrongNameSignatureVerification Method](iclrstrongname-strongnamesignatureverification-method.md)|Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature, which is verified according to the specified flags.| -|[StrongNameSignatureVerificationEx Method](iclrstrongname-strongnamesignatureverificationex-method.md)|Gets a value indicating whether the assembly manifest at the supplied path contains a strong name signature.| -|[StrongNameSignatureVerificationFromImage Method](iclrstrongname-strongnamesignatureverificationfromimage-method.md)|Verifies that an assembly that has already been mapped to memory is valid for the associated public key.| -|[StrongNameTokenFromAssembly Method](iclrstrongname-strongnametokenfromassembly-method.md)|Creates a strong name token from the specified assembly file.| -|[StrongNameTokenFromAssemblyEx Method](iclrstrongname-strongnametokenfromassemblyex-method.md)|Creates a strong name token from the specified assembly file, and returns the public key.| -|[StrongNameTokenFromPublicKey Method](iclrstrongname-strongnametokenfrompublickey-method.md)|Gets a token representing a public key.| - -## Remarks - - You can get an instance of the `ICLRStrongName` by calling the [ICLRRuntimeInfo::GetInterface](iclrruntimeinfo-getinterface-method.md) method using `CLSID_CLRStrongName` and `IID_ICLRStrongName` as parameters. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] + You can get an instance of the `ICLRStrongName` by calling the [ICLRRuntimeInfo::GetInterface](iclrruntimeinfo-getinterface-method.md) method using `CLSID_CLRStrongName` and `IID_ICLRStrongName` as parameters. + +## 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/hosting/iclrstrongname-strongnamecompareassemblies-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md new file mode 100644 index 0000000000000..08e0497bb4421 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamecompareassemblies-method.md @@ -0,0 +1,71 @@ +--- +description: "Learn more about: ICLRStrongName::StrongNameCompareAssemblies Method" +title: "ICLRStrongName::StrongNameCompareAssemblies Method" +ms.date: "03/30/2017" +api_name: + - "ICLRStrongName.StrongNameCompareAssemblies" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRStrongName::StrongNameCompareAssemblies" +helpviewer_keywords: + - "ICLRStrongName::StrongNameCompareAssemblies method [.NET Framework hosting]" + - "StrongNameCompareAssemblies method, ICLRStrongName interface [.NET Framework hosting]" +ms.assetid: b1fb356c-72cf-4aa4-8376-f291a6d97c01 +topic_type: + - "apiref" +--- +# ICLRStrongName::StrongNameCompareAssemblies Method + +Determines whether two assemblies differ only by their strong name signatures. + +## Syntax + +```cpp +HRESULT StrongNameCompareAssemblies ( + [in] LPCWSTR wszAssembly1, + [in] LPCWSTR wszAssembly2, + [out] DWORD *pdwResult +); +``` + +## Parameters + + `wszAssembly1` + [in] The path to the first assembly. + + `wszAssembly2` + [in] The path to the second assembly. + + `pdwResult` + [out] One of the following values: + +- `SN_CMP_DIFFERENT` (0) - Specifies that the assemblies contain different data. + +- `SN_CMP_IDENTICAL` (1) - Specifies that the assemblies are exactly the same, including their signatures and checksum. + +- `SN_CMP_SIGONLY` (2) - Specifies that the assemblies differ only by signature and checksum. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## 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)] + +## Remarks + + The strong name signature of an assembly consists of the assembly's text name, version, culture, and public key token. + +## See also + +- [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md similarity index 62% rename from docs/core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md rename to docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md index 3253bd1bf3160..dadaf56652681 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamefreebuffer-method.md @@ -2,51 +2,52 @@ description: "Learn more about: ICLRStrongName::StrongNameFreeBuffer Method" title: "ICLRStrongName::StrongNameFreeBuffer Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameFreeBuffer" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameFreeBuffer" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameFreeBuffer method, ICLRStrongName interface [.NET Framework hosting]" - "ICLRStrongName::StrongNameFreeBuffer method [.NET Framework hosting]" -topic_type: +ms.assetid: 6148c508-bd1d-4a37-85c3-06ecb09cc857 +topic_type: - "apiref" --- # ICLRStrongName::StrongNameFreeBuffer Method -Frees memory that was allocated with a previous call to a strong name method such as [ICLRStrongName::StrongNameGetPublicKey](iclrstrongname-strongnamegetpublickey-method.md), [ICLRStrongName::StrongNameTokenFromPublicKey](iclrstrongname-strongnametokenfrompublickey-method.md), or [ICLRStrongName::StrongNameSignatureGeneration](iclrstrongname-strongnamesignaturegeneration-method.md). - -## Syntax - -```cpp +Frees memory that was allocated with a previous call to a strong name method such as [ICLRStrongName::StrongNameGetPublicKey](iclrstrongname-strongnamegetpublickey-method.md), [ICLRStrongName::StrongNameTokenFromPublicKey](iclrstrongname-strongnametokenfrompublickey-method.md), or [ICLRStrongName::StrongNameSignatureGeneration](iclrstrongname-strongnamesignaturegeneration-method.md). + +## Syntax + +```cpp HRESULT StrongNameFreeBuffer ( - [in] BYTE *pbMemory -); -``` - -## Parameters - - `pbMemory` - [in] A pointer to the memory to free. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - + [in] BYTE *pbMemory +); +``` + +## Parameters + + `pbMemory` + [in] A pointer to the memory to free. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## 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 - [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md new file mode 100644 index 0000000000000..c4bd0e040fee0 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamegetblob-method.md @@ -0,0 +1,63 @@ +--- +description: "Learn more about: ICLRStrongName::StrongNameGetBlob Method" +title: "ICLRStrongName::StrongNameGetBlob Method" +ms.date: "03/30/2017" +api_name: + - "ICLRStrongName.StrongNameGetBlob" + - "ICLRStrongName.StrongNameGetBlob" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRStrongName::StrongNameGetBlob" +helpviewer_keywords: + - "ICLRStrongName::StrongNameGetBlob method [.NET Framework hosting]" + - "StrongNameGetBlob method, ICLRStrongName interface [.NET Framework hosting]" +ms.assetid: a24218f8-7196-44be-b7a2-ee9cdd7a85c4 +topic_type: + - "apiref" +--- +# ICLRStrongName::StrongNameGetBlob Method + +Fills the specified buffer with the binary representation of the executable file at the specified address. + +## Syntax + +```cpp +HRESULT StrongNameGetBlob ( + [in] LPCWSTR wszFilePath, + [in] BYTE *pbBlob, + [in, out] DWORD *pcbBlob +); +``` + +## Parameters + + `wszFilePath` + [in] A valid path to the executable file to be loaded. + + `pbBlob` + [in] The buffer into which to load the executable file. + + `pcbBlob` + [in, out] The requested maximum size, in bytes, of `pbBlob`. Upon return, the actual size, in bytes, of `pbBlob`. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## 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 + +- [StrongNameGetBlobFromImage Method](iclrstrongname-strongnamegetblobfromimage-method.md) +- [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md new file mode 100644 index 0000000000000..b51c7449d3e68 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamegetblobfromimage-method.md @@ -0,0 +1,66 @@ +--- +description: "Learn more about: ICLRStrongName::StrongNameGetBlobFromImage Method" +title: "ICLRStrongName::StrongNameGetBlobFromImage Method" +ms.date: "03/30/2017" +api_name: + - "ICLRStrongName.StrongNameGetBlobFromImage" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRStrongName::StrongNameGetBlobFromImage" +helpviewer_keywords: + - "StrongNameGetBlobFromImage method, ICLRStrongName interface [.NET Framework hosting]" + - "ICLRStrongName::StrongNameGetBlobFromImage method [.NET Framework hosting]" +ms.assetid: 0f5a2ec8-e776-4fd8-bda6-937b6834575a +topic_type: + - "apiref" +--- +# ICLRStrongName::StrongNameGetBlobFromImage Method + +Gets a binary representation of the assembly image at the specified memory address. + +## Syntax + +```cpp +HRESULT StrongNameGetBlobFromImage ( + [in] BYTE *pbBase, + [in] DWORD dwLength, + [in] BYTE *pbBlob, + [in, out] DWORD *pcbBlob +); +``` + +## Parameters + + `pbBase` + [in] The memory address of the mapped assembly manifest. + + `dwLength` + [in] The size, in bytes, of the image at `pbBase`. + + `pbBlob` + [in] A buffer to contain the binary representation of the image. + + `pcbBlob` + [in, out] The requested maximum size, in bytes, of `pbBlob`. Upon return, the actual size, in bytes, of `pbBlob`. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## 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 + +- [StrongNameGetBlob Method](iclrstrongname-strongnamegetblob-method.md) +- [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md similarity index 56% rename from docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md rename to docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md index d922df2e413fd..efeb0c92e2697 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamegetpublickey-method.md @@ -2,77 +2,78 @@ description: "Learn more about: ICLRStrongName::StrongNameGetPublicKey Method" title: "ICLRStrongName::StrongNameGetPublicKey Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameGetPublicKey" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameGetPublicKey" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameGetPublicKey method, ICLRStrongName interface [.NET Framework hosting]" - "ICLRStrongName::StrongNameGetPublicKey method [.NET Framework hosting]" -topic_type: +ms.assetid: a31dcaa9-a404-4c1d-8cc7-081827c52935 +topic_type: - "apiref" --- # ICLRStrongName::StrongNameGetPublicKey Method -Gets the public key from a public/private key pair. The key pair can be supplied either as a key container name within a cryptographic service provider (CSP) or as a raw collection of bytes. - -## Syntax - -```cpp +Gets the public key from a public/private key pair. The key pair can be supplied either as a key container name within a cryptographic service provider (CSP) or as a raw collection of bytes. + +## Syntax + +```cpp HRESULT StrongNameGetPublicKey ( - [in] LPCWSTR szKeyContainer, - [in] BYTE *pbKeyBlob, - [in] ULONG cbKeyBlob, - [out] BYTE **ppbPublicKeyBlob, - [out] ULONG *pcbPublicKeyBlob -); -``` - -## Parameters - - `szKeyContainer` - [in] The name of the key container that contains the public/private key pair. If `pbKeyBlob` is null, `szKeyContainer` must specify a valid container within the CSP. In this case, the [ICLRStrongName::StrongNameGetPublicKey](iclrstrongname-strongnamegetpublickey-method.md) method extracts the public key from the key pair stored in the container. - - If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). - - The keys must be 1024-bit Rivest-Shamir-Adleman (RSA) signing keys. No other types of keys are supported at this time. - - `pbKeyBlob` - [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `szKeyContainer` is assumed to contain the key pair. - - `cbKeyBlob` - [in] The size, in bytes, of `pbKeyBlob`. - - `ppbPublicKeyBlob` - [out] The returned public key BLOB. The `ppbPublicKeyBlob` parameter is allocated by the common language runtime and returned to the caller. The caller must free the memory by using the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method. - - `pcbPublicKeyBlob` - [out] The size of the returned public key BLOB. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - The public key is contained in a [PublicKeyBlob]((../../../framework/unmanaged-api/strong-naming/publickeyblob-structure.md) structure. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - + [in] LPCWSTR szKeyContainer, + [in] BYTE *pbKeyBlob, + [in] ULONG cbKeyBlob, + [out] BYTE **ppbPublicKeyBlob, + [out] ULONG *pcbPublicKeyBlob +); +``` + +## Parameters + + `szKeyContainer` + [in] The name of the key container that contains the public/private key pair. If `pbKeyBlob` is null, `szKeyContainer` must specify a valid container within the CSP. In this case, the [ICLRStrongName::StrongNameGetPublicKey](iclrstrongname-strongnamegetpublickey-method.md) method extracts the public key from the key pair stored in the container. + + If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). + + The keys must be 1024-bit Rivest-Shamir-Adleman (RSA) signing keys. No other types of keys are supported at this time. + + `pbKeyBlob` + [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `szKeyContainer` is assumed to contain the key pair. + + `cbKeyBlob` + [in] The size, in bytes, of `pbKeyBlob`. + + `ppbPublicKeyBlob` + [out] The returned public key BLOB. The `ppbPublicKeyBlob` parameter is allocated by the common language runtime and returned to the caller. The caller must free the memory by using the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method. + + `pcbPublicKeyBlob` + [out] The size of the returned public key BLOB. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + The public key is contained in a [PublicKeyBlob](../strong-naming/publickeyblob-structure.md) structure. + +## 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 - [StrongNameTokenFromPublicKey Method](iclrstrongname-strongnametokenfrompublickey-method.md) -- [PublicKeyBlob Structure]((../../../framework/unmanaged-api/strong-naming/publickeyblob-structure.md) +- [PublicKeyBlob Structure](../strong-naming/publickeyblob-structure.md) - [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md new file mode 100644 index 0000000000000..faaa6fddcd82a --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamehashsize-method.md @@ -0,0 +1,57 @@ +--- +description: "Learn more about: ICLRStrongName::StrongNameHashSize Method" +title: "ICLRStrongName::StrongNameHashSize Method" +ms.date: "03/30/2017" +api_name: + - "ICLRStrongName.StrongNameHashSize" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRStrongName::StrongNameHashSize" +helpviewer_keywords: + - "ICLRStrongName::StrongNameHashSize method [.NET Framework hosting]" + - "StrongNameHashSize method, ICLRStrongName interface [.NET Framework hosting]" +ms.assetid: 4a05ee56-08e4-4f3a-86a9-9b52083d5c0f +topic_type: + - "apiref" +--- +# ICLRStrongName::StrongNameHashSize Method + +Gets the buffer size required for a hash, using the specified hash algorithm. + +## Syntax + +```cpp +HRESULT StrongNameHashSize ( + [in] ULONG ulHashAlg, + [out] DWORD *pcbSize +); +``` + +## Parameters + + `ulHashAlg` + [in] The hash algorithm used to compute the buffer size. + + `pcbSize` + [out] The returned buffer size, in bytes. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## 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 + +- [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md similarity index 52% rename from docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md rename to docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md index d851f07ed9b06..f62b82747652f 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamekeydelete-method.md @@ -2,55 +2,56 @@ description: "Learn more about: ICLRStrongName::StrongNameKeyDelete Method" title: "ICLRStrongName::StrongNameKeyDelete Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameKeyDelete" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameKeyDelete" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameKeyDelete method, ICLRStrongName interface [.NET Framework hosting]" - "ICLRStrongName::StrongNameKeyDelete method [.NET Framework hosting]" -topic_type: +ms.assetid: 0163412f-f617-4428-89e0-03992fec31e8 +topic_type: - "apiref" --- # ICLRStrongName::StrongNameKeyDelete Method -Deletes the specified key container. - -## Syntax - -```cpp -HRESULT StrongNameKeyDelete ( - [in] LPCWSTR wszKeyContainer -); -``` - -## Parameters - - `wszKeyContainer` - [in] The name of the key container to delete. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - Use the [ICLRStrongName::StrongNameKeyInstall](iclrstrongname-strongnamekeyinstall-method.md) method to import a public/private key pair into a container. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Deletes the specified key container. + +## Syntax + +```cpp +HRESULT StrongNameKeyDelete ( + [in] LPCWSTR wszKeyContainer +); +``` + +## Parameters + + `wszKeyContainer` + [in] The name of the key container to delete. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + Use the [ICLRStrongName::StrongNameKeyInstall](iclrstrongname-strongnamekeyinstall-method.md) method to import a public/private key pair into a container. + +## 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 - [StrongNameKeyInstall Method](iclrstrongname-strongnamekeyinstall-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md similarity index 53% rename from docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md rename to docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md index 7958c4f3eaf2d..3d597a8bae268 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamekeygen-method.md @@ -2,71 +2,72 @@ description: "Learn more about: ICLRStrongName::StrongNameKeyGen Method" title: "ICLRStrongName::StrongNameKeyGen Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameKeyGen" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameKeyGen" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameKeyGen method, ICLRStrongName interface [.NET Framework hosting]" - "ICLRStrongName::StrongNameKeyGen method [.NET Framework hosting]" -topic_type: +ms.assetid: ac5c1245-9acf-4271-9c08-3d9b7c670df3 +topic_type: - "apiref" --- # ICLRStrongName::StrongNameKeyGen Method -Creates a new public/private key pair for strong name use. - -## Syntax - -```cpp -HRESULT StrongNameKeyGen ( - [in] LPCWSTR wszKeyContainer, - [in] DWORD dwFlags, - [out] BYTE **ppbKeyBlob, - [out] ULONG *pcbKeyBlob -); -``` - -## Parameters - - `wszKeyContainer` - [in] The requested key container name. `wszKeyContainer` must either be a non-empty string or null to generate a temporary name. - - `dwFlags` - [in] A value that specifies whether to leave the key registered. The following values are supported: - -- 0x00000000 - Used when `wszKeyContainer` is null to generate a temporary key container name. - -- 0x00000001 (`SN_LEAVE_KEY`) - Specifies that the key should be left registered. - - `ppbKeyBlob` - [out] The returned public/private key pair. - - `pcbKeyBlob` - [out] The size, in bytes, of `ppbKeyBlob`. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - The [ICLRStrongName::StrongNameKeyGen](iclrstrongname-strongnamekeygen-method.md) method creates a 1024-bit key. After the key is retrieved, you should call the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method to release the allocated memory. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Creates a new public/private key pair for strong name use. + +## Syntax + +```cpp +HRESULT StrongNameKeyGen ( + [in] LPCWSTR wszKeyContainer, + [in] DWORD dwFlags, + [out] BYTE **ppbKeyBlob, + [out] ULONG *pcbKeyBlob +); +``` + +## Parameters + + `wszKeyContainer` + [in] The requested key container name. `wszKeyContainer` must either be a non-empty string or null to generate a temporary name. + + `dwFlags` + [in] A value that specifies whether to leave the key registered. The following values are supported: + +- 0x00000000 - Used when `wszKeyContainer` is null to generate a temporary key container name. + +- 0x00000001 (`SN_LEAVE_KEY`) - Specifies that the key should be left registered. + + `ppbKeyBlob` + [out] The returned public/private key pair. + + `pcbKeyBlob` + [out] The size, in bytes, of `ppbKeyBlob`. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + The [ICLRStrongName::StrongNameKeyGen](iclrstrongname-strongnamekeygen-method.md) method creates a 1024-bit key. After the key is retrieved, you should call the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method to release the allocated memory. + +## 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 - [StrongNameKeyGenEx Method](iclrstrongname-strongnamekeygenex-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md similarity index 52% rename from docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md rename to docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md index 26070ca59e6e0..aecb6b5684c2f 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamekeygenex-method.md @@ -2,77 +2,78 @@ description: "Learn more about: ICLRStrongName::StrongNameKeyGenEx Method" title: "ICLRStrongName::StrongNameKeyGenEx Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameKeyGenEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameKeyGenEx" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName::StrongNameKeyGenEx method [.NET Framework hosting]" - "StrongNameKeyGenEx method, ICLRStrongName interface [.NET Framework hosting]" -topic_type: +ms.assetid: 1f8b59d0-5b72-45b8-ab74-c2b43ffc806e +topic_type: - "apiref" --- # ICLRStrongName::StrongNameKeyGenEx Method -Generates a new public/private key pair with the specified key size, for strong name use. - -## Syntax - -```cpp -HRESULT StrongNameKeyGenEx ( - [in] LPCWSTR wszKeyContainer, - [in] DWORD dwFlags, - [in] DWORD dwKeySize, - [out] BYTE **ppbKeyBlob, - [out] ULONG *pcbKeyBlob -); -``` - -## Parameters - - `wszKeyContainer` - [in] The requested key container name. `wszKeyContainer` must either be a non-empty string or null to generate a temporary name. - - `dwFlags` - [in] A value that specifies whether to leave the key registered. The following values are supported: - -- 0x00000000 - Used when `wszKeyContainer` is null to generate a temporary key container name. - -- 0x00000001 (`SN_LEAVE_KEY`) - Specifies that the key should be left registered. - - `dwKeySize` - [in] The requested size of the key, in bits. - - `ppbKeyBlob` - [out] The returned public/private key pair. - - `pcbKeyBlob` - [out] The size, in bytes, of `ppbKeyBlob`. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - The .NET Framework versions 1.0 and 1.1 require a `dwKeySize` of 1024 bits to sign an assembly with a strong name; version 2.0 adds supports for 2048-bit keys. - - After the key is retrieved, you should call the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method to release the allocated memory. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Generates a new public/private key pair with the specified key size, for strong name use. + +## Syntax + +```cpp +HRESULT StrongNameKeyGenEx ( + [in] LPCWSTR wszKeyContainer, + [in] DWORD dwFlags, + [in] DWORD dwKeySize, + [out] BYTE **ppbKeyBlob, + [out] ULONG *pcbKeyBlob +); +``` + +## Parameters + + `wszKeyContainer` + [in] The requested key container name. `wszKeyContainer` must either be a non-empty string or null to generate a temporary name. + + `dwFlags` + [in] A value that specifies whether to leave the key registered. The following values are supported: + +- 0x00000000 - Used when `wszKeyContainer` is null to generate a temporary key container name. + +- 0x00000001 (`SN_LEAVE_KEY`) - Specifies that the key should be left registered. + + `dwKeySize` + [in] The requested size of the key, in bits. + + `ppbKeyBlob` + [out] The returned public/private key pair. + + `pcbKeyBlob` + [out] The size, in bytes, of `ppbKeyBlob`. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + The .NET Framework versions 1.0 and 1.1 require a `dwKeySize` of 1024 bits to sign an assembly with a strong name; version 2.0 adds supports for 2048-bit keys. + + After the key is retrieved, you should call the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method to release the allocated memory. + +## 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 - [StrongNameKeyGen Method](iclrstrongname-strongnamekeygen-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md similarity index 50% rename from docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md rename to docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md index 14fe0932b9f44..94fcac9d9aabc 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamekeyinstall-method.md @@ -2,63 +2,64 @@ description: "Learn more about: ICLRStrongName::StrongNameKeyInstall Method" title: "ICLRStrongName::StrongNameKeyInstall Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameKeyInstall" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameKeyInstall" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName::StrongNameKeyInstall method [.NET Framework hosting]" - "StrongNameKeyInstall method, ICLRStrongName interface [.NET Framework hosting]" -topic_type: +ms.assetid: 5c15cf3b-164c-49d1-8e57-e42949d55acf +topic_type: - "apiref" --- # ICLRStrongName::StrongNameKeyInstall Method -Imports a public/private key pair into a container. - -## Syntax - -```cpp -HRESULT StrongNameKeyInstall ( - [in] LPCWSTR wszKeyContainer, - [in] BYTE *pbKeyBlob, - [in] ULONG cbKeyBlob -); -``` - -## Parameters - - `wszKeyContainer` - [in] The name of the key container. `wszKeyContainer` must be a non-empty string. - - `pbKeyBlob` - [in] The binary key pair. - - `cbKeyBlob` - [in] The size, in bytes, of `pbKeyBlob`. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - Use the [ICLRStrongName::StrongNameKeyDelete](iclrstrongname-strongnamekeydelete-method.md) method to delete the key container. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Imports a public/private key pair into a container. + +## Syntax + +```cpp +HRESULT StrongNameKeyInstall ( + [in] LPCWSTR wszKeyContainer, + [in] BYTE *pbKeyBlob, + [in] ULONG cbKeyBlob +); +``` + +## Parameters + + `wszKeyContainer` + [in] The name of the key container. `wszKeyContainer` must be a non-empty string. + + `pbKeyBlob` + [in] The binary key pair. + + `cbKeyBlob` + [in] The size, in bytes, of `pbKeyBlob`. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + Use the [ICLRStrongName::StrongNameKeyDelete](iclrstrongname-strongnamekeydelete-method.md) method to delete the key container. + +## 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 - [StrongNameKeyDelete Method](iclrstrongname-strongnamekeydelete-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md similarity index 57% rename from docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md rename to docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md index 7fbec3ea9b4b5..055d64f0e53eb 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegeneration-method.md @@ -2,85 +2,86 @@ description: "Learn more about: ICLRStrongName::StrongNameSignatureGeneration Method" title: "ICLRStrongName::StrongNameSignatureGeneration Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameSignatureGeneration" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameSignatureGeneration" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameSignatureGeneration method, ICLRStrongName interface [.NET Framework hosting]" - "ICLRStrongName::StrongNameSignatureGeneration method [.NET Framework hosting]" -topic_type: +ms.assetid: 4cdb1284-947a-4ed4-94c1-c5ff5cdfce56 +topic_type: - "apiref" --- # ICLRStrongName::StrongNameSignatureGeneration Method -Generates a strong name signature for the specified assembly. - -## Syntax - -```cpp +Generates a strong name signature for the specified assembly. + +## Syntax + +```cpp HRESULT StrongNameSignatureGeneration ( - [in] LPCWSTR wszFilePath, - [in] LPCWSTR wszKeyContainer, - [in] BYTE *pbKeyBlob, - [in] ULONG cbKeyBlob, - [out] BYTE **ppbSignatureBlob, - [out] ULONG *pcbSignatureBlob -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the file that contains the manifest of the assembly for which the strong name signature will be generated. - - `wszKeyContainer` - [in] The name of the key container that contains the public/private key pair. - - If `pbKeyBlob` is null, `wszKeyContainer` must specify a valid container within the cryptographic service provider (CSP). In this case, the key pair stored in the container is used to sign the file. - - If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). - - The keys must be 1024-bit Rivest-Shamir-Adleman (RSA) signing keys. No other types of keys are supported at this time. - - `pbKeyBlob` - [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `wszKeyContainer` is assumed to contain the key pair. - - `cbKeyBlob` - [in] The size, in bytes, of `pbKeyBlob`. - - `ppbSignatureBlob` - [out] A pointer to the location to which the common language runtime returns the signature. If `ppbSignatureBlob` is null, the runtime stores the signature in the file specified by `wszFilePath`. - - If `ppbSignatureBlob` is not null, the common language runtime allocates space in which to return the signature. The caller must free this space by using the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method. - - `pcbSignatureBlob` - [out] The size, in bytes, of the returned signature. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - Specify null for `wszFilePath` to calculate the size of the signature without creating the signature. - - The signature can be stored either directly in the file, or returned to the caller. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - + [in] LPCWSTR wszFilePath, + [in] LPCWSTR wszKeyContainer, + [in] BYTE *pbKeyBlob, + [in] ULONG cbKeyBlob, + [out] BYTE **ppbSignatureBlob, + [out] ULONG *pcbSignatureBlob +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the file that contains the manifest of the assembly for which the strong name signature will be generated. + + `wszKeyContainer` + [in] The name of the key container that contains the public/private key pair. + + If `pbKeyBlob` is null, `wszKeyContainer` must specify a valid container within the cryptographic service provider (CSP). In this case, the key pair stored in the container is used to sign the file. + + If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). + + The keys must be 1024-bit Rivest-Shamir-Adleman (RSA) signing keys. No other types of keys are supported at this time. + + `pbKeyBlob` + [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `wszKeyContainer` is assumed to contain the key pair. + + `cbKeyBlob` + [in] The size, in bytes, of `pbKeyBlob`. + + `ppbSignatureBlob` + [out] A pointer to the location to which the common language runtime returns the signature. If `ppbSignatureBlob` is null, the runtime stores the signature in the file specified by `wszFilePath`. + + If `ppbSignatureBlob` is not null, the common language runtime allocates space in which to return the signature. The caller must free this space by using the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method. + + `pcbSignatureBlob` + [out] The size, in bytes, of the returned signature. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + Specify null for `wszFilePath` to calculate the size of the signature without creating the signature. + + The signature can be stored either directly in the file, or returned to the caller. + +## 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 - [StrongNameSignatureGenerationEx Method](iclrstrongname-strongnamesignaturegenerationex-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md rename to docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md index fde466d3972e5..604f21020bd4d 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignaturegenerationex-method.md @@ -2,95 +2,96 @@ description: "Learn more about: ICLRStrongName::StrongNameSignatureGenerationEx Method" title: "ICLRStrongName::StrongNameSignatureGenerationEx Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameSignatureGenerationEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameSignatureGenerationEx" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName::StrongNameSignatureGenerationEx method [.NET Framework hosting]" - "StrongNameSignatureGenerationEx method, ICLRStrongName interface [.NET Framework hosting]" -topic_type: +ms.assetid: c3f34584-c6e2-41fd-bb44-e44da8546309 +topic_type: - "apiref" --- # ICLRStrongName::StrongNameSignatureGenerationEx Method -Generates a strong name signature for the specified assembly, according to the specified flags. - -## Syntax - +Generates a strong name signature for the specified assembly, according to the specified flags. + +## Syntax + ```cpp -HRESULT StrongNameSignatureGenerationEx ( - [in] LPCWSTR wszFilePath, - [in] LPCWSTR wszKeyContainer, - [in] BYTE *pbKeyBlob, - [in] ULONG cbKeyBlob, - [out] BYTE **ppbSignatureBlob, - [out] ULONG *pcbSignatureBlob, - [in] DWORD dwFlags -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the file that contains the manifest of the assembly for which the strong name signature will be generated. - - `wszKeyContainer` - [in] The name of the key container that contains the public/private key pair. - - If `pbKeyBlob` is null, `wszKeyContainer` must specify a valid container within the cryptographic service provider (CSP). In this case, the key pair stored in the container is used to sign the file. - - If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). - - `pbKeyBlob` - [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `wszKeyContainer` is assumed to contain the key pair. - - `cbKeyBlob` - [in] The size, in bytes, of `pbKeyBlob`. - - `ppbSignatureBlob` - [out] A pointer to the location to which the common language runtime returns the signature. If `ppbSignatureBlob` is null, the runtime stores the signature in the file specified by `wszFilePath`. - - If `ppbSignatureBlob` is not null, the common language runtime allocates space in which to return the signature. The caller must free this space using the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method. - - `pcbSignatureBlob` - [out] The size, in bytes, of the returned signature. - - `dwFlags` - [in] One or more of the following values: - -- `SN_SIGN_ALL_FILES` (0x00000001) - Recompute all hashes for linked modules. - -- `SN_TEST_SIGN` (0x00000002) - Test-sign the assembly. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - Specify null for `wszFilePath` to calculate the size of the signature without creating the signature. - - The signature can be either stored directly in the file, or returned to the caller. - - If `SN_SIGN_ALL_FILES` is specified but a public key is not included (both `pbKeyBlob` and `wszFilePath` are null), hashes for linked modules are recomputed, but the assembly is not re-signed. - - If `SN_TEST_SIGN` is specified, the common language runtime header is not modified to indicate that the assembly is signed with a strong name. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +HRESULT StrongNameSignatureGenerationEx ( + [in] LPCWSTR wszFilePath, + [in] LPCWSTR wszKeyContainer, + [in] BYTE *pbKeyBlob, + [in] ULONG cbKeyBlob, + [out] BYTE **ppbSignatureBlob, + [out] ULONG *pcbSignatureBlob, + [in] DWORD dwFlags +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the file that contains the manifest of the assembly for which the strong name signature will be generated. + + `wszKeyContainer` + [in] The name of the key container that contains the public/private key pair. + + If `pbKeyBlob` is null, `wszKeyContainer` must specify a valid container within the cryptographic service provider (CSP). In this case, the key pair stored in the container is used to sign the file. + + If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). + + `pbKeyBlob` + [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `wszKeyContainer` is assumed to contain the key pair. + + `cbKeyBlob` + [in] The size, in bytes, of `pbKeyBlob`. + + `ppbSignatureBlob` + [out] A pointer to the location to which the common language runtime returns the signature. If `ppbSignatureBlob` is null, the runtime stores the signature in the file specified by `wszFilePath`. + + If `ppbSignatureBlob` is not null, the common language runtime allocates space in which to return the signature. The caller must free this space using the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method. + + `pcbSignatureBlob` + [out] The size, in bytes, of the returned signature. + + `dwFlags` + [in] One or more of the following values: + +- `SN_SIGN_ALL_FILES` (0x00000001) - Recompute all hashes for linked modules. + +- `SN_TEST_SIGN` (0x00000002) - Test-sign the assembly. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + Specify null for `wszFilePath` to calculate the size of the signature without creating the signature. + + The signature can be either stored directly in the file, or returned to the caller. + + If `SN_SIGN_ALL_FILES` is specified but a public key is not included (both `pbKeyBlob` and `wszFilePath` are null), hashes for linked modules are recomputed, but the assembly is not re-signed. + + If `SN_TEST_SIGN` is specified, the common language runtime header is not modified to indicate that the assembly is signed with a strong name. + +## 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 - [StrongNameSignatureGeneration Method](iclrstrongname-strongnamesignaturegeneration-method.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md new file mode 100644 index 0000000000000..b3e71e9f85b2f --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignaturesize-method.md @@ -0,0 +1,61 @@ +--- +description: "Learn more about: ICLRStrongName::StrongNameSignatureSize Method" +title: "ICLRStrongName::StrongNameSignatureSize Method" +ms.date: "03/30/2017" +api_name: + - "ICLRStrongName.StrongNameSignatureSize" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRStrongName::StrongNameSignatureSize" +helpviewer_keywords: + - "ICLRStrongName::StrongNameSignatureSize method [.NET Framework hosting]" + - "StrongNameSignatureSize method, ICLRStrongName interface [.NET Framework hosting]" +ms.assetid: 76d4f93a-5e25-4399-abcc-a1389549481d +topic_type: + - "apiref" +--- +# ICLRStrongName::StrongNameSignatureSize Method + +Returns the size of the strong name signature. This method is typically used by compilers to determine how much space to reserve in the file when creating a delay-signed assembly. + +## Syntax + +```cpp +HRESULT StrongNameSignatureSize ( + [in] BYTE *pbPublicKeyBlob, + [in] ULONG cbPublicKeyBlob, + [in] DWORD *pcbSize +); +``` + +## Parameters + + `pbPublicKeyBlob` + [in] A structure of type [PublicKeyBlob](../strong-naming/publickeyblob-structure.md) that contains the public portion of the key pair used to generate the strong name signature. + + `cbPublicKeyBlob` + [in] The size, in bytes, of `pbPublicKeyBlob`. + + `pcbSize` + [in] The number of bytes required to store the strong name signature. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## 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 + +- [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md similarity index 60% rename from docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md rename to docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md index 4369d2a778fc8..72b77067e55f2 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverification-method.md @@ -2,73 +2,74 @@ description: "Learn more about: ICLRStrongName::StrongNameSignatureVerification Method" title: "ICLRStrongName::StrongNameSignatureVerification Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameSignatureVerification" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameSignatureVerification" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName::StrongNameSignatureVerification method [.NET Framework hosting]" - "StrongNameSignatureVerification method, ICLRStrongName interface [.NET Framework hosting]" -topic_type: +ms.assetid: 734dc4d1-0a76-4736-b5ac-cb4253b3dd49 +topic_type: - "apiref" --- # ICLRStrongName::StrongNameSignatureVerification Method -Gets a value that indicates whether the assembly manifest at the supplied path contains a strong name signature, which is verified according to the specified flags. - -## Syntax - -```cpp -HRESULT StrongNameSignatureVerification ( - [in] LPCWSTR wszFilePath, - [in] DWORD dwInFlags, - [out] DWORD *pdwOutFlags -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the portable executable (.dll or .exe) file for the assembly to verify. - - `dwInFlags` - [in] Flags to modify the verification behavior. The following values are supported: - -- `SN_INFLAG_FORCE_VER` (0x00000001) - Forces verification even if it is necessary to override registry settings. - -- `SN_INFLAG_INSTALL` (0x00000002) - Specifies that this is the first time the manifest is verified. - -- `SN_INFLAG_ADMIN_ACCESS` (0x00000004) - Specifies that the cache will allow access only to users who have administrative privileges. - -- `SN_INFLAG_USER_ACCESS` (0x00000008) - Specifies that the assembly will be accessible only to the current user. - -- `SN_INFLAG_ALL_ACCESS` (0x00000010) - Specifies that the cache will provide no guarantees of access restriction. - -- `SN_INFLAG_RUNTIME` (0x80000000) - Reserved for internal debugging. - - `pdwOutFlags` - [out] Flags indicating whether the strong name signature was verified. The following value is supported: - -- `SN_OUTFLAG_WAS_VERIFIED` (0x00000001) - This value is set to `false` to specify that the verification succeeded due to registry settings. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Gets a value that indicates whether the assembly manifest at the supplied path contains a strong name signature, which is verified according to the specified flags. + +## Syntax + +```cpp +HRESULT StrongNameSignatureVerification ( + [in] LPCWSTR wszFilePath, + [in] DWORD dwInFlags, + [out] DWORD *pdwOutFlags +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the portable executable (.dll or .exe) file for the assembly to verify. + + `dwInFlags` + [in] Flags to modify the verification behavior. The following values are supported: + +- `SN_INFLAG_FORCE_VER` (0x00000001) - Forces verification even if it is necessary to override registry settings. + +- `SN_INFLAG_INSTALL` (0x00000002) - Specifies that this is the first time the manifest is verified. + +- `SN_INFLAG_ADMIN_ACCESS` (0x00000004) - Specifies that the cache will allow access only to users who have administrative privileges. + +- `SN_INFLAG_USER_ACCESS` (0x00000008) - Specifies that the assembly will be accessible only to the current user. + +- `SN_INFLAG_ALL_ACCESS` (0x00000010) - Specifies that the cache will provide no guarantees of access restriction. + +- `SN_INFLAG_RUNTIME` (0x80000000) - Reserved for internal debugging. + + `pdwOutFlags` + [out] Flags indicating whether the strong name signature was verified. The following value is supported: + +- `SN_OUTFLAG_WAS_VERIFIED` (0x00000001) - This value is set to `false` to specify that the verification succeeded due to registry settings. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## 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 - [StrongNameSignatureVerificationEx Method](iclrstrongname-strongnamesignatureverificationex-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md similarity index 60% rename from docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md rename to docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md index 06abcd18602e8..fb45029a0fa40 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationex-method.md @@ -2,63 +2,64 @@ description: "Learn more about: ICLRStrongName::StrongNameSignatureVerificationEx Method" title: "ICLRStrongName::StrongNameSignatureVerificationEx Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameSignatureVerificationEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameSignatureVerificationEx" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameSignatureVerificationEx method, ICLRStrongName interface [.NET Framework hosting]" - "ICLRStrongName::StrongNameSignatureVerificationEx method [.NET Framework hosting]" -topic_type: +ms.assetid: dbd2f662-208b-4174-b301-5c99af91040f +topic_type: - "apiref" --- # ICLRStrongName::StrongNameSignatureVerificationEx Method -Gets a value that indicates whether the assembly manifest at the supplied path contains a strong name signature. - -## Syntax - -```cpp -HRESULT StrongNameSignatureVerificationEx ( - [in] LPCWSTR wszFilePath, - [in] BOOLEAN fForceVerification, - [out] BOOLEAN *pfWasVerified -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the portable executable (.exe or .dll) file for the assembly to be verified. - - `fForceVerification` - [in] `true` to perform verification, even if it is necessary to override registry settings; otherwise, `false`. - - `pfWasVerified` - [out] `true` if the strong name signature was verified; otherwise, `false`. `pfWasVerified` is also set to `false` if the verification was successful due to registry settings. - -## Return Value - - `S_OK` if the verification was successful; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - The [ICLRStrongName::StrongNameSignatureVerificationEx](iclrstrongname-strongnamesignatureverificationex-method.md) method provides a capability similar to the [ICLRStrongName::StrongNameSignatureVerification](iclrstrongname-strongnamesignatureverification-method.md) method. However, the second input parameter and the output parameter for [ICLRStrongName::StrongNameSignatureVerificationEx](iclrstrongname-strongnamesignatureverificationex-method.md) are of type `BOOLEAN` instead of `DWORD`. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Gets a value that indicates whether the assembly manifest at the supplied path contains a strong name signature. + +## Syntax + +```cpp +HRESULT StrongNameSignatureVerificationEx ( + [in] LPCWSTR wszFilePath, + [in] BOOLEAN fForceVerification, + [out] BOOLEAN *pfWasVerified +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the portable executable (.exe or .dll) file for the assembly to be verified. + + `fForceVerification` + [in] `true` to perform verification, even if it is necessary to override registry settings; otherwise, `false`. + + `pfWasVerified` + [out] `true` if the strong name signature was verified; otherwise, `false`. `pfWasVerified` is also set to `false` if the verification was successful due to registry settings. + +## Return Value + + `S_OK` if the verification was successful; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + The [ICLRStrongName::StrongNameSignatureVerificationEx](iclrstrongname-strongnamesignatureverificationex-method.md) method provides a capability similar to the [ICLRStrongName::StrongNameSignatureVerification](iclrstrongname-strongnamesignatureverification-method.md) method. However, the second input parameter and the output parameter for [ICLRStrongName::StrongNameSignatureVerificationEx](iclrstrongname-strongnamesignatureverificationex-method.md) are of type `BOOLEAN` instead of `DWORD`. + +## 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 - [StrongNameSignatureVerification Method](iclrstrongname-strongnamesignatureverification-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md similarity index 57% rename from docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md rename to docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md index a66c07e2a51ab..946398fa5092f 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnamesignatureverificationfromimage-method.md @@ -2,77 +2,78 @@ description: "Learn more about: ICLRStrongName::StrongNameSignatureVerificationFromImage Method" title: "ICLRStrongName::StrongNameSignatureVerificationFromImage Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameSignatureVerificationFromImage" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameSignatureVerificationFromImage" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName::StrongNameSignatureVerificationFromImage method [.NET Framework hosting]" - "StrongNameSignatureVerificationFromImage method, ICLRStrongName interface [.NET Framework hosting]" -topic_type: +ms.assetid: da91c138-ee30-4fd4-a040-464d97d7e41a +topic_type: - "apiref" --- # ICLRStrongName::StrongNameSignatureVerificationFromImage Method -Verifies that an assembly that has already been mapped to memory is valid for the associated public key. - -## Syntax - -```cpp -HRESULT StrongNameSignatureVerificationFromImage ( - [in] BYTE *pbBase, - [in] DWORD dwLength, - [in] DWORD dwInFlags, - [out] DWORD *pdwOutFlags -); -``` - -## Parameters - - `pbBase` - [in] The relative virtual address of the mapped assembly manifest. - - `dwLength` - [in] The size, in bytes, of the mapped image. - - `dwInFlags` - [in] Flags that influence verification behavior. The following values are supported: - -- `SN_INFLAG_FORCE_VER` (0x00000001) - Forces verification even if it is necessary to override registry settings. - -- `SN_INFLAG_INSTALL` (0x00000002) - Specifies that this is the first verification performed on this image. - -- `SN_INFLAG_ADMIN_ACCESS` (0x00000004) - Specifies that the cache will allow access only to users who have administrative privileges. - -- `SN_INFLAG_USER_ACCESS` (0x00000008) - Specifies that the assembly will be accessible only to the current user. - -- `SN_INFLAG_ALL_ACCESS` (0x00000010) - Specifies that the cache will provide no guarantees of access restriction. - -- `SN_INFLAG_RUNTIME` (0x80000000) - Reserved for internal debugging. - - `pdwOutFlags` - [out] A flag for additional output information. The following value is supported: - -- `SN_OUTFLAG_WAS_VERIFIED` (0x00000001) - This value is set to `false` to specify that the verification succeeded due to registry settings. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Verifies that an assembly that has already been mapped to memory is valid for the associated public key. + +## Syntax + +```cpp +HRESULT StrongNameSignatureVerificationFromImage ( + [in] BYTE *pbBase, + [in] DWORD dwLength, + [in] DWORD dwInFlags, + [out] DWORD *pdwOutFlags +); +``` + +## Parameters + + `pbBase` + [in] The relative virtual address of the mapped assembly manifest. + + `dwLength` + [in] The size, in bytes, of the mapped image. + + `dwInFlags` + [in] Flags that influence verification behavior. The following values are supported: + +- `SN_INFLAG_FORCE_VER` (0x00000001) - Forces verification even if it is necessary to override registry settings. + +- `SN_INFLAG_INSTALL` (0x00000002) - Specifies that this is the first verification performed on this image. + +- `SN_INFLAG_ADMIN_ACCESS` (0x00000004) - Specifies that the cache will allow access only to users who have administrative privileges. + +- `SN_INFLAG_USER_ACCESS` (0x00000008) - Specifies that the assembly will be accessible only to the current user. + +- `SN_INFLAG_ALL_ACCESS` (0x00000010) - Specifies that the cache will provide no guarantees of access restriction. + +- `SN_INFLAG_RUNTIME` (0x80000000) - Reserved for internal debugging. + + `pdwOutFlags` + [out] A flag for additional output information. The following value is supported: + +- `SN_OUTFLAG_WAS_VERIFIED` (0x00000001) - This value is set to `false` to specify that the verification succeeded due to registry settings. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## 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 - [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md similarity index 52% rename from docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md rename to docs/framework/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md index 33d5a0c161149..7c8a5bc0902d9 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassembly-method.md @@ -2,65 +2,66 @@ description: "Learn more about: ICLRStrongName::StrongNameTokenFromAssembly Method" title: "ICLRStrongName::StrongNameTokenFromAssembly Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameTokenFromAssembly" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameTokenFromAssembly" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName::StrongNameTokenFromAssembly method [.NET Framework hosting]" - "StrongNameTokenFromAssembly method, ICLRStrongName interface [.NET Framework hosting]" -topic_type: +ms.assetid: fc725afb-b66b-4015-aa44-1c0d1304197f +topic_type: - "apiref" --- # ICLRStrongName::StrongNameTokenFromAssembly Method -Creates a strong name token from the specified assembly file. - -## Syntax - -```cpp -HRESULT StrongNameTokenFromAssembly ( - [in] LPCWSTR wszFilePath, - [out] BYTE **ppbStrongNameToken, - [out] ULONG *pcbStrongNameToken -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the portable executable (PE) file for the assembly. - - `ppbStrongNameToken` - [out] The returned strong name token. - - `pcbStrongNameToken` - [out] The size, in bytes, of the strong name token. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - A strong name token is the shortened form of a public key. The token is a 64-bit hash that is created from the public key used to sign the assembly. The token is a part of the strong name for the assembly, and can be read from the assembly metadata. - - After the token is created, you should call the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method to release the allocated memory. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Creates a strong name token from the specified assembly file. + +## Syntax + +```cpp +HRESULT StrongNameTokenFromAssembly ( + [in] LPCWSTR wszFilePath, + [out] BYTE **ppbStrongNameToken, + [out] ULONG *pcbStrongNameToken +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the portable executable (PE) file for the assembly. + + `ppbStrongNameToken` + [out] The returned strong name token. + + `pcbStrongNameToken` + [out] The size, in bytes, of the strong name token. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + A strong name token is the shortened form of a public key. The token is a 64-bit hash that is created from the public key used to sign the assembly. The token is a part of the strong name for the assembly, and can be read from the assembly metadata. + + After the token is created, you should call the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method to release the allocated memory. + +## 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 - [StrongNameTokenFromAssemblyEx Method](iclrstrongname-strongnametokenfromassemblyex-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md similarity index 51% rename from docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md rename to docs/framework/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md index cf244d5edaba7..5bd895e343c7d 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnametokenfromassemblyex-method.md @@ -2,73 +2,74 @@ description: "Learn more about: ICLRStrongName::StrongNameTokenFromAssemblyEx Method" title: "ICLRStrongName::StrongNameTokenFromAssemblyEx Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameTokenFromAssemblyEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameTokenFromAssemblyEx" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameTokenFromAssemblyEx method, ICLRStrongName interface [.NET Framework hosting]" - "ICLRStrongName::StrongNameTokenFromAssemblyEx method [.NET Framework hosting]" -topic_type: +ms.assetid: 648ea90e-5e60-40a0-a56a-3e61bf2fba7c +topic_type: - "apiref" --- # ICLRStrongName::StrongNameTokenFromAssemblyEx Method -Creates a strong name token from the specified assembly file, and returns the public key that the token represents. - -## Syntax - -```cpp -HRESULT StrongNameTokenFromAssemblyEx ( - [in] LPCWSTR wszFilePath, - [out] BYTE **ppbStrongNameToken, - [out] ULONG *pcbStrongNameToken, - [out] BYTE **ppbPublicKeyBlob, - [out] ULONG *pcbPublicKeyBlob -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the portable executable (PE) file for the assembly. - - `ppbStrongNameToken` - [out] The returned strong name token. - - `pcbStrongNameToken` - [out] The size, in bytes, of the strong name token. - - `ppbPublicKeyBlob` - [out] The returned public key. - - `pcbPublicKeyBlob` - [out] The size, in bytes, of the public key. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - A strong name token is the shortened form of a public key. The token is a 64-bit hash that is created from the public key used to sign the assembly. The token is a part of the strong name for the assembly, and can be read from the assembly metadata. - - After the key is retrieved and the token is created, you should call the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method to release the allocated memory. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Creates a strong name token from the specified assembly file, and returns the public key that the token represents. + +## Syntax + +```cpp +HRESULT StrongNameTokenFromAssemblyEx ( + [in] LPCWSTR wszFilePath, + [out] BYTE **ppbStrongNameToken, + [out] ULONG *pcbStrongNameToken, + [out] BYTE **ppbPublicKeyBlob, + [out] ULONG *pcbPublicKeyBlob +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the portable executable (PE) file for the assembly. + + `ppbStrongNameToken` + [out] The returned strong name token. + + `pcbStrongNameToken` + [out] The size, in bytes, of the strong name token. + + `ppbPublicKeyBlob` + [out] The returned public key. + + `pcbPublicKeyBlob` + [out] The size, in bytes, of the public key. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + A strong name token is the shortened form of a public key. The token is a 64-bit hash that is created from the public key used to sign the assembly. The token is a part of the strong name for the assembly, and can be read from the assembly metadata. + + After the key is retrieved and the token is created, you should call the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method to release the allocated memory. + +## 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 - [StrongNameTokenFromAssembly Method](iclrstrongname-strongnametokenfromassembly-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md similarity index 50% rename from docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md rename to docs/framework/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md index 31f7d82579047..769a3bb87434c 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname-strongnametokenfrompublickey-method.md @@ -2,69 +2,70 @@ description: "Learn more about: ICLRStrongName::StrongNameTokenFromPublicKey Method" title: "ICLRStrongName::StrongNameTokenFromPublicKey Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName.StrongNameTokenFromPublicKey" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName::StrongNameTokenFromPublicKey" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName::StrongNameTokenFromPublicKey method [.NET Framework hosting]" - "StrongNameTokenFromPublicKey method, ICLRStrongName interface [.NET Framework hosting]" -topic_type: +ms.assetid: 7962ce88-7e86-4a6f-8298-621b01ffc3c2 +topic_type: - "apiref" --- # ICLRStrongName::StrongNameTokenFromPublicKey Method -Gets a token that represents a public key. A strong name token is the shortened form of a public key. - -## Syntax - -```cpp +Gets a token that represents a public key. A strong name token is the shortened form of a public key. + +## Syntax + +```cpp HRESULT StrongNameTokenFromPublicKey ( - [in] BYTE *pbPublicKeyBlob, - [in] ULONG cbPublicKeyBlob, - [out] BYTE **ppbStrongNameToken, - [out] ULONG *pcbStrongNameToken -); -``` - -## Parameters - - `pbPublicKeyBlob` - [in] A structure of type [PublicKeyBlob]((../../../framework/unmanaged-api/strong-naming/publickeyblob-structure.md) that contains the public portion of the key pair used to generate the strong name signature. - - `cbPublicKeyBlob` - [in] The size, in bytes, of `pbPublicKeyBlob`. - - `ppbStrongNameToken` - [out] The strong name token corresponding to the key passed in `pbPublicKeyBlob`. The common language runtime allocates the memory in which to return the token. The caller must free this memory by using the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method. - - `pcbStrongNameToken` - [out] The size, in bytes, of the returned strong name token. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - A strong name token is the shortened form of a public key that is used to save space when storing key information in metadata. Specifically, strong name tokens are used in assembly references to refer to the dependent assembly. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in mscoree.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - + [in] BYTE *pbPublicKeyBlob, + [in] ULONG cbPublicKeyBlob, + [out] BYTE **ppbStrongNameToken, + [out] ULONG *pcbStrongNameToken +); +``` + +## Parameters + + `pbPublicKeyBlob` + [in] A structure of type [PublicKeyBlob](../strong-naming/publickeyblob-structure.md) that contains the public portion of the key pair used to generate the strong name signature. + + `cbPublicKeyBlob` + [in] The size, in bytes, of `pbPublicKeyBlob`. + + `ppbStrongNameToken` + [out] The strong name token corresponding to the key passed in `pbPublicKeyBlob`. The common language runtime allocates the memory in which to return the token. The caller must free this memory by using the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method. + + `pcbStrongNameToken` + [out] The size, in bytes, of the returned strong name token. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + A strong name token is the shortened form of a public key that is used to save space when storing key information in metadata. Specifically, strong name tokens are used in assembly references to refer to the dependent assembly. + +## 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 - [StrongNameGetPublicKey Method](iclrstrongname-strongnamegetpublickey-method.md) -- [PublicKeyBlob Structure]((../../../framework/unmanaged-api/strong-naming/publickeyblob-structure.md) +- [PublicKeyBlob Structure](../strong-naming/publickeyblob-structure.md) - [ICLRStrongName Interface](iclrstrongname-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md b/docs/framework/unmanaged-api/hosting/iclrstrongname2-interface.md similarity index 50% rename from docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md rename to docs/framework/unmanaged-api/hosting/iclrstrongname2-interface.md index 892ee27078df8..cd4fba057ee33 100644 --- a/docs/core/unmanaged-api/hosting/iclrstrongname2-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrstrongname2-interface.md @@ -2,38 +2,39 @@ description: "Learn more about: ICLRStrongName2 Interface" title: "ICLRStrongName2 Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName2" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRStrongName2" -helpviewer_keywords: +helpviewer_keywords: - "ICLRStrongName2 interface [.NET Framework hosting]" -topic_type: +ms.assetid: 9f098a74-201e-4628-a468-8dee9ab99b4a +topic_type: - "apiref" --- # ICLRStrongName2 Interface -Provides the ability to create strong names using the SHA-2 group of Secure Hash Algorithms (SHA-256, SHA-384, and SHA-512). - -## Methods - -|Method|Description| -|------------|-----------------| -|[StrongNameGetPublicKeyEx Method](strongnamegetpublickeyex-method.md)|Gets the public key from a public/private key pair, and specifies a hash algorithm and a signature algorithm.| -|[StrongNameSignatureVerificationEx2 Method](strongnamesignatureverificationex2-method.md)|Verifies the signature of a strongly named assembly, and provides a mapping from the ECMA key to a real key.| - -## Remarks - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] +Provides the ability to create strong names using the SHA-2 group of Secure Hash Algorithms (SHA-256, SHA-384, and SHA-512). + +## Methods + +|Method|Description| +|------------|-----------------| +|[StrongNameGetPublicKeyEx Method](strongnamegetpublickeyex-method.md)|Gets the public key from a public/private key pair, and specifies a hash algorithm and a signature algorithm.| +|[StrongNameSignatureVerificationEx2 Method](strongnamesignatureverificationex2-method.md)|Verifies the signature of a strongly named assembly, and provides a mapping from the ECMA key to a real key.| + +## Remarks + +## 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_v45plus](../../../../includes/net-current-v45plus-md.md)] diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md b/docs/framework/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md similarity index 63% rename from docs/core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md rename to docs/framework/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md index a6cb754c616a4..f692f6c67dc48 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrsyncmanager-createrwlockowneriterator-method.md @@ -2,74 +2,75 @@ description: "Learn more about: ICLRSyncManager::CreateRWLockOwnerIterator Method" title: "ICLRSyncManager::CreateRWLockOwnerIterator Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRSyncManager.CreateRWLockOwnerIterator" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRSyncManager::CreateRWLockOwnerIterator" -helpviewer_keywords: +helpviewer_keywords: - "ICLRSyncManager::CreateRWLockOwnerIterator method [.NET Framework hosting]" - "CreateRWLockOwnerIterator method [.NET Framework hosting]" -topic_type: +ms.assetid: b5535b87-9439-424e-b9b3-7d6fafb9819e +topic_type: - "apiref" --- # ICLRSyncManager::CreateRWLockOwnerIterator Method -Requests that the common language runtime (CLR) create an iterator for the host to use to determine the set of tasks waiting on a reader-writer lock. - -## Syntax - -```cpp -HRESULT CreateRWLockOwnerIterator ( - [in] SIZE_T cookie, - [out] SIZE_T *pIterator -); -``` - -## Parameters - - `cookie` - [in] The cookie associated with the desired reader-writer lock. - - `pIterator` - [out] A pointer to an iterator that can be passed to the [GetRWLockOwnerNext](iclrsyncmanager-getrwlockownernext-method.md) and [DeleteRWLockOwnerIterator](iclrsyncmanager-deleterwlockowneriterator-method.md) methods. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateRWLockOwnerIterator` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|HOST_E_INVALIDOPERATION|`CreateRWLockOwnerIterator` was called on a thread that is currently running managed code.| - -## Remarks - - Hosts typically call the `CreateRWLockOwnerIterator`, `DeleteRWLockOwnerIterator`, and `GetRWLockOwnerNext` methods during deadlock detection. The host is responsible for ensuring that the reader-writer lock is still valid, because the CLR makes no attempt to keep the reader-writer lock alive. Several strategies are available for the host to ensure the validity of the lock: - -- The host can block release calls on the reader-writer lock (for example, [IHostSemaphore::ReleaseSemaphore](ihostsemaphore-releasesemaphore-method.md)) while ensuring that this block does not cause deadlock. - -- The host can block the exit from waiting on the event object associated with the reader-writer lock, again ensuring that this block does not cause deadlock. - +Requests that the common language runtime (CLR) create an iterator for the host to use to determine the set of tasks waiting on a reader-writer lock. + +## Syntax + +```cpp +HRESULT CreateRWLockOwnerIterator ( + [in] SIZE_T cookie, + [out] SIZE_T *pIterator +); +``` + +## Parameters + + `cookie` + [in] The cookie associated with the desired reader-writer lock. + + `pIterator` + [out] A pointer to an iterator that can be passed to the [GetRWLockOwnerNext](iclrsyncmanager-getrwlockownernext-method.md) and [DeleteRWLockOwnerIterator](iclrsyncmanager-deleterwlockowneriterator-method.md) methods. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateRWLockOwnerIterator` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|HOST_E_INVALIDOPERATION|`CreateRWLockOwnerIterator` was called on a thread that is currently running managed code.| + +## Remarks + + Hosts typically call the `CreateRWLockOwnerIterator`, `DeleteRWLockOwnerIterator`, and `GetRWLockOwnerNext` methods during deadlock detection. The host is responsible for ensuring that the reader-writer lock is still valid, because the CLR makes no attempt to keep the reader-writer lock alive. Several strategies are available for the host to ensure the validity of the lock: + +- The host can block release calls on the reader-writer lock (for example, [IHostSemaphore::ReleaseSemaphore](ihostsemaphore-releasesemaphore-method.md)) while ensuring that this block does not cause deadlock. + +- The host can block the exit from waiting on the event object associated with the reader-writer lock, again ensuring that this block does not cause deadlock. + > [!NOTE] -> `CreateRWLockOwnerIterator` must be called only on threads that are currently executing unmanaged code. - -## 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 2.0 - +> `CreateRWLockOwnerIterator` must be called only on threads that are currently executing unmanaged code. + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md b/docs/framework/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md similarity index 60% rename from docs/core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md rename to docs/framework/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md index 3d26dbbc608d2..3991273713ec2 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrsyncmanager-deleterwlockowneriterator-method.md @@ -2,62 +2,63 @@ description: "Learn more about: ICLRSyncManager::DeleteRWLockOwnerIterator Method" title: "ICLRSyncManager::DeleteRWLockOwnerIterator Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRSyncManager.DeleteRWLockOwnerIterator" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRSyncManager::DeleteRWLockOwnerIterator" -helpviewer_keywords: +helpviewer_keywords: - "ICLRSyncManager::DeleteRWLockOwnerIterator method [.NET Framework hosting]" - "DeleteRWLockOwnerIterator method [.NET Framework hosting]" -topic_type: +ms.assetid: fcfd340a-b7d6-44e4-8167-2c05b789d483 +topic_type: - "apiref" --- # ICLRSyncManager::DeleteRWLockOwnerIterator Method -Requests that the common language runtime (CLR) destroy an iterator that was created by a call to [ICLRSyncManager::CreateRWLockOwnerIterator](iclrsyncmanager-createrwlockowneriterator-method.md). - -## Syntax - -```cpp -HRESULT DeleteRWLockOwnerIterator ( - [in] SIZE_T Iterator -); -``` - -## Parameters - - `Iterator` - [in] The iterator that was created by using a call to `CreateRWLockOwnerIterator`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`DeleteRWLockOwnerIterator` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The CLR has not been loaded into a process, or is in a state in which it cannot run managed code or successfully process the call.| -|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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The host can call this method and `CreateRWLockOwnerIterator` to ensure that its threading implementation remains synchronized. - -## 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 2.0 - +Requests that the common language runtime (CLR) destroy an iterator that was created by a call to [ICLRSyncManager::CreateRWLockOwnerIterator](iclrsyncmanager-createrwlockowneriterator-method.md). + +## Syntax + +```cpp +HRESULT DeleteRWLockOwnerIterator ( + [in] SIZE_T Iterator +); +``` + +## Parameters + + `Iterator` + [in] The iterator that was created by using a call to `CreateRWLockOwnerIterator`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`DeleteRWLockOwnerIterator` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The CLR has not been loaded into a process, or is in a state in which it cannot run managed code or successfully process the call.| +|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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The host can call this method and `CreateRWLockOwnerIterator` to ensure that its threading implementation remains synchronized. + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md b/docs/framework/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md similarity index 55% rename from docs/core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md rename to docs/framework/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md index ff6d6633f29a3..85ddf6a87d282 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrsyncmanager-getmonitorowner-method.md @@ -2,71 +2,72 @@ description: "Learn more about: ICLRSyncManager::GetMonitorOwner Method" title: "ICLRSyncManager::GetMonitorOwner Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRSyncManager.GetMonitorOwner" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRSyncManager::GetMonitorOwner" -helpviewer_keywords: +helpviewer_keywords: - "ICLRSyncManager::GetMonitorOwner method [.NET Framework hosting]" - "GetMonitorOwner method [.NET Framework hosting]" -topic_type: +ms.assetid: 840983a4-396d-47b4-86a0-d35f9b437cdb +topic_type: - "apiref" --- # ICLRSyncManager::GetMonitorOwner Method -Gets the [IHostTask](ihosttask-interface.md) instance that owns the monitor identified by the specified cookie. - -## Syntax - -```cpp -HRESULT GetMonitorOwner ( - [in] SIZE_T cookie, - [out] IHostTask *ppOwnerHostTask -); -``` - -## Parameters - - `cookie` - [in] The cookie associated with the monitor. - - `ppOwnerHostTask` - [out] A pointer to the `IHostTask` that currently owns the monitor, or null if no task has ownership. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetMonitorOwner` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The host typically calls `GetMonitorOwner` as part of a deadlock-detection mechanism. The cookie is associated with a monitor when it is created by using a call to [IHostSyncManager::CreateMonitorEvent](ihostsyncmanager-createmonitorevent-method.md). - +Gets the [IHostTask](ihosttask-interface.md) instance that owns the monitor identified by the specified cookie. + +## Syntax + +```cpp +HRESULT GetMonitorOwner ( + [in] SIZE_T cookie, + [out] IHostTask *ppOwnerHostTask +); +``` + +## Parameters + + `cookie` + [in] The cookie associated with the monitor. + + `ppOwnerHostTask` + [out] A pointer to the `IHostTask` that currently owns the monitor, or null if no task has ownership. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetMonitorOwner` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The host typically calls `GetMonitorOwner` as part of a deadlock-detection mechanism. The cookie is associated with a monitor when it is created by using a call to [IHostSyncManager::CreateMonitorEvent](ihostsyncmanager-createmonitorevent-method.md). + > [!NOTE] -> A call to release the event underlying the monitor might block—but will not deadlock—if a call to this method is currently in effect on the cookie associated with that monitor. Other tasks might also block if they attempt to acquire this monitor. - - `GetMonitorOwner` always returns immediately and can be called any time after a call to `CreateMonitorEvent`. The host does not need to wait until a task is waiting on the event. - -## 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 2.0 - +> A call to release the event underlying the monitor might block—but will not deadlock—if a call to this method is currently in effect on the cookie associated with that monitor. Other tasks might also block if they attempt to acquire this monitor. + + `GetMonitorOwner` always returns immediately and can be called any time after a call to `CreateMonitorEvent`. The host does not need to wait until a task is waiting on the event. + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md b/docs/framework/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md similarity index 57% rename from docs/core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md rename to docs/framework/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md index a183bd35db2c7..d3dbfb390b15a 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrsyncmanager-getrwlockownernext-method.md @@ -2,69 +2,70 @@ description: "Learn more about: ICLRSyncManager::GetRWLockOwnerNext Method" title: "ICLRSyncManager::GetRWLockOwnerNext Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRSyncManager.GetRWLockOwnerNext" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRSyncManager::GetRWLockOwnerNext" -helpviewer_keywords: +helpviewer_keywords: - "ICLRSyncManager::GetRWLockOwnerNext method [.NET Framework hosting]" - "GetRWLockOwnerNext method [.NET Framework hosting]" -topic_type: +ms.assetid: 0e025b6a-280e-40a2-a2d0-b15f58777b81 +topic_type: - "apiref" --- # ICLRSyncManager::GetRWLockOwnerNext Method -Gets the next [IHostTask](ihosttask-interface.md) instance that is blocked on the current reader-writer lock. - -## Syntax - +Gets the next [IHostTask](ihosttask-interface.md) instance that is blocked on the current reader-writer lock. + +## Syntax + ```cpp -HRESULT GetRWLockOwnerNext ( - [in] SIZE_T Iterator, - [out] IHostTask *ppOwnerHostTask -); -``` - -## Parameters - - `Iterator` - [in] The iterator that was created by using a call to [CreateRWLockOwnerIterator](iclrsyncmanager-createrwlockowneriterator-method.md). - - `ppOwnerHostTask` - [out] A pointer to the next `IHostTask` that is waiting on the lock, or null if no task is waiting. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetRWLockOwnerNext` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - If `ppOwnerHostTask` is set to null, the iteration has terminated, and the host should call the [DeleteRWLockOwnerIterator](iclrsyncmanager-deleterwlockowneriterator-method.md) method. - +HRESULT GetRWLockOwnerNext ( + [in] SIZE_T Iterator, + [out] IHostTask *ppOwnerHostTask +); +``` + +## Parameters + + `Iterator` + [in] The iterator that was created by using a call to [CreateRWLockOwnerIterator](iclrsyncmanager-createrwlockowneriterator-method.md). + + `ppOwnerHostTask` + [out] A pointer to the next `IHostTask` that is waiting on the lock, or null if no task is waiting. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetRWLockOwnerNext` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + If `ppOwnerHostTask` is set to null, the iteration has terminated, and the host should call the [DeleteRWLockOwnerIterator](iclrsyncmanager-deleterwlockowneriterator-method.md) method. + > [!NOTE] -> The CLR calls `AddRef` on the `IHostTask` to which `ppOwnerHostTask` points to prevent this task from exiting while the host holds the pointer. The host must call `Release` to decrement the reference count when it is finished. - -## 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 2.0 - +> The CLR calls `AddRef` on the `IHostTask` to which `ppOwnerHostTask` points to prevent this task from exiting while the host holds the pointer. The host must call `Release` to decrement the reference count when it is finished. + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md b/docs/framework/unmanaged-api/hosting/iclrsyncmanager-interface.md similarity index 62% rename from docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md rename to docs/framework/unmanaged-api/hosting/iclrsyncmanager-interface.md index 15bcc274dd952..3ca29a8748bf3 100644 --- a/docs/core/unmanaged-api/hosting/iclrsyncmanager-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrsyncmanager-interface.md @@ -2,42 +2,43 @@ description: "Learn more about: ICLRSyncManager Interface" title: "ICLRSyncManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRSyncManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRSyncManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLRSyncManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: a49f9d80-1c76-4ddd-8c49-34f913a5c596 +topic_type: - "apiref" --- # ICLRSyncManager Interface -Defines methods that allow the host to get information about requested tasks and to detect deadlocks in its synchronization implementation. - -## Methods - -|Method|Description| -|------------|-----------------| -|[CreateRWLockOwnerIterator Method](iclrsyncmanager-createrwlockowneriterator-method.md)|Requests that the common language runtime (CLR) create an iterator for the host to use to determine the set of tasks waiting on a reader-writer lock.| -|[DeleteRWLockOwnerIterator Method](iclrsyncmanager-deleterwlockowneriterator-method.md)|Requests that the CLR destroy an iterator that was created by a call to `CreateRWLockOwnerIterator`.| -|[GetMonitorOwner Method](iclrsyncmanager-getmonitorowner-method.md)|Gets the task that owns the specified monitor.| -|[GetRWLockOwnerNext Method](iclrsyncmanager-getrwlockownernext-method.md)|Gets the next task that is waiting on the current reader-writer lock.| - -## 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 2.0 - +Defines methods that allow the host to get information about requested tasks and to detect deadlocks in its synchronization implementation. + +## Methods + +|Method|Description| +|------------|-----------------| +|[CreateRWLockOwnerIterator Method](iclrsyncmanager-createrwlockowneriterator-method.md)|Requests that the common language runtime (CLR) create an iterator for the host to use to determine the set of tasks waiting on a reader-writer lock.| +|[DeleteRWLockOwnerIterator Method](iclrsyncmanager-deleterwlockowneriterator-method.md)|Requests that the CLR destroy an iterator that was created by a call to `CreateRWLockOwnerIterator`.| +|[GetMonitorOwner Method](iclrsyncmanager-getmonitorowner-method.md)|Gets the task that owns the specified monitor.| +|[GetRWLockOwnerNext Method](iclrsyncmanager-getrwlockownernext-method.md)|Gets the next task that is waiting on the current reader-writer lock.| + +## 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 - diff --git a/docs/core/unmanaged-api/hosting/iclrtask-abort-method.md b/docs/framework/unmanaged-api/hosting/iclrtask-abort-method.md similarity index 61% rename from docs/core/unmanaged-api/hosting/iclrtask-abort-method.md rename to docs/framework/unmanaged-api/hosting/iclrtask-abort-method.md index 0c0d0a1036fd8..a661e2d7de822 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-abort-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrtask-abort-method.md @@ -2,55 +2,56 @@ description: "Learn more about: ICLRTask::Abort Method" title: "ICLRTask::Abort Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask.Abort" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask::Abort" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTask::Abort method [.NET Framework hosting]" - "Abort method, ICLRTask interface [.NET Framework hosting]" -topic_type: +ms.assetid: b3594b5f-2e41-4e36-9096-3586276a138c +topic_type: - "apiref" --- # ICLRTask::Abort Method -Requests that the common language runtime (CLR) abort the task that the current [ICLRTask](iclrtask-interface.md) instance represents. - -## Syntax - -```cpp -HRESULT Abort (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Abort` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR raises a when the host calls `Abort`. It returns immediately after the exception information is initialized, without waiting for user code, such as finalizers or exception handling mechanisms, to execute. Calls to `Abort` thus return quickly. - -## 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 2.0 - +Requests that the common language runtime (CLR) abort the task that the current [ICLRTask](iclrtask-interface.md) instance represents. + +## Syntax + +```cpp +HRESULT Abort (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Abort` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR raises a when the host calls `Abort`. It returns immediately after the exception information is initialized, without waiting for user code, such as finalizers or exception handling mechanisms, to execute. Calls to `Abort` thus return quickly. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md b/docs/framework/unmanaged-api/hosting/iclrtask-exittask-method.md similarity index 55% rename from docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md rename to docs/framework/unmanaged-api/hosting/iclrtask-exittask-method.md index 0aae775af077e..5497f6a16e077 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-exittask-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrtask-exittask-method.md @@ -2,55 +2,56 @@ description: "Learn more about: ICLRTask::ExitTask Method" title: "ICLRTask::ExitTask Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask.ExitTask" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask::ExitTask" -helpviewer_keywords: +helpviewer_keywords: - "ExitTask method [.NET Framework hosting]" - "ICLRTask::ExitTask method [.NET Framework hosting]" -topic_type: +ms.assetid: 746c85a6-4b33-4f72-a2e9-379fdf2e96af +topic_type: - "apiref" --- # ICLRTask::ExitTask Method -Notifies the common language runtime (CLR) that the task represented by the current [ICLRTask](iclrtask-interface.md) instance is ending, and attempts to shut the task down gracefully. - -## Syntax - -```cpp -HRESULT ExitTask (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`ExitTask` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `ExitTask` attempts a clean shutdown of a task, in a manner analogous to detaching a thread from an unmanaged type library. - -## 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 2.0 - +Notifies the common language runtime (CLR) that the task represented by the current [ICLRTask](iclrtask-interface.md) instance is ending, and attempts to shut the task down gracefully. + +## Syntax + +```cpp +HRESULT ExitTask (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`ExitTask` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `ExitTask` attempts a clean shutdown of a task, in a manner analogous to detaching a thread from an unmanaged type library. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md b/docs/framework/unmanaged-api/hosting/iclrtask-getmemstats-method.md similarity index 55% rename from docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md rename to docs/framework/unmanaged-api/hosting/iclrtask-getmemstats-method.md index dd76a53a297db..ca432b3fc546f 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-getmemstats-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrtask-getmemstats-method.md @@ -2,58 +2,59 @@ description: "Learn more about: ICLRTask::GetMemStats Method" title: "ICLRTask::GetMemStats Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask.GetMemStats" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask::GetMemStats" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTask::GetMemStats method [.NET Framework hosting]" - "GetMemStats method [.NET Framework hosting]" -topic_type: +ms.assetid: c9e07657-1682-4c30-a336-f8658ff1a125 +topic_type: - "apiref" --- # ICLRTask::GetMemStats Method -Gets statistical memory usage information related to the task that the current [ICLRTask](iclrtask-interface.md) instance represents. - -## Syntax - -```cpp -HRESULT GetMemStats ( - [out] COR_GC_THREAD_STATS *pMemUsage -); -``` - -## Parameters - - `pMemUsage` - [out] A pointer to a [COR_GC_THREAD_STATS](cor-gc-thread-stats-structure.md) instance that contains details about the memory usage of the task, including the number of bytes allocated. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetMemStats` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## 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 2.0 - +Gets statistical memory usage information related to the task that the current [ICLRTask](iclrtask-interface.md) instance represents. + +## Syntax + +```cpp +HRESULT GetMemStats ( + [out] COR_GC_THREAD_STATS *pMemUsage +); +``` + +## Parameters + + `pMemUsage` + [out] A pointer to a [COR_GC_THREAD_STATS](cor-gc-thread-stats-structure.md) instance that contains details about the memory usage of the task, including the number of bytes allocated. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetMemStats` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask-interface.md b/docs/framework/unmanaged-api/hosting/iclrtask-interface.md similarity index 77% rename from docs/core/unmanaged-api/hosting/iclrtask-interface.md rename to docs/framework/unmanaged-api/hosting/iclrtask-interface.md index 1fdb372e50310..8b6f4ae2088f9 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrtask-interface.md @@ -2,55 +2,56 @@ description: "Learn more about: ICLRTask Interface" title: "ICLRTask Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTask interface [.NET Framework hosting]" -topic_type: +ms.assetid: b3a44df3-578a-4451-b55e-70c8e7695f5e +topic_type: - "apiref" --- # ICLRTask Interface -Provides methods that allow the host to make requests of the common language runtime (CLR), or to provide notification to the CLR about the associated task. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Abort Method](iclrtask-abort-method.md)|Requests that the CLR abort the task that the current `ICLRTask` instance represents.| -|[ExitTask Method](iclrtask-exittask-method.md)|Notifies the CLR that the task associated with the current `ICLRTask` instance is ending, and attempts to shut the task down gracefully.| -|[GetMemStats Method](iclrtask-getmemstats-method.md)|Gets statistical information on the use of memory resources by the task represented by the current `ICLRTask` instance.| -|[LocksHeld Method](iclrtask-locksheld-method.md)|Gets the number of locks currently held on the task.| -|[NeedsPriorityScheduling Method](iclrtask-needspriorityscheduling-method.md)|Gets a value indicating whether the host should assign a high priority to rescheduling the task represented by the current `ICLRTask` instance.| -|[Reset Method](iclrtask-reset-method.md)|Informs the CLR that the host has completed a task, and enables the CLR to reuse the current `ICLRTask` instance to represent another task.| -|[RudeAbort Method](iclrtask-rudeabort-method.md)|Causes the CLR to abort the task represented by the current `ICLRTask` instance immediately, without a guarantee that finalizers will be executed.| -|[SetTaskIdentifier Method](iclrtask-settaskidentifier-method.md)|Sets a unique identifier for the task represented by the current `ICLRTask` instance, for use in debugging.| -|[SwitchIn Method](iclrtask-switchin-method.md)|Notifies the CLR that the task represented by the current `ICLRTask` instance is in an operable state.| -|[SwitchOut Method](iclrtask-switchout-method.md)|Notifies the CLR that the task represented by the current `ICLRTask` instance is no longer in an operable state.| -|[YieldTask Method](iclrtask-yieldtask-method.md)|Requests that the CLR make processor time available to other tasks. The CLR makes no guarantee that the task will be put in a state where it can yield processing time.| - -## Remarks - - An `ICLRTask` is the representation of a task for the CLR. At any point during code execution, a task can be described either as running or waiting to run. The host calls the `ICLRTask::SwitchIn` method to notify the CLR that the task that the current `ICLRTask` instance represents is now in an operable state. After a call to `ICLRTask::SwitchIn`, the host can schedule the task on any operating system thread, except in cases where the runtime requires thread-affinity, as specified by calls to the [IHostTaskManager::BeginThreadAffinity](ihosttaskmanager-beginthreadaffinity-method.md) and [IHostTaskManager::EndThreadAffinity](ihosttaskmanager-endthreadaffinity-method.md) methods. Some time later, the operating system might decide to remove the task from the thread and place it in a non-running state. For example, this might happen whenever the task blocks on synchronization primitives, or waits for I/O operations to complete. The host calls [SwitchOut](iclrtask-switchout-method.md) to notify the CLR that the task represented by the current `ICLRTask` instance is no longer in an operable state. - - A task typically terminates at the end of code execution. At that time, the host calls `ICLRTask::ExitTask` to destroy the associated `ICLRTask`. However, tasks can also be recycled by using a call to `ICLRTask::Reset`, which allows the `ICLRTask` instance to be used again. This approach prevents the overhead of repeatedly creating and destroying instances. - -## 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 2.0 - +Provides methods that allow the host to make requests of the common language runtime (CLR), or to provide notification to the CLR about the associated task. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Abort Method](iclrtask-abort-method.md)|Requests that the CLR abort the task that the current `ICLRTask` instance represents.| +|[ExitTask Method](iclrtask-exittask-method.md)|Notifies the CLR that the task associated with the current `ICLRTask` instance is ending, and attempts to shut the task down gracefully.| +|[GetMemStats Method](iclrtask-getmemstats-method.md)|Gets statistical information on the use of memory resources by the task represented by the current `ICLRTask` instance.| +|[LocksHeld Method](iclrtask-locksheld-method.md)|Gets the number of locks currently held on the task.| +|[NeedsPriorityScheduling Method](iclrtask-needspriorityscheduling-method.md)|Gets a value indicating whether the host should assign a high priority to rescheduling the task represented by the current `ICLRTask` instance.| +|[Reset Method](iclrtask-reset-method.md)|Informs the CLR that the host has completed a task, and enables the CLR to reuse the current `ICLRTask` instance to represent another task.| +|[RudeAbort Method](iclrtask-rudeabort-method.md)|Causes the CLR to abort the task represented by the current `ICLRTask` instance immediately, without a guarantee that finalizers will be executed.| +|[SetTaskIdentifier Method](iclrtask-settaskidentifier-method.md)|Sets a unique identifier for the task represented by the current `ICLRTask` instance, for use in debugging.| +|[SwitchIn Method](iclrtask-switchin-method.md)|Notifies the CLR that the task represented by the current `ICLRTask` instance is in an operable state.| +|[SwitchOut Method](iclrtask-switchout-method.md)|Notifies the CLR that the task represented by the current `ICLRTask` instance is no longer in an operable state.| +|[YieldTask Method](iclrtask-yieldtask-method.md)|Requests that the CLR make processor time available to other tasks. The CLR makes no guarantee that the task will be put in a state where it can yield processing time.| + +## Remarks + + An `ICLRTask` is the representation of a task for the CLR. At any point during code execution, a task can be described either as running or waiting to run. The host calls the `ICLRTask::SwitchIn` method to notify the CLR that the task that the current `ICLRTask` instance represents is now in an operable state. After a call to `ICLRTask::SwitchIn`, the host can schedule the task on any operating system thread, except in cases where the runtime requires thread-affinity, as specified by calls to the [IHostTaskManager::BeginThreadAffinity](ihosttaskmanager-beginthreadaffinity-method.md) and [IHostTaskManager::EndThreadAffinity](ihosttaskmanager-endthreadaffinity-method.md) methods. Some time later, the operating system might decide to remove the task from the thread and place it in a non-running state. For example, this might happen whenever the task blocks on synchronization primitives, or waits for I/O operations to complete. The host calls [SwitchOut](iclrtask-switchout-method.md) to notify the CLR that the task represented by the current `ICLRTask` instance is no longer in an operable state. + + A task typically terminates at the end of code execution. At that time, the host calls `ICLRTask::ExitTask` to destroy the associated `ICLRTask`. However, tasks can also be recycled by using a call to `ICLRTask::Reset`, which allows the `ICLRTask` instance to be used again. This approach prevents the overhead of repeatedly creating and destroying instances. + +## 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 - [ICLRTaskManager Interface](iclrtaskmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md b/docs/framework/unmanaged-api/hosting/iclrtask-locksheld-method.md similarity index 51% rename from docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md rename to docs/framework/unmanaged-api/hosting/iclrtask-locksheld-method.md index 2e15d950e92bf..842d35d918d45 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-locksheld-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrtask-locksheld-method.md @@ -2,58 +2,59 @@ description: "Learn more about: ICLRTask::LocksHeld Method" title: "ICLRTask::LocksHeld Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask.LocksHeld" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask::LocksHeld" -helpviewer_keywords: +helpviewer_keywords: - "LocksHeld method [.NET Framework hosting]" - "ICLRTask::LocksHeld method [.NET Framework hosting]" -topic_type: +ms.assetid: e88a4dc3-02cc-4703-a474-292b71c40657 +topic_type: - "apiref" --- # ICLRTask::LocksHeld Method -Gets the number of locks currently held on the task. - -## Syntax - -```cpp -HRESULT LocksHeld ( - [out] SIZE_T *pLockCount -); -``` - -## Parameters - - `pLockCount` - [out] The number of locks held on the task at the time of the method call. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`LocksHeld` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## 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 2.0 - +Gets the number of locks currently held on the task. + +## Syntax + +```cpp +HRESULT LocksHeld ( + [out] SIZE_T *pLockCount +); +``` + +## Parameters + + `pLockCount` + [out] The number of locks held on the task at the time of the method call. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`LocksHeld` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md b/docs/framework/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md similarity index 60% rename from docs/core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md rename to docs/framework/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md index 159cdeda9e990..a6dec6a556022 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrtask-needspriorityscheduling-method.md @@ -2,62 +2,63 @@ description: "Learn more about: ICLRTask::NeedsPriorityScheduling Method" title: "ICLRTask::NeedsPriorityScheduling Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask.NeedsPriorityScheduling" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask::NeedsPriorityScheduling" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTask::NeedsPriorityScheduling method [.NET Framework hosting]" - "NeedsPriorityScheduling method [.NET Framework hosting]" -topic_type: +ms.assetid: 9c9db3f3-26bf-4317-88de-5eb926a22a1d +topic_type: - "apiref" --- # ICLRTask::NeedsPriorityScheduling Method -Gets a value that indicates whether the current task, which is being switched out, needs to be marked as a high priority for rescheduling. - -## Syntax - -```cpp -HRESULT NeedsPriorityScheduling ( - [out] BOOL *pbNeedsPriorityScheduling -); -``` - -## Parameters - - `pbNeedsPriorityRescheduling` - [out] `true`, if the host should attempt to reschedule the current task instance as soon as possible; otherwise, `false`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`NeedsPriorityRescheduling` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - In situations where the task is close to being collected by the garbage collector, the CLR sets the value of `pbNeedsPriorityScheduling` to `true`, indicating high-priority rescheduling. This allows the host to reschedule the task quickly, thereby minimizing the potential for delays in garbage collection, and enabling the host and the runtime to cooperate in conserving memory resources. - -## 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 2.0 - +Gets a value that indicates whether the current task, which is being switched out, needs to be marked as a high priority for rescheduling. + +## Syntax + +```cpp +HRESULT NeedsPriorityScheduling ( + [out] BOOL *pbNeedsPriorityScheduling +); +``` + +## Parameters + + `pbNeedsPriorityRescheduling` + [out] `true`, if the host should attempt to reschedule the current task instance as soon as possible; otherwise, `false`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`NeedsPriorityRescheduling` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + In situations where the task is close to being collected by the garbage collector, the CLR sets the value of `pbNeedsPriorityScheduling` to `true`, indicating high-priority rescheduling. This allows the host to reschedule the task quickly, thereby minimizing the potential for delays in garbage collection, and enabling the host and the runtime to cooperate in conserving memory resources. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask-reset-method.md b/docs/framework/unmanaged-api/hosting/iclrtask-reset-method.md similarity index 63% rename from docs/core/unmanaged-api/hosting/iclrtask-reset-method.md rename to docs/framework/unmanaged-api/hosting/iclrtask-reset-method.md index 31da7e7a1944e..a6974ef802cf8 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-reset-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrtask-reset-method.md @@ -2,78 +2,79 @@ description: "Learn more about: ICLRTask::Reset Method" title: "ICLRTask::Reset Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask.Reset" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask::Reset" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTask::Reset method [.NET Framework hosting]" - "Reset method, ICLRTask interface [.NET Framework hosting]" -topic_type: +ms.assetid: 1bfb5d3a-0ffd-4bb4-9bf6-aec00cb675b7 +topic_type: - "apiref" --- # ICLRTask::Reset Method -Informs the common language runtime (CLR) that the host has completed a task, and enables the CLR to reuse the current [ICLRTask](iclrtask-interface.md) instance to represent another task. - -## Syntax - -```cpp -HRESULT Reset ( - [in] BOOL fFull -); -``` - -## Parameters - - `fFull` - [in] `true`, if the runtime should reset all thread-related static values in addition to the security and locale information related to the current `ICLRTask` instance; otherwise, `false`. - - If the value is `true`, the runtime resets data that was stored using or . - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Reset` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR can recycle previously created `ICLRTask` instances to avoid the overhead of repeatedly creating new instances every time it needs a fresh task. The host enables this feature by calling `ICLRTask::Reset` instead of [ICLRTask::ExitTask](iclrtask-exittask-method.md) when it has completed a task. The following list summarizes the normal life cycle of an `ICLRTask` instance: - -1. The runtime creates a new `ICLRTask` instance. - -2. The runtime calls [IHostTaskManager::GetCurrentTask](ihosttaskmanager-getcurrenttask-method.md) to get a reference to the current host task. - -3. The runtime calls [IHostTask::SetCLRTask](ihosttask-setclrtask-method.md) to associate the new instance with the host task. - -4. The task executes and completes. - -5. The host destroys the task by calling `ICLRTask::ExitTask`. - - `Reset` alters this scenario in two ways. In step 5 above, the host calls `Reset` to reset the task to a clean state, and then decouples the `ICLRTask` instance from its associated [IHostTask](ihosttask-interface.md) instance. If desired, the host can also cache the `IHostTask` instance for reuse. In step 1 above, the runtime pulls a recycled `ICLRTask` from the cache instead of creating a new instance. - - This approach works well when the host also has a pool of reusable worker tasks. When the host destroys one of its `IHostTask` instances, it destroys the corresponding `ICLRTask` by calling `ExitTask`. - -## 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 2.0 - +Informs the common language runtime (CLR) that the host has completed a task, and enables the CLR to reuse the current [ICLRTask](iclrtask-interface.md) instance to represent another task. + +## Syntax + +```cpp +HRESULT Reset ( + [in] BOOL fFull +); +``` + +## Parameters + + `fFull` + [in] `true`, if the runtime should reset all thread-related static values in addition to the security and locale information related to the current `ICLRTask` instance; otherwise, `false`. + + If the value is `true`, the runtime resets data that was stored using or . + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Reset` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR can recycle previously created `ICLRTask` instances to avoid the overhead of repeatedly creating new instances every time it needs a fresh task. The host enables this feature by calling `ICLRTask::Reset` instead of [ICLRTask::ExitTask](iclrtask-exittask-method.md) when it has completed a task. The following list summarizes the normal life cycle of an `ICLRTask` instance: + +1. The runtime creates a new `ICLRTask` instance. + +2. The runtime calls [IHostTaskManager::GetCurrentTask](ihosttaskmanager-getcurrenttask-method.md) to get a reference to the current host task. + +3. The runtime calls [IHostTask::SetCLRTask](ihosttask-setclrtask-method.md) to associate the new instance with the host task. + +4. The task executes and completes. + +5. The host destroys the task by calling `ICLRTask::ExitTask`. + + `Reset` alters this scenario in two ways. In step 5 above, the host calls `Reset` to reset the task to a clean state, and then decouples the `ICLRTask` instance from its associated [IHostTask](ihosttask-interface.md) instance. If desired, the host can also cache the `IHostTask` instance for reuse. In step 1 above, the runtime pulls a recycled `ICLRTask` from the cache instead of creating a new instance. + + This approach works well when the host also has a pool of reusable worker tasks. When the host destroys one of its `IHostTask` instances, it destroys the corresponding `ICLRTask` by calling `ExitTask`. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md b/docs/framework/unmanaged-api/hosting/iclrtask-rudeabort-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md rename to docs/framework/unmanaged-api/hosting/iclrtask-rudeabort-method.md index c62cec9eb13a1..b3061e2c6045f 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-rudeabort-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrtask-rudeabort-method.md @@ -2,55 +2,56 @@ description: "Learn more about: ICLRTask::RudeAbort Method" title: "ICLRTask::RudeAbort Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask.RudeAbort" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask::RudeAbort" -helpviewer_keywords: +helpviewer_keywords: - "RudeAbort method, ICLRTask interface [.NET Framework hosting]" - "ICLRTask::RudeAbort method [.NET Framework hosting]" -topic_type: +ms.assetid: b5785468-fcd7-4cc3-8a5d-8796337b53fc +topic_type: - "apiref" --- # ICLRTask::RudeAbort Method -Instructs the common language runtime (CLR) to abort the task represented by the current [ICLRTask Interface](iclrtask-interface.md) instance immediately and unconditionally. - -## Syntax - -```cpp +Instructs the common language runtime (CLR) to abort the task represented by the current [ICLRTask Interface](iclrtask-interface.md) instance immediately and unconditionally. + +## Syntax + +```cpp HRESULT RudeAbort (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`RudeAbort` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - A host calls `RudeAbort` to abort a task immediately. Finalizers and exception handling routines are not guaranteed to be executed. - -## 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 2.0 - +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`RudeAbort` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + A host calls `RudeAbort` to abort a task immediately. Finalizers and exception handling routines are not guaranteed to be executed. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md b/docs/framework/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md similarity index 63% rename from docs/core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md rename to docs/framework/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md index 183123174ddde..f99c5428d4da0 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md @@ -2,62 +2,63 @@ description: "Learn more about: ICLRTask::SetTaskIdentifier Method" title: "ICLRTask::SetTaskIdentifier Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask.SetTaskIdentifier" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask::SetTaskIdentifier" -helpviewer_keywords: +helpviewer_keywords: - "SetTaskIdentifier method [.NET Framework hosting]" - "ICLRTask::SetTaskIdentifier method [.NET Framework hosting]" -topic_type: +ms.assetid: bdb7f047-1e90-40fc-9e3b-d44a16509073 +topic_type: - "apiref" --- # ICLRTask::SetTaskIdentifier Method -Instructs the common language runtime (CLR) to associate the specified identifier value with the task represented by the current [ICLRTask](iclrtask-interface.md) instance. - -## Syntax - -```cpp -HRESULT SetTaskIdentifier ( - [in] DWORD Asked -); -``` - -## Parameters - - `Asked` - [in] The unique identifier for the common language runtime to associate with the task represented by the current `ICLRTask` instance. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetTaskIdentifier` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The host can associate an identifier with a task to help integrate the CLR and the host in a debugging environment. The identifier has no meaning for the CLR. The CLR passes it along to a debugger application. The debugger can use this identifier to associate a CLR call stack with a host call stack, and enable their respective trace information to be unified when viewed in the debugger's user interface. - -## 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 2.0 - +Instructs the common language runtime (CLR) to associate the specified identifier value with the task represented by the current [ICLRTask](iclrtask-interface.md) instance. + +## Syntax + +```cpp +HRESULT SetTaskIdentifier ( + [in] DWORD Asked +); +``` + +## Parameters + + `Asked` + [in] The unique identifier for the common language runtime to associate with the task represented by the current `ICLRTask` instance. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetTaskIdentifier` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The host can associate an identifier with a task to help integrate the CLR and the host in a debugging environment. The identifier has no meaning for the CLR. The CLR passes it along to a debugger application. The debugger can use this identifier to associate a CLR call stack with a host call stack, and enable their respective trace information to be unified when viewed in the debugger's user interface. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md b/docs/framework/unmanaged-api/hosting/iclrtask-switchin-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md rename to docs/framework/unmanaged-api/hosting/iclrtask-switchin-method.md index 2f954d52f0558..c84aed42f7bc9 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-switchin-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrtask-switchin-method.md @@ -2,66 +2,67 @@ description: "Learn more about: ICLRTask::SwitchIn Method" title: "ICLRTask::SwitchIn Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask.SwitchIn" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask::SwitchIn" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTask::SwitchIn method [.NET Framework hosting]" - "SwitchIn method [.NET Framework hosting]" -topic_type: +ms.assetid: 3d37ce20-aa65-4043-8f13-7c728b5d8a52 +topic_type: - "apiref" --- # ICLRTask::SwitchIn Method -Notifies the common language runtime (CLR) that the task that the current [ICLRTask](iclrtask-interface.md) instance represents is now in an operable state. - -## Syntax - -```cpp -HRESULT SwitchIn ( - [in] HANDLE threadHandle -); -``` - -## Parameters - - `threadHandle` - [in] A handle to the physical thread on which the task represented by the current `ICLRTask` instance is executing. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SwitchIn` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|HOST_E_INVALIDOPERATION|`SwitchIn` was called without an earlier call to [SwitchOut Method](iclrtask-switchout-method.md).| - -## Remarks - - The `threadHandle` parameter represents a handle to the operating system thread on which the task represented by the current `ICLRTask` instance has been scheduled. If impersonation has occurred on this thread, you must call [IHostSecurityManager::RevertToSelf](ihostsecuritymanager-reverttoself-method.md) before switching in the task. - +Notifies the common language runtime (CLR) that the task that the current [ICLRTask](iclrtask-interface.md) instance represents is now in an operable state. + +## Syntax + +```cpp +HRESULT SwitchIn ( + [in] HANDLE threadHandle +); +``` + +## Parameters + + `threadHandle` + [in] A handle to the physical thread on which the task represented by the current `ICLRTask` instance is executing. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SwitchIn` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|HOST_E_INVALIDOPERATION|`SwitchIn` was called without an earlier call to [SwitchOut Method](iclrtask-switchout-method.md).| + +## Remarks + + The `threadHandle` parameter represents a handle to the operating system thread on which the task represented by the current `ICLRTask` instance has been scheduled. If impersonation has occurred on this thread, you must call [IHostSecurityManager::RevertToSelf](ihostsecuritymanager-reverttoself-method.md) before switching in the task. + > [!NOTE] -> A call to `SwitchIn` without an earlier call to `SwitchOut` fails with an HRESULT value of HOST_E_INVALIDOPERATION. - -## 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 2.0 - +> A call to `SwitchIn` without an earlier call to `SwitchOut` fails with an HRESULT value of HOST_E_INVALIDOPERATION. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md b/docs/framework/unmanaged-api/hosting/iclrtask-switchout-method.md similarity index 57% rename from docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md rename to docs/framework/unmanaged-api/hosting/iclrtask-switchout-method.md index e930ab72edb22..b4f70e984f6ae 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-switchout-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrtask-switchout-method.md @@ -2,55 +2,56 @@ description: "Learn more about: ICLRTask::SwitchOut Method" title: "ICLRTask::SwitchOut Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask.SwitchOut" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask::SwitchOut" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTask::SwitchOut method [.NET Framework hosting]" - "SwitchOut method [.NET Framework hosting]" -topic_type: +ms.assetid: b6fb168c-b24b-4ecf-a390-2b5ba3317ae6 +topic_type: - "apiref" --- # ICLRTask::SwitchOut Method -Notifies the common language runtime (CLR) that the task represented by the current [ICLRTask](iclrtask-interface.md) instance is no longer in an operable state. - -## Syntax - -```cpp -HRESULT SwitchOut (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SwitchOut` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - A host calls `SwitchOut` to inform the CLR that it has temporarily stopped executing the task that the current `ICLRTask` instance represents, and will reschedule the task. - -## 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 2.0 - +Notifies the common language runtime (CLR) that the task represented by the current [ICLRTask](iclrtask-interface.md) instance is no longer in an operable state. + +## Syntax + +```cpp +HRESULT SwitchOut (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SwitchOut` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + A host calls `SwitchOut` to inform the CLR that it has temporarily stopped executing the task that the current `ICLRTask` instance represents, and will reschedule the task. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md b/docs/framework/unmanaged-api/hosting/iclrtask-yieldtask-method.md similarity index 63% rename from docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md rename to docs/framework/unmanaged-api/hosting/iclrtask-yieldtask-method.md index c7142b733d5f4..6d1a3243c8e44 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask-yieldtask-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrtask-yieldtask-method.md @@ -2,55 +2,56 @@ description: "Learn more about: ICLRTask::YieldTask Method" title: "ICLRTask::YieldTask Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask.YieldTask" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask::YieldTask" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTask::YieldTask method [.NET Framework hosting]" - "YieldTask method [.NET Framework hosting]" -topic_type: +ms.assetid: b8eb4095-3a8f-4be3-9446-63e9893dce7d +topic_type: - "apiref" --- # ICLRTask::YieldTask Method -Requests that the common language runtime (CLR) put aside the task that the current [ICLRTask](iclrtask-interface.md) instance represents, and make the processor time available to other tasks. - -## Syntax - -```cpp -HRESULT YieldTask (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`YieldTask` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - A host calls `YieldTask` to request processor resources for other tasks or processes. This method is primarily intended to allow long-running code to give up CPU time. The runtime attempts to put the task that the current `ICLRTask` instance represents in a state where it can yield processing time, but makes no guarantee of success. - -## 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 2.0 - +Requests that the common language runtime (CLR) put aside the task that the current [ICLRTask](iclrtask-interface.md) instance represents, and make the processor time available to other tasks. + +## Syntax + +```cpp +HRESULT YieldTask (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`YieldTask` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + A host calls `YieldTask` to request processor resources for other tasks or processes. This method is primarily intended to allow long-running code to give up CPU time. The runtime attempts to put the task that the current `ICLRTask` instance represents in a state where it can yield processing time, but makes no guarantee of success. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md b/docs/framework/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md similarity index 68% rename from docs/core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md rename to docs/framework/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md index 136474fc335aa..919df21b722c4 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrtask2-beginpreventasyncabort-method.md @@ -2,59 +2,60 @@ description: "Learn more about: ICLRTask2::BeginPreventAsyncAbort Method" title: "ICLRTask2::BeginPreventAsyncAbort Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask2.BeginPreventAsyncAbort" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask2::BeginPreventAsyncAbort" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTask2::BeginPreventAsyncAbort method [.NET Framework hosting]" - "BeginPreventAsyncAbort method [.NET Framework hosting]" -topic_type: +ms.assetid: 75754c2f-38c7-4707-85fe-559db4542729 +topic_type: - "apiref" --- # ICLRTask2::BeginPreventAsyncAbort Method -Delays new thread abort requests from resulting in thread aborts on the current thread. - -## Syntax - -```cpp -HRESULT BeginPreventAsyncAbort(); -``` - -## 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.| -|HOST_E_INVALIDOPERATION|The method was called on a thread which is not the current thread.| - -## Remarks - - Calling this method increments the delay-thread-abort counter for the current thread by one. - - Calls to `BeginPreventAsyncAbort` and [ICLRTask2::EndPreventAsyncAbort](iclrtask2-endpreventasyncabort-method.md) can be nested. As long as the counter is greater than zero, thread aborts for the current thread are delayed. If this call is not paired with a call to the `EndPreventAsyncAbort` method, it is possible to reach a state in which thread aborts cannot be delivered to the current thread. - - The delay is not honored for a thread that aborts itself. - - The functionality that is exposed by this feature is used internally by the virtual machine (VM). Misuse of these methods may cause unspecified behavior in the VM. For example, calling `EndPreventAsyncAbort` without first calling `BeginPreventAsyncAbort` could set the counter to zero when the VM has previously incremented it. Similarly, the internal counter is not checked for overflow. If it exceeds its integral limit because it is incremented by both the host and the VM, the resulting behavior is unspecified. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Delays new thread abort requests from resulting in thread aborts on the current thread. + +## Syntax + +```cpp +HRESULT BeginPreventAsyncAbort(); +``` + +## 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.| +|HOST_E_INVALIDOPERATION|The method was called on a thread which is not the current thread.| + +## Remarks + + Calling this method increments the delay-thread-abort counter for the current thread by one. + + Calls to `BeginPreventAsyncAbort` and [ICLRTask2::EndPreventAsyncAbort](iclrtask2-endpreventasyncabort-method.md) can be nested. As long as the counter is greater than zero, thread aborts for the current thread are delayed. If this call is not paired with a call to the `EndPreventAsyncAbort` method, it is possible to reach a state in which thread aborts cannot be delivered to the current thread. + + The delay is not honored for a thread that aborts itself. + + The functionality that is exposed by this feature is used internally by the virtual machine (VM). Misuse of these methods may cause unspecified behavior in the VM. For example, calling `EndPreventAsyncAbort` without first calling `BeginPreventAsyncAbort` could set the counter to zero when the VM has previously incremented it. Similarly, the internal counter is not checked for overflow. If it exceeds its integral limit because it is incremented by both the host and the VM, the resulting behavior is unspecified. + +## 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_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [EndPreventAsyncAbort Method](iclrtask2-endpreventasyncabort-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md b/docs/framework/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md similarity index 67% rename from docs/core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md rename to docs/framework/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md index b93549cf450a7..cb07573735a22 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrtask2-endpreventasyncabort-method.md @@ -2,57 +2,58 @@ description: "Learn more about: ICLRTask2::EndPreventAsyncAbort Method" title: "ICLRTask2::EndPreventAsyncAbort Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask2.EndPreventAsyncAbort" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask2::EndPreventAsyncAbort" -helpviewer_keywords: +helpviewer_keywords: - "EndPreventAsyncAbort method [.NET Framework hosting]" - "ICLRTask2::EndPreventAsyncAbort method [.NET Framework hosting]" -topic_type: +ms.assetid: d8013659-e3df-44b3-814f-a6b534ce62f8 +topic_type: - "apiref" --- # ICLRTask2::EndPreventAsyncAbort Method -Allows new or pending thread abort requests to result in thread aborts on the current thread. - -## Syntax - -```cpp -HRESULT EndPreventAsyncAbort(); -``` - -## 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.| -|HOST_E_INVALIDOPERATION|The method was called on a thread which is not the current thread.| - -## Remarks - - Calling this method decrements the delay-thread-abort counter for the current thread by one. - - Calls to [ICLRTask2::BeginPreventAsyncAbort](iclrtask2-beginpreventasyncabort-method.md) and `EndPreventAsyncAbort` can be nested. As long as the counter is greater than zero, thread aborts for the current thread are delayed. - - The functionality that is exposed by this feature is used internally by the virtual machine (VM). Misuse of these methods may cause unspecified behavior in the VM. For example, calling `EndPreventAsyncAbort` without first calling `BeginPreventAsyncAbort` could set the counter to zero when the VM has previously incremented it. Similarly, the internal counter is not checked for overflow. If it exceeds its integral limit because it is incremented by both the host and the VM, the resulting behavior is unspecified. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Allows new or pending thread abort requests to result in thread aborts on the current thread. + +## Syntax + +```cpp +HRESULT EndPreventAsyncAbort(); +``` + +## 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.| +|HOST_E_INVALIDOPERATION|The method was called on a thread which is not the current thread.| + +## Remarks + + Calling this method decrements the delay-thread-abort counter for the current thread by one. + + Calls to [ICLRTask2::BeginPreventAsyncAbort](iclrtask2-beginpreventasyncabort-method.md) and `EndPreventAsyncAbort` can be nested. As long as the counter is greater than zero, thread aborts for the current thread are delayed. + + The functionality that is exposed by this feature is used internally by the virtual machine (VM). Misuse of these methods may cause unspecified behavior in the VM. For example, calling `EndPreventAsyncAbort` without first calling `BeginPreventAsyncAbort` could set the counter to zero when the VM has previously incremented it. Similarly, the internal counter is not checked for overflow. If it exceeds its integral limit because it is incremented by both the host and the VM, the resulting behavior is unspecified. + +## 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_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [BeginPreventAsyncAbort Method](iclrtask2-beginpreventasyncabort-method.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtask2-interface.md b/docs/framework/unmanaged-api/hosting/iclrtask2-interface.md similarity index 71% rename from docs/core/unmanaged-api/hosting/iclrtask2-interface.md rename to docs/framework/unmanaged-api/hosting/iclrtask2-interface.md index 606ebe99496fc..391ae72253559 100644 --- a/docs/core/unmanaged-api/hosting/iclrtask2-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrtask2-interface.md @@ -2,52 +2,53 @@ description: "Learn more about: ICLRTask2 Interface" title: "ICLRTask2 Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTask2" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTask2" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTask2 interface [.NET Framework hosting]" -topic_type: +ms.assetid: b5a22ebc-0582-49de-91f9-97a3d9789290 +topic_type: - "apiref" --- # ICLRTask2 Interface -Provides all the functionality of the [ICLRTask](iclrtask-interface.md) interface; in addition, provides methods that allow thread aborts to be delayed on the current thread. - -## Methods - -|Method|Description| -|------------|-----------------| -|[BeginPreventAsyncAbort Method](iclrtask2-beginpreventasyncabort-method.md)|Delays new thread abort requests on the current thread.| -|[EndPreventAsyncAbort Method](iclrtask2-endpreventasyncabort-method.md)|Allows new or pending thread abort requests to result in thread aborts on the current thread.| - -## Remarks - - The `ICLRTask2` interface inherits the `ICLRTask` interface and adds methods that allow the host to delay thread aborts, to protect a region of code that must not fail. Calling `BeginPreventAsyncAbort` increments the delay-thread-abort counter for the current thread, and calling `EndPreventAsyncAbort` decrements it. Calls to `BeginPreventAsyncAbort` and `EndPreventAsyncAbort` can be nested. As long as the counter is greater than zero, thread aborts for the current thread are delayed. - - If calls to `BeginPreventAsyncAbort` and `EndPreventAsyncAbort` are not paired, it is possible to reach a state in which thread aborts cannot be delivered to the current thread. - - The delay is not honored for a thread that aborts itself. - - The functionality that is exposed by this feature is used internally by the virtual machine (VM). Misuse of these methods may cause unspecified behavior in the VM. For example, calling `EndPreventAsyncAbort` without first calling `BeginPreventAsyncAbort` could set the counter to zero when the VM has previously incremented it. Similarly, the internal counter is not checked for overflow. If it exceeds its integral limit because it is incremented by both the host and the VM, the resulting behavior is unspecified. - - For information about members inherited from `ICLRTask` and about the other uses of this interface, see the [ICLRTask](iclrtask-interface.md) interface. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Provides all the functionality of the [ICLRTask](iclrtask-interface.md) interface; in addition, provides methods that allow thread aborts to be delayed on the current thread. + +## Methods + +|Method|Description| +|------------|-----------------| +|[BeginPreventAsyncAbort Method](iclrtask2-beginpreventasyncabort-method.md)|Delays new thread abort requests on the current thread.| +|[EndPreventAsyncAbort Method](iclrtask2-endpreventasyncabort-method.md)|Allows new or pending thread abort requests to result in thread aborts on the current thread.| + +## Remarks + + The `ICLRTask2` interface inherits the `ICLRTask` interface and adds methods that allow the host to delay thread aborts, to protect a region of code that must not fail. Calling `BeginPreventAsyncAbort` increments the delay-thread-abort counter for the current thread, and calling `EndPreventAsyncAbort` decrements it. Calls to `BeginPreventAsyncAbort` and `EndPreventAsyncAbort` can be nested. As long as the counter is greater than zero, thread aborts for the current thread are delayed. + + If calls to `BeginPreventAsyncAbort` and `EndPreventAsyncAbort` are not paired, it is possible to reach a state in which thread aborts cannot be delivered to the current thread. + + The delay is not honored for a thread that aborts itself. + + The functionality that is exposed by this feature is used internally by the virtual machine (VM). Misuse of these methods may cause unspecified behavior in the VM. For example, calling `EndPreventAsyncAbort` without first calling `BeginPreventAsyncAbort` could set the counter to zero when the VM has previously incremented it. Similarly, the internal counter is not checked for overflow. If it exceeds its integral limit because it is incremented by both the host and the VM, the resulting behavior is unspecified. + + For information about members inherited from `ICLRTask` and about the other uses of this interface, see the [ICLRTask](iclrtask-interface.md) interface. + +## 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_v40plus](../../../../includes/net-current-v40plus-md.md)] + ## See also - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md b/docs/framework/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md similarity index 64% rename from docs/core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md rename to docs/framework/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md index c31da2a2f1a6a..3b672e3479cad 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrtaskmanager-createtask-method.md @@ -2,68 +2,69 @@ description: "Learn more about: ICLRTaskManager::CreateTask Method" title: "ICLRTaskManager::CreateTask Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTaskManager.CreateTask" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTaskManager::CreateTask" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTaskManager::CreateTask method [.NET Framework hosting]" - "CreateTask method, ICLRTaskManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: eea570d9-2e53-4320-9ea0-eb777bf9dcf3 +topic_type: - "apiref" --- # ICLRTaskManager::CreateTask Method -Requests explicitly that the common language runtime (CLR) create a new task. - -## Syntax - -```cpp -HRESULT CreateTask ( - [out] ICLRTask **pTask -); -``` - -## Parameters - - `pTask` - [out] A pointer to the address of a newly created [ICLRTask](iclrtask-interface.md), or null, if the task could not be created. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory is available to allocate the requested resource.| - -## Remarks - - The CLR creates a new task automatically upon initialization, when user code creates a thread by using types in the namespace, or when the size of the thread pool is increased. It also creates tasks when unmanaged code makes a call to a managed function. - - `CreateTask` allows the host to make an explicit request that the CLR create a new task. For example, the host can invoke this method to preinitialize data structures. - +Requests explicitly that the common language runtime (CLR) create a new task. + +## Syntax + +```cpp +HRESULT CreateTask ( + [out] ICLRTask **pTask +); +``` + +## Parameters + + `pTask` + [out] A pointer to the address of a newly created [ICLRTask](iclrtask-interface.md), or null, if the task could not be created. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory is available to allocate the requested resource.| + +## Remarks + + The CLR creates a new task automatically upon initialization, when user code creates a thread by using types in the namespace, or when the size of the thread pool is increased. It also creates tasks when unmanaged code makes a call to a managed function. + + `CreateTask` allows the host to make an explicit request that the CLR create a new task. For example, the host can invoke this method to preinitialize data structures. + > [!IMPORTANT] -> The new task is returned in a suspended state and remains suspended until the host explicitly calls [IHostTask::Start](ihosttask-start-method.md). - -## 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 2.0 - +> The new task is returned in a suspended state and remains suspended until the host explicitly calls [IHostTask::Start](ihosttask-start-method.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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md b/docs/framework/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md similarity index 63% rename from docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md rename to docs/framework/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md index 1646586916675..e1470881a1ba2 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrtaskmanager-getcurrenttask-method.md @@ -2,62 +2,63 @@ description: "Learn more about: ICLRTaskManager::GetCurrentTask Method" title: "ICLRTaskManager::GetCurrentTask Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTaskManager.GetCurrentTask" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTaskManager::GetCurrentTask" -helpviewer_keywords: +helpviewer_keywords: - "GetCurrentTask method, ICLRTaskManager interface [.NET Framework hosting]" - "ICLRTaskManager::GetCurrentTask method [.NET Framework hosting]" -topic_type: +ms.assetid: c0b82a9f-edc6-4878-9c81-48de53c02142 +topic_type: - "apiref" --- # ICLRTaskManager::GetCurrentTask Method -Gets the [ICLRTask](iclrtask-interface.md) instance that is currently running on the operating system thread from which the method call originated. - -## Syntax - -```cpp -HRESULT GetCurrentTask ( - [out] ICLRTask **ppTask -); -``` - -## Parameters - - `ppTask` - [out] A pointer to the address of an `ICLRTask` instance that is currently executing on the operating system thread from which the call originated, or null if no task is currently executing on this thread. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The `ICLRTask` instance that the `ppTask` parameter points to represents the currently executing task for the CLR. The `ICLRTask` instance is associated with a corresponding [IHostTask](ihosttask-interface.md) instance that represents the task for the host. - -## 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 2.0 - +Gets the [ICLRTask](iclrtask-interface.md) instance that is currently running on the operating system thread from which the method call originated. + +## Syntax + +```cpp +HRESULT GetCurrentTask ( + [out] ICLRTask **ppTask +); +``` + +## Parameters + + `ppTask` + [out] A pointer to the address of an `ICLRTask` instance that is currently executing on the operating system thread from which the call originated, or null if no task is currently executing on this thread. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The `ICLRTask` instance that the `ppTask` parameter points to represents the currently executing task for the CLR. The `ICLRTask` instance is associated with a corresponding [IHostTask](ihosttask-interface.md) instance that represents the task for the host. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md b/docs/framework/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md similarity index 50% rename from docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md rename to docs/framework/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md index 3952b3ce9cd5e..7afdf761b2db1 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrtaskmanager-getcurrenttasktype-method.md @@ -2,47 +2,48 @@ description: "Learn more about: ICLRTaskManager::GetCurrentTaskType Method" title: "ICLRTaskManager::GetCurrentTaskType Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTaskManager.GetCurrentTaskType" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTaskManager::GetCurrentTaskType" -helpviewer_keywords: +helpviewer_keywords: - "GetCurrentTaskType method [.NET Framework hosting]" - "ICLRTaskManager::GetCurrentTaskType method [.NET Framework hosting]" -topic_type: +ms.assetid: 6b0d9259-dbe2-45bb-b34d-990f60c73424 +topic_type: - "apiref" --- # ICLRTaskManager::GetCurrentTaskType Method -Gets the type of the task that is currently executing. - -## Syntax - -```cpp -HRESULT GetCurrentTaskType( - [out] ETaskType *pTaskType -); -``` - -## Parameters - - `pTaskType` - [out] A pointer to a value of the [ETaskType](etasktype-enumeration.md) enumeration that indicates the type of task that is currently executing. - -## 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 2.0 - +Gets the type of the task that is currently executing. + +## Syntax + +```cpp +HRESULT GetCurrentTaskType( + [out] ETaskType *pTaskType +); +``` + +## Parameters + + `pTaskType` + [out] A pointer to a value of the [ETaskType](etasktype-enumeration.md) enumeration that indicates the type of task that is currently executing. + +## 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 - [ICLRTaskManager Interface](iclrtaskmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md b/docs/framework/unmanaged-api/hosting/iclrtaskmanager-interface.md similarity index 72% rename from docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md rename to docs/framework/unmanaged-api/hosting/iclrtaskmanager-interface.md index 3264f1cd7337e..b0badfdc2500e 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrtaskmanager-interface.md @@ -2,47 +2,48 @@ description: "Learn more about: ICLRTaskManager Interface" title: "ICLRTaskManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTaskManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTaskManager" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTaskManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: 2bd55e0c-001b-41fd-b29d-f01670fe8216 +topic_type: - "apiref" --- # ICLRTaskManager Interface -Provides methods that allow the host to request explicitly that the common language runtime (CLR) create a new task, get the currently executing task, and set the geographic language and culture for the task. - -## Methods - -|Method|Description| -|------------|-----------------| -|[CreateTask Method](iclrtaskmanager-createtask-method.md)|Requests explicitly that the CLR create a new [ICLRTask](iclrtask-interface.md) instance.| -|[GetCurrentTask Method](iclrtaskmanager-getcurrenttask-method.md)|Gets the `ICLRTask` instance that represents the task that is currently executing.| -|[GetCurrentTaskType Method](iclrtaskmanager-getcurrenttasktype-method.md)|Gets the type of the task that is currently executing.| -|[SetLocale Method](iclrtaskmanager-setlocale-method.md)|Notifies the CLR that the host has modified the locale identifier on the currently executing task.| -|[SetUILocale Method](iclrtaskmanager-setuilocale-method.md)|Notifies the common language runtime that the host has modified the user interface locale identifier on the currently executing task.| - -## Remarks - - Each task that is running in a hosted environment has representations both on the host side (an instance of [IHostTask](ihosttask-interface.md)) and on the CLR side (an instance of [ICLRTask](iclrtask-interface.md)). Either the host or the CLR can initiate the creation of a task, but the host-side representation must be associated with a corresponding CLR-side representation to ensure successful communication between the host and the CLR regarding the task. The two objects must be created and instantiated before managed code can execute on an operating system thread. - -## 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 2.0 - +Provides methods that allow the host to request explicitly that the common language runtime (CLR) create a new task, get the currently executing task, and set the geographic language and culture for the task. + +## Methods + +|Method|Description| +|------------|-----------------| +|[CreateTask Method](iclrtaskmanager-createtask-method.md)|Requests explicitly that the CLR create a new [ICLRTask](iclrtask-interface.md) instance.| +|[GetCurrentTask Method](iclrtaskmanager-getcurrenttask-method.md)|Gets the `ICLRTask` instance that represents the task that is currently executing.| +|[GetCurrentTaskType Method](iclrtaskmanager-getcurrenttasktype-method.md)|Gets the type of the task that is currently executing.| +|[SetLocale Method](iclrtaskmanager-setlocale-method.md)|Notifies the CLR that the host has modified the locale identifier on the currently executing task.| +|[SetUILocale Method](iclrtaskmanager-setuilocale-method.md)|Notifies the common language runtime that the host has modified the user interface locale identifier on the currently executing task.| + +## Remarks + + Each task that is running in a hosted environment has representations both on the host side (an instance of [IHostTask](ihosttask-interface.md)) and on the CLR side (an instance of [ICLRTask](iclrtask-interface.md)). Either the host or the CLR can initiate the creation of a task, but the host-side representation must be associated with a corresponding CLR-side representation to ensure successful communication between the host and the CLR regarding the task. The two objects must be created and instantiated before managed code can execute on an operating system thread. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md b/docs/framework/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md similarity index 55% rename from docs/core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md rename to docs/framework/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md index 5710b839f8b69..90232b1ea67c6 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrtaskmanager-setlocale-method.md @@ -2,62 +2,63 @@ description: "Learn more about: ICLRTaskManager::SetLocale Method" title: "ICLRTaskManager::SetLocale Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTaskManager.SetLocale" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTaskManager::SetLocale" -helpviewer_keywords: +helpviewer_keywords: - "SetLocale method, ICLRTaskManager interface [.NET Framework hosting]" - "ICLRTaskManager::SetLocale method [.NET Framework hosting]" -topic_type: +ms.assetid: ed16bb7f-4206-43a8-b9e9-c5737b69e3af +topic_type: - "apiref" --- # ICLRTaskManager::SetLocale Method -Notifies the common language runtime (CLR) that the host has modified the value of the locale identifier (which maps to the geographical culture and language) on the currently executing task. - -## Syntax - -```cpp -HRESULT SetLocale ( - [in] LCID lcid -); -``` - -## Parameters - - `lcid` - [in] The locale identifier value that maps to the newly assigned geographical culture and language. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `SetLocale` gives the host an opportunity to execute any mechanisms it might have for the synchronization of locales. - -## 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 2.0 - +Notifies the common language runtime (CLR) that the host has modified the value of the locale identifier (which maps to the geographical culture and language) on the currently executing task. + +## Syntax + +```cpp +HRESULT SetLocale ( + [in] LCID lcid +); +``` + +## Parameters + + `lcid` + [in] The locale identifier value that maps to the newly assigned geographical culture and language. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `SetLocale` gives the host an opportunity to execute any mechanisms it might have for the synchronization of locales. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md b/docs/framework/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md similarity index 56% rename from docs/core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md rename to docs/framework/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md index a0ab5544cf3f1..f2ab9c4a71648 100644 --- a/docs/core/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrtaskmanager-setuilocale-method.md @@ -2,62 +2,63 @@ description: "Learn more about: ICLRTaskManager::SetUILocale Method" title: "ICLRTaskManager::SetUILocale Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRTaskManager.SetUILocale" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICLRTaskManager::SetUILocale" -helpviewer_keywords: +helpviewer_keywords: - "ICLRTaskManager::SetUILocale method [.NET Framework hosting]" - "SetUILocale method, ICLRTaskManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: 03adaa9a-2beb-49b3-b2c4-6b4fc3f10715 +topic_type: - "apiref" --- # ICLRTaskManager::SetUILocale Method -Notifies the common language runtime (CLR) that the host has modified the user interface (UI) locale, or culture, on the currently executing task. - -## Syntax - -```cpp -HRESULT SetUILocale ( - [in] LCID lcid -); -``` - -## Parameters - - `lcid` - [in] The locale identifier value that maps to the newly assigned geographical culture and language for the user interface. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetUILocale` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `SetUILocale` provides an opportunity for the host to execute any mechanisms it might have for the synchronization of locales. - -## 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 2.0 - +Notifies the common language runtime (CLR) that the host has modified the user interface (UI) locale, or culture, on the currently executing task. + +## Syntax + +```cpp +HRESULT SetUILocale ( + [in] LCID lcid +); +``` + +## Parameters + + `lcid` + [in] The locale identifier value that maps to the newly assigned geographical culture and language for the user interface. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetUILocale` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `SetUILocale` provides an opportunity for the host to execute any mechanisms it might have for the synchronization of locales. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md b/docs/framework/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md new file mode 100644 index 0000000000000..2740adf9ad619 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iclrvalidator-formateventinfo-method.md @@ -0,0 +1,77 @@ +--- +description: "Learn more about: ICLRValidator::FormatEventInfo Method" +title: "ICLRValidator::FormatEventInfo Method" +ms.date: "03/30/2017" +api_name: + - "ICLRValidator.FormatEventInfo" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICLRValidator::FormatEventInfo" +helpviewer_keywords: + - "FormatEventInfo method, ICLRValidator interface [.NET Framework hosting]" + - "ICLRValidator::FormatEventInfo method [.NET Framework hosting]" +ms.assetid: 808e1f1d-52f4-47c4-83cc-dcf47d075219 +topic_type: + - "apiref" +--- +# ICLRValidator::FormatEventInfo Method + +Gets a detailed message about the specified validation error. + +## Syntax + +```cpp +HRESULT FormatEventInfo ( + [in] HRESULT hVECode, + [in] VEContext Context, + [in, out] LPWSTR msg, + [in] unsigned long ulMaxLength, + [in] SAFEARRAY(VARIANT) psa +); +``` + +## Parameters + + `hVECode` + [in] The HRESULT value that was passed to the validation error handler. + + `Context` + [in] A `VEContext` instance that contains context information about the validation errors. + + `msg` + [in, out] The friendly error message. + + `ulMaxLength` + [in] The maximum length of the error message. + + `psa` + [in] A safe array of additional parameters to be used in the message. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`FormatEventInfo` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** IValidator.idl, IValidator.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + +## See also + +- [ICLRErrorReportingManager Interface](iclrerrorreportingmanager-interface.md) +- [ICLRValidator Interface](iclrvalidator-interface.md) diff --git a/docs/core/unmanaged-api/hosting/iclrvalidator-interface.md b/docs/framework/unmanaged-api/hosting/iclrvalidator-interface.md similarity index 82% rename from docs/core/unmanaged-api/hosting/iclrvalidator-interface.md rename to docs/framework/unmanaged-api/hosting/iclrvalidator-interface.md index 4495318c6893d..3caf8c9b0279a 100644 --- a/docs/core/unmanaged-api/hosting/iclrvalidator-interface.md +++ b/docs/framework/unmanaged-api/hosting/iclrvalidator-interface.md @@ -12,6 +12,7 @@ f1_keywords: - "ICLRValidator" helpviewer_keywords: - "ICLRValidator interface [.NET Framework hosting]" +ms.assetid: 2edd0a10-77fb-4173-91eb-f2970cc364d0 topic_type: - "apiref" --- @@ -28,13 +29,13 @@ Provides methods for validating portable executable (PE) images and reporting va ## Requirements - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h **Library:** Included as a resource in MSCorEE.dll - **.NET versions:** Available since .NET Framework 2.0 + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] ## See also diff --git a/docs/core/unmanaged-api/hosting/iclrvalidator-validate-method.md b/docs/framework/unmanaged-api/hosting/iclrvalidator-validate-method.md similarity index 90% rename from docs/core/unmanaged-api/hosting/iclrvalidator-validate-method.md rename to docs/framework/unmanaged-api/hosting/iclrvalidator-validate-method.md index 79ec33bbfabee..0ac6dd1afc64b 100644 --- a/docs/core/unmanaged-api/hosting/iclrvalidator-validate-method.md +++ b/docs/framework/unmanaged-api/hosting/iclrvalidator-validate-method.md @@ -13,6 +13,7 @@ f1_keywords: helpviewer_keywords: - "Validate method, ICLRValidator interface [.NET Framework hosting]" - "ICLRValidator::Validate method [.NET Framework hosting]" +ms.assetid: 0b1b432a-d234-4002-839b-81366c3a8bdc topic_type: - "apiref" --- @@ -74,13 +75,13 @@ HRESULT Validate ( ## Requirements - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h **Library:** Included as a resource in MSCorEE.dll - **.NET versions:** Available since .NET Framework 2.0 + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] ## See also diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md b/docs/framework/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md similarity index 57% rename from docs/core/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md rename to docs/framework/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md index c4d59d9ee066d..fa007c0317271 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md +++ b/docs/framework/unmanaged-api/hosting/icorconfiguration-adddebuggerspecialthread-method.md @@ -2,51 +2,52 @@ description: "Learn more about: ICorConfiguration::AddDebuggerSpecialThread Method" title: "ICorConfiguration::AddDebuggerSpecialThread Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorConfiguration.AddDebuggerSpecialThread" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "AddDebuggerSpecialThread" -helpviewer_keywords: +helpviewer_keywords: - "AddDebuggerSpecialThread method [.NET Framework hosting]" - "ICorConfiguration::AddDebuggerSpecialThread method [.NET Framework hosting]" -topic_type: +ms.assetid: 1f1e3239-438e-4be9-a3bb-7d0722d3a76d +topic_type: - "apiref" --- # ICorConfiguration::AddDebuggerSpecialThread Method -Indicates to the debugging services that a particular thread should be allowed to continue executing while the debugger has an application stopped during managed or unmanaged debugging scenarios. - -## Syntax - -```cpp -HRESULT AddDebuggerSpecialThread ( - [in] DWORD dwSpecialThreadId -); -``` - -## Parameters - - `dwSpecialThreadId` - [in] The ID of the thread that should be allowed to continue executing. - -## Remarks - - The specified thread will not be allowed to run managed code or enter the runtime in any way. An example of such a thread would be an in-process thread to support legacy script debuggers. - -## 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 2.0 - +Indicates to the debugging services that a particular thread should be allowed to continue executing while the debugger has an application stopped during managed or unmanaged debugging scenarios. + +## Syntax + +```cpp +HRESULT AddDebuggerSpecialThread ( + [in] DWORD dwSpecialThreadId +); +``` + +## Parameters + + `dwSpecialThreadId` + [in] The ID of the thread that should be allowed to continue executing. + +## Remarks + + The specified thread will not be allowed to run managed code or enter the runtime in any way. An example of such a thread would be an in-process thread to support legacy script debuggers. + +## 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 - [ICorConfiguration Interface](icorconfiguration-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-interface.md b/docs/framework/unmanaged-api/hosting/icorconfiguration-interface.md similarity index 68% rename from docs/core/unmanaged-api/hosting/icorconfiguration-interface.md rename to docs/framework/unmanaged-api/hosting/icorconfiguration-interface.md index 4750eabe4a000..86a77af1871bd 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-interface.md +++ b/docs/framework/unmanaged-api/hosting/icorconfiguration-interface.md @@ -2,42 +2,43 @@ description: "Learn more about: ICorConfiguration Interface" title: "ICorConfiguration Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICorConfiguration" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorConfiguration" -helpviewer_keywords: +helpviewer_keywords: - "ICorConfiguration interface [.NET Framework hosting]" -topic_type: +ms.assetid: aaf96116-372b-4538-afb1-9e0fcdac1f98 +topic_type: - "apiref" --- # ICorConfiguration Interface -Provides methods for configuring the common language runtime (CLR). - -## Methods - -|Method|Description| -|------------|-----------------| -|[AddDebuggerSpecialThread Method](icorconfiguration-adddebuggerspecialthread-method.md)|Indicates to the debugging services that a particular thread should be allowed to continue executing while the debugger has an application stopped during managed or unmanaged debugging scenarios.| -|[SetDebuggerThreadControl Method](icorconfiguration-setdebuggerthreadcontrol-method.md)|Sets the callback interface that the debugging services will call as CLR threads are blocked and unblocked for debugging.| -|[SetGCHostControl Method](icorconfiguration-setgchostcontrol-method.md)|Sets the callback interface to be used by the garbage collector to request the host to change the limits of virtual memory.| -|[SetGCThreadControl Method](icorconfiguration-setgcthreadcontrol-method.md)|Sets the callback interface for scheduling threads for non-runtime tasks that would otherwise be blocked for a garbage collection.| - -## 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 2.0 - +Provides methods for configuring the common language runtime (CLR). + +## Methods + +|Method|Description| +|------------|-----------------| +|[AddDebuggerSpecialThread Method](icorconfiguration-adddebuggerspecialthread-method.md)|Indicates to the debugging services that a particular thread should be allowed to continue executing while the debugger has an application stopped during managed or unmanaged debugging scenarios.| +|[SetDebuggerThreadControl Method](icorconfiguration-setdebuggerthreadcontrol-method.md)|Sets the callback interface that the debugging services will call as CLR threads are blocked and unblocked for debugging.| +|[SetGCHostControl Method](icorconfiguration-setgchostcontrol-method.md)|Sets the callback interface to be used by the garbage collector to request the host to change the limits of virtual memory.| +|[SetGCThreadControl Method](icorconfiguration-setgcthreadcontrol-method.md)|Sets the callback interface for scheduling threads for non-runtime tasks that would otherwise be blocked for a garbage collection.| + +## 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 - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md b/docs/framework/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md similarity index 53% rename from docs/core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md rename to docs/framework/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md index cd5ac23b37a99..8fa5b05dd792c 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md +++ b/docs/framework/unmanaged-api/hosting/icorconfiguration-setdebuggerthreadcontrol-method.md @@ -2,47 +2,48 @@ description: "Learn more about: ICorConfiguration::SetDebuggerThreadControl Method" title: "ICorConfiguration::SetDebuggerThreadControl Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorConfiguration.SetDebuggerThreadControl" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "SetDebuggerThreadControl" -helpviewer_keywords: +helpviewer_keywords: - "SetDebuggerThreadControl method [.NET Framework hosting]" - "ICorConfiguration::SetDebuggerThreadControl method [.NET Framework hosting]" -topic_type: +ms.assetid: 1ded7639-dacb-4db1-961c-d1ceaec01959 +topic_type: - "apiref" --- # ICorConfiguration::SetDebuggerThreadControl Method -Sets the callback interface that the debugging services will call as common language runtime (CLR) threads are blocked and unblocked for debugging. - -## Syntax - -```cpp -HRESULT SetDebuggerThreadControl ( - [in] IDebuggerThreadControl* pDebuggerThreadControl -); -``` - -## Parameters - - `pDebuggerThreadControl` - [in] A pointer to an [IDebuggerThreadControl](idebuggerthreadcontrol-interface.md) object that notifies the host about the blocking and unblocking of threads by the debugging services. - -## 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 2.0 - +Sets the callback interface that the debugging services will call as common language runtime (CLR) threads are blocked and unblocked for debugging. + +## Syntax + +```cpp +HRESULT SetDebuggerThreadControl ( + [in] IDebuggerThreadControl* pDebuggerThreadControl +); +``` + +## Parameters + + `pDebuggerThreadControl` + [in] A pointer to an [IDebuggerThreadControl](idebuggerthreadcontrol-interface.md) object that notifies the host about the blocking and unblocking of threads by the debugging services. + +## 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 - [ICorConfiguration Interface](icorconfiguration-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md b/docs/framework/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md similarity index 50% rename from docs/core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md rename to docs/framework/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md index 946963bde38b5..41345d11bf57c 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md +++ b/docs/framework/unmanaged-api/hosting/icorconfiguration-setgchostcontrol-method.md @@ -2,47 +2,48 @@ description: "Learn more about: ICorConfiguration::SetGCHostControl Method" title: "ICorConfiguration::SetGCHostControl Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorConfiguration.SetGCHostControl" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "SetGCHostControl" -helpviewer_keywords: +helpviewer_keywords: - "ICorConfiguration::SetGCHostControl method [.NET Framework hosting]" - "SetGCHostControl method [.NET Framework hosting]" -topic_type: +ms.assetid: bca6bd79-e288-475a-aa46-6bf81541d966 +topic_type: - "apiref" --- # ICorConfiguration::SetGCHostControl Method -Sets the callback interface to be used by the garbage collector to request the host to change the limits of virtual memory. - -## Syntax - -```cpp -HRESULT SetGCHostControl ( - [in] IGCHostControl* pGCHostControl -); -``` - -## Parameters - - `pGCHostControl` - [in] A pointer to an [IGCHostControl](igchostcontrol-interface.md) object that allows the garbage collector to request the host to change the limits of virtual memory. - -## 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 2.0 - +Sets the callback interface to be used by the garbage collector to request the host to change the limits of virtual memory. + +## Syntax + +```cpp +HRESULT SetGCHostControl ( + [in] IGCHostControl* pGCHostControl +); +``` + +## Parameters + + `pGCHostControl` + [in] A pointer to an [IGCHostControl](igchostcontrol-interface.md) object that allows the garbage collector to request the host to change the limits of virtual memory. + +## 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 - [ICorConfiguration Interface](icorconfiguration-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md b/docs/framework/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md similarity index 56% rename from docs/core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md rename to docs/framework/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md index 77160f5c85c55..60e53f44d8bb6 100644 --- a/docs/core/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md +++ b/docs/framework/unmanaged-api/hosting/icorconfiguration-setgcthreadcontrol-method.md @@ -2,51 +2,52 @@ description: "Learn more about: ICorConfiguration::SetGCThreadControl Method" title: "ICorConfiguration::SetGCThreadControl Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorConfiguration.SetGCThreadControl" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "SetGCThreadControl" -helpviewer_keywords: +helpviewer_keywords: - "ICorConfiguration::SetGCThreadControl method [.NET Framework hosting]" - "SetGCThreadControl method [.NET Framework hosting]" -topic_type: +ms.assetid: 72e38e61-3d56-4ae3-b8f6-0ab7922aaf11 +topic_type: - "apiref" --- # ICorConfiguration::SetGCThreadControl Method -Sets the callback interface for scheduling threads for non-runtime tasks that would otherwise be blocked for a garbage collection. - -## Syntax - -```cpp -HRESULT SetGCThreadControl ( - [in] IGCThreadControl* pGCThreadControl -); -``` - -## Parameters - - `pGCThreadControl` - [in] A pointer to an [IGCThreadControl](igcthreadcontrol-interface.md) object that notifies the host about the suspension of threads for non-runtime tasks. - -## Remarks - - The host may choose within the [IGCThreadControl::ThreadIsBlockingForSuspension](igcthreadcontrol-threadisblockingforsuspension-method.md) callback whether to reschedule a thread. - -## 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 2.0 - +Sets the callback interface for scheduling threads for non-runtime tasks that would otherwise be blocked for a garbage collection. + +## Syntax + +```cpp +HRESULT SetGCThreadControl ( + [in] IGCThreadControl* pGCThreadControl +); +``` + +## Parameters + + `pGCThreadControl` + [in] A pointer to an [IGCThreadControl](igcthreadcontrol-interface.md) object that notifies the host about the suspension of threads for non-runtime tasks. + +## Remarks + + The host may choose within the [IGCThreadControl::ThreadIsBlockingForSuspension](igcthreadcontrol-threadisblockingforsuspension-method.md) callback whether to reschedule a thread. + +## 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 - [ICorConfiguration Interface](icorconfiguration-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md b/docs/framework/unmanaged-api/hosting/icorruntimehost-closeenum-method.md similarity index 55% rename from docs/core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md rename to docs/framework/unmanaged-api/hosting/icorruntimehost-closeenum-method.md index 86c3a749d1dc6..8d57f5c2023c9 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-closeenum-method.md +++ b/docs/framework/unmanaged-api/hosting/icorruntimehost-closeenum-method.md @@ -2,56 +2,57 @@ description: "Learn more about: ICorRuntimeHost::CloseEnum Method" title: "ICorRuntimeHost::CloseEnum Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.CloseEnum" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::CloseEnum" -helpviewer_keywords: +helpviewer_keywords: - "CloseEnum method, ICorRuntimeHost interface [.NET Framework hosting]" - "ICorRuntimeHost::CloseEnum method [.NET Framework hosting]" -topic_type: +ms.assetid: f7ce7e8c-0a3e-4587-a180-063e2b85940e +topic_type: - "apiref" --- # ICorRuntimeHost::CloseEnum Method -Resets a domain enumerator back to the beginning of the domain list. - -## Syntax - -```cpp -HRESULT CloseEnum ( - [in] HCORENUM hEnum -); -``` - -## Parameters - - `hEnum` - [in] The enumerator to reset. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** 1.0, 1.1 - +Resets a domain enumerator back to the beginning of the domain list. + +## Syntax + +```cpp +HRESULT CloseEnum ( + [in] HCORENUM hEnum +); +``` + +## Parameters + + `hEnum` + [in] The enumerator to reset. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** 1.0, 1.1 + ## See also - [CorBindToRuntimeEx Function](corbindtoruntimeex-function.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md b/docs/framework/unmanaged-api/hosting/icorruntimehost-createdomain-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md rename to docs/framework/unmanaged-api/hosting/icorruntimehost-createdomain-method.md index 22c5989fe5cd4..3fed011a9378d 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomain-method.md +++ b/docs/framework/unmanaged-api/hosting/icorruntimehost-createdomain-method.md @@ -2,64 +2,65 @@ description: "Learn more about: ICorRuntimeHost::CreateDomain Method" title: "ICorRuntimeHost::CreateDomain Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.CreateDomain" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::CreateDomain" -helpviewer_keywords: +helpviewer_keywords: - "CreateDomain method [.NET Framework hosting]" - "ICorRuntimeHost::CreateDomain method [.NET Framework hosting]" -topic_type: +ms.assetid: b96c5ef3-a9df-4c7c-9952-432d3272cb5c +topic_type: - "apiref" --- # ICorRuntimeHost::CreateDomain Method -Creates an application domain. The caller receives an interface pointer of type to an instance of type . - -## Syntax - -```cpp -HRESULT CreateDomain ( - [in] LPWSTR pwzFriendlyName, - [in] IUnknown* pIdentityArray, - [out] void **pAppDomain -); -``` - -## Parameters - - `pwzFriendlyName` - [in] An optional parameter used to give a friendly name to the domain. This friendly name can be displayed in user interfaces such as debuggers to identify the domain. - - `pIdentityArray` - [in] An optional array of pointers to `IIdentity` instances that represent evidence mapped through security policy to establish a permission set. An `IIdentity` object can be obtained by calling the [CreateEvidence](icorruntimehost-createevidence-method.md) method. - - `pAppDomain` - [out] An interface pointer of type to an instance of that can be used to further control the domain. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** 1.0, 1.1 - +Creates an application domain. The caller receives an interface pointer of type to an instance of type . + +## Syntax + +```cpp +HRESULT CreateDomain ( + [in] LPWSTR pwzFriendlyName, + [in] IUnknown* pIdentityArray, + [out] void **pAppDomain +); +``` + +## Parameters + + `pwzFriendlyName` + [in] An optional parameter used to give a friendly name to the domain. This friendly name can be displayed in user interfaces such as debuggers to identify the domain. + + `pIdentityArray` + [in] An optional array of pointers to `IIdentity` instances that represent evidence mapped through security policy to establish a permission set. An `IIdentity` object can be obtained by calling the [CreateEvidence](icorruntimehost-createevidence-method.md) method. + + `pAppDomain` + [out] An interface pointer of type to an instance of that can be used to further control the domain. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** 1.0, 1.1 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md b/docs/framework/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md similarity index 65% rename from docs/core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md rename to docs/framework/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md index ac562afa919e8..67e84ec20b905 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md +++ b/docs/framework/unmanaged-api/hosting/icorruntimehost-createdomainex-method.md @@ -2,72 +2,73 @@ description: "Learn more about: ICorRuntimeHost::CreateDomainEx Method" title: "ICorRuntimeHost::CreateDomainEx Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.CreateDomainEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::CreateDomainEx" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost::CreateDomainEx method [.NET Framework hosting]" - "CreateDomainEx method [.NET Framework hosting]" -topic_type: +ms.assetid: 1bdde382-f8ba-4cc8-94b2-d1ac919c585e +topic_type: - "apiref" --- # ICorRuntimeHost::CreateDomainEx Method -Creates an application domain. The caller receives an interface pointer, of type , to an instance of type . This method allows the caller to pass an IAppDomainSetup instance to configure additional features of the returned instance. - -## Syntax - -```cpp -HRESULT CreateDomainEx ( - [in] LPCWSTR pwzFriendlyName, - [in] IUnknown* pSetup, - [in] IUnknown* pIdentityArray, - [out] IUnknown** pAppDomain -); -``` - -## Parameters - - `pwzFriendlyName` - [in] An optional parameter used to give a friendly name to the domain. This friendly name can be displayed in user interfaces such as debuggers to identify the domain. - - `pSetup` - [in] An optional interface pointer of type `IAppDomainSetup`, obtained by a call to the [ICorRuntimeHost::CreateDomainSetup](icorruntimehost-createdomainsetup-method.md) method. - - `pIdentityArray` - [in] An optional array of pointers to `IIdentity` instances that represent evidence mapped through security policy to establish a permission set. An `IIdentity` object can be obtained by calling the [CreateEvidence](icorruntimehost-createevidence-method.md) method. - - `pAppDomain` - [out] An interface pointer of type to an instance of that can be used to further control the domain. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Remarks - - `CreateDomainEx` extends the capabilities of [CreateDomain](icorruntimehost-createdomain-method.md) by allowing the caller to pass in an `IAppDomainSetup` instance with property values for configuring the application domain. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Version:** 1.0, 1.1 - +Creates an application domain. The caller receives an interface pointer, of type , to an instance of type . This method allows the caller to pass an IAppDomainSetup instance to configure additional features of the returned instance. + +## Syntax + +```cpp +HRESULT CreateDomainEx ( + [in] LPCWSTR pwzFriendlyName, + [in] IUnknown* pSetup, + [in] IUnknown* pIdentityArray, + [out] IUnknown** pAppDomain +); +``` + +## Parameters + + `pwzFriendlyName` + [in] An optional parameter used to give a friendly name to the domain. This friendly name can be displayed in user interfaces such as debuggers to identify the domain. + + `pSetup` + [in] An optional interface pointer of type `IAppDomainSetup`, obtained by a call to the [ICorRuntimeHost::CreateDomainSetup](icorruntimehost-createdomainsetup-method.md) method. + + `pIdentityArray` + [in] An optional array of pointers to `IIdentity` instances that represent evidence mapped through security policy to establish a permission set. An `IIdentity` object can be obtained by calling the [CreateEvidence](icorruntimehost-createevidence-method.md) method. + + `pAppDomain` + [out] An interface pointer of type to an instance of that can be used to further control the domain. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Remarks + + `CreateDomainEx` extends the capabilities of [CreateDomain](icorruntimehost-createdomain-method.md) by allowing the caller to pass in an `IAppDomainSetup` instance with property values for configuring the application domain. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Version:** 1.0, 1.1 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md b/docs/framework/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md similarity index 65% rename from docs/core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md rename to docs/framework/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md index 0beb0735ad632..a551383146682 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md +++ b/docs/framework/unmanaged-api/hosting/icorruntimehost-createdomainsetup-method.md @@ -2,60 +2,61 @@ description: "Learn more about: ICorRuntimeHost::CreateDomainSetup Method" title: "ICorRuntimeHost::CreateDomainSetup Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.CreateDomainSetup" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::CreateDomainSetup" -helpviewer_keywords: +helpviewer_keywords: - "CreateDomainSetup method [.NET Framework hosting]" - "ICorRuntimeHost::CreateDomainSetup method [.NET Framework hosting]" -topic_type: +ms.assetid: c21dab60-fb65-47d9-8a94-7fd47ca53b48 +topic_type: - "apiref" --- # ICorRuntimeHost::CreateDomainSetup Method -Gets an interface pointer of type IAppDomainSetup to an instance. `IAppDomainSetup` provides methods to configure aspects of an application domain before it is created. - -## Syntax - -```cpp -HRESULT CreateDomainSetup ( - [out] IUnknown** pAppDomainSetup -); -``` - -## Parameters - - `pAppDomainSetup` - [out] An interface pointer to an instance. This parameter is typed as `IUnknown`, so callers should generally call `QueryInterface` on this pointer to obtain an interface pointer of type `IAppDomainSetup`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Remarks - - The pointer returned from this method is typically passed as a parameter to the [CreateDomainEx](icorruntimehost-createdomainex-method.md) method. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Version:** 1.0, 1.1 - +Gets an interface pointer of type IAppDomainSetup to an instance. `IAppDomainSetup` provides methods to configure aspects of an application domain before it is created. + +## Syntax + +```cpp +HRESULT CreateDomainSetup ( + [out] IUnknown** pAppDomainSetup +); +``` + +## Parameters + + `pAppDomainSetup` + [out] An interface pointer to an instance. This parameter is typed as `IUnknown`, so callers should generally call `QueryInterface` on this pointer to obtain an interface pointer of type `IAppDomainSetup`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Remarks + + The pointer returned from this method is typically passed as a parameter to the [CreateDomainEx](icorruntimehost-createdomainex-method.md) method. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Version:** 1.0, 1.1 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md b/docs/framework/unmanaged-api/hosting/icorruntimehost-createevidence-method.md similarity index 64% rename from docs/core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md rename to docs/framework/unmanaged-api/hosting/icorruntimehost-createevidence-method.md index 3095e8880eead..a2dbb12fdae4b 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createevidence-method.md +++ b/docs/framework/unmanaged-api/hosting/icorruntimehost-createevidence-method.md @@ -2,60 +2,61 @@ description: "Learn more about: ICorRuntimeHost::CreateEvidence Method" title: "ICorRuntimeHost::CreateEvidence Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.CreateEvidence" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::CreateEvidence" -helpviewer_keywords: +helpviewer_keywords: - "CreateEvidence method [.NET Framework hosting]" - "ICorRuntimeHost::CreateEvidence method [.NET Framework hosting]" -topic_type: +ms.assetid: e235ea80-b84c-4442-a4c3-fc96c25a8eb9 +topic_type: - "apiref" --- # ICorRuntimeHost::CreateEvidence Method -Gets an interface pointer of type , which allows the host to create security evidence to pass to the [CreateDomain](icorruntimehost-createdomain-method.md) or [CreateDomainEx](icorruntimehost-createdomainex-method.md) method. - -## Syntax - -```cpp -HRESULT CreateEvidence ( - [out] IUnknown** pEvidence -); -``` - -## Parameters - - `pEvidence` - [out] A interface pointer to an instance used to create security evidence. This pointer is typed `IUnknown`, so callers should typically call `QueryInterface` on this interface to obtain a pointer to an . - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Remarks - - This method returns an empty collection that cannot be populated from native code. You should use the method instead. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Version:** 1.0, 1.1 - +Gets an interface pointer of type , which allows the host to create security evidence to pass to the [CreateDomain](icorruntimehost-createdomain-method.md) or [CreateDomainEx](icorruntimehost-createdomainex-method.md) method. + +## Syntax + +```cpp +HRESULT CreateEvidence ( + [out] IUnknown** pEvidence +); +``` + +## Parameters + + `pEvidence` + [out] A interface pointer to an instance used to create security evidence. This pointer is typed `IUnknown`, so callers should typically call `QueryInterface` on this interface to obtain a pointer to an . + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Remarks + + This method returns an empty collection that cannot be populated from native code. You should use the method instead. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Version:** 1.0, 1.1 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md b/docs/framework/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md similarity index 56% rename from docs/core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md rename to docs/framework/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md index 96bff315decbc..e0c84d95c3304 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md +++ b/docs/framework/unmanaged-api/hosting/icorruntimehost-createlogicalthreadstate-method.md @@ -2,40 +2,41 @@ description: "Learn more about: ICorRuntimeHost::CreateLogicalThreadState Method" title: "ICorRuntimeHost::CreateLogicalThreadState Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.CreateLogicalThreadState" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::CreateLogicalThreadState" -helpviewer_keywords: +helpviewer_keywords: - "CreateLogicalThreadState method [.NET Framework hosting]" - "ICorRuntimeHost::CreateLogicalThreadState method [.NET Framework hosting]" -topic_type: +ms.assetid: 90f5e791-038b-4b05-9bc5-8d4367d0173e +topic_type: - "apiref" --- # ICorRuntimeHost::CreateLogicalThreadState Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CreateLogicalThreadState ( ); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Version:** 1.0, 1.1 - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CreateLogicalThreadState ( ); +``` + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Version:** 1.0, 1.1 + ## See also - [ICorRuntimeHost Interface](icorruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md b/docs/framework/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md similarity index 61% rename from docs/core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md rename to docs/framework/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md index fee824374f5cf..8b11555be3262 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md +++ b/docs/framework/unmanaged-api/hosting/icorruntimehost-currentdomain-method.md @@ -2,56 +2,57 @@ description: "Learn more about: ICorRuntimeHost::CurrentDomain Method" title: "ICorRuntimeHost::CurrentDomain Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.CurrentDomain" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::CurrentDomain" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost::CreateDomain method [.NET Framework hosting]" - "CurrentDomain method [.NET Framework hosting]" -topic_type: +ms.assetid: dd2afb38-675b-4c3c-a9f3-8ab3b133eb02 +topic_type: - "apiref" --- # ICorRuntimeHost::CurrentDomain Method -Gets an interface pointer of type that represents the domain loaded on the current thread. - -## Syntax - -```cpp -HRESULT CurrentDomain ( - [out] IUnknown** pAppDomain -); -``` - -## Parameters - - `pAppDomain` - [out] A pointer of type that represents the thread's current application domain. This pointer is typed `IUnknown`, so callers should generally call `QueryInterface` to obtain a pointer of type . - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** 1.0, 1.1 - +Gets an interface pointer of type that represents the domain loaded on the current thread. + +## Syntax + +```cpp +HRESULT CurrentDomain ( + [out] IUnknown** pAppDomain +); +``` + +## Parameters + + `pAppDomain` + [out] A pointer of type that represents the thread's current application domain. This pointer is typed `IUnknown`, so callers should generally call `QueryInterface` to obtain a pointer of type . + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** 1.0, 1.1 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md b/docs/framework/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md similarity index 56% rename from docs/core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md rename to docs/framework/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md index e40d25ebbe43a..0740d660c4a96 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md +++ b/docs/framework/unmanaged-api/hosting/icorruntimehost-deletelogicalthreadstate-method.md @@ -2,40 +2,41 @@ description: "Learn more about: ICorRuntimeHost::DeleteLogicalThreadState Method" title: "ICorRuntimeHost::DeleteLogicalThreadState Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.DeleteLogicalThreadState" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::DeleteLogicalThreadState" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost::DeleteLogicalThreadState method [.NET Framework hosting]" - "DeleteLogicalThreadState method [.NET Framework hosting]" -topic_type: +ms.assetid: 34ffc4a6-6553-43df-9b43-779effb67e2c +topic_type: - "apiref" --- # ICorRuntimeHost::DeleteLogicalThreadState Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT DeleteLogicalThreadState ( ); -``` - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** 1.0, 1.1 - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT DeleteLogicalThreadState ( ); +``` + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** 1.0, 1.1 + ## See also - [ICorRuntimeHost Interface](icorruntimehost-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md b/docs/framework/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md new file mode 100644 index 0000000000000..0b164731c9729 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/icorruntimehost-enumdomains-method.md @@ -0,0 +1,58 @@ +--- +description: "Learn more about: ICorRuntimeHost::EnumDomains Method" +title: "ICorRuntimeHost::EnumDomains Method" +ms.date: "03/30/2017" +api_name: + - "ICorRuntimeHost.EnumDomains" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICorRuntimeHost::EnumDomains" +helpviewer_keywords: + - "ICorRuntimeHost::EnumDomains method [.NET Framework hosting]" + - "EnumDomains method [.NET Framework hosting]" +ms.assetid: 96b74995-0cde-4876-b6df-7fc164e6a5d1 +topic_type: + - "apiref" +--- +# ICorRuntimeHost::EnumDomains Method + +Gets an enumerator for the domains in the current process. + +## Syntax + +```cpp +HRESULT EnumDomains ( + [out] HCORENUM *hEnum +); +``` + +## Parameters + + `hEnum` + [out] An enumerator for the domains. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Version:** 1.0, 1.1 + +## See also + +- [ICorRuntimeHost Interface](icorruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md b/docs/framework/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md similarity index 57% rename from docs/core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md rename to docs/framework/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md index f7c735a271bbd..ce7be4ea895bf 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md +++ b/docs/framework/unmanaged-api/hosting/icorruntimehost-getconfiguration-method.md @@ -2,51 +2,52 @@ description: "Learn more about: ICorRuntimeHost::GetConfiguration Method" title: "ICorRuntimeHost::GetConfiguration Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.GetConfiguration" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::GetConfiguration" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost::GetConfiguration method [.NET Framework hosting]" - "GetConfiguration method [.NET Framework hosting]" -topic_type: +ms.assetid: c431617a-b055-44a0-8730-48b7a86d9610 +topic_type: - "apiref" --- # ICorRuntimeHost::GetConfiguration Method -Gets an object that allows the host to specify the callback configuration of the common language runtime (CLR). - -## Syntax - -```cpp -HRESULT GetConfiguration( - [out] ICorConfiguration** pConfiguration -); -``` - -## Parameters - - `pConfiguration` - [out] A pointer to the address of an [ICorConfiguration](icorconfiguration-interface.md) object that can be used to configure the CLR. - -## Remarks - - The CLR must be configured prior to its initialization; otherwise, the `GetConfiguration` method returns an HRESULT indicating an error. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** 1.0, 1.1 - +Gets an object that allows the host to specify the callback configuration of the common language runtime (CLR). + +## Syntax + +```cpp +HRESULT GetConfiguration( + [out] ICorConfiguration** pConfiguration +); +``` + +## Parameters + + `pConfiguration` + [out] A pointer to the address of an [ICorConfiguration](icorconfiguration-interface.md) object that can be used to configure the CLR. + +## Remarks + + The CLR must be configured prior to its initialization; otherwise, the `GetConfiguration` method returns an HRESULT indicating an error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** 1.0, 1.1 + ## See also - [ICorRuntimeHost Interface](icorruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md b/docs/framework/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md similarity index 61% rename from docs/core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md rename to docs/framework/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md index e4abfd0524a95..2e3ab52b90d08 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md +++ b/docs/framework/unmanaged-api/hosting/icorruntimehost-getdefaultdomain-method.md @@ -2,58 +2,59 @@ description: "Learn more about: ICorRuntimeHost::GetDefaultDomain Method" title: "ICorRuntimeHost::GetDefaultDomain Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.GetDefaultDomain" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::GetDefaultDomain" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost::GetDefaultDomain method [.NET Framework hosting]" - "GetDefaultDomain method [.NET Framework hosting]" -topic_type: +ms.assetid: 5e17a6fc-f335-4aae-9bb0-c3e1271a9426 +topic_type: - "apiref" --- # ICorRuntimeHost::GetDefaultDomain Method -Gets an interface pointer of type that represents the default domain for the current process. - -## Syntax - -```cpp -HRESULT GetDefaultDomain ( - [out] IUnknown** pAppDomain -); -``` - -## Parameters - - `pAppDomain` - [out] An interface pointer of type to the instance that represents the default application domain for the process. - - This pointer is typed `IUnknown`, so callers should generally call `QueryInterface` to obtain an interface pointer of type . - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** 1.0, 1.1 - +Gets an interface pointer of type that represents the default domain for the current process. + +## Syntax + +```cpp +HRESULT GetDefaultDomain ( + [out] IUnknown** pAppDomain +); +``` + +## Parameters + + `pAppDomain` + [out] An interface pointer of type to the instance that represents the default application domain for the process. + + This pointer is typed `IUnknown`, so callers should generally call `QueryInterface` to obtain an interface pointer of type . + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** 1.0, 1.1 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-interface.md b/docs/framework/unmanaged-api/hosting/icorruntimehost-interface.md similarity index 69% rename from docs/core/unmanaged-api/hosting/icorruntimehost-interface.md rename to docs/framework/unmanaged-api/hosting/icorruntimehost-interface.md index e780bc695ccde..875dc8ba349d7 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-interface.md +++ b/docs/framework/unmanaged-api/hosting/icorruntimehost-interface.md @@ -2,59 +2,60 @@ description: "Learn more about: ICorRuntimeHost Interface" title: "ICorRuntimeHost Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost interface [.NET Framework hosting]" -topic_type: +ms.assetid: 4369533d-7834-4497-bc37-bfea0ad737b1 +topic_type: - "apiref" --- # ICorRuntimeHost Interface -Provides methods that enable the host to start and stop the common language runtime (CLR) explicitly, to create and configure application domains, to access the default domain, and to enumerate all domains running in the process. - - In .NET Framework version 2.0, this interface is superseded by [ICLRRuntimeHost](iclrruntimehost-interface.md). - -## Methods - -|Method|Description| -|------------|-----------------| -|[CloseEnum Method](icorruntimehost-closeenum-method.md)|Resets a domain enumerator back to the beginning of the domain list.| -|[CreateDomain Method](icorruntimehost-createdomain-method.md)|Creates an application domain. The caller receives an interface pointer of type to an instance of type .| -|[CreateDomainEx Method](icorruntimehost-createdomainex-method.md)|Creates an application domain. This method allows the caller to pass an IAppDomainSetup instance to configure additional features of the returned instance.| -|[CreateDomainSetup Method](icorruntimehost-createdomainsetup-method.md)|Gets an interface pointer of type `IAppDomainSetup` to an instance. `IAppDomainSetup` provides methods to configure aspects of an application domain before it is created.| -|[CreateEvidence Method](icorruntimehost-createevidence-method.md)|Gets an interface pointer of type , which allows the host to create security evidence to pass to [CreateDomain](icorruntimehost-createdomain-method.md) or [CreateDomainEx](icorruntimehost-createdomainex-method.md).| -|[CreateLogicalThreadState Method](icorruntimehost-createlogicalthreadstate-method.md)|Do not use.| -|[CurrentDomain Method](icorruntimehost-currentdomain-method.md)|Gets an interface pointer of type that represents the domain loaded on the current thread.| -|[DeleteLogicalThreadState Method](icorruntimehost-deletelogicalthreadstate-method.md)|Do not use.| -|[EnumDomains Method](icorruntimehost-enumdomains-method.md)|Gets an enumerator for the domains in the current process.| -|[GetConfiguration Method](icorruntimehost-getconfiguration-method.md)|Gets an object that allows the host to specify the callback configuration of the CLR.| -|[GetDefaultDomain Method](icorruntimehost-getdefaultdomain-method.md)|Gets an interface pointer of type that represents the default domain for the current process.| -|[LocksHeldByLogicalThread Method](icorruntimehost-locksheldbylogicalthread-method.md)|Do not use.| -|[MapFile Method](icorruntimehost-mapfile-method.md)|Maps the specified file into memory. This method is obsolete.| -|[NextDomain Method](icorruntimehost-nextdomain-method.md)|Gets an interface pointer to the next domain in the enumeration.| -|[Start Method](icorruntimehost-start-method.md)|Starts the CLR.| -|[Stop Method](icorruntimehost-stop-method.md)|Stops the execution of code in the runtime for the current process.| -|[SwitchInLogicalThreadState Method](icorruntimehost-switchinlogicalthreadstate-method.md)|Do not use.| -|[SwitchOutLogicalThreadState Method](icorruntimehost-switchoutlogicalthreadstate-method.md)|Do not use.| -|[UnloadDomain Method](icorruntimehost-unloaddomain-method.md)|Unloads the specified application domain from the current process.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** 1.0, 1.1 +Provides methods that enable the host to start and stop the common language runtime (CLR) explicitly, to create and configure application domains, to access the default domain, and to enumerate all domains running in the process. + + In .NET Framework version 2.0, this interface is superseded by [ICLRRuntimeHost](iclrruntimehost-interface.md). + +## Methods + +|Method|Description| +|------------|-----------------| +|[CloseEnum Method](icorruntimehost-closeenum-method.md)|Resets a domain enumerator back to the beginning of the domain list.| +|[CreateDomain Method](icorruntimehost-createdomain-method.md)|Creates an application domain. The caller receives an interface pointer of type to an instance of type .| +|[CreateDomainEx Method](icorruntimehost-createdomainex-method.md)|Creates an application domain. This method allows the caller to pass an IAppDomainSetup instance to configure additional features of the returned instance.| +|[CreateDomainSetup Method](icorruntimehost-createdomainsetup-method.md)|Gets an interface pointer of type `IAppDomainSetup` to an instance. `IAppDomainSetup` provides methods to configure aspects of an application domain before it is created.| +|[CreateEvidence Method](icorruntimehost-createevidence-method.md)|Gets an interface pointer of type , which allows the host to create security evidence to pass to [CreateDomain](icorruntimehost-createdomain-method.md) or [CreateDomainEx](icorruntimehost-createdomainex-method.md).| +|[CreateLogicalThreadState Method](icorruntimehost-createlogicalthreadstate-method.md)|Do not use.| +|[CurrentDomain Method](icorruntimehost-currentdomain-method.md)|Gets an interface pointer of type that represents the domain loaded on the current thread.| +|[DeleteLogicalThreadState Method](icorruntimehost-deletelogicalthreadstate-method.md)|Do not use.| +|[EnumDomains Method](icorruntimehost-enumdomains-method.md)|Gets an enumerator for the domains in the current process.| +|[GetConfiguration Method](icorruntimehost-getconfiguration-method.md)|Gets an object that allows the host to specify the callback configuration of the CLR.| +|[GetDefaultDomain Method](icorruntimehost-getdefaultdomain-method.md)|Gets an interface pointer of type that represents the default domain for the current process.| +|[LocksHeldByLogicalThread Method](icorruntimehost-locksheldbylogicalthread-method.md)|Do not use.| +|[MapFile Method](icorruntimehost-mapfile-method.md)|Maps the specified file into memory. This method is obsolete.| +|[NextDomain Method](icorruntimehost-nextdomain-method.md)|Gets an interface pointer to the next domain in the enumeration.| +|[Start Method](icorruntimehost-start-method.md)|Starts the CLR.| +|[Stop Method](icorruntimehost-stop-method.md)|Stops the execution of code in the runtime for the current process.| +|[SwitchInLogicalThreadState Method](icorruntimehost-switchinlogicalthreadstate-method.md)|Do not use.| +|[SwitchOutLogicalThreadState Method](icorruntimehost-switchoutlogicalthreadstate-method.md)|Do not use.| +|[UnloadDomain Method](icorruntimehost-unloaddomain-method.md)|Unloads the specified application domain from the current process.| + +## Requirements + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** 1.0, 1.1 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md b/docs/framework/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md similarity index 52% rename from docs/core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md rename to docs/framework/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md index 59501bf907924..8b0f23801bb07 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md +++ b/docs/framework/unmanaged-api/hosting/icorruntimehost-locksheldbylogicalthread-method.md @@ -2,49 +2,50 @@ description: "Learn more about: ICorRuntimeHost::LocksHeldByLogicalThread Method" title: "ICorRuntimeHost::LocksHeldByLogicalThread Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.LocksHeldByLogicalThread" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::LocksHeldByLogicalThread" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost::LocksHeldByLogicalThread method [.NET Framework hosting]" - "LocksHeldByLogicalThread method [.NET Framework hosting]" -topic_type: +ms.assetid: c3601255-d894-4d7c-b1df-c31334551700 +topic_type: - "apiref" --- # ICorRuntimeHost::LocksHeldByLogicalThread Method -Retrieves the number of locks that current thread holds. - - This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT LocksHeldByLogicalThread( - [out] DWORD *pCount -); -``` - -## Parameters - - `pCount` - [out] A pointer to the number of locks that the current thread holds. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** 1.0, 1.1 - +Retrieves the number of locks that current thread holds. + + This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT LocksHeldByLogicalThread( + [out] DWORD *pCount +); +``` + +## Parameters + + `pCount` + [out] A pointer to the number of locks that the current thread holds. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** 1.0, 1.1 + ## See also - [ICorRuntimeHost Interface](icorruntimehost-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/icorruntimehost-mapfile-method.md b/docs/framework/unmanaged-api/hosting/icorruntimehost-mapfile-method.md new file mode 100644 index 0000000000000..64bdca1e88efa --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/icorruntimehost-mapfile-method.md @@ -0,0 +1,53 @@ +--- +description: "Learn more about: ICorRuntimeHost::MapFile Method" +title: "ICorRuntimeHost::MapFile Method" +ms.date: "03/30/2017" +api_name: + - "ICorRuntimeHost.MapFile" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ICorRuntimeHost::MapFile" +helpviewer_keywords: + - "ICorRuntimeHost::MapFile method [.NET Framework hosting]" + - "MapFile method [.NET Framework hosting]" +ms.assetid: 45ae0502-0a31-4342-b7e3-f36e1cf738f3 +topic_type: + - "apiref" +--- +# ICorRuntimeHost::MapFile Method + +Maps the specified file into memory. This method is obsolete. + +## Syntax + +```cpp +HRESULT MapFile( + [in] HANDLE hFile, + [out] HMODULE* hMapAddress +); +``` + +## Parameters + + `hFile` + [in] The handle of the file to be mapped. + + `hMapAddress` + [out] The starting memory address at which to begin mapping the file. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Version:** 1.0, 1.1 + +## See also + +- [ICorRuntimeHost Interface](icorruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md b/docs/framework/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md similarity index 57% rename from docs/core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md rename to docs/framework/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md index 7db675bbe7e66..f9534b80d4964 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md +++ b/docs/framework/unmanaged-api/hosting/icorruntimehost-nextdomain-method.md @@ -2,60 +2,61 @@ description: "Learn more about: ICorRuntimeHost::NextDomain Method" title: "ICorRuntimeHost::NextDomain Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.NextDomain" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::NextDomain" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost::NextDomain method [.NET Framework hosting]" - "NextDomain method [.NET Framework hosting]" -topic_type: +ms.assetid: fe07a05b-f6d6-44b5-ab01-b9a6eb15c350 +topic_type: - "apiref" --- # ICorRuntimeHost::NextDomain Method -Gets an interface pointer to the next domain in the enumeration. +Gets an interface pointer to the next domain in the enumeration. + +## Syntax + +```cpp +HRESULT NextDomain ( + [in] HCORENUM hEnum, + [out] void** pAppDomain +); +``` + +## Parameters -## Syntax - -```cpp -HRESULT NextDomain ( - [in] HCORENUM hEnum, - [out] void** pAppDomain -); -``` - -## Parameters - - `hEnum` - [in] The enumerator that was obtained through a call to [EnumDomains](icorruntimehost-enumdomains-method.md). - - `pAppDomain` - [out] An interface pointer to the type that represents the next domain in the enumeration, or null, if no more domains exist. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete, or there are no more domains in the enumeration.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** 1.0, 1.1 + `hEnum` + [in] The enumerator that was obtained through a call to [EnumDomains](icorruntimehost-enumdomains-method.md). + + `pAppDomain` + [out] An interface pointer to the type that represents the next domain in the enumeration, or null, if no more domains exist. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete, or there are no more domains in the enumeration.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Requirements + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** 1.0, 1.1 + ## See also - diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md b/docs/framework/unmanaged-api/hosting/icorruntimehost-start-method.md similarity index 52% rename from docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md rename to docs/framework/unmanaged-api/hosting/icorruntimehost-start-method.md index 34615626a1cce..37e41420c4f9d 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-start-method.md +++ b/docs/framework/unmanaged-api/hosting/icorruntimehost-start-method.md @@ -2,53 +2,54 @@ description: "Learn more about: ICorRuntimeHost::Start Method" title: "ICorRuntimeHost::Start Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.Start" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::Start" -helpviewer_keywords: +helpviewer_keywords: - "Start method, ICorRuntimeHost interface [.NET Framework hosting]" - "ICorRuntimeHost::Start method [.NET Framework hosting]" -topic_type: +ms.assetid: c66f3ac5-6489-484a-9bed-c31b711cee01 +topic_type: - "apiref" --- # ICorRuntimeHost::Start Method -Starts the common language runtime (CLR). - -## Syntax - -```cpp -HRESULT Start (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the CLR is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Remarks - - It is typically not necessary to call the `Start` method, because the CLR starts automatically upon the first request to run managed code. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** 1.0, 1.1 - +Starts the common language runtime (CLR). + +## Syntax + +```cpp +HRESULT Start (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the CLR is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Remarks + + It is typically not necessary to call the `Start` method, because the CLR starts automatically upon the first request to run managed code. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** 1.0, 1.1 + ## See also - [ICorRuntimeHost Interface](icorruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md b/docs/framework/unmanaged-api/hosting/icorruntimehost-stop-method.md similarity index 56% rename from docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md rename to docs/framework/unmanaged-api/hosting/icorruntimehost-stop-method.md index 648503cbee12f..255fd84e8cb2b 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-stop-method.md +++ b/docs/framework/unmanaged-api/hosting/icorruntimehost-stop-method.md @@ -2,56 +2,57 @@ description: "Learn more about: ICorRuntimeHost::Stop Method" title: "ICorRuntimeHost::Stop Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.Stop" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::Stop" -helpviewer_keywords: +helpviewer_keywords: - "Stop method, ICorRuntimeHost interface [.NET Framework hosting]" - "ICorRuntimeHost::Stop method [.NET Framework hosting]" -topic_type: +ms.assetid: 46a0d450-b516-4bef-8b71-8d3bf265cbed +topic_type: - "apiref" --- # ICorRuntimeHost::Stop Method -Stops the execution of code in the runtime for the current process. - -## Syntax - -```cpp -HRESULT Stop (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Remarks - - It is typically unnecessary to call the `Stop` method, because the code stops executing when the process exits. - +Stops the execution of code in the runtime for the current process. + +## Syntax + +```cpp +HRESULT Stop (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Remarks + + It is typically unnecessary to call the `Stop` method, because the code stops executing when the process exits. + > [!NOTE] -> After a call to `Stop`, the CLR cannot be reinitialized into the same process. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** 1.0, 1.1 - +> After a call to `Stop`, the CLR cannot be reinitialized into the same process. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** 1.0, 1.1 + ## See also - [ICorRuntimeHost Interface](icorruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md b/docs/framework/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md similarity index 51% rename from docs/core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md rename to docs/framework/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md index 2d13ef877009a..148347c38a4bf 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md +++ b/docs/framework/unmanaged-api/hosting/icorruntimehost-switchinlogicalthreadstate-method.md @@ -2,47 +2,48 @@ description: "Learn more about: ICorRuntimeHost::SwitchInLogicalThreadState Method" title: "ICorRuntimeHost::SwitchInLogicalThreadState Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.SwitchInLogicalThreadState" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::SwitchInLogicalThreadState" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost::SwitchInLogicalThreadState method [.NET Framework hosting]" - "SwitchInLogicalThreadState method [.NET Framework hosting]" -topic_type: +ms.assetid: 7df1e492-8014-43ea-80d1-a4743e9b1c17 +topic_type: - "apiref" --- # ICorRuntimeHost::SwitchInLogicalThreadState Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT SwitchInLogicalThreadState( - [in] DWORD *pFiberCookie -); -``` - -## Parameters - - `pFiberCookie` - [in] Cookie that indicates the fiber to use. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Version:** 1.0, 1.1 - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT SwitchInLogicalThreadState( + [in] DWORD *pFiberCookie +); +``` + +## Parameters + + `pFiberCookie` + [in] Cookie that indicates the fiber to use. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Version:** 1.0, 1.1 + ## See also - [ICorRuntimeHost Interface](icorruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md b/docs/framework/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md similarity index 51% rename from docs/core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md rename to docs/framework/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md index 2afb488e7d234..2b98ff0852b3f 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md +++ b/docs/framework/unmanaged-api/hosting/icorruntimehost-switchoutlogicalthreadstate-method.md @@ -2,47 +2,48 @@ description: "Learn more about: ICorRuntimeHost::SwitchOutLogicalThreadState Method" title: "ICorRuntimeHost::SwitchOutLogicalThreadState Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.SwitchOutLogicalThreadState" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::SwitchOutLogicalThreadState" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost::SwitchOutLogicalThreadState method [.NET Framework hosting]" - "SwitchOutLogicalThreadState method [.NET Framework hosting]" -topic_type: +ms.assetid: e1968f0b-2675-4dc2-8507-46164e1df154 +topic_type: - "apiref" --- # ICorRuntimeHost::SwitchOutLogicalThreadState Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT SwitchOutLogicalThreadState( - [out] DWORD **pFiberCookie -); -``` - -## Parameters - - `pFiberCookie` - [out] Cookie that indicates the fiber being switched out. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Version:** 1.0, 1.1 - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT SwitchOutLogicalThreadState( + [out] DWORD **pFiberCookie +); +``` + +## Parameters + + `pFiberCookie` + [out] Cookie that indicates the fiber being switched out. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Version:** 1.0, 1.1 + ## See also - [ICorRuntimeHost Interface](icorruntimehost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md b/docs/framework/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md similarity index 55% rename from docs/core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md rename to docs/framework/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md index 9344ee25dc50f..dff3c6d80a668 100644 --- a/docs/core/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md +++ b/docs/framework/unmanaged-api/hosting/icorruntimehost-unloaddomain-method.md @@ -2,56 +2,57 @@ description: "Learn more about: ICorRuntimeHost::UnloadDomain Method" title: "ICorRuntimeHost::UnloadDomain Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICorRuntimeHost.UnloadDomain" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorRuntimeHost::UnloadDomain" -helpviewer_keywords: +helpviewer_keywords: - "ICorRuntimeHost::UnloadDomain method [.NET Framework hosting]" - "UnloadDomain method [.NET Framework hosting]" -topic_type: +ms.assetid: dd9e9204-a80d-44f3-8192-779224b35056 +topic_type: - "apiref" --- # ICorRuntimeHost::UnloadDomain Method -Unloads the specified application domain from the current process. - -## Syntax - -```cpp -HRESULT UnloadDomain ( - [in] IUnknown* pAppDomain -); -``` - -## Parameters - - `pAppDomain` - [in] A pointer of type that represents the domain to be unloaded. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The operation was successful.| -|S_FALSE|The operation failed to complete.| -|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| -|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.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET Framework Version:** 1.0, 1.1 - +Unloads the specified application domain from the current process. + +## Syntax + +```cpp +HRESULT UnloadDomain ( + [in] IUnknown* pAppDomain +); +``` + +## Parameters + + `pAppDomain` + [in] A pointer of type that represents the domain to be unloaded. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The operation was successful.| +|S_FALSE|The operation failed to complete.| +|E_FAIL|An unknown, catastrophic failure occurred. If a method returns E_FAIL, the common language runtime (CLR) is no longer usable in the process. Subsequent calls to any hosting APIs return HOST_E_CLRNOTAVAILABLE.| +|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.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Version:** 1.0, 1.1 + ## See also - diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md b/docs/framework/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md new file mode 100644 index 0000000000000..bad222098d1de --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/icorthreadpool-corbindiocompletioncallback-method.md @@ -0,0 +1,45 @@ +--- +description: "Learn more about: ICorThreadpool::CorBindIoCompletionCallback Method" +title: "ICorThreadpool::CorBindIoCompletionCallback Method" +ms.date: "03/30/2017" +api_name: + - "ICorThreadpool.CorBindIoCompletionCallback" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorBindIoCompletionCallback" +helpviewer_keywords: + - "CorBindIoCompletionCallback method [.NET Framework hosting]" + - "ICorThreadpool::CorBindIoCompletionCallback method [.NET Framework hosting]" +ms.assetid: 2b159225-f09c-42f1-aa7c-44087e121249 +topic_type: + - "apiref" +--- +# ICorThreadpool::CorBindIoCompletionCallback Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CorBindIoCompletionCallback ( + [in] HANDLE fileHandle, + [in] LPOVERLAPPED_COMPLETION_ROUTINE callback +); +``` + +## 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 + +- [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md b/docs/framework/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md new file mode 100644 index 0000000000000..53b9bf07b6c6a --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/icorthreadpool-corcallorqueueuserworkitem-method.md @@ -0,0 +1,46 @@ +--- +description: "Learn more about: ICorThreadpool::CorCallOrQueueUserWorkItem Method" +title: "ICorThreadpool::CorCallOrQueueUserWorkItem Method" +ms.date: "03/30/2017" +api_name: + - "ICorThreadpool.CorCallOrQueueUserWorkItem" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorCallOrQueueUserWorkItem" +helpviewer_keywords: + - "ICorThreadpool::CorCallOrQueueUserWorkItem method [.NET Framework hosting]" + - "CorCallOrQueueUserWorkItem method [.NET Framework hosting]" +ms.assetid: a2081223-84ca-4331-a8d3-9352f422f3e7 +topic_type: + - "apiref" +--- +# ICorThreadpool::CorCallOrQueueUserWorkItem Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CorCallOrQueueUserWorkItem ( + [in] LPTHREAD_START_ROUTINE Function, + [in] PVOID Context, + [out] BOOL* result +); +``` + +## 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 + +- [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md b/docs/framework/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md new file mode 100644 index 0000000000000..80d48361c30c4 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/icorthreadpool-corchangetimer-method.md @@ -0,0 +1,47 @@ +--- +description: "Learn more about: ICorThreadpool::CorChangeTimer Method" +title: "ICorThreadpool::CorChangeTimer Method" +ms.date: "03/30/2017" +api_name: + - "ICorThreadpool.CorChangeTimer" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorChangeTimer" +helpviewer_keywords: + - "CorChangeTimer method [.NET Framework hosting]" + - "ICorThreadpool::CorChangeTimer method [.NET Framework hosting]" +ms.assetid: 82b03a59-5a87-43ed-9b75-e04b256e1a46 +topic_type: + - "apiref" +--- +# ICorThreadpool::CorChangeTimer Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CorChangeTimer ( + [in] HANDLE Timer, + [in] ULONG DueTime, + [in] ULONG Period, + [out] BOOL* result +); +``` + +## 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 + +- [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md b/docs/framework/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md new file mode 100644 index 0000000000000..ec21f4403e406 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/icorthreadpool-corcreatetimer-method.md @@ -0,0 +1,49 @@ +--- +description: "Learn more about: ICorThreadpool::CorCreateTimer Method" +title: "ICorThreadpool::CorCreateTimer Method" +ms.date: "03/30/2017" +api_name: + - "ICorThreadpool.CorCreateTimer" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorCreateTimer" +helpviewer_keywords: + - "CorCreateTimer method [.NET Framework hosting]" + - "ICorThreadpool::CorCreateTimer method [.NET Framework hosting]" +ms.assetid: 0d56ef25-30f1-4499-8a1f-76e7654ec614 +topic_type: + - "apiref" +--- +# ICorThreadpool::CorCreateTimer Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CorCreateTimer ( + [in] HANDLE* phNewTimer, + [in] WAITORTIMERCALLBACK Callback, + [in] PVOID Parameter, + [in] DWORD DueTime, + [in] DWORD Period, + [out] BOOL* result +); +``` + +## 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 + +- [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md b/docs/framework/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md new file mode 100644 index 0000000000000..9de264cbc3dda --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/icorthreadpool-cordeletetimer-method.md @@ -0,0 +1,46 @@ +--- +description: "Learn more about: ICorThreadpool::CorDeleteTimer Method" +title: "ICorThreadpool::CorDeleteTimer Method" +ms.date: "03/30/2017" +api_name: + - "ICorThreadpool.CorDeleteTimer" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorDeleteTimer" +helpviewer_keywords: + - "ICorThreadpool::CorDeleteTimer method [.NET Framework hosting]" + - "CorDeleteTimer method [.NET Framework hosting]" +ms.assetid: 74847c35-7ca1-466a-b750-b25e7b03d100 +topic_type: + - "apiref" +--- +# ICorThreadpool::CorDeleteTimer Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CorDeleteTimer ( + [in] HANDLE Timer, + [in] HANDLE CompletionEvent, + [out] BOOL* result +); +``` + +## 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 + +- [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md b/docs/framework/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md new file mode 100644 index 0000000000000..95c5c1cee836e --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/icorthreadpool-corgetavailablethreads-method.md @@ -0,0 +1,45 @@ +--- +description: "Learn more about: ICorThreadpool::CorGetAvailableThreads Method" +title: "ICorThreadpool::CorGetAvailableThreads Method" +ms.date: "03/30/2017" +api_name: + - "ICorThreadpool.CorGetAvailableThreads" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorGetAvailableThreads" +helpviewer_keywords: + - "CorGetAvailableThreads method [.NET Framework hosting]" + - "ICorThreadpool::CorGetAvailableThreads method [.NET Framework hosting]" +ms.assetid: 0b09b750-0b86-4ba4-9621-041857cfe8ba +topic_type: + - "apiref" +--- +# ICorThreadpool::CorGetAvailableThreads Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CorGetAvailableThreads ( + [out] DWORD *AvailableWorkerThreads, + [out] DWORD *AvailableIOCompletionThreads +); +``` + +## 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 + +- [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md b/docs/framework/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md new file mode 100644 index 0000000000000..6c12d70ee2cb6 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/icorthreadpool-corgetmaxthreads-method.md @@ -0,0 +1,45 @@ +--- +description: "Learn more about: ICorThreadpool::CorGetMaxThreads Method" +title: "ICorThreadpool::CorGetMaxThreads Method" +ms.date: "03/30/2017" +api_name: + - "ICorThreadpool.CorGetMaxThreads" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorGetMaxThreads" +helpviewer_keywords: + - "CorGetMaxThreads method [.NET Framework hosting]" + - "ICorThreadpool::CorGetMaxThreads method [.NET Framework hosting]" +ms.assetid: 2861533a-cda0-47b3-b716-0d363505289b +topic_type: + - "apiref" +--- +# ICorThreadpool::CorGetMaxThreads Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CorGetMaxThreads ( + [out] DWORD *MaxWorkerThreads, + [out] DWORD *MaxIOCompletionThreads +); +``` + +## 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 + +- [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md b/docs/framework/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md new file mode 100644 index 0000000000000..cba38b6c844b9 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/icorthreadpool-corqueueuserworkitem-method.md @@ -0,0 +1,47 @@ +--- +description: "Learn more about: ICorThreadpool::CorQueueUserWorkItem Method" +title: "ICorThreadpool::CorQueueUserWorkItem Method" +ms.date: "03/30/2017" +api_name: + - "ICorThreadpool.CorQueueUserWorkItem" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorQueueUserWorkItem" +helpviewer_keywords: + - "ICorThreadpool::CorQueueUserWorkItem method [.NET Framework hosting]" + - "CorQueueUserWorkItem method [.NET Framework hosting]" +ms.assetid: 29ac7898-a7c7-433e-8f79-cd5237e0bab8 +topic_type: + - "apiref" +--- +# ICorThreadpool::CorQueueUserWorkItem Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CorQueueUserWorkItem ( + [in] LPTHREAD_START_ROUTINE Function, + [in] PVOID Context, + [in] BOOL executeOnlyOnce, + [out] BOOL* result +); +``` + +## 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 + +- [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md b/docs/framework/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md new file mode 100644 index 0000000000000..76225acb7d207 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/icorthreadpool-corregisterwaitforsingleobject-method.md @@ -0,0 +1,50 @@ +--- +description: "Learn more about: ICorThreadpool::CorRegisterWaitForSingleObject Method" +title: "ICorThreadpool::CorRegisterWaitForSingleObject Method" +ms.date: "03/30/2017" +api_name: + - "ICorThreadpool.CorRegisterWaitForSingleObject" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorRegisterWaitForSingleObject" +helpviewer_keywords: + - "ICorThreadpool::CorRegisterWaitForSingleObject method [.NET Framework hosting]" + - "CorRegisterWaitForSingleObject method [.NET Framework hosting]" +ms.assetid: cade1feb-71d2-43ed-85ca-7b2e9da12994 +topic_type: + - "apiref" +--- +# ICorThreadpool::CorRegisterWaitForSingleObject Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CorRegisterWaitForSingleObject ( + [in] HANDLE* phNewWaitObject, + [in] HANDLE hWaitObject, + [in] WAITORTIMERCALLBACK Callback, + [in] PVOID Context, + [in] ULONG timeout, + [in] BOOL executeOnlyOnce, + [out] BOOL* result +); +``` + +## 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 + +- [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md b/docs/framework/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md new file mode 100644 index 0000000000000..124e9cadd2d62 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/icorthreadpool-corsetmaxthreads-method.md @@ -0,0 +1,45 @@ +--- +description: "Learn more about: ICorThreadpool::CorSetMaxThreads Method" +title: "ICorThreadpool::CorSetMaxThreads Method" +ms.date: "03/30/2017" +api_name: + - "ICorThreadpool.CorSetMaxThreads" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorSetMaxThreads" +helpviewer_keywords: + - "ICorThreadpool::CorSetMaxThreads method [.NET Framework hosting]" + - "CorSetMaxThreads method [.NET Framework hosting]" +ms.assetid: 4a846238-df4e-4060-ba3b-5173f6a51e85 +topic_type: + - "apiref" +--- +# ICorThreadpool::CorSetMaxThreads Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CorSetMaxThreads ( + [in] DWORD MaxWorkerThreads, + [in] DWORD MaxIOCompletionThreads +); +``` + +## 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 + +- [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md b/docs/framework/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md new file mode 100644 index 0000000000000..a7e8951731b1a --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/icorthreadpool-corunregisterwait-method.md @@ -0,0 +1,46 @@ +--- +description: "Learn more about: ICorThreadpool::CorUnregisterWait Method" +title: "ICorThreadpool::CorUnregisterWait Method" +ms.date: "03/30/2017" +api_name: + - "ICorThreadpool.CorUnregisterWait" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "CorUnregisterWait" +helpviewer_keywords: + - "CorUnregisterWait method [.NET Framework hosting]" + - "ICorThreadpool::CorUnregisterWait method [.NET Framework hosting]" +ms.assetid: 42c933f1-30a8-4011-bdea-e117f3c3265e +topic_type: + - "apiref" +--- +# ICorThreadpool::CorUnregisterWait Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CorUnregisterWait ( + [in] HANDLE hWaitObject, + [in] HANDLE CompletionEvent, + [out] BOOL* result +); +``` + +## 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 + +- [ICorThreadpool Interface](icorthreadpool-interface.md) diff --git a/docs/core/unmanaged-api/hosting/icorthreadpool-interface.md b/docs/framework/unmanaged-api/hosting/icorthreadpool-interface.md similarity index 50% rename from docs/core/unmanaged-api/hosting/icorthreadpool-interface.md rename to docs/framework/unmanaged-api/hosting/icorthreadpool-interface.md index f6baa1cec3d2a..1ef46e99bea08 100644 --- a/docs/core/unmanaged-api/hosting/icorthreadpool-interface.md +++ b/docs/framework/unmanaged-api/hosting/icorthreadpool-interface.md @@ -2,52 +2,53 @@ description: "Learn more about: ICorThreadpool Interface" title: "ICorThreadpool Interface" ms.date: "03/30/2017" -api_name: +api_name: - "ICorThreadpool" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ICorThreadpool" -helpviewer_keywords: +helpviewer_keywords: - "ICorThreadpool interface [.NET Framework hosting]" -topic_type: +ms.assetid: 18485a27-cae3-4c6a-baa8-f7df601122d5 +topic_type: - "apiref" --- # ICorThreadpool Interface -Provides methods for accessing the thread pool. - +Provides methods for accessing the thread pool. + > [!NOTE] -> This interface is reserved for internal use only. - -## Methods - -|Method|Description| -|------------|-----------------| -|[CorRegisterWaitForSingleObject Method](icorthreadpool-corregisterwaitforsingleobject-method.md)|Reserved for internal use only.| -|[CorUnregisterWait Method](icorthreadpool-corunregisterwait-method.md)|Reserved for internal use only.| -|[CorQueueUserWorkItem Method](icorthreadpool-corqueueuserworkitem-method.md)|Reserved for internal use only.| -|[CorCreateTimer Method](icorthreadpool-corcreatetimer-method.md)|Reserved for internal use only.| -|[CorChangeTimer Method](icorthreadpool-corchangetimer-method.md)|Reserved for internal use only.| -|[CorDeleteTimer Method](icorthreadpool-cordeletetimer-method.md)|Reserved for internal use only.| -|[CorBindIoCompletionCallback Method](icorthreadpool-corbindiocompletioncallback-method.md)|Reserved for internal use only.| -|[CorCallOrQueueUserWorkItem Method](icorthreadpool-corcallorqueueuserworkitem-method.md)|Reserved for internal use only.| -|[CorSetMaxThreads Method](icorthreadpool-corsetmaxthreads-method.md)|Reserved for internal use only.| -|[CorGetMaxThreads Method](icorthreadpool-corgetmaxthreads-method.md)|Reserved for internal use only.| -|[CorGetAvailableThreads Method](icorthreadpool-corgetavailablethreads-method.md)|Reserved for internal use only.| - -## 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 2.0 - +> This interface is reserved for internal use only. + +## Methods + +|Method|Description| +|------------|-----------------| +|[CorRegisterWaitForSingleObject Method](icorthreadpool-corregisterwaitforsingleobject-method.md)|Reserved for internal use only.| +|[CorUnregisterWait Method](icorthreadpool-corunregisterwait-method.md)|Reserved for internal use only.| +|[CorQueueUserWorkItem Method](icorthreadpool-corqueueuserworkitem-method.md)|Reserved for internal use only.| +|[CorCreateTimer Method](icorthreadpool-corcreatetimer-method.md)|Reserved for internal use only.| +|[CorChangeTimer Method](icorthreadpool-corchangetimer-method.md)|Reserved for internal use only.| +|[CorDeleteTimer Method](icorthreadpool-cordeletetimer-method.md)|Reserved for internal use only.| +|[CorBindIoCompletionCallback Method](icorthreadpool-corbindiocompletioncallback-method.md)|Reserved for internal use only.| +|[CorCallOrQueueUserWorkItem Method](icorthreadpool-corcallorqueueuserworkitem-method.md)|Reserved for internal use only.| +|[CorSetMaxThreads Method](icorthreadpool-corsetmaxthreads-method.md)|Reserved for internal use only.| +|[CorGetMaxThreads Method](icorthreadpool-corgetmaxthreads-method.md)|Reserved for internal use only.| +|[CorGetAvailableThreads Method](icorthreadpool-corgetavailablethreads-method.md)|Reserved for internal use only.| + +## 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 - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md b/docs/framework/unmanaged-api/hosting/idebuggerinfo-interface.md similarity index 50% rename from docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md rename to docs/framework/unmanaged-api/hosting/idebuggerinfo-interface.md index a411c74a480c3..8ab95e1fba0e6 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerinfo-interface.md +++ b/docs/framework/unmanaged-api/hosting/idebuggerinfo-interface.md @@ -2,39 +2,40 @@ description: "Learn more about: IDebuggerInfo Interface" title: "IDebuggerInfo Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IDebuggerInfo" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IDebuggerInfo" -helpviewer_keywords: +helpviewer_keywords: - "IDebuggerInfo interface [.NET Framework hosting]" -topic_type: +ms.assetid: 9395a8a0-ffb9-475f-8da6-890999ae4bb6 +topic_type: - "apiref" --- # IDebuggerInfo Interface -Provides methods for obtaining information about the state of the debugging services. - -## Methods - -|Method|Description| -|------------|-----------------| -|[IsDebuggerAttached Method](idebuggerinfo-isdebuggerattached-method.md)|Gets a value that indicates whether a managed debugger is attached to this process.| - -## 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 2.0 - +Provides methods for obtaining information about the state of the debugging services. + +## Methods + +|Method|Description| +|------------|-----------------| +|[IsDebuggerAttached Method](idebuggerinfo-isdebuggerattached-method.md)|Gets a value that indicates whether a managed debugger is attached to this process.| + +## 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 - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md b/docs/framework/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md similarity index 50% rename from docs/core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md rename to docs/framework/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md index 73638c6723a2d..92fc8137a62df 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md +++ b/docs/framework/unmanaged-api/hosting/idebuggerinfo-isdebuggerattached-method.md @@ -2,47 +2,48 @@ description: "Learn more about: IDebuggerInfo::IsDebuggerAttached Method" title: "IDebuggerInfo::IsDebuggerAttached Method" ms.date: "03/30/2017" -api_name: +api_name: - "IDebuggerInfo.IsDebuggerAttached" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IsDebuggerAttached" -helpviewer_keywords: +helpviewer_keywords: - "IDebuggerInfo::IsDebuggerAttached method [.NET Framework hosting]" - "IsDebuggerAttached method, IDebuggerInfo interface [.NET Framework hosting]" -topic_type: +ms.assetid: 6e21872f-602f-411a-a423-bff5cdf27000 +topic_type: - "apiref" --- # IDebuggerInfo::IsDebuggerAttached Method -Gets a value that indicates whether a managed debugger is attached to this process. - -## Syntax - -```cpp -HRESULT IsDebuggerAttached ( - [out] BOOL *pbAttached -); -``` - -## Parameters - - `pbAttached` - [out] A pointer to a value that is `true` if a managed debugger is attached to the process; otherwise, `false`. - -## 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 2.0 - +Gets a value that indicates whether a managed debugger is attached to this process. + +## Syntax + +```cpp +HRESULT IsDebuggerAttached ( + [out] BOOL *pbAttached +); +``` + +## Parameters + + `pbAttached` + [out] A pointer to a value that is `true` if a managed debugger is attached to the process; otherwise, `false`. + +## 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 - [IDebuggerInfo Interface](idebuggerinfo-interface.md) diff --git a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md b/docs/framework/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md similarity index 55% rename from docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md rename to docs/framework/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md index 44e6049687d54..163fa536f9b2f 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md +++ b/docs/framework/unmanaged-api/hosting/idebuggerthreadcontrol-interface.md @@ -2,41 +2,42 @@ description: "Learn more about: IDebuggerThreadControl Interface" title: "IDebuggerThreadControl Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IDebuggerThreadControl" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IDebuggerThreadControl" -helpviewer_keywords: +helpviewer_keywords: - "IDebuggerThreadControl interface [.NET Framework hosting]" -topic_type: +ms.assetid: 0a270c42-a7d1-45f1-a64d-fa3e84d14532 +topic_type: - "apiref" --- # IDebuggerThreadControl Interface -Provides methods for notifying the host about the blocking and unblocking of threads by the debugging services. - -## Methods - -|Method|Description| -|------------|-----------------| -|[ThreadIsBlockingForDebugger Method](idebuggerthreadcontrol-threadisblockingfordebugger-method.md)|Notifies the host that the thread that is sending this callback is about to block within the debugging services.| -|[ReleaseAllRuntimeThreads Method](idebuggerthreadcontrol-releaseallruntimethreads-method.md)|Notifies the host that the debugging services are about to release all threads that are blocked.| -|[StartBlockingForDebugger Method](idebuggerthreadcontrol-startblockingfordebugger-method.md)|Notifies the host that the debugging services are about to start blocking all threads.| - -## 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 2.0 - +Provides methods for notifying the host about the blocking and unblocking of threads by the debugging services. + +## Methods + +|Method|Description| +|------------|-----------------| +|[ThreadIsBlockingForDebugger Method](idebuggerthreadcontrol-threadisblockingfordebugger-method.md)|Notifies the host that the thread that is sending this callback is about to block within the debugging services.| +|[ReleaseAllRuntimeThreads Method](idebuggerthreadcontrol-releaseallruntimethreads-method.md)|Notifies the host that the debugging services are about to release all threads that are blocked.| +|[StartBlockingForDebugger Method](idebuggerthreadcontrol-startblockingfordebugger-method.md)|Notifies the host that the debugging services are about to start blocking all threads.| + +## 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 - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md b/docs/framework/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md similarity index 57% rename from docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md rename to docs/framework/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md index f7ba31c9a9b87..da3468da7871a 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md +++ b/docs/framework/unmanaged-api/hosting/idebuggerthreadcontrol-releaseallruntimethreads-method.md @@ -2,44 +2,45 @@ description: "Learn more about: IDebuggerThreadControl::ReleaseAllRuntimeThreads Method" title: "IDebuggerThreadControl::ReleaseAllRuntimeThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "IDebuggerThreadControl.ReleaseAllRuntimeThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ReleaseAllRuntimeThreads" -helpviewer_keywords: +helpviewer_keywords: - "ReleaseAllRuntimeThreads method [.NET Framework hosting]" - "IDebuggerThreadControl::ReleaseAllRuntimeThreads method [.NET Framework hosting]" -topic_type: +ms.assetid: 1a2995ff-5f02-4b49-84dc-3a5f9cfd7d55 +topic_type: - "apiref" --- # IDebuggerThreadControl::ReleaseAllRuntimeThreads Method -Notifies the host that the debugging services are about to release all threads that are blocked. - -## Syntax - -```cpp -HRESULT ReleaseAllRuntimeThreads ( ); -``` - -## Remarks - - The `ReleaseAllRuntimeThreads` method will never be called on a runtime thread. If the host has a runtime thread blocked, it should release it now. - -## 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 2.0 - +Notifies the host that the debugging services are about to release all threads that are blocked. + +## Syntax + +```cpp +HRESULT ReleaseAllRuntimeThreads ( ); +``` + +## Remarks + + The `ReleaseAllRuntimeThreads` method will never be called on a runtime thread. If the host has a runtime thread blocked, it should release it now. + +## 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 - [IDebuggerThreadControl Interface](idebuggerthreadcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md b/docs/framework/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md similarity index 52% rename from docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md rename to docs/framework/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md index efcd1d62a6706..953bff59db957 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md +++ b/docs/framework/unmanaged-api/hosting/idebuggerthreadcontrol-startblockingfordebugger-method.md @@ -2,51 +2,52 @@ description: "Learn more about: IDebuggerThreadControl::StartBlockingForDebugger Method" title: "IDebuggerThreadControl::StartBlockingForDebugger Method" ms.date: "03/30/2017" -api_name: +api_name: - "IDebuggerThreadControl.StartBlockingForDebugger" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "StartBlockingForDebugger" -helpviewer_keywords: +helpviewer_keywords: - "IDebuggerThreadControl::StartBlockingForDebugger method [.NET Framework hosting]" - "StartBlockingForDebugger method [.NET Framework hosting]" -topic_type: +ms.assetid: 5c8f11b4-35d3-4c39-9bbd-58b896ba5ba6 +topic_type: - "apiref" --- # IDebuggerThreadControl::StartBlockingForDebugger Method -Notifies the host that the debugging services are about to start blocking all threads. - -## Syntax - -```cpp -HRESULT StartBlockingForDebugger ( - [in] DWORD dwUnused -); -``` - -## Parameters - - `dwUnused` - [in] Reserved for future use. - -## Remarks - - The `StartBlockingForDebugger` method could be called on a runtime thread. - -## 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 2.0 - +Notifies the host that the debugging services are about to start blocking all threads. + +## Syntax + +```cpp +HRESULT StartBlockingForDebugger ( + [in] DWORD dwUnused +); +``` + +## Parameters + + `dwUnused` + [in] Reserved for future use. + +## Remarks + + The `StartBlockingForDebugger` method could be called on a runtime thread. + +## 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 - [IDebuggerThreadControl Interface](idebuggerthreadcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md b/docs/framework/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md similarity index 54% rename from docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md rename to docs/framework/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md index 3a8528289e837..7bf73928fdd79 100644 --- a/docs/core/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md +++ b/docs/framework/unmanaged-api/hosting/idebuggerthreadcontrol-threadisblockingfordebugger-method.md @@ -2,46 +2,47 @@ description: "Learn more about: IDebuggerThreadControl::ThreadIsBlockingForDebugger Method" title: "IDebuggerThreadControl::ThreadIsBlockingForDebugger Method" ms.date: "03/30/2017" -api_name: +api_name: - "IDebuggerThreadControl.ThreadIsBlockingForDebugger" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ThreadIsBlockingForDebugger" -helpviewer_keywords: +helpviewer_keywords: - "ThreadIsBlockingForDebugger method [.NET Framework hosting]" - "IDebuggerThreadControl::ThreadIsBlockingForDebugger method [.NET Framework hosting]" -topic_type: +ms.assetid: d4d7cb2d-69da-48b3-879a-1a8a68c9bfa8 +topic_type: - "apiref" --- # IDebuggerThreadControl::ThreadIsBlockingForDebugger Method -Notifies the host that the thread that is sending this callback is about to block within the debugging services. - -## Syntax - -```cpp -HRESULT ThreadIsBlockingForDebugger ( ); -``` - -## Remarks - - The `ThreadIsBlockingForDebugger` method will always be called on a runtime thread. - - The `ThreadIsBlockingForDebugger` method gives the host an opportunity to perform another action while the thread blocks. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll - - **NET Framework Versions:** Available since .NET Framework 2.0 - +Notifies the host that the thread that is sending this callback is about to block within the debugging services. + +## Syntax + +```cpp +HRESULT ThreadIsBlockingForDebugger ( ); +``` + +## Remarks + + The `ThreadIsBlockingForDebugger` method will always be called on a runtime thread. + + The `ThreadIsBlockingForDebugger` method gives the host an opportunity to perform another action while the thread blocks. + +## 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 - [IDebuggerThreadControl Interface](idebuggerthreadcontrol-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/igchost-collect-method.md b/docs/framework/unmanaged-api/hosting/igchost-collect-method.md new file mode 100644 index 0000000000000..dc0426b7da5f6 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/igchost-collect-method.md @@ -0,0 +1,49 @@ +--- +description: "Learn more about: IGCHost::Collect Method" +title: "IGCHost::Collect Method" +ms.date: "03/30/2017" +api_name: + - "IGCHost.Collect" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "Collect" +helpviewer_keywords: + - "Collect method, IGCHost interface [.NET Framework hosting]" + - "IGCHost::Collect method [.NET Framework hosting]" +ms.assetid: fc7d9448-3186-494d-9f0d-ea39717e9a82 +topic_type: + - "apiref" +--- +# IGCHost::Collect Method + +Forces a collection to occur for the given generation, regardless of the state of the current garbage collection. + +## Syntax + +```cpp +HRESULT Collect ( + [in] LONG Generation +); +``` + +## Parameters + + `Generation` + [in] The generation on which to perform the garbage collection. A value of -1 indicates that all generations will undergo a garbage collection. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** GCHost.idl, GCHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + +## See also + +- [IGCHost Interface](igchost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/igchost-getstats-method.md b/docs/framework/unmanaged-api/hosting/igchost-getstats-method.md similarity index 53% rename from docs/core/unmanaged-api/hosting/igchost-getstats-method.md rename to docs/framework/unmanaged-api/hosting/igchost-getstats-method.md index 907623a69c150..4a3e905c75035 100644 --- a/docs/core/unmanaged-api/hosting/igchost-getstats-method.md +++ b/docs/framework/unmanaged-api/hosting/igchost-getstats-method.md @@ -2,51 +2,52 @@ description: "Learn more about: IGCHost::GetStats Method" title: "IGCHost::GetStats Method" ms.date: "03/30/2017" -api_name: +api_name: - "IGCHost.GetStats" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "GetStats" -helpviewer_keywords: +helpviewer_keywords: - "GetStats method, IGCHost interface [.NET Framework hosting]" - "IGCHost::GetStats method [.NET Framework hosting]" -topic_type: +ms.assetid: c4ae022c-46ac-4f19-9ddd-09b955f19412 +topic_type: - "apiref" --- # IGCHost::GetStats Method -Gets the statistics for the current state of the garbage collection system. - -## Syntax - -```cpp -HRESULT GetStats ( - [in, out] COR_GC_STATS *pStats -); -``` - -## Parameters - - `pStats` - [in, out] A pointer to a [COR_GC_STATS](cor-gc-stats-structure.md) structure that contains the statistics for the current state of the garbage collection system. - -## Remarks - - The statistics can be used by a smart allocation system to help the garbage collection system operate. For example, the allocation system may determine, after reviewing the statistics, that it needs to add more memory or force a collection. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl, GCHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - +Gets the statistics for the current state of the garbage collection system. + +## Syntax + +```cpp +HRESULT GetStats ( + [in, out] COR_GC_STATS *pStats +); +``` + +## Parameters + + `pStats` + [in, out] A pointer to a [COR_GC_STATS](cor-gc-stats-structure.md) structure that contains the statistics for the current state of the garbage collection system. + +## Remarks + + The statistics can be used by a smart allocation system to help the garbage collection system operate. For example, the allocation system may determine, after reviewing the statistics, that it needs to add more memory or force a collection. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** GCHost.idl, GCHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [IGCHost Interface](igchost-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/igchost-getthreadstats-method.md b/docs/framework/unmanaged-api/hosting/igchost-getthreadstats-method.md new file mode 100644 index 0000000000000..cdd63b9e54f6e --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/igchost-getthreadstats-method.md @@ -0,0 +1,53 @@ +--- +description: "Learn more about: IGCHost::GetThreadStats Method" +title: "IGCHost::GetThreadStats Method" +ms.date: "03/30/2017" +api_name: + - "IGCHost.GetThreadStats" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "GetThreadStats" +helpviewer_keywords: + - "IGCHost::GetThreadStats method [.NET Framework hosting]" + - "GetThreadStats method [.NET Framework hosting]" +ms.assetid: 826baa9b-9218-4736-a509-7ab193b125a0 +topic_type: + - "apiref" +--- +# IGCHost::GetThreadStats Method + +Gets the per-thread statistics for garbage collection. + +## Syntax + +```cpp +HRESULT GetThreadStats ( + [in] DWORD *pFiberCookie, + [in, out] COR_GC_THREAD_STATS *pStats +); +``` + +## Parameters + + `pFiberCookie` + [in] A pointer to a fiber cookie that specifies the thread for which to retrieve the statistics. + + `pStats` + [in, out] A pointer to a [COR_GC_THREAD_STATS](cor-gc-thread-stats-structure.md) structure that contains the garbage collection statistics for the specified thread. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** GCHost.idl, GCHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + +## See also + +- [IGCHost Interface](igchost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/igchost-interface.md b/docs/framework/unmanaged-api/hosting/igchost-interface.md similarity index 60% rename from docs/core/unmanaged-api/hosting/igchost-interface.md rename to docs/framework/unmanaged-api/hosting/igchost-interface.md index 4fd676eb35da6..1981fd4a67f43 100644 --- a/docs/core/unmanaged-api/hosting/igchost-interface.md +++ b/docs/framework/unmanaged-api/hosting/igchost-interface.md @@ -2,49 +2,50 @@ description: "Learn more about: IGCHost Interface" title: "IGCHost Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IGCHost" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IGCHost" -helpviewer_keywords: +helpviewer_keywords: - "IGCHost interface [.NET Framework hosting]" -topic_type: +ms.assetid: 9ad70ffd-6963-4ab2-8c84-3d86c3fb8deb +topic_type: - "apiref" --- # IGCHost Interface -Provides methods for obtaining information about the garbage collection system and for controlling some aspects of garbage collection. - +Provides methods for obtaining information about the garbage collection system and for controlling some aspects of garbage collection. + > [!NOTE] -> Starting with .NET Framework 4.5, you can use the [IGCHost2::SetGCStartupLimitsEx](igchost2-setgcstartuplimitsex-method.md) method to set the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0 to values greater than the `DWORD` limit that is imposed by the [SetGCStartupLimits](igchost-setgcstartuplimits-method.md) method. - +> Starting with .NET Framework 4.5, you can use the [IGCHost2::SetGCStartupLimitsEx](igchost2-setgcstartuplimitsex-method.md) method to set the size of a garbage collection segment and the maximum size of the garbage collection system's generation 0 to values greater than the `DWORD` limit that is imposed by the [SetGCStartupLimits](igchost-setgcstartuplimits-method.md) method. + > [!NOTE] -> This interface is for expert usage only. It can affect the performance of an application if used improperly. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Collect Method](igchost-collect-method.md)|Forces a collection to occur for the given generation, regardless of the state of the current garbage collection.| -|[GetStats Method](igchost-getstats-method.md)|Gets the statistics for the current state of the garbage collection system.| -|[GetThreadStats Method](igchost-getthreadstats-method.md)|Gets the per-thread statistics for garbage collection.| -|[SetGCStartupLimits Method](igchost-setgcstartuplimits-method.md)|Sets the segment size and the maximum size for generation 0.| -|[SetVirtualMemLimit Method](igchost-setvirtualmemlimit-method.md)|Sets the maximum size of the runtime's virtual memory.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl, GCHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - +> This interface is for expert usage only. It can affect the performance of an application if used improperly. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Collect Method](igchost-collect-method.md)|Forces a collection to occur for the given generation, regardless of the state of the current garbage collection.| +|[GetStats Method](igchost-getstats-method.md)|Gets the statistics for the current state of the garbage collection system.| +|[GetThreadStats Method](igchost-getthreadstats-method.md)|Gets the per-thread statistics for garbage collection.| +|[SetGCStartupLimits Method](igchost-setgcstartuplimits-method.md)|Sets the segment size and the maximum size for generation 0.| +|[SetVirtualMemLimit Method](igchost-setvirtualmemlimit-method.md)|Sets the maximum size of the runtime's virtual memory.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** GCHost.idl, GCHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md b/docs/framework/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md new file mode 100644 index 0000000000000..47f2f03714efc --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/igchost-setgcstartuplimits-method.md @@ -0,0 +1,60 @@ +--- +description: "Learn more about: IGCHost::SetGCStartupLimits Method" +title: "IGCHost::SetGCStartupLimits Method" +ms.date: "03/30/2017" +api_name: + - "IGCHost.SetGCStartupLimits" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "SetGCStartupLimits" +helpviewer_keywords: + - "SetGCStartupLimits method, IGCHost interface [.NET Framework hosting]" + - "IGCHost::SetGCStartupLimits method [.NET Framework hosting]" +ms.assetid: cae53926-82ac-4d1d-b297-0bde0bd1bebb +topic_type: + - "apiref" +--- +# IGCHost::SetGCStartupLimits Method + +Sets the segment size and the maximum size for generation 0. + +> [!IMPORTANT] +> Starting with .NET Framework 4.5, you can set segment size and maximum generation 0 size to values greater than `DWORD` by using the [IGCHost2::SetGCStartupLimitsEx](igchost2-setgcstartuplimitsex-method.md) method. + +## Syntax + +```cpp +HRESULT SetGCStartupLimits ( + [in] DWORD SegmentSize, + [in] DWORD MaxGen0Size +); +``` + +## Parameters + + `SegmentSize` + [in] The size of the segment used by the garbage collection system. + + `MaxGen0Size` + [in] The maximum size for generation 0. + +## Remarks + + The `SetGCStartupLimits` method may be called only once. These values cannot be changed later. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** GCHost.idl, GCHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + +## See also + +- [IGCHost Interface](igchost-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md b/docs/framework/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md new file mode 100644 index 0000000000000..ec6490a70f541 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/igchost-setvirtualmemlimit-method.md @@ -0,0 +1,53 @@ +--- +description: "Learn more about: IGCHost::SetVirtualMemLimit Method" +title: "IGCHost::SetVirtualMemLimit Method" +ms.date: "03/30/2017" +api_name: + - "IGCHost.SetVirtualMemLimit" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "SetVirtualMemLimit" +helpviewer_keywords: + - "IGCHost::SetVirtualMemLimit method [.NET Framework hosting]" + - "SetVirtualMemLimit method [.NET Framework hosting]" +ms.assetid: c7e7c2d0-e58c-4650-b40c-47b2be2cda45 +topic_type: + - "apiref" +--- +# IGCHost::SetVirtualMemLimit Method + +Sets the maximum size of the runtime's virtual memory. + +## Syntax + +```cpp +HRESULT SetVirtualMemLimit ( + [in] SIZE_T sztMaxVirtualMemMB +); +``` + +## Parameters + + `sztMaxVirtualMemMB` + [in] The maximum size, in megabytes, of the runtime's virtual memory. + +## Remarks + + The maximum size of the runtime's virtual memory can be changed dynamically. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** GCHost.idl, GCHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + +## See also + +- [IGCHost Interface](igchost-interface.md) diff --git a/docs/core/unmanaged-api/hosting/igchost2-interface.md b/docs/framework/unmanaged-api/hosting/igchost2-interface.md similarity index 57% rename from docs/core/unmanaged-api/hosting/igchost2-interface.md rename to docs/framework/unmanaged-api/hosting/igchost2-interface.md index 306f3358fc49f..502e2f5ab7502 100644 --- a/docs/core/unmanaged-api/hosting/igchost2-interface.md +++ b/docs/framework/unmanaged-api/hosting/igchost2-interface.md @@ -2,42 +2,43 @@ description: "Learn more about: IGCHost2 Interface" title: "IGCHost2 Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IGCHost2" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IGCHost2" -helpviewer_keywords: +helpviewer_keywords: - "IGCHost2 interface [.NET Framework hosting]" -topic_type: +ms.assetid: e5323fa4-18ac-424d-859d-a65a550d08d9 +topic_type: - "apiref" --- # IGCHost2 Interface -Provides methods for obtaining information about the garbage collection system and for controlling some aspects of garbage collection. - +Provides methods for obtaining information about the garbage collection system and for controlling some aspects of garbage collection. + > [!NOTE] -> For new development, we recommend that you use the [ICLRGCManager2](iclrgcmanager2-interface.md) interface instead. - -## Methods - -|Method|Description| -|------------|-----------------| -|[SetGCStartupLimitsEx Method](igchost2-setgcstartuplimitsex-method.md)|Sets the segment size and the maximum size for generation 0. Enables generation 0 and segment sizes larger than `DWORD`.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** GCHost.idl, GCHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] - +> For new development, we recommend that you use the [ICLRGCManager2](iclrgcmanager2-interface.md) interface instead. + +## Methods + +|Method|Description| +|------------|-----------------| +|[SetGCStartupLimitsEx Method](igchost2-setgcstartuplimitsex-method.md)|Sets the segment size and the maximum size for generation 0. Enables generation 0 and segment sizes larger than `DWORD`.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** GCHost.idl, GCHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] + ## See also - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md b/docs/framework/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md new file mode 100644 index 0000000000000..5a66af63d8588 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/igchost2-setgcstartuplimitsex-method.md @@ -0,0 +1,57 @@ +--- +description: "Learn more about: IGCHost2::SetGCStartupLimitsEx Method" +title: "IGCHost2::SetGCStartupLimitsEx Method" +ms.date: "03/30/2017" +api_name: + - "IGCHost2.SetGCStartupLimitsEx" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IGCHost2::SetGCStartupLimitsEx" +helpviewer_keywords: + - "IGCHost2::SetGCStartupLimitsEx method [.NET Framework hosting]" + - "SetGCStartupLimitsEx method, IGCHost2 interface [.NET Framework hosting]" +ms.assetid: bba941c2-1c57-46d3-bbf5-5fb92700c490 +topic_type: + - "apiref" +--- +# IGCHost2::SetGCStartupLimitsEx Method + +Sets the segment size and the maximum size for generation 0. + +## Syntax + +```cpp +HRESULT SetGCStartupLimitsEx ( + [in] SIZE_T SegmentSize, + [in] SIZE_T MaxGen0Size +); +``` + +## Parameters + + `SegmentSize` + [in] The size of the segment used by the garbage collection system. + + `MaxGen0Size` + [in] The maximum size for generation 0. + +## Remarks + + The values that `SetGCStartupLimitsEx` sets can be specified only before the host is started. These values cannot be changed later. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** GCHost.idl, GCHost.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] + +## See also + +- [IGCHost2 Interface](igchost2-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/igchostcontrol-interface.md b/docs/framework/unmanaged-api/hosting/igchostcontrol-interface.md new file mode 100644 index 0000000000000..d5462d766f50e --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/igchostcontrol-interface.md @@ -0,0 +1,41 @@ +--- +description: "Learn more about: IGCHostControl Interface" +title: "IGCHostControl Interface" +ms.date: "03/30/2017" +api_name: + - "IGCHostControl" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IGCHostControl" +helpviewer_keywords: + - "IGCHostControl interface [.NET Framework hosting]" +ms.assetid: 2eb56ea9-8b7e-452b-a209-3d2be719fca6 +topic_type: + - "apiref" +--- +# IGCHostControl Interface + +Provides a method that allows the garbage collector to request the host to change the limits of virtual memory. + +## Methods + +|Method|Description| +|------------|-----------------| +|[RequestVirtualMemLimit Method](igchostcontrol-requestvirtualmemlimit-method.md)|Requests the host to change the limits of virtual memory.| + +## 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 + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md b/docs/framework/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md new file mode 100644 index 0000000000000..fad3ebf5541b4 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/igchostcontrol-requestvirtualmemlimit-method.md @@ -0,0 +1,53 @@ +--- +description: "Learn more about: IGCHostControl::RequestVirtualMemLimit Method" +title: "IGCHostControl::RequestVirtualMemLimit Method" +ms.date: "03/30/2017" +api_name: + - "IGCHostControl.RequestVirtualMemLimit" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "RequestVirtualMemLimit" +helpviewer_keywords: + - "IGCHostControl::RequestVirtualMemLimit method [.NET Framework hosting]" + - "RequestVirtualMemLimit method [.NET Framework hosting]" +ms.assetid: f4984a8c-4c0e-4460-9aa1-d022b3621228 +topic_type: + - "apiref" +--- +# IGCHostControl::RequestVirtualMemLimit Method + +Requests the host to change the limits of virtual memory. + +## Syntax + +```cpp +HRESULT RequestVirtualMemLimit ( + [in] SIZE_T sztMaxVirtualMemMB, + [in, out] SIZE_T* psztNewMaxVirtualMemMB +); +``` + +## Parameters + + `sztMaxVirtualMemMB` + [in] The requested size of memory to be allocated. + + `psztNewMaxVirtualMemMB` + [in, out] A pointer to the actual size of memory allocated. + +## 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 + +- [IGCHostControl Interface](igchostcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md b/docs/framework/unmanaged-api/hosting/igcthreadcontrol-interface.md similarity index 54% rename from docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md rename to docs/framework/unmanaged-api/hosting/igcthreadcontrol-interface.md index edff57212777d..44c1f39c21eb3 100644 --- a/docs/core/unmanaged-api/hosting/igcthreadcontrol-interface.md +++ b/docs/framework/unmanaged-api/hosting/igcthreadcontrol-interface.md @@ -2,41 +2,42 @@ description: "Learn more about: IGCThreadControl Interface" title: "IGCThreadControl Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IGCThreadControl" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IGCThreadControl" -helpviewer_keywords: +helpviewer_keywords: - "IGCThreadControl interface [.NET Framework hosting]" -topic_type: +ms.assetid: 3ff04d75-85ac-4df9-886d-dbaa037c0552 +topic_type: - "apiref" --- # IGCThreadControl Interface -Provides methods for participating in the scheduling of threads that would otherwise be blocked for a garbage collection. - -## Methods - -|Method|Description| -|------------|-----------------| -|[SuspensionEnding Method](igcthreadcontrol-suspensionending-method.md)|Notifies the host that the runtime is resuming threads after a garbage collection or other suspension.| -|[SuspensionStarting Method](igcthreadcontrol-suspensionstarting-method.md)|Notifies the host that the runtime is beginning a thread suspension for a garbage collection or other suspension.| -|[ThreadIsBlockingForSuspension Method](igcthreadcontrol-threadisblockingforsuspension-method.md)|Notifies the host that the thread making the call is about to block, perhaps for a garbage collection or other suspension.| - -## 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 2.0 - +Provides methods for participating in the scheduling of threads that would otherwise be blocked for a garbage collection. + +## Methods + +|Method|Description| +|------------|-----------------| +|[SuspensionEnding Method](igcthreadcontrol-suspensionending-method.md)|Notifies the host that the runtime is resuming threads after a garbage collection or other suspension.| +|[SuspensionStarting Method](igcthreadcontrol-suspensionstarting-method.md)|Notifies the host that the runtime is beginning a thread suspension for a garbage collection or other suspension.| +|[ThreadIsBlockingForSuspension Method](igcthreadcontrol-threadisblockingforsuspension-method.md)|Notifies the host that the thread making the call is about to block, perhaps for a garbage collection or other suspension.| + +## 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 - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md b/docs/framework/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md similarity index 52% rename from docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md rename to docs/framework/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md index 1df7e5cf425ed..128b886c79e9c 100644 --- a/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md +++ b/docs/framework/unmanaged-api/hosting/igcthreadcontrol-suspensionending-method.md @@ -2,51 +2,52 @@ description: "Learn more about: IGCThreadControl::SuspensionEnding Method" title: "IGCThreadControl::SuspensionEnding Method" ms.date: "03/30/2017" -api_name: +api_name: - "IGCThreadControl.SuspensionEnding" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "SuspensionEnding" -helpviewer_keywords: +helpviewer_keywords: - "IGCThreadControl::SuspensionEnding method [.NET Framework hosting]" - "SuspensionEnding method, IGCThreadControl interface [.NET Framework hosting]" -topic_type: +ms.assetid: 70814265-c734-4ddc-9502-fe8b28d2b414 +topic_type: - "apiref" --- # IGCThreadControl::SuspensionEnding Method -Notifies the host that the runtime is resuming threads after a garbage collection or other suspension. - -## Syntax - -```cpp -HRESULT SuspensionEnding ( - [in] DWORD Generation -); -``` - -## Parameters - - `Generation` - [in] The generation on which a garbage collection has been performed. - -## Remarks - - Do not reschedule any threads during the `SuspensionEnding` callback. - -## 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 2.0 - +Notifies the host that the runtime is resuming threads after a garbage collection or other suspension. + +## Syntax + +```cpp +HRESULT SuspensionEnding ( + [in] DWORD Generation +); +``` + +## Parameters + + `Generation` + [in] The generation on which a garbage collection has been performed. + +## Remarks + + Do not reschedule any threads during the `SuspensionEnding` callback. + +## 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 - [IGCThreadControl Interface](igcthreadcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md b/docs/framework/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md similarity index 53% rename from docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md rename to docs/framework/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md index 7565d9deb4881..df94fbbfa17a7 100644 --- a/docs/core/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md +++ b/docs/framework/unmanaged-api/hosting/igcthreadcontrol-suspensionstarting-method.md @@ -2,44 +2,45 @@ description: "Learn more about: IGCThreadControl::SuspensionStarting Method" title: "IGCThreadControl::SuspensionStarting Method" ms.date: "03/30/2017" -api_name: +api_name: - "IGCThreadControl.SuspensionStarting" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "SuspensionStarting" -helpviewer_keywords: +helpviewer_keywords: - "IGCThreadControl::SuspensionStarting method [.NET Framework hosting]" - "SuspensionStarting method, IGCThreadControl interface [.NET Framework hosting]" -topic_type: +ms.assetid: 0af312af-98e9-415e-b182-42e80a1aee51 +topic_type: - "apiref" --- # IGCThreadControl::SuspensionStarting Method -Notifies the host that the runtime is beginning a thread suspension for a garbage collection or other suspension. - -## Syntax - -```cpp -HRESULT SuspensionStarting ( ); -``` - -## Remarks - - Do not reschedule any threads during the `SuspensionStarting` callback. - -## 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 2.0 - +Notifies the host that the runtime is beginning a thread suspension for a garbage collection or other suspension. + +## Syntax + +```cpp +HRESULT SuspensionStarting ( ); +``` + +## Remarks + + Do not reschedule any threads during the `SuspensionStarting` callback. + +## 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 - [IGCThreadControl Interface](igcthreadcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md b/docs/framework/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md similarity index 57% rename from docs/core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md rename to docs/framework/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md index 6de822eb98d5e..d59d24b1e2852 100644 --- a/docs/core/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md +++ b/docs/framework/unmanaged-api/hosting/igcthreadcontrol-threadisblockingforsuspension-method.md @@ -2,44 +2,45 @@ description: "Learn more about: IGCThreadControl::ThreadIsBlockingForSuspension Method" title: "IGCThreadControl::ThreadIsBlockingForSuspension Method" ms.date: "03/30/2017" -api_name: +api_name: - "IGCThreadControl.ThreadIsBlockingForSuspension" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ThreadIsBlockingForSuspension" -helpviewer_keywords: +helpviewer_keywords: - "IGCThreadControl::ThreadIsBlockingForSuspension method [.NET Framework hosting]" - "ThreadIsBlockingForSuspension method [.NET Framework hosting]" -topic_type: +ms.assetid: ed5b5b58-7db7-46b5-9e2c-278db7159cee +topic_type: - "apiref" --- # IGCThreadControl::ThreadIsBlockingForSuspension Method -Notifies the host that the thread that is making the call is about to block, perhaps for a garbage collection or other suspension. - -## Syntax - -```cpp -HRESULT ThreadIsBlockingForSuspension ( ); -``` - -## Remarks - - The host may choose within the `ThreadIsBlockingForSuspension` callback whether to reschedule a thread. - -## 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 2.0 - +Notifies the host that the thread that is making the call is about to block, perhaps for a garbage collection or other suspension. + +## Syntax + +```cpp +HRESULT ThreadIsBlockingForSuspension ( ); +``` + +## Remarks + + The host may choose within the `ThreadIsBlockingForSuspension` callback whether to reschedule a thread. + +## 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 - [IGCThreadControl Interface](igcthreadcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md b/docs/framework/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md similarity index 58% rename from docs/core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md rename to docs/framework/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md index f7c4844251f76..53c16256b026c 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostassemblymanager-getassemblystore-method.md @@ -2,66 +2,67 @@ description: "Learn more about: IHostAssemblyManager::GetAssemblyStore Method" title: "IHostAssemblyManager::GetAssemblyStore Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostAssemblyManager.GetAssemblyStore" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostAssemblyManager::GetAssemblyStore" -helpviewer_keywords: +helpviewer_keywords: - "IHostAssemblyManager::GetAssemblyStore method [.NET Framework hosting]" - "GetAssemblyStore method [.NET Framework hosting]" -topic_type: +ms.assetid: d0f74593-9bb1-4a11-8096-e29734b20698 +topic_type: - "apiref" --- # IHostAssemblyManager::GetAssemblyStore Method -Gets an interface pointer to an [IHostAssemblyStore](ihostassemblystore-interface.md) that represents the list of assemblies loaded by the host. - -## Syntax - -```cpp -HRESULT GetAssemblyStore ( - [out] IHostAssemblyStore **ppAssemblyStore -); -``` - -## Parameters - - `ppAssemblyStore` - [out] A function pointer to an `IHostAssemblyStore` instance, or null, if the host does not implement `IHostAssemblyStore`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetAssemblyStore` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOINTERFACE|The host does not provide an implementation of `IHostAssemblyStore`.| - -## Remarks - - `IHostAssemblyStore` provides methods that allow a host to bind to assemblies and modules independently of the CLR. Hosts typically provide assembly stores to allow assemblies to be loaded from formats other than the file system. - +Gets an interface pointer to an [IHostAssemblyStore](ihostassemblystore-interface.md) that represents the list of assemblies loaded by the host. + +## Syntax + +```cpp +HRESULT GetAssemblyStore ( + [out] IHostAssemblyStore **ppAssemblyStore +); +``` + +## Parameters + + `ppAssemblyStore` + [out] A function pointer to an `IHostAssemblyStore` instance, or null, if the host does not implement `IHostAssemblyStore`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetAssemblyStore` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOINTERFACE|The host does not provide an implementation of `IHostAssemblyStore`.| + +## Remarks + + `IHostAssemblyStore` provides methods that allow a host to bind to assemblies and modules independently of the CLR. Hosts typically provide assembly stores to allow assemblies to be loaded from formats other than the file system. + > [!NOTE] -> If the host does not implement `IHostAssemblyStore`, `GetAssemblyStore` should return an HRESULT value of E_NOINTERFACE, and should set `ppAssemblyStore` to null. - -## 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 2.0 - +> If the host does not implement `IHostAssemblyStore`, `GetAssemblyStore` should return an HRESULT value of E_NOINTERFACE, and should set `ppAssemblyStore` to null. + +## 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 - [IHostAssemblyManager Interface](ihostassemblymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md b/docs/framework/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md similarity index 62% rename from docs/core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md rename to docs/framework/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md index 7466c9222591b..7808c8c2f360a 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostassemblymanager-getnonhoststoreassemblies-method.md @@ -2,76 +2,77 @@ description: "Learn more about: IHostAssemblyManager::GetNonHostStoreAssemblies Method" title: "IHostAssemblyManager::GetNonHostStoreAssemblies Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostAssemblyManager.GetNonHostStoreAssemblies" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostAssemblyManager::GetNonHostStoreAssemblies" -helpviewer_keywords: +helpviewer_keywords: - "IHostAssemblyManager::GetNonHostStoreAssemblies method [.NET Framework hosting]" - "GetNonHostStoreAssemblies method [.NET Framework hosting]" -topic_type: +ms.assetid: d2250b38-c76a-40ce-80c8-ba45149886e8 +topic_type: - "apiref" --- # IHostAssemblyManager::GetNonHostStoreAssemblies Method -Gets an interface pointer to an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) that represents the list of assemblies that the host expects the common language runtime (CLR) to load. - -## Syntax - -```cpp -HRESULT GetNonHostStoreAssemblies ( - [out] ICLRAssemblyReferenceList **ppReferenceList -); -``` - -## Parameters - - `ppReferenceList` - [out] A pointer to the address of an `ICLRAssemblyReferenceList` that contains a list of references to assemblies that the host expects the CLR to load. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetNonHostStoreAssemblies` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to create the list of references for the requested `ICLRAssemblyReferenceList`.| - -## Remarks - - The CLR resolves references using the following set of guidelines: - -- First, it consults the list of assembly references returned by `GetNonHostStoreAssemblies`. - -- If the assembly appears in the list, the CLR binds to it normally. - -- If the assembly does not appear in the list and the host has provided an implementation of [IHostAssemblyStore](ihostassemblystore-interface.md), the CLR calls [IHostAssemblyStore::ProvideAssembly](ihostassemblystore-provideassembly-method.md) to allow the host to supply the assembly to bind to. - -- Otherwise, the CLR fails to bind to the assembly. - - If the host sets `ppReferenceList` to null, the CLR first probes the global assembly cache, calls `ProvideAssembly`, and then probes the application base to resolve an assembly reference. - +Gets an interface pointer to an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) that represents the list of assemblies that the host expects the common language runtime (CLR) to load. + +## Syntax + +```cpp +HRESULT GetNonHostStoreAssemblies ( + [out] ICLRAssemblyReferenceList **ppReferenceList +); +``` + +## Parameters + + `ppReferenceList` + [out] A pointer to the address of an `ICLRAssemblyReferenceList` that contains a list of references to assemblies that the host expects the CLR to load. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetNonHostStoreAssemblies` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to create the list of references for the requested `ICLRAssemblyReferenceList`.| + +## Remarks + + The CLR resolves references using the following set of guidelines: + +- First, it consults the list of assembly references returned by `GetNonHostStoreAssemblies`. + +- If the assembly appears in the list, the CLR binds to it normally. + +- If the assembly does not appear in the list and the host has provided an implementation of [IHostAssemblyStore](ihostassemblystore-interface.md), the CLR calls [IHostAssemblyStore::ProvideAssembly](ihostassemblystore-provideassembly-method.md) to allow the host to supply the assembly to bind to. + +- Otherwise, the CLR fails to bind to the assembly. + + If the host sets `ppReferenceList` to null, the CLR first probes the global assembly cache, calls `ProvideAssembly`, and then probes the application base to resolve an assembly reference. + > [!NOTE] -> Upon initialization, the CLR calls `GetNonHostStoreAssemblies` only once. The method is not called again. - -## 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 2.0 - +> Upon initialization, the CLR calls `GetNonHostStoreAssemblies` only once. The method is not called again. + +## 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 - [ICLRAssemblyReferenceList Interface](iclrassemblyreferencelist-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostassemblymanager-interface.md b/docs/framework/unmanaged-api/hosting/ihostassemblymanager-interface.md similarity index 68% rename from docs/core/unmanaged-api/hosting/ihostassemblymanager-interface.md rename to docs/framework/unmanaged-api/hosting/ihostassemblymanager-interface.md index 52991bcd87c8c..f287d9af6a396 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblymanager-interface.md +++ b/docs/framework/unmanaged-api/hosting/ihostassemblymanager-interface.md @@ -2,46 +2,47 @@ description: "Learn more about: IHostAssemblyManager Interface" title: "IHostAssemblyManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostAssemblyManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostAssemblyManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostAssemblyManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: dfec05bb-3cd7-4bd5-b396-a4f097c3a636 +topic_type: - "apiref" --- # IHostAssemblyManager Interface -Provides methods that allow a host to specify sets of assemblies that should be loaded by the common language runtime (CLR) or by the host. - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetAssemblyStore Method](ihostassemblymanager-getassemblystore-method.md)|Gets an interface pointer to an [IHostAssemblyStore](ihostassemblystore-interface.md) that represents the list of assemblies loaded by the host.| -|[GetNonHostStoreAssemblies Method](ihostassemblymanager-getnonhoststoreassemblies-method.md)|Gets an interface pointer to an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) that represents the list of assemblies that the host expects the CLR to load.| - -## Remarks - - The host is not required to implement `IHostAssemblyManager` or `IHostAssemblyStore`. If the host does implement `IHostAssemblyManager`, it must also implement `IHostAssemblyStore`. - - The runtime queries for an `IHostAssemblyManager` by calling [IHostControl::GetHostManager](ihostcontrol-gethostmanager-method.md) upon initialization with an `IID` of IID_IHostAssemblyManager. - -## 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 2.0 - +Provides methods that allow a host to specify sets of assemblies that should be loaded by the common language runtime (CLR) or by the host. + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetAssemblyStore Method](ihostassemblymanager-getassemblystore-method.md)|Gets an interface pointer to an [IHostAssemblyStore](ihostassemblystore-interface.md) that represents the list of assemblies loaded by the host.| +|[GetNonHostStoreAssemblies Method](ihostassemblymanager-getnonhoststoreassemblies-method.md)|Gets an interface pointer to an [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) that represents the list of assemblies that the host expects the CLR to load.| + +## Remarks + + The host is not required to implement `IHostAssemblyManager` or `IHostAssemblyStore`. If the host does implement `IHostAssemblyManager`, it must also implement `IHostAssemblyStore`. + + The runtime queries for an `IHostAssemblyManager` by calling [IHostControl::GetHostManager](ihostcontrol-gethostmanager-method.md) upon initialization with an `IID` of IID_IHostAssemblyManager. + +## 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 - [ICLRAssemblyReferenceList Interface](iclrassemblyreferencelist-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md b/docs/framework/unmanaged-api/hosting/ihostassemblystore-interface.md similarity index 63% rename from docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md rename to docs/framework/unmanaged-api/hosting/ihostassemblystore-interface.md index 59e952e848728..8ff9b7a4652f5 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblystore-interface.md +++ b/docs/framework/unmanaged-api/hosting/ihostassemblystore-interface.md @@ -2,52 +2,53 @@ description: "Learn more about: IHostAssemblyStore Interface" title: "IHostAssemblyStore Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostAssemblyStore" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostAssemblyStore" -helpviewer_keywords: +helpviewer_keywords: - "IHostAssemblyStore interface [.NET Framework hosting]" -topic_type: +ms.assetid: cccb650f-abe0-41e2-9fd1-b383788eb1f6 +topic_type: - "apiref" --- # IHostAssemblyStore Interface -Provides methods that allow a host to load assemblies and modules independently of the common language runtime (CLR). - -## Methods - -| Method | Description | -|--------|-------------| -|[ProvideAssembly Method](ihostassemblystore-provideassembly-method.md)|Gets a reference to an assembly that is not referenced by the [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) returned from a call to [IHostAssemblyManager::GetNonHostStoreAssemblies](ihostassemblymanager-getnonhoststoreassemblies-method.md).| -|[ProvideModule Method](ihostassemblystore-providemodule-method.md)|Resolves a module within an assembly or a linked (not embedded) resource file.| - -## Remarks - - `IHostAssemblyStore` provides a way for a host to load assemblies efficiently based on assembly identity. The host loads assemblies by returning `IStream` instances that point directly at the bytes. - - The CLR determines whether a host has implemented `IHostAssemblyStore` by calling `IHostAssemblyManager::GetNonHostAssemblyStores` upon initialization. This allows the host, for example, to control binding to user assemblies, but to rely on the runtime to bind to .NET Framework assemblies. - +Provides methods that allow a host to load assemblies and modules independently of the common language runtime (CLR). + +## Methods + +|Method|Description| +|------------|-----------------| +|[ProvideAssembly Method](ihostassemblystore-provideassembly-method.md)|Gets a reference to an assembly that is not referenced by the [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) returned from a call to [IHostAssemblyManager::GetNonHostStoreAssemblies](ihostassemblymanager-getnonhoststoreassemblies-method.md).| +|[ProvideModule Method](ihostassemblystore-providemodule-method.md)|Resolves a module within an assembly or a linked (not embedded) resource file.| + +## Remarks + + `IHostAssemblyStore` provides a way for a host to load assemblies efficiently based on assembly identity. The host loads assemblies by returning `IStream` instances that point directly at the bytes. + + The CLR determines whether a host has implemented `IHostAssemblyStore` by calling `IHostAssemblyManager::GetNonHostAssemblyStores` upon initialization. This allows the host, for example, to control binding to user assemblies, but to rely on the runtime to bind to .NET Framework assemblies. + > [!NOTE] -> In providing an implementation of `IHostAssemblyStore`, the host specifies its intent to resolve all assemblies that are not referenced by the `ICLRAssemblyReferenceList` returned from `IHostAssemblyManager::GetNonHostStoreAssemblies`. - +> In providing an implementation of `IHostAssemblyStore`, the host specifies its intent to resolve all assemblies that are not referenced by the `ICLRAssemblyReferenceList` returned from `IHostAssemblyManager::GetNonHostStoreAssemblies`. + > [!NOTE] -> .NET Framework version 2.0 does not provide a way for the host to load the native image of an assembly, as provided by the [Native Image Generator (Ngen.exe)](../../../framework/tools/ngen-exe-native-image-generator.md) utility. - -## 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 2.0 - +> The .NET Framework version 2.0 does not provide a way for the host to load the native image of an assembly, as provided by the [Native Image Generator (Ngen.exe)](../../tools/ngen-exe-native-image-generator.md) utility. + +## 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 - [ICLRAssemblyReferenceList Interface](iclrassemblyreferencelist-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md b/docs/framework/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md similarity index 66% rename from docs/core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md rename to docs/framework/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md index 4947dcd8a654e..80568da0efdd9 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostassemblystore-provideassembly-method.md @@ -2,80 +2,81 @@ description: "Learn more about: IHostAssemblyStore::ProvideAssembly Method" title: "IHostAssemblyStore::ProvideAssembly Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostAssemblyStore.ProvideAssembly" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostAssemblyStore::ProvideAssembly" -helpviewer_keywords: +helpviewer_keywords: - "ProvideAssembly method [.NET Framework hosting]" - "IHostAssemblyStore::ProvideAssembly method [.NET Framework hosting]" -topic_type: +ms.assetid: 625c3dd5-a3f0-442c-adde-310dadbb5054 +topic_type: - "apiref" --- # IHostAssemblyStore::ProvideAssembly Method -Gets a reference to an assembly that is not referenced by the [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) that is returned from [IHostAssemblyManager::GetNonHostStoreAssemblies](ihostassemblymanager-getnonhoststoreassemblies-method.md). The common language runtime (CLR) calls `ProvideAssembly` for each assembly that does not appear in the list. - -## Syntax - -```cpp -HRESULT ProvideAssembly ( - [in] AssemblyBindInfo *pBindInfo, - [out] UINT64 *pAssemblyId, - [out] UINT64 *pHostContext, - [out] IStream **ppStmAssemblyImage, - [out] IStream **ppStmPDB -); -``` - -## Parameters - - `pBindInfo` - [in] A pointer to an [AssemblyBindInfo](assemblybindinfo-structure.md) instance that the host uses to determine certain bind characteristics, including the presence or absence of any versioning policy, and which assembly to bind to. - - `pAssemblyId` - [out] A pointer to a unique identifier for the requested assembly for this `IStream`. - - `pHostContext` - [out] A pointer to host-specific data that is used to determine the evidence of the requested assembly without the need of a platform invoke call. `pHostContext` corresponds to the property of the managed class. - - `ppStmAssemblyImage` - [out] A pointer to the address of an `IStream` that contains the portable executable (PE) image to be loaded, or null if the assembly could not be found. - - `ppStmPDB` - [out] A pointer to the address of an `IStream` that contains the program debug (PDB) information, or null if the .pdb file could not be found. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`ProvideAssembly` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|COR_E_FILENOTFOUND (0x80070002)|The requested assembly could not be located.| -|E_NOT_SUFFICIENT_BUFFER|The buffer size specified by `pAssemblyId` is not large enough to hold the identifier that the host wants to return.| - -## Remarks - - The identity value returned for `pAssemblyId` is specified by the host. Identifiers must be unique within the lifetime of a process. The CLR uses this value as a unique identifier for the stream. It checks each value against the values for `pAssemblyId` returned by other calls to `ProvideAssembly`. If the host returns the same `pAssemblyId` value for another `IStream`, the CLR checks whether the contents of that stream have already been mapped. If so, the runtime loads the existing copy of the image instead of mapping a new one. - -## 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 2.0 - +Gets a reference to an assembly that is not referenced by the [ICLRAssemblyReferenceList](iclrassemblyreferencelist-interface.md) that is returned from [IHostAssemblyManager::GetNonHostStoreAssemblies](ihostassemblymanager-getnonhoststoreassemblies-method.md). The common language runtime (CLR) calls `ProvideAssembly` for each assembly that does not appear in the list. + +## Syntax + +```cpp +HRESULT ProvideAssembly ( + [in] AssemblyBindInfo *pBindInfo, + [out] UINT64 *pAssemblyId, + [out] UINT64 *pHostContext, + [out] IStream **ppStmAssemblyImage, + [out] IStream **ppStmPDB +); +``` + +## Parameters + + `pBindInfo` + [in] A pointer to an [AssemblyBindInfo](assemblybindinfo-structure.md) instance that the host uses to determine certain bind characteristics, including the presence or absence of any versioning policy, and which assembly to bind to. + + `pAssemblyId` + [out] A pointer to a unique identifier for the requested assembly for this `IStream`. + + `pHostContext` + [out] A pointer to host-specific data that is used to determine the evidence of the requested assembly without the need of a platform invoke call. `pHostContext` corresponds to the property of the managed class. + + `ppStmAssemblyImage` + [out] A pointer to the address of an `IStream` that contains the portable executable (PE) image to be loaded, or null if the assembly could not be found. + + `ppStmPDB` + [out] A pointer to the address of an `IStream` that contains the program debug (PDB) information, or null if the .pdb file could not be found. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`ProvideAssembly` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|COR_E_FILENOTFOUND (0x80070002)|The requested assembly could not be located.| +|E_NOT_SUFFICIENT_BUFFER|The buffer size specified by `pAssemblyId` is not large enough to hold the identifier that the host wants to return.| + +## Remarks + + The identity value returned for `pAssemblyId` is specified by the host. Identifiers must be unique within the lifetime of a process. The CLR uses this value as a unique identifier for the stream. It checks each value against the values for `pAssemblyId` returned by other calls to `ProvideAssembly`. If the host returns the same `pAssemblyId` value for another `IStream`, the CLR checks whether the contents of that stream have already been mapped. If so, the runtime loads the existing copy of the image instead of mapping a new one. + +## 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 - [ICLRAssemblyReferenceList Interface](iclrassemblyreferencelist-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md b/docs/framework/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md similarity index 63% rename from docs/core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md rename to docs/framework/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md index 0fb2d3ef5d02a..8beaecfc3de50 100644 --- a/docs/core/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostassemblystore-providemodule-method.md @@ -2,76 +2,77 @@ description: "Learn more about: IHostAssemblyStore::ProvideModule Method" title: "IHostAssemblyStore::ProvideModule Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostAssemblyStore.ProvideModule" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostAssemblyStore::ProvideModule" -helpviewer_keywords: +helpviewer_keywords: - "IHostAssemblyStore::ProvideModule method [.NET Framework hosting]" - "ProvideModule method [.NET Framework hosting]" -topic_type: +ms.assetid: f42e3dd0-c88e-4748-b6c0-4c515a633180 +topic_type: - "apiref" --- # IHostAssemblyStore::ProvideModule Method -Resolves a module within an assembly or a linked (but not an embedded) resource file. - -## Syntax - -```cpp -HRESULT ProvideModule ( - [in] ModuleBindInfo *pBindInfo, - [out] DWORD *pdwModuleId, - [out] IStream **ppStmModuleImage, - [out] IStream **ppStmPDB -); -``` - -## Parameters - - `pBindInfo` - [in] A pointer to a [ModuleBindInfo](modulebindinfo-structure.md) instance that describes the requested module's , assembly, and module name. - - `pdwModuleId` - [out] A pointer to a unique identifier for the `IStream` containing the loaded module. - - `ppStmModuleImage` - [out] A pointer to the address of an `IStream` object, which contains the portable executable (PE) image to be loaded, or null if the module could not be found. - - `ppStmPDB` - [out] A pointer to the address of an `IStream` object, which contains the program debug (PDB) information for the requested module, or null if the .pdb file could not be found. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`ProvideModule` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|COR_E_FILENOTFOUND (0x80070002)|The requested assembly or linked resource could not be located.| -|E_NOT_SUFFICIENT_BUFFER|`pdwModuleId` is not large enough to contain the identifier that the host wants to return.| - -## Remarks - - The identity value returned for `pdwModuleId` is specified by the host. Identifiers must be unique within the lifetime of a process. The CLR uses this value as the unique identifier for the associated stream. It checks each value against the values for `pAssemblyId` returned by calls to [ProvideAssembly](ihostassemblystore-provideassembly-method.md) and against the values for `pdwModuleId` returned by other calls to `ProvideModule`. If the host returns the same identifier value for another `IStream`, the CLR checks whether the contents of that stream have already been mapped. If so, the CLR loads the existing copy of the image instead of mapping a new one. Therefore, the identifier must also not overlap with the assembly identifiers returned from `ProvideAssembly`. - -## 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 2.0 - +Resolves a module within an assembly or a linked (but not an embedded) resource file. + +## Syntax + +```cpp +HRESULT ProvideModule ( + [in] ModuleBindInfo *pBindInfo, + [out] DWORD *pdwModuleId, + [out] IStream **ppStmModuleImage, + [out] IStream **ppStmPDB +); +``` + +## Parameters + + `pBindInfo` + [in] A pointer to a [ModuleBindInfo](modulebindinfo-structure.md) instance that describes the requested module's , assembly, and module name. + + `pdwModuleId` + [out] A pointer to a unique identifier for the `IStream` containing the loaded module. + + `ppStmModuleImage` + [out] A pointer to the address of an `IStream` object, which contains the portable executable (PE) image to be loaded, or null if the module could not be found. + + `ppStmPDB` + [out] A pointer to the address of an `IStream` object, which contains the program debug (PDB) information for the requested module, or null if the .pdb file could not be found. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`ProvideModule` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|COR_E_FILENOTFOUND (0x80070002)|The requested assembly or linked resource could not be located.| +|E_NOT_SUFFICIENT_BUFFER|`pdwModuleId` is not large enough to contain the identifier that the host wants to return.| + +## Remarks + + The identity value returned for `pdwModuleId` is specified by the host. Identifiers must be unique within the lifetime of a process. The CLR uses this value as the unique identifier for the associated stream. It checks each value against the values for `pAssemblyId` returned by calls to [ProvideAssembly](ihostassemblystore-provideassembly-method.md) and against the values for `pdwModuleId` returned by other calls to `ProvideModule`. If the host returns the same identifier value for another `IStream`, the CLR checks whether the contents of that stream have already been mapped. If so, the CLR loads the existing copy of the image instead of mapping a new one. Therefore, the identifier must also not overlap with the assembly identifiers returned from `ProvideAssembly`. + +## 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 - [ICLRAssemblyReferenceList Interface](iclrassemblyreferencelist-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostautoevent-interface.md b/docs/framework/unmanaged-api/hosting/ihostautoevent-interface.md similarity index 55% rename from docs/core/unmanaged-api/hosting/ihostautoevent-interface.md rename to docs/framework/unmanaged-api/hosting/ihostautoevent-interface.md index bb5829d876f4b..d18fd4787a87b 100644 --- a/docs/core/unmanaged-api/hosting/ihostautoevent-interface.md +++ b/docs/framework/unmanaged-api/hosting/ihostautoevent-interface.md @@ -2,40 +2,41 @@ description: "Learn more about: IHostAutoEvent Interface" title: "IHostAutoEvent Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostAutoEvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostAutoEvent" -helpviewer_keywords: +helpviewer_keywords: - "IHostAutoEvent interface [.NET Framework hosting]" -topic_type: +ms.assetid: 6c1d15c1-a80a-4ee9-b1e4-6e859db6575a +topic_type: - "apiref" --- # IHostAutoEvent Interface -Provides a representation of the host's implementation of an auto-reset event. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Set Method](ihostautoevent-set-method.md)|Sets the current `IHostAutoEvent` instance to a signaled state.| -|[Wait Method](ihostautoevent-wait-method.md)|Causes the current `IHostAutoEvent` instance to wait until the event is owned or a specified amount of time elapses.| - -## 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 2.0 - +Provides a representation of the host's implementation of an auto-reset event. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Set Method](ihostautoevent-set-method.md)|Sets the current `IHostAutoEvent` instance to a signaled state.| +|[Wait Method](ihostautoevent-wait-method.md)|Causes the current `IHostAutoEvent` instance to wait until the event is owned or a specified amount of time elapses.| + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md b/docs/framework/unmanaged-api/hosting/ihostautoevent-set-method.md similarity index 56% rename from docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md rename to docs/framework/unmanaged-api/hosting/ihostautoevent-set-method.md index e683e1c6e5850..37520563497ee 100644 --- a/docs/core/unmanaged-api/hosting/ihostautoevent-set-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostautoevent-set-method.md @@ -2,51 +2,52 @@ description: "Learn more about: IHostAutoEvent::Set Method" title: "IHostAutoEvent::Set Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostAutoEvent.Set" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostAutoEvent::Set" -helpviewer_keywords: +helpviewer_keywords: - "Set method, IHostAutoEvent interface [.NET Framework hosting]" - "IHostAutoEvent::Set method [.NET Framework hosting]" -topic_type: +ms.assetid: 46becf3e-bc0e-4338-85c0-9ab0df76a1d0 +topic_type: - "apiref" --- # IHostAutoEvent::Set Method -Sets the current [IHostAutoEvent](ihostautoevent-interface.md) instance to a signaled state. - -## Syntax - -```cpp -HRESULT Set (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Set` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## 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 2.0 - +Sets the current [IHostAutoEvent](ihostautoevent-interface.md) instance to a signaled state. + +## Syntax + +```cpp +HRESULT Set (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Set` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md b/docs/framework/unmanaged-api/hosting/ihostautoevent-wait-method.md similarity index 60% rename from docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md rename to docs/framework/unmanaged-api/hosting/ihostautoevent-wait-method.md index aba7bae829da3..3e778393d15c9 100644 --- a/docs/core/unmanaged-api/hosting/ihostautoevent-wait-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostautoevent-wait-method.md @@ -2,63 +2,64 @@ description: "Learn more about: IHostAutoEvent::Wait Method" title: "IHostAutoEvent::Wait Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostAutoEvent.Wait" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostAutoEvent::Wait" -helpviewer_keywords: +helpviewer_keywords: - "Wait method, IHostAutoEvent interface [.NET Framework hosting]" - "IHostAutoEvent::Wait method [.NET Framework hosting]" -topic_type: +ms.assetid: 535d51c5-9112-401b-8c36-85f35d7ee609 +topic_type: - "apiref" --- # IHostAutoEvent::Wait Method -Causes the current [IHostAutoEvent](ihostautoevent-interface.md) instance to wait until it is owned or a specified amount of time elapses. +Causes the current [IHostAutoEvent](ihostautoevent-interface.md) instance to wait until it is owned or a specified amount of time elapses. + +## Syntax + +```cpp +HRESULT Wait ( + [in] DWORD dwMilliseconds, + [in] DWORD option +); +``` + +## Parameters -## Syntax - -```cpp -HRESULT Wait ( - [in] DWORD dwMilliseconds, - [in] DWORD option -); -``` - -## Parameters - - `dwMilliseconds` - [in] The number of milliseconds the current `IHostAutoEvent` instance should wait before returning, if no thread or fiber takes ownership. - - `option` - [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values, specifying the action the host should take if this operation blocks. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Wait` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|HOST_E_DEADLOCK|The host detected a deadlock during the wait interval, and chose the event represented by the current `IHostAutoEvent` instance as the deadlock victim.| - -## 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 2.0 + `dwMilliseconds` + [in] The number of milliseconds the current `IHostAutoEvent` instance should wait before returning, if no thread or fiber takes ownership. + + `option` + [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values, specifying the action the host should take if this operation blocks. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Wait` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|HOST_E_DEADLOCK|The host detected a deadlock during the wait interval, and chose the event represented by the current `IHostAutoEvent` instance as the deadlock victim.| + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md b/docs/framework/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md new file mode 100644 index 0000000000000..69c01420bbbd6 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/ihostcontrol-gethostmanager-method.md @@ -0,0 +1,92 @@ +--- +description: "Learn more about: IHostControl::GetHostManager Method" +title: "IHostControl::GetHostManager Method" +ms.date: "03/30/2017" +api_name: + - "IHostControl.GetHostManager" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IHostControl::GetHostManager" +helpviewer_keywords: + - "GetHostManager method [.NET Framework hosting]" + - "IHostControl::GetHostManager method [.NET Framework hosting]" +ms.assetid: 0fa34bca-ed18-4626-9e78-d33684d18edb +topic_type: + - "apiref" +--- +# IHostControl::GetHostManager Method + +Gets an interface pointer to the host's implementation of the interface with the specified `IID`. + +## Syntax + +```cpp +HRESULT GetHostManager ( + [in] REFIID riid, + [out, iid_is(riid)] void** ppObject +); +``` + +## Parameters + + `riid` + [in] The `IID` of the interface that the common language runtime (CLR) is querying for. + + `ppObject` + [out] A pointer to the host-implemented interface, or null if the host does not support this interface. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetHostManager` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_INVALIDARG|The requested `IID` is not valid.| +|E_NOINTERFACE|The requested interface is not supported.| + +## Remarks + + The CLR queries the host to determine whether it supports one or more of the following interfaces: + +- [IHostMemoryManager](ihostmemorymanager-interface.md) + +- [IHostTaskManager](ihosttaskmanager-interface.md) + +- [IHostThreadPoolManager](ihostthreadpoolmanager-interface.md) + +- [IHostIoCompletionManager](ihostiocompletionmanager-interface.md) + +- [IHostSyncManager](ihostsyncmanager-interface.md) + +- [IHostAssemblyManager](ihostassemblymanager-interface.md) + +- [IHostGCManager](ihostgcmanager-interface.md) + +- [IHostPolicyManager](ihostpolicymanager-interface.md) + +- [IHostSecurityManager](ihostsecuritymanager-interface.md) + + If the host supports the specified interface, it sets `ppObject` to its implementation of that interface. Otherwise, it sets `ppObject` to null. + + The CLR does not call `Release` on host managers, even when you shut it down. + +## 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 + +- [IHostControl Interface](ihostcontrol-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostcontrol-interface.md b/docs/framework/unmanaged-api/hosting/ihostcontrol-interface.md similarity index 55% rename from docs/core/unmanaged-api/hosting/ihostcontrol-interface.md rename to docs/framework/unmanaged-api/hosting/ihostcontrol-interface.md index e54bb3744423b..a2b19c1a21aa9 100644 --- a/docs/core/unmanaged-api/hosting/ihostcontrol-interface.md +++ b/docs/framework/unmanaged-api/hosting/ihostcontrol-interface.md @@ -2,40 +2,41 @@ description: "Learn more about: IHostControl Interface" title: "IHostControl Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostControl" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostControl" -helpviewer_keywords: +helpviewer_keywords: - "IHostControl interface [.NET Framework hosting]" -topic_type: +ms.assetid: a4ae0d1f-ade9-4b0a-a122-93ed11a5e6b3 +topic_type: - "apiref" --- # IHostControl Interface -Provides methods for configuring the loading of assemblies, and for determining which hosting interfaces the host supports. - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetHostManager Method](ihostcontrol-gethostmanager-method.md)|Gets an interface pointer to the host's implementation of the interface with the specified `IID`.| -|[SetAppDomainManager Method](ihostcontrol-setappdomainmanager-method.md)|Notifies the host that an application domain has been created.| - -## 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 2.0 - +Provides methods for configuring the loading of assemblies, and for determining which hosting interfaces the host supports. + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetHostManager Method](ihostcontrol-gethostmanager-method.md)|Gets an interface pointer to the host's implementation of the interface with the specified `IID`.| +|[SetAppDomainManager Method](ihostcontrol-setappdomainmanager-method.md)|Notifies the host that an application domain has been created.| + +## 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 - diff --git a/docs/core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md b/docs/framework/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md rename to docs/framework/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md index fd06113742447..bc49dd1a2a6e6 100644 --- a/docs/core/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostcontrol-setappdomainmanager-method.md @@ -2,68 +2,69 @@ description: "Learn more about: IHostControl::SetAppDomainManager Method" title: "IHostControl::SetAppDomainManager Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostControl.SetAppDomainManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostControl::SetAppDomainManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostControl::SetAppDomainManager method [.NET Framework hosting]" - "SetAppDomainManager method [.NET Framework hosting]" -topic_type: +ms.assetid: 6562bbe7-0d67-4c50-a958-3a18cf680375 +topic_type: - "apiref" --- # IHostControl::SetAppDomainManager Method -Notifies the host that an application domain has been created. - -## Syntax - -```cpp -HRESULT SetAppDomainManager ( - [in] DWORD dwAppDomainID, - [in] IUnknown* pUnkAppDomainManager -); -``` - -## Parameters - - `dwAppDomainID` - [in] The numeric identifier of the selected . - - `pUnkAppDomainManager` - [in] A pointer to the object that the host implements as `IUnknown`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetAppDomainManager` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The provides the host with a mechanism to bootstrap into managed code and to control the creation and settings of each . The is loaded into each when that is created. If it chooses, the CLR notifies the host that the application domain has been created by setting the value of the `pUnkAppDomainManager` parameter. - - In its implementation of the `SetAppDomainManager` method, the host can set the assembly name and type for the application domain manager. - -## 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 2.0 - +Notifies the host that an application domain has been created. + +## Syntax + +```cpp +HRESULT SetAppDomainManager ( + [in] DWORD dwAppDomainID, + [in] IUnknown* pUnkAppDomainManager +); +``` + +## Parameters + + `dwAppDomainID` + [in] The numeric identifier of the selected . + + `pUnkAppDomainManager` + [in] A pointer to the object that the host implements as `IUnknown`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetAppDomainManager` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The provides the host with a mechanism to bootstrap into managed code and to control the creation and settings of each . The is loaded into each when that is created. If it chooses, the CLR notifies the host that the application domain has been created by setting the value of the `pUnkAppDomainManager` parameter. + + In its implementation of the `SetAppDomainManager` method, the host can set the assembly name and type for the application domain manager. + +## 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 - diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md b/docs/framework/unmanaged-api/hosting/ihostcrst-enter-method.md similarity index 53% rename from docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md rename to docs/framework/unmanaged-api/hosting/ihostcrst-enter-method.md index 06601df34fb6b..4d702cdb023b1 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-enter-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostcrst-enter-method.md @@ -2,65 +2,66 @@ description: "Learn more about: IHostCrst::Enter Method" title: "IHostCrst::Enter Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostCrst.Enter" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostCrst::Enter" -helpviewer_keywords: +helpviewer_keywords: - "Enter method [.NET Framework hosting]" - "IHostCrst::Enter method [.NET Framework hosting]" -topic_type: +ms.assetid: 100dd7eb-7053-4295-9bb3-32ba47f6ec79 +topic_type: - "apiref" --- # IHostCrst::Enter Method -Enters the critical section that is represented by the current [IHostCrst](ihostcrst-interface.md) instance. - -## Syntax - -```cpp -HRESULT Enter ( - [in] DWORD option -); -``` - -## Parameters - - `option` - [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values, indicating what action the host should take if the operation blocks. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Enter` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `Enter` mirrors the Win32 `EnterCriticalSection` function. - +Enters the critical section that is represented by the current [IHostCrst](ihostcrst-interface.md) instance. + +## Syntax + +```cpp +HRESULT Enter ( + [in] DWORD option +); +``` + +## Parameters + + `option` + [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values, indicating what action the host should take if the operation blocks. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Enter` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `Enter` mirrors the Win32 `EnterCriticalSection` function. + > [!NOTE] -> This method does not return until the critical section is entered. - -## 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 2.0 - +> This method does not return until the critical section is entered. + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-interface.md b/docs/framework/unmanaged-api/hosting/ihostcrst-interface.md similarity index 60% rename from docs/core/unmanaged-api/hosting/ihostcrst-interface.md rename to docs/framework/unmanaged-api/hosting/ihostcrst-interface.md index 93f590c91fb0d..bbab0ccc50f8d 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-interface.md +++ b/docs/framework/unmanaged-api/hosting/ihostcrst-interface.md @@ -2,46 +2,47 @@ description: "Learn more about: IHostCrst Interface" title: "IHostCrst Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostCrst" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostCrst" -helpviewer_keywords: +helpviewer_keywords: - "IHostCrst interface [.NET Framework hosting]" -topic_type: +ms.assetid: ac298ebd-0815-47e4-a823-30b31baab903 +topic_type: - "apiref" --- # IHostCrst Interface -Serves as the host's representation of a critical section for threading. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Enter Method](ihostcrst-enter-method.md)|Enters the critical section.| -|[Leave Method](ihostcrst-leave-method.md)|Leaves the critical section.| -|[SetSpinCount Method](ihostcrst-setspincount-method.md)|Sets the spin count for the critical section.| -|[TryEnter Method](ihostcrst-tryenter-method.md)|Attempts to enter the critical section, and reports success or failure immediately.| - -## Remarks - - `IHostCrst` allows the common language runtime (CLR) to communicate directly with the host's representation of a critical section, rather than using Win32 functions such as `EnterCriticalSection` or `LeaveCriticalSection`. - -## 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 2.0 - +Serves as the host's representation of a critical section for threading. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Enter Method](ihostcrst-enter-method.md)|Enters the critical section.| +|[Leave Method](ihostcrst-leave-method.md)|Leaves the critical section.| +|[SetSpinCount Method](ihostcrst-setspincount-method.md)|Sets the spin count for the critical section.| +|[TryEnter Method](ihostcrst-tryenter-method.md)|Attempts to enter the critical section, and reports success or failure immediately.| + +## Remarks + + `IHostCrst` allows the common language runtime (CLR) to communicate directly with the host's representation of a critical section, rather than using Win32 functions such as `EnterCriticalSection` or `LeaveCriticalSection`. + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md b/docs/framework/unmanaged-api/hosting/ihostcrst-leave-method.md similarity index 58% rename from docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md rename to docs/framework/unmanaged-api/hosting/ihostcrst-leave-method.md index 719c66f6bd3ae..4c03044fa5b32 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-leave-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostcrst-leave-method.md @@ -2,55 +2,56 @@ description: "Learn more about: IHostCrst::Leave Method" title: "IHostCrst::Leave Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostCrst.Leave" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostCrst::Leave" -helpviewer_keywords: +helpviewer_keywords: - "IHostCrst::Leave method [.NET Framework hosting]" - "Leave method [.NET Framework hosting]" -topic_type: +ms.assetid: dfc51d9e-b36d-4dba-9ea1-4f63fa0601ae +topic_type: - "apiref" --- # IHostCrst::Leave Method -Leaves the critical section that is represented by the current instance of [IHostCrst](ihostcrst-interface.md). - -## Syntax - -```cpp -HRESULT Leave (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Leave` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `Leave` allows the CLR to communicate directly with the host's threading implementation, rather than using the corresponding Win32 `LeaveCriticalSection` function. A thread that takes ownership of the critical section represented by the current `IHostCrst` instance must call `Leave` once for each time it enters that critical section. - -## 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 2.0 - +Leaves the critical section that is represented by the current instance of [IHostCrst](ihostcrst-interface.md). + +## Syntax + +```cpp +HRESULT Leave (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Leave` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `Leave` allows the CLR to communicate directly with the host's threading implementation, rather than using the corresponding Win32 `LeaveCriticalSection` function. A thread that takes ownership of the critical section represented by the current `IHostCrst` instance must call `Leave` once for each time it enters that critical section. + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-setspincount-method.md b/docs/framework/unmanaged-api/hosting/ihostcrst-setspincount-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/ihostcrst-setspincount-method.md rename to docs/framework/unmanaged-api/hosting/ihostcrst-setspincount-method.md index 2e2b9f6d55b05..968c65df2f404 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-setspincount-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostcrst-setspincount-method.md @@ -2,64 +2,65 @@ description: "Learn more about: IHostCrst::SetSpinCount Method" title: "IHostCrst::SetSpinCount Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostCrst.SetSpinCount" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostCrst::SetSpinCount" -helpviewer_keywords: +helpviewer_keywords: - "IHostCrst::SetSpinCount method [.NET Framework hosting]" - "SetSpinCount method [.NET Framework hosting]" -topic_type: +ms.assetid: 863fc8ce-9b8a-477e-8dd8-75c8544bb43a +topic_type: - "apiref" --- # IHostCrst::SetSpinCount Method -Sets the spin count for the current [IHostCrst](ihostcrst-interface.md) instance. - -## Syntax - -```cpp -HRESULT SetSpinCount ( - [in] DWORD dwSpinCount -); -``` - -## Parameters - - `dwSpinCount` - [in] The new spin count for the current `IHostCrst` instance. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetSpinCount` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - On multi-processor systems, if the critical section represented by the current `IHostCrst` instance is unavailable, a calling thread spins `dwSpinCount` times before calling [IHostSemaphore::Wait](ihostsemaphore-wait-method.md) on a semaphore associated with the critical section. If the critical section becomes free during the spin operation, the calling thread avoids the wait operation. - - The usage of `dwSpinCount` is identical to the usage of the parameter of the same name in the Win32 `InitializeCriticalSectionAndSpinCount` function. - -## 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 2.0 - +Sets the spin count for the current [IHostCrst](ihostcrst-interface.md) instance. + +## Syntax + +```cpp +HRESULT SetSpinCount ( + [in] DWORD dwSpinCount +); +``` + +## Parameters + + `dwSpinCount` + [in] The new spin count for the current `IHostCrst` instance. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetSpinCount` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + On multi-processor systems, if the critical section represented by the current `IHostCrst` instance is unavailable, a calling thread spins `dwSpinCount` times before calling [IHostSemaphore::Wait](ihostsemaphore-wait-method.md) on a semaphore associated with the critical section. If the critical section becomes free during the spin operation, the calling thread avoids the wait operation. + + The usage of `dwSpinCount` is identical to the usage of the parameter of the same name in the Win32 `InitializeCriticalSectionAndSpinCount` function. + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md b/docs/framework/unmanaged-api/hosting/ihostcrst-tryenter-method.md similarity index 55% rename from docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md rename to docs/framework/unmanaged-api/hosting/ihostcrst-tryenter-method.md index ad1a8de192155..882a9bf13dc82 100644 --- a/docs/core/unmanaged-api/hosting/ihostcrst-tryenter-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostcrst-tryenter-method.md @@ -2,66 +2,67 @@ description: "Learn more about: IHostCrst::TryEnter Method" title: "IHostCrst::TryEnter Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostCrst.TryEnter" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostCrst::TryEnter" -helpviewer_keywords: +helpviewer_keywords: - "IHostCrst::TryEnter method [.NET Framework hosting]" - "TryEnter method [.NET Framework hosting]" -topic_type: +ms.assetid: a922fa98-beab-4f09-a342-cc94fc65687f +topic_type: - "apiref" --- # IHostCrst::TryEnter Method -Attempts to enter the critical section represented by the current [IHostCrst](ihostcrst-interface.md) instance. - -## Syntax - -```cpp -HRESULT TryEnter ( - [in] DWORD option, - [out] BOOL *pbSucceeded -); -``` - -## Parameters - - `option` - [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values, indicating what action the host should take if the operation blocks. - - `pbSucceeded` - [out] `true` if the critical section can be entered; otherwise, `false`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`TryEnter` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `TryEnter` returns immediately and indicates whether the calling thread entered the critical section. This method mirrors the Wind32 `TryEnterCriticalSection` function. - -## 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 2.0 - +Attempts to enter the critical section represented by the current [IHostCrst](ihostcrst-interface.md) instance. + +## Syntax + +```cpp +HRESULT TryEnter ( + [in] DWORD option, + [out] BOOL *pbSucceeded +); +``` + +## Parameters + + `option` + [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values, indicating what action the host should take if the operation blocks. + + `pbSucceeded` + [out] `true` if the critical section can be entered; otherwise, `false`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`TryEnter` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `TryEnter` returns immediately and indicates whether the calling thread entered the critical section. This method mirrors the Wind32 `TryEnterCriticalSection` function. + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md b/docs/framework/unmanaged-api/hosting/ihostgcmanager-interface.md similarity index 66% rename from docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md rename to docs/framework/unmanaged-api/hosting/ihostgcmanager-interface.md index 0a7627dd281eb..01cba1fee02e1 100644 --- a/docs/core/unmanaged-api/hosting/ihostgcmanager-interface.md +++ b/docs/framework/unmanaged-api/hosting/ihostgcmanager-interface.md @@ -2,41 +2,42 @@ description: "Learn more about: IHostGCManager Interface" title: "IHostGCManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostGCManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostGCManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostGCManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: 820330a4-244c-4f67-ab5e-f24b0b3c2080 +topic_type: - "apiref" --- # IHostGCManager Interface -Provides methods that notify the host of events in the garbage collection mechanism implemented by the common language runtime (CLR). - -## Members - -|Member|Description| -|------------|-----------------| -|[SuspensionEnding Method](ihostgcmanager-suspensionending-method.md)|Notifies the host that the CLR is resuming execution of tasks on threads that had been suspended for a garbage collection.| -|[SuspensionStarting Method](ihostgcmanager-suspensionstarting-method.md)|Notifies the host that the CLR is suspending execution of tasks, to perform a garbage collection.| -|[ThreadIsBlockingForSuspension Method](ihostgcmanager-threadisblockingforsuspension-method.md)|Notifies the host that the thread from which the method call was made is about to block for a garbage collection.| - -## 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 2.0 - +Provides methods that notify the host of events in the garbage collection mechanism implemented by the common language runtime (CLR). + +## Members + +|Member|Description| +|------------|-----------------| +|[SuspensionEnding Method](ihostgcmanager-suspensionending-method.md)|Notifies the host that the CLR is resuming execution of tasks on threads that had been suspended for a garbage collection.| +|[SuspensionStarting Method](ihostgcmanager-suspensionstarting-method.md)|Notifies the host that the CLR is suspending execution of tasks, to perform a garbage collection.| +|[ThreadIsBlockingForSuspension Method](ihostgcmanager-threadisblockingforsuspension-method.md)|Notifies the host that the thread from which the method call was made is about to block for a garbage collection.| + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md b/docs/framework/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md similarity index 58% rename from docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md rename to docs/framework/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md index ed4107a46e951..e0e4ec6ca0233 100644 --- a/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostgcmanager-suspensionending-method.md @@ -2,65 +2,66 @@ description: "Learn more about: IHostGCManager::SuspensionEnding Method" title: "IHostGCManager::SuspensionEnding Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostGCManager.SuspensionEnding" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostGCManager::SuspensionEnding" -helpviewer_keywords: +helpviewer_keywords: - "SuspensionEnding method, IHostGCManager interface [.NET Framework hosting]" - "IHostGCManager::SuspensionEnding method [.NET Framework hosting]" -topic_type: +ms.assetid: 8849a1db-17f0-44b7-880a-bd36d431eb91 +topic_type: - "apiref" --- # IHostGCManager::SuspensionEnding Method -Notifies the host that the common language runtime (CLR) is resuming execution of tasks on threads that had been suspended for a garbage collection. - -## Syntax - -```cpp -HRESULT SuspensionEnding ( - [in] DWORD generation -); -``` - -## Parameters - - `generation` - [in] The garbage collection generation that is just finishing, from which the thread is resuming. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SuspensionEnding` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR calls `SuspensionEnding` after it performs a garbage collection, to inform the host that the thread is resuming execution. - +Notifies the host that the common language runtime (CLR) is resuming execution of tasks on threads that had been suspended for a garbage collection. + +## Syntax + +```cpp +HRESULT SuspensionEnding ( + [in] DWORD generation +); +``` + +## Parameters + + `generation` + [in] The garbage collection generation that is just finishing, from which the thread is resuming. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SuspensionEnding` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR calls `SuspensionEnding` after it performs a garbage collection, to inform the host that the thread is resuming execution. + > [!IMPORTANT] -> Do not reschedule the thread the method call was made from. - -## 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 2.0 - +> Do not reschedule the thread the method call was made from. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md b/docs/framework/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md rename to docs/framework/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md index 8cfa77bcf376a..1595c0add386f 100644 --- a/docs/core/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostgcmanager-suspensionstarting-method.md @@ -2,58 +2,59 @@ description: "Learn more about: IHostGCManager::SuspensionStarting Method" title: "IHostGCManager::SuspensionStarting Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostGCManager.SuspensionStarting" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostGCManager::SuspensionStarting" -helpviewer_keywords: +helpviewer_keywords: - "SuspensionStarting method, IHostGCManager interface [.NET Framework hosting]" - "IHostGCManager::SuspensionStarting method [.NET Framework hosting]" -topic_type: +ms.assetid: c381f524-94cf-4fa2-9298-50f847a03431 +topic_type: - "apiref" --- # IHostGCManager::SuspensionStarting Method -Notifies the host that the common language runtime (CLR) is suspending execution of tasks, to perform a garbage collection. - -## Syntax - -```cpp -HRESULT SuspensionStarting (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SuspensionStarting` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR calls `SuspensionStarting` to inform the host that garbage collection is occurring. +Notifies the host that the common language runtime (CLR) is suspending execution of tasks, to perform a garbage collection. + +## Syntax + +```cpp +HRESULT SuspensionStarting (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SuspensionStarting` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + The CLR calls `SuspensionStarting` to inform the host that garbage collection is occurring. + > [!IMPORTANT] -> Do not reschedule this task. The host must reschedule a task when [ThreadIsBlockingForSuspension](ihostgcmanager-threadisblockingforsuspension-method.md) is called. - -## 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 2.0 +> Do not reschedule this task. The host must reschedule a task when [ThreadIsBlockingForSuspension](ihostgcmanager-threadisblockingforsuspension-method.md) is called. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md b/docs/framework/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md similarity index 61% rename from docs/core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md rename to docs/framework/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md index 4aac5bf367bc7..8b0420b788712 100644 --- a/docs/core/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostgcmanager-threadisblockingforsuspension-method.md @@ -2,58 +2,59 @@ description: "Learn more about: IHostGCManager::ThreadIsBlockingForSuspension Method" title: "IHostGCManager::ThreadIsBlockingForSuspension Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostGCManager.ThreadIsBlockingForSuspension" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostGCManager::ThreadIsBlockingForSuspension" -helpviewer_keywords: +helpviewer_keywords: - "IHostGCManager::ThreadIsBlockingForSuspension method [.NET Framework hosting]" - "ThreadIsBlockingForSuspension method [.NET Framework hosting]" -topic_type: +ms.assetid: 2657d45d-26d2-4d0a-8473-32b652e3321d +topic_type: - "apiref" --- # IHostGCManager::ThreadIsBlockingForSuspension Method -Notifies the host that the thread from which the method call was made is about to block for a garbage collection. - -## Syntax - -```cpp -HRESULT ThreadIsBlockingForSuspension (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`ThreadIsBlockingForSuspension` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR typically calls the `ThreadIsBlockForSuspension` method in preparation for a garbage collection, to give the host an opportunity to reschedule the thread for unmanaged tasks. +Notifies the host that the thread from which the method call was made is about to block for a garbage collection. + +## Syntax + +```cpp +HRESULT ThreadIsBlockingForSuspension (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`ThreadIsBlockingForSuspension` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + The CLR typically calls the `ThreadIsBlockForSuspension` method in preparation for a garbage collection, to give the host an opportunity to reschedule the thread for unmanaged tasks. + > [!IMPORTANT] -> The host can reschedule tasks only after a call to `ThreadIsBlockingForSuspension`. After the runtime calls [SuspensionStarting](ihostgcmanager-suspensionstarting-method.md), the host must not reschedule a task. - -## 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 2.0 +> The host can reschedule tasks only after a call to `ThreadIsBlockingForSuspension`. After the runtime calls [SuspensionStarting](ihostgcmanager-suspensionstarting-method.md), the host must not reschedule a task. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md similarity index 56% rename from docs/core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md rename to docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md index c5e7338e6a193..eb6a3c95cea8c 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-bind-method.md @@ -2,69 +2,70 @@ description: "Learn more about: IHostIoCompletionManager::Bind Method" title: "IHostIoCompletionManager::Bind Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager.Bind" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager::Bind" -helpviewer_keywords: +helpviewer_keywords: - "IHostIoCompletionManager::Bind method [.NET Framework hosting]" - "Bind method [.NET Framework hosting]" -topic_type: +ms.assetid: acd74cb5-7e22-4a07-83c3-82288e1abd9f +topic_type: - "apiref" --- # IHostIoCompletionManager::Bind Method -Binds the specified handle to an I/O completion port that has been created by an earlier call to [CreateIoCompletionPort](ihostiocompletionmanager-createiocompletionport-method.md). - -## Syntax - -```cpp -HRESULT Bind ( - [in] HANDLE hPort, - [in] HANDLE hHandle -); -``` - -## Parameters - - `hPort` - [in] The I/O completion port to which to bind `hHandle`. If the value of `hPort` is null, `hHandle` is bound to the default I/O completion port. - - `hHandle` - [in] The operating system handle to bind to `hPort`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Bind` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - An I/O completion port is created by using a call to `CreateIoCompletionPort`. The CLR calls `Bind` to bind a handle to that port. - +Binds the specified handle to an I/O completion port that has been created by an earlier call to [CreateIoCompletionPort](ihostiocompletionmanager-createiocompletionport-method.md). + +## Syntax + +```cpp +HRESULT Bind ( + [in] HANDLE hPort, + [in] HANDLE hHandle +); +``` + +## Parameters + + `hPort` + [in] The I/O completion port to which to bind `hHandle`. If the value of `hPort` is null, `hHandle` is bound to the default I/O completion port. + + `hHandle` + [in] The operating system handle to bind to `hPort`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Bind` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + An I/O completion port is created by using a call to `CreateIoCompletionPort`. The CLR calls `Bind` to bind a handle to that port. + > [!NOTE] -> When an I/O request completes, the host must call the [ICLRIoCompletionManager::OnComplete](iclriocompletionmanager-oncomplete-method.md) method. - -## 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 2.0 - +> When an I/O request completes, the host must call the [ICLRIoCompletionManager::OnComplete](iclriocompletionmanager-oncomplete-method.md) method. + +## 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 - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md similarity index 53% rename from docs/core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md rename to docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md index cb46d64c9795e..e449235c0ac07 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-closeiocompletionport-method.md @@ -2,63 +2,64 @@ description: "Learn more about: IHostIoCompletionManager::CloseIoCompletionPort Method" title: "IHostIoCompletionManager::CloseIoCompletionPort Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager.CloseIoCompletionPort" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager::CloseIoCompletionPort" -helpviewer_keywords: +helpviewer_keywords: - "IHostIoCompletionManager::CloseIoCompletionPort method [.NET Framework hosting]" - "CloseIoCompletionPort method [.NET Framework hosting]" -topic_type: +ms.assetid: e86ad7be-3758-498a-a972-5522d69dfbb3 +topic_type: - "apiref" --- # IHostIoCompletionManager::CloseIoCompletionPort Method -Requests that the host close a port that was opened through an earlier call to [CreateIoCompletionPort](ihostiocompletionmanager-createiocompletionport-method.md). - -## Syntax - -```cpp -HRESULT CloseIoCompletionPort ( - [in] HANDLE hPort -); -``` - -## Parameters - - `hPort` - [in] The handle of the port to close. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CloseIoCompletionPort` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_INVALIDARG|An invalid port handle was passed.| - -## Remarks - - `hPort` must be a handle to a port that was created by an earlier call to `CreateIoCompletionPort`. - -## 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 2.0 - +Requests that the host close a port that was opened through an earlier call to [CreateIoCompletionPort](ihostiocompletionmanager-createiocompletionport-method.md). + +## Syntax + +```cpp +HRESULT CloseIoCompletionPort ( + [in] HANDLE hPort +); +``` + +## Parameters + + `hPort` + [in] The handle of the port to close. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CloseIoCompletionPort` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_INVALIDARG|An invalid port handle was passed.| + +## Remarks + + `hPort` must be a handle to a port that was created by an earlier call to `CreateIoCompletionPort`. + +## 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 - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md similarity index 60% rename from docs/core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md rename to docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md index 02558515e6933..cd4f5e905648c 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-createiocompletionport-method.md @@ -2,63 +2,64 @@ description: "Learn more about: IHostIoCompletionManager::CreateIoCompletionPort Method" title: "IHostIoCompletionManager::CreateIoCompletionPort Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager.CreateIoCompletionPort" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager::CreateIoCompletionPort" -helpviewer_keywords: +helpviewer_keywords: - "IHostIoCompletionManager::CreateIoCompletionPort method [.NET Framework hosting]" - "CreateIoCompletionPort method [.NET Framework hosting]" -topic_type: +ms.assetid: 907a2b43-68db-44a7-acac-89e792e7bb3c +topic_type: - "apiref" --- # IHostIoCompletionManager::CreateIoCompletionPort Method -Requests that the host create a new I/O completion port. - -## Syntax - -```cpp -HRESULT CreateIoCompletionPort ( - [out] HANDLE *phPort -); -``` - -## Parameters - - `phPort` - [out] A pointer to a handle to the newly created I/O completion port, or 0 (zero), if the port could not be created. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateIoCompletionPort` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to allocate the requested resource.| - -## Remarks - - The CLR calls the `CreateIoCompletionPort` method to request that the host create a new I/O completion port. It binds I/O operations to this port through a call to the [IHostIoCompletionManager::Bind](ihostiocompletionmanager-bind-method.md) method. The host reports status back to the CLR by calling [ICLRIoCompletionManager::OnComplete](iclriocompletionmanager-oncomplete-method.md). - -## 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 2.0 - +Requests that the host create a new I/O completion port. + +## Syntax + +```cpp +HRESULT CreateIoCompletionPort ( + [out] HANDLE *phPort +); +``` + +## Parameters + + `phPort` + [out] A pointer to a handle to the newly created I/O completion port, or 0 (zero), if the port could not be created. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateIoCompletionPort` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to allocate the requested resource.| + +## Remarks + + The CLR calls the `CreateIoCompletionPort` method to request that the host create a new I/O completion port. It binds I/O operations to this port through a call to the [IHostIoCompletionManager::Bind](ihostiocompletionmanager-bind-method.md) method. The host reports status back to the CLR by calling [ICLRIoCompletionManager::OnComplete](iclriocompletionmanager-oncomplete-method.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 - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md rename to docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md index 5d4e7176848d9..d4be50962f0e4 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-getavailablethreads-method.md @@ -2,63 +2,64 @@ description: "Learn more about: IHostIoCompletionManager::GetAvailableThreads Method" title: "IHostIoCompletionManager::GetAvailableThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager.GetAvailableThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager::GetAvailableThreads" -helpviewer_keywords: +helpviewer_keywords: - "GetAvailableThreads method, IHostIoCompletionManager interface [.NET Framework hosting]" - "IHostIoCompletionManager::GetAvailableThreads method [.NET Framework hosting]" -topic_type: +ms.assetid: bab363d1-b859-47a4-9884-5661c611cce7 +topic_type: - "apiref" --- # IHostIoCompletionManager::GetAvailableThreads Method -Gets the number of I/O completion threads, of the total number of threads managed by the host, that are not currently servicing requests. - -## Syntax - -```cpp -HRESULT GetAvailableThreads ( - [out] DWORD *pdwAvailableIoCompletionThreads -); -``` - -## Parameters - - `pdwAvailableIoCompletionThreads` - [out] A pointer to the number of I/O completion threads managed by the host that are currently available to service requests. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetAvailableThreads` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not provide an implementation of `GetAvailableThreads`.| - -## Remarks - - A host might want exclusive control over the size of the I/O completion thread pool, for reasons such as implementation, performance, or scalability. Therefore, the host is not required to implement `GetAvailableThreads`. In this case, the host should return E_NOTIMPL from this method. - -## 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 2.0 - +Gets the number of I/O completion threads, of the total number of threads managed by the host, that are not currently servicing requests. + +## Syntax + +```cpp +HRESULT GetAvailableThreads ( + [out] DWORD *pdwAvailableIoCompletionThreads +); +``` + +## Parameters + + `pdwAvailableIoCompletionThreads` + [out] A pointer to the number of I/O completion threads managed by the host that are currently available to service requests. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetAvailableThreads` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not provide an implementation of `GetAvailableThreads`.| + +## Remarks + + A host might want exclusive control over the size of the I/O completion thread pool, for reasons such as implementation, performance, or scalability. Therefore, the host is not required to implement `GetAvailableThreads`. In this case, the host should return E_NOTIMPL from this method. + +## 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 - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md similarity index 65% rename from docs/core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md rename to docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md index d11d44c1e7823..a9ca204dc9863 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-gethostoverlappedsize-method.md @@ -2,72 +2,73 @@ description: "Learn more about: IHostIoCompletionManager::GetHostOverlappedSize Method" title: "IHostIoCompletionManager::GetHostOverlappedSize Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager.GetHostOverlappedSize" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager::GetHostOverlappedSize" -helpviewer_keywords: +helpviewer_keywords: - "IHostIoCompletionManager::GetHostOverlappedSize method [.NET Framework hosting]" - "GetHostOverlappedSize method [.NET Framework hosting]" -topic_type: +ms.assetid: 2902578b-d5e2-4f8d-a103-0c7b6dceda9e +topic_type: - "apiref" --- # IHostIoCompletionManager::GetHostOverlappedSize Method -Gets the size of any custom data the host intends to append to I/O requests. - -## Syntax - -```cpp -HRESULT GetHostOverlappedSize ( - [out] DWORD *pcbSize -); -``` - -## Parameters - - `pcbSize` - [out] A pointer to the number of bytes that the common language runtime (CLR) should allocate in addition to the size of the Win32 `OVERLAPPED` object. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetHostOverlappedSize` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - All asynchronous I/O calls to Windows Platform APIs take a Win32 `OVERLAPPED` object, which provides information such as the file pointer position. To maintain state, applications that make asynchronous I/O calls typically add custom data to the structure. `GetHostOverlappedSize` and [IHostIoCompletionManager::InitializeHostOverlapped](ihostiocompletionmanager-initializehostoverlapped-method.md) provide an opportunity for the host to include such custom data. - - The CLR calls the `GetHostOverlappedSize` method to determine the size of the custom data that the host intends to append to the `OVERLAPPED` object. - +Gets the size of any custom data the host intends to append to I/O requests. + +## Syntax + +```cpp +HRESULT GetHostOverlappedSize ( + [out] DWORD *pcbSize +); +``` + +## Parameters + + `pcbSize` + [out] A pointer to the number of bytes that the common language runtime (CLR) should allocate in addition to the size of the Win32 `OVERLAPPED` object. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetHostOverlappedSize` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + All asynchronous I/O calls to Windows Platform APIs take a Win32 `OVERLAPPED` object, which provides information such as the file pointer position. To maintain state, applications that make asynchronous I/O calls typically add custom data to the structure. `GetHostOverlappedSize` and [IHostIoCompletionManager::InitializeHostOverlapped](ihostiocompletionmanager-initializehostoverlapped-method.md) provide an opportunity for the host to include such custom data. + + The CLR calls the `GetHostOverlappedSize` method to determine the size of the custom data that the host intends to append to the `OVERLAPPED` object. + > [!NOTE] -> `GetHostOverlappedSize` is called only once. The host's custom data must be the same size for every I/O request. - +> `GetHostOverlappedSize` is called only once. The host's custom data must be the same size for every I/O request. + > [!IMPORTANT] -> The size of the `OVERLAPPED` object itself is not included in the value of `pcbSize`. - - For more information about the `OVERLAPPED` structure, see the Windows Platform documentation. - -## 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 2.0 - +> The size of the `OVERLAPPED` object itself is not included in the value of `pcbSize`. + + For more information about the `OVERLAPPED` structure, see the Windows Platform documentation. + +## 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 - diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md similarity index 58% rename from docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md rename to docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md index d04a09f02cab2..298d8c9154071 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-getmaxthreads-method.md @@ -2,63 +2,64 @@ description: "Learn more about: IHostIoCompletionManager::GetMaxThreads Method" title: "IHostIoCompletionManager::GetMaxThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager.GetMaxThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager::GetMaxThreads" -helpviewer_keywords: +helpviewer_keywords: - "IHostIoCompletionManager::GetMaxThreads method [.NET Framework hosting]" - "GetMaxThreads method, IHostIoCompletionManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: e7a6cadc-2433-4472-a701-58891abcde45 +topic_type: - "apiref" --- # IHostIoCompletionManager::GetMaxThreads Method -Gets the maximum number of threads that the host can allot to service I/O requests. - -## Syntax - -```cpp -HRESULT GetMaxThreads ( - [out] DWORD *pdwMaxIoCompletionThreads -); -``` - -## Parameters - - `pdwMaxIoCompletionThreads` - [out] A pointer to the maximum number of threads in the thread pool that the host can allot to service I/O requests. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetMaxThreads` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not provide an implementation of `GetMaxThreads`.| - -## Remarks - - A host might want exclusive control over the number of threads that can be allotted to process I/O requests, for reasons such as implementation, performance, or scalability. For this reason, the host is not required to implement `GetMaxThreads`. In this case, the host should return E_NOTIMPL from this method. - -## 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 2.0 - +Gets the maximum number of threads that the host can allot to service I/O requests. + +## Syntax + +```cpp +HRESULT GetMaxThreads ( + [out] DWORD *pdwMaxIoCompletionThreads +); +``` + +## Parameters + + `pdwMaxIoCompletionThreads` + [out] A pointer to the maximum number of threads in the thread pool that the host can allot to service I/O requests. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetMaxThreads` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not provide an implementation of `GetMaxThreads`.| + +## Remarks + + A host might want exclusive control over the number of threads that can be allotted to process I/O requests, for reasons such as implementation, performance, or scalability. For this reason, the host is not required to implement `GetMaxThreads`. In this case, the host should return E_NOTIMPL from this method. + +## 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 - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md similarity index 58% rename from docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md rename to docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md index 23e471bffc8ae..7faadc1b6d8a1 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-getminthreads-method.md @@ -2,63 +2,64 @@ description: "Learn more about: IHostIoCompletionManager::GetMinThreads Method" title: "IHostIoCompletionManager::GetMinThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager.GetMinThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager::GetMinThreads" -helpviewer_keywords: +helpviewer_keywords: - "GetMinThreads method, IHostIoCompletionManager interface [.NET Framework hosting]" - "IHostIoCompletionManager::GetMinThreads method [.NET Framework hosting]" -topic_type: +ms.assetid: d7a7f733-677d-481c-b3d5-444fcc502b8e +topic_type: - "apiref" --- # IHostIoCompletionManager::GetMinThreads Method -Gets the minimum number of threads that the host provides for processing I/O requests. - -## Syntax - -```cpp -HRESULT GetMinThreads ( - [out] DWORD *pdwMinIOCompletionThreads -); -``` - -## Parameters - - `pdwMinIOCompletionThreads` - [out] A pointer to the minimum number of threads that the host provides to process I/O requests. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetMinThreads` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not provide an implementation of `GetMinThreads`.| - -## Remarks - - A host might want exclusive control over the number of threads allotted to service I/O requests, for reasons such as implementation, performance, or scalability. For this reason, the host is not required to implement `GetMinThreads`. In this case, the host should return E_NOTIMPL from this method. - -## 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 2.0 - +Gets the minimum number of threads that the host provides for processing I/O requests. + +## Syntax + +```cpp +HRESULT GetMinThreads ( + [out] DWORD *pdwMinIOCompletionThreads +); +``` + +## Parameters + + `pdwMinIOCompletionThreads` + [out] A pointer to the minimum number of threads that the host provides to process I/O requests. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetMinThreads` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not provide an implementation of `GetMinThreads`.| + +## Remarks + + A host might want exclusive control over the number of threads allotted to service I/O requests, for reasons such as implementation, performance, or scalability. For this reason, the host is not required to implement `GetMinThreads`. In this case, the host should return E_NOTIMPL from this method. + +## 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 - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md similarity index 62% rename from docs/core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md rename to docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md index 8ccc34344d808..fdb92967fe625 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-initializehostoverlapped-method.md @@ -2,68 +2,69 @@ description: "Learn more about: IHostIoCompletionManager::InitializeHostOverlapped Method" title: "IHostIoCompletionManager::InitializeHostOverlapped Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager.InitializeHostOverlapped" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager::InitializeHostOverlapped" -helpviewer_keywords: +helpviewer_keywords: - "IHostIoCompletionManager::InitializeHostOverlapped method [.NET Framework hosting]" - "InitializeHostOverlapped method [.NET Framework hosting]" -topic_type: +ms.assetid: c35199bf-bc47-4901-b467-4e8a37644bbb +topic_type: - "apiref" --- # IHostIoCompletionManager::InitializeHostOverlapped Method -Provides the host with an opportunity to initialize any custom data to append to a Win32 `OVERLAPPED` structure that is used for asynchronous I/O requests. - -## Syntax - -```cpp -HRESULT InitializeHostOverlapped ( - [in] void* pvOverlapped -); -``` - -## Parameters - - `pvOverlapped` - [in] A pointer to the Win32 `OVERLAPPED` structure to be included with the I/O request. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`InitializeHostOverlapped` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to allocate the requested resource.| - -## Remarks - - The Windows Platform functions use the `OVERLAPPED` structure to store state for asynchronous I/O requests. The CLR calls the `InitializeHostOverlapped` method to give the host the opportunity to append custom data to an `OVERLAPPED` instance. - +Provides the host with an opportunity to initialize any custom data to append to a Win32 `OVERLAPPED` structure that is used for asynchronous I/O requests. + +## Syntax + +```cpp +HRESULT InitializeHostOverlapped ( + [in] void* pvOverlapped +); +``` + +## Parameters + + `pvOverlapped` + [in] A pointer to the Win32 `OVERLAPPED` structure to be included with the I/O request. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`InitializeHostOverlapped` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to allocate the requested resource.| + +## Remarks + + The Windows Platform functions use the `OVERLAPPED` structure to store state for asynchronous I/O requests. The CLR calls the `InitializeHostOverlapped` method to give the host the opportunity to append custom data to an `OVERLAPPED` instance. + > [!IMPORTANT] -> To get to the beginning of their custom data block, hosts must set the offset to the size of the `OVERLAPPED` structure (`sizeof(OVERLAPPED)`). - - A return value of E_OUTOFMEMORY indicates that the host has failed to initialize its custom data. In this case, the CLR reports an error and fails the call. - -## 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 2.0 - +> To get to the beginning of their custom data block, hosts must set the offset to the size of the `OVERLAPPED` structure (`sizeof(OVERLAPPED)`). + + A return value of E_OUTOFMEMORY indicates that the host has failed to initialize its custom data. In this case, the CLR reports an error and fails the call. + +## 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 - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-interface.md similarity index 65% rename from docs/core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md rename to docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-interface.md index 321be0ace0b57..b2fb17246de1e 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-interface.md +++ b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-interface.md @@ -2,53 +2,54 @@ description: "Learn more about: IHostIoCompletionManager Interface" title: "IHostIoCompletionManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostIoCompletionManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: c28d1983-83f7-46e2-990f-dbb9dc07c818 +topic_type: - "apiref" --- # IHostIoCompletionManager Interface -Provides methods that allow the common language runtime (CLR) to interact with I/O completion ports provided by the host. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Bind Method](ihostiocompletionmanager-bind-method.md)|Binds a handle to an I/O completion port.| -|[CloseIoCompletionPort Method](ihostiocompletionmanager-closeiocompletionport-method.md)|Closes a port that was created through an earlier call to `CreateIoCompletionPort`.| -|[CreateIoCompletionPort Method](ihostiocompletionmanager-createiocompletionport-method.md)|Requests that the host create a new I/O completion port.| -|[GetAvailableThreads Method](ihostiocompletionmanager-getavailablethreads-method.md)|Gets the number of I/O completion threads that are not currently processing requests.| -|[GetHostOverlappedSize Method](ihostiocompletionmanager-gethostoverlappedsize-method.md)|Gets the size of any custom data the host intends to append to I/O requests.| -|[GetMaxThreads Method](ihostiocompletionmanager-getmaxthreads-method.md)|Gets the maximum number of threads that the host can allot to service I/O requests.| -|[GetMinThreads Method](ihostiocompletionmanager-getminthreads-method.md)|Gets the minimum number of threads that the host provides to service I/O requests.| -|[InitializeHostOverlapped Method](ihostiocompletionmanager-initializehostoverlapped-method.md)|Provides the host with an opportunity to initialize any custom data about an I/O request.| -|[SetCLRIoCompletionManager Method](ihostiocompletionmanager-setclriocompletionmanager-method.md)|Provides the host with an interface pointer to an [ICLRIoCompletionManager](iclriocompletionmanager-interface.md) instance implemented by the CLR.| -|[SetMaxThreads Method](ihostiocompletionmanager-setmaxthreads-method.md)|Sets the maximum number of threads that the host allots to service I/O requests.| -|[SetMinThreads Method](ihostiocompletionmanager-setminthreads-method.md)|Sets the minimum number of threads that the host should allot to I/O completion.| - -## Remarks - - `IHostIoCompletionManager` corresponds to the `ICLRIoCompletionManager` interface implemented by the CLR. The CLR calls the methods of `IHostIoCompletionManager` to bind handles to the ports that the host provides, and the host calls the methods of `ICLRIoCompletionManager` to report the completion of I/O requests. - -## 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 2.0 - +Provides methods that allow the common language runtime (CLR) to interact with I/O completion ports provided by the host. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Bind Method](ihostiocompletionmanager-bind-method.md)|Binds a handle to an I/O completion port.| +|[CloseIoCompletionPort Method](ihostiocompletionmanager-closeiocompletionport-method.md)|Closes a port that was created through an earlier call to `CreateIoCompletionPort`.| +|[CreateIoCompletionPort Method](ihostiocompletionmanager-createiocompletionport-method.md)|Requests that the host create a new I/O completion port.| +|[GetAvailableThreads Method](ihostiocompletionmanager-getavailablethreads-method.md)|Gets the number of I/O completion threads that are not currently processing requests.| +|[GetHostOverlappedSize Method](ihostiocompletionmanager-gethostoverlappedsize-method.md)|Gets the size of any custom data the host intends to append to I/O requests.| +|[GetMaxThreads Method](ihostiocompletionmanager-getmaxthreads-method.md)|Gets the maximum number of threads that the host can allot to service I/O requests.| +|[GetMinThreads Method](ihostiocompletionmanager-getminthreads-method.md)|Gets the minimum number of threads that the host provides to service I/O requests.| +|[InitializeHostOverlapped Method](ihostiocompletionmanager-initializehostoverlapped-method.md)|Provides the host with an opportunity to initialize any custom data about an I/O request.| +|[SetCLRIoCompletionManager Method](ihostiocompletionmanager-setclriocompletionmanager-method.md)|Provides the host with an interface pointer to an [ICLRIoCompletionManager](iclriocompletionmanager-interface.md) instance implemented by the CLR.| +|[SetMaxThreads Method](ihostiocompletionmanager-setmaxthreads-method.md)|Sets the maximum number of threads that the host allots to service I/O requests.| +|[SetMinThreads Method](ihostiocompletionmanager-setminthreads-method.md)|Sets the minimum number of threads that the host should allot to I/O completion.| + +## Remarks + + `IHostIoCompletionManager` corresponds to the `ICLRIoCompletionManager` interface implemented by the CLR. The CLR calls the methods of `IHostIoCompletionManager` to bind handles to the ports that the host provides, and the host calls the methods of `ICLRIoCompletionManager` to report the completion of I/O requests. + +## 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 - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md rename to docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md index 1109b79e92659..9dc302202f8d8 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-setclriocompletionmanager-method.md @@ -2,62 +2,63 @@ description: "Learn more about: IHostIoCompletionManager::SetCLRIoCompletionManager Method" title: "IHostIoCompletionManager::SetCLRIoCompletionManager Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager.SetCLRIoCompletionManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager::SetCLRIoCompletionManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostIoCompletionManager::SetCLRIoCompletionManager method [.NET Framework hosting]" - "SetCLRIoCompletionManager method [.NET Framework hosting]" -topic_type: +ms.assetid: 4254bb01-3a14-4f34-a3be-60ff1f5072b5 +topic_type: - "apiref" --- # IHostIoCompletionManager::SetCLRIoCompletionManager Method -Provides the host with an interface pointer to the [ICLRIoCompletionManager](iclriocompletionmanager-interface.md) instance implemented by the common language runtime (CLR). - -## Syntax - -```cpp -HRESULT SetCLRIoCompletionManager ( - [in] ICLRIoCompletionManager *pManager -); -``` - -## Parameters - - `pManager` - [in] An interface pointer to an `ICLRIoCompletionManager` instance provided by the CLR. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetCLRIoCompletionManager` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - After the CLR has called `SetCLRIoCompletionManager`, the host must call [ICLRIoCompletionManager::OnComplete](iclriocompletionmanager-oncomplete-method.md) to notify the CLR when an I/O request has been completed. - -## 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 2.0 - +Provides the host with an interface pointer to the [ICLRIoCompletionManager](iclriocompletionmanager-interface.md) instance implemented by the common language runtime (CLR). + +## Syntax + +```cpp +HRESULT SetCLRIoCompletionManager ( + [in] ICLRIoCompletionManager *pManager +); +``` + +## Parameters + + `pManager` + [in] An interface pointer to an `ICLRIoCompletionManager` instance provided by the CLR. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetCLRIoCompletionManager` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + After the CLR has called `SetCLRIoCompletionManager`, the host must call [ICLRIoCompletionManager::OnComplete](iclriocompletionmanager-oncomplete-method.md) to notify the CLR when an I/O request has been completed. + +## 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 - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md rename to docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md index d67e5ade83ed9..f2aa095e698d0 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-setmaxthreads-method.md @@ -2,63 +2,64 @@ description: "Learn more about: IHostIoCompletionManager::SetMaxThreads Method" title: "IHostIoCompletionManager::SetMaxThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager.SetMaxThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager::SetMaxThreads" -helpviewer_keywords: +helpviewer_keywords: - "IHostIoCompletionManager::SetMaxThreads method [.NET Framework hosting]" - "SetMaxThreads method, IHostIoCompletionManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: ebad4f40-d9f1-4dc6-9b27-a89c9eb3926f +topic_type: - "apiref" --- # IHostIoCompletionManager::SetMaxThreads Method -Sets the maximum number of threads that the host allots to service I/O requests. - -## Syntax - -```cpp -HRESULT SetMaxThreads ( - [in] DWORD dwMaxIoCompletionThreads -); -``` - -## Parameters - - `dwMaxIoCompletionThreads` - [in] The maximum number of threads to allot for I/O requests. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetMaxThreads` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not provide an implementation of `SetMaxThreads`.| - -## Remarks - - `SetMaxThreads` provides the CLR with an opportunity to set the maximum number of threads that are available to service requests on I/O ports. A host might need exclusive control over the size of the thread pool, for reasons such as implementation, performance, or scalability. For this reason, the host is not required to implement `SetMaxThreads`. In this case, a host should return E_NOTIMPL from this method. - -## 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 2.0 - +Sets the maximum number of threads that the host allots to service I/O requests. + +## Syntax + +```cpp +HRESULT SetMaxThreads ( + [in] DWORD dwMaxIoCompletionThreads +); +``` + +## Parameters + + `dwMaxIoCompletionThreads` + [in] The maximum number of threads to allot for I/O requests. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetMaxThreads` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not provide an implementation of `SetMaxThreads`.| + +## Remarks + + `SetMaxThreads` provides the CLR with an opportunity to set the maximum number of threads that are available to service requests on I/O ports. A host might need exclusive control over the size of the thread pool, for reasons such as implementation, performance, or scalability. For this reason, the host is not required to implement `SetMaxThreads`. In this case, a host should return E_NOTIMPL from this method. + +## 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 - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md similarity index 60% rename from docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md rename to docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md index bf9fcc40366e4..e167268abe3b5 100644 --- a/docs/core/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostiocompletionmanager-setminthreads-method.md @@ -2,63 +2,64 @@ description: "Learn more about: IHostIoCompletionManager::SetMinThreads Method" title: "IHostIoCompletionManager::SetMinThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostIoCompletionManager.SetMinThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostIoCompletionManager::SetMinThreads" -helpviewer_keywords: +helpviewer_keywords: - "SetMinThreads method, IHostIoCompletionManager interface [.NET Framework hosting]" - "IHostIoCompletionManager::SetMinThreads method [.NET Framework hosting]" -topic_type: +ms.assetid: dea34b81-8d2b-4cc3-8696-0ad4291d8a92 +topic_type: - "apiref" --- # IHostIoCompletionManager::SetMinThreads Method -Sets the minimum number of threads that the host should allot to I/O completion. - -## Syntax - -```cpp -HRESULT SetMinThreads ( - [in] DWORD dwMinIoCompletionThreads -); -``` - -## Parameters - - `dwMinIoCompletionThreads` - [in] The minimum number of I/O completion threads that the host should create. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetMinThreads` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not provide an implementation of `SetMinThreads`.| - -## Remarks - - A host might want exclusive control over the number of threads that can be allotted to process I/O requests, for reasons such as implementation, performance, or scalability. For this reason, the host is not required to implement `SetMinThreads`. In this case, the host should return E_NOTIMPL from this method. - -## 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 2.0 - +Sets the minimum number of threads that the host should allot to I/O completion. + +## Syntax + +```cpp +HRESULT SetMinThreads ( + [in] DWORD dwMinIoCompletionThreads +); +``` + +## Parameters + + `dwMinIoCompletionThreads` + [in] The minimum number of I/O completion threads that the host should create. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetMinThreads` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not provide an implementation of `SetMinThreads`.| + +## Remarks + + A host might want exclusive control over the number of threads that can be allotted to process I/O requests, for reasons such as implementation, performance, or scalability. For this reason, the host is not required to implement `SetMinThreads`. In this case, the host should return E_NOTIMPL from this method. + +## 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 - [ICLRIoCompletionManager Interface](iclriocompletionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md b/docs/framework/unmanaged-api/hosting/ihostmalloc-alloc-method.md similarity index 58% rename from docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md rename to docs/framework/unmanaged-api/hosting/ihostmalloc-alloc-method.md index ea289b2e8f0d0..dc6febbc932cb 100644 --- a/docs/core/unmanaged-api/hosting/ihostmalloc-alloc-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostmalloc-alloc-method.md @@ -2,71 +2,72 @@ description: "Learn more about: IHostMAlloc::Alloc Method" title: "IHostMAlloc::Alloc Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMAlloc.Alloc" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMAlloc::Alloc" -helpviewer_keywords: +helpviewer_keywords: - "Alloc method, IHostMAlloc interface [.NET Framework hosting]" - "IHostMAlloc::Alloc method [.NET Framework hosting]" -topic_type: +ms.assetid: a3007f5e-d75d-4b37-842b-704e9edced5e +topic_type: - "apiref" --- # IHostMAlloc::Alloc Method -Requests that the host allocate the specified amount of memory from the heap. - -## Syntax - -```cpp -HRESULT Alloc ( +Requests that the host allocate the specified amount of memory from the heap. + +## Syntax + +```cpp +HRESULT Alloc ( [in] SIZE_T cbSize, [in] EMemoryCriticalLevel dwCriticalLevel, - [out] void** ppMem -); -``` - -## Parameters - - `cbSize` - [in] The size, in bytes, of the current memory allocation request. - - `dwCriticalLevel` - [in] One of the [EMemoryCriticalLevel](ememorycriticallevel-enumeration.md) values, indicating the impact of an allocation failure. - - `ppMem` - [out] A pointer to the allocated memory, or null if the request could not be completed. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Alloc` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to complete the allocation request.| - -## Remarks - - The CLR gets an interface pointer to an `IHostMalloc` instance by calling the [IHostMemoryManager::CreateMalloc](ihostmemorymanager-createmalloc-method.md) method. - -## 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 2.0 - + [out] void** ppMem +); +``` + +## Parameters + + `cbSize` + [in] The size, in bytes, of the current memory allocation request. + + `dwCriticalLevel` + [in] One of the [EMemoryCriticalLevel](ememorycriticallevel-enumeration.md) values, indicating the impact of an allocation failure. + + `ppMem` + [out] A pointer to the allocated memory, or null if the request could not be completed. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Alloc` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to complete the allocation request.| + +## Remarks + + The CLR gets an interface pointer to an `IHostMalloc` instance by calling the [IHostMemoryManager::CreateMalloc](ihostmemorymanager-createmalloc-method.md) method. + +## 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 - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md b/docs/framework/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md similarity index 61% rename from docs/core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md rename to docs/framework/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md index 81817a388a8ed..5399ef089601c 100644 --- a/docs/core/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostmalloc-debugalloc-method.md @@ -2,79 +2,80 @@ description: "Learn more about: IHostMAlloc::DebugAlloc Method" title: "IHostMAlloc::DebugAlloc Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMAlloc.DebugAlloc" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMAlloc::DebugAlloc" -helpviewer_keywords: +helpviewer_keywords: - "DebugAlloc method [.NET Framework hosting]" - "IHostMAlloc::DebugAlloc method [.NET Framework hosting]" -topic_type: +ms.assetid: 0bfbc527-bea2-43ce-b041-69186f4440dd +topic_type: - "apiref" --- # IHostMAlloc::DebugAlloc Method -Requests that the host allocate the specified amount of memory from the heap, and additionally track where the memory was allocated. - -## Syntax - -```cpp -HRESULT DebugAlloc ( +Requests that the host allocate the specified amount of memory from the heap, and additionally track where the memory was allocated. + +## Syntax + +```cpp +HRESULT DebugAlloc ( [in] SIZE_T cbSize, [in] EMemoryCriticalLevel dwCriticalLevel, [in] char* pszFileName, [in] int iLineNo, - [out] void** ppMem -); -``` - -## Parameters - - `cbSize` - [in] The size, in bytes, of the current memory allocation request. - - `dwCriticalLevel` - [in] One of the [EMemoryCriticalLevel](ememorycriticallevel-enumeration.md) values, indicating the impact of an allocation failure. - - `pszFileName` - [in] The code file of the executable being debugged. - - `iLineNo` - [in] The line number in `pszFileName` where the allocation was requested. - - `ppMem` - [out] A pointer to the allocated memory, or null if the request could not be completed. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`DebugAlloc` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to complete the allocation request.| - -## Remarks - - The CLR gets an interface pointer to an [IHostMalloc](ihostmalloc-interface.md) instance by calling the [IHostMemoryManager::CreateMalloc](ihostmemorymanager-createmalloc-method.md) method. `DebugAlloc` allows the runtime to get code file information for use during debugging. - -## 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 2.0 - + [out] void** ppMem +); +``` + +## Parameters + + `cbSize` + [in] The size, in bytes, of the current memory allocation request. + + `dwCriticalLevel` + [in] One of the [EMemoryCriticalLevel](ememorycriticallevel-enumeration.md) values, indicating the impact of an allocation failure. + + `pszFileName` + [in] The code file of the executable being debugged. + + `iLineNo` + [in] The line number in `pszFileName` where the allocation was requested. + + `ppMem` + [out] A pointer to the allocated memory, or null if the request could not be completed. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`DebugAlloc` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to complete the allocation request.| + +## Remarks + + The CLR gets an interface pointer to an [IHostMalloc](ihostmalloc-interface.md) instance by calling the [IHostMemoryManager::CreateMalloc](ihostmemorymanager-createmalloc-method.md) method. `DebugAlloc` allows the runtime to get code file information for use during debugging. + +## 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 - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md b/docs/framework/unmanaged-api/hosting/ihostmalloc-free-method.md similarity index 52% rename from docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md rename to docs/framework/unmanaged-api/hosting/ihostmalloc-free-method.md index 75f1c583d40c9..861dae3f9670f 100644 --- a/docs/core/unmanaged-api/hosting/ihostmalloc-free-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostmalloc-free-method.md @@ -2,63 +2,64 @@ description: "Learn more about: IHostMAlloc::Free Method" title: "IHostMAlloc::Free Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMAlloc.Free" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMAlloc::Free" -helpviewer_keywords: +helpviewer_keywords: - "IHostMAlloc::Free method [.NET Framework hosting]" - "Free method, IHostMAlloc interface [.NET Framework hosting]" -topic_type: +ms.assetid: c89abf5b-1120-4437-8b57-4a99fb3ae7f9 +topic_type: - "apiref" --- # IHostMAlloc::Free Method -Frees memory that was allocated by using the [Alloc](ihostmalloc-alloc-method.md) function. - -## Syntax - -```cpp -HRESULT Free ( - [in] void* pMem -); -``` - -## Parameters - - `pMem` - [in] A pointer to the memory to be freed. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Free` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|HOST_E_INVALIDOPERATION|An attempt was made to free memory that was not allocated through the host.| - -## Remarks - - If the `pMem` parameter refers to a region of memory that was not allocated by using a call to `Alloc`, the host should return HOST_E_INVALIDOPERATION. - -## 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 2.0 - +Frees memory that was allocated by using the [Alloc](ihostmalloc-alloc-method.md) function. + +## Syntax + +```cpp +HRESULT Free ( + [in] void* pMem +); +``` + +## Parameters + + `pMem` + [in] A pointer to the memory to be freed. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Free` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|HOST_E_INVALIDOPERATION|An attempt was made to free memory that was not allocated through the host.| + +## Remarks + + If the `pMem` parameter refers to a region of memory that was not allocated by using a call to `Alloc`, the host should return HOST_E_INVALIDOPERATION. + +## 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 - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmalloc-interface.md b/docs/framework/unmanaged-api/hosting/ihostmalloc-interface.md similarity index 54% rename from docs/core/unmanaged-api/hosting/ihostmalloc-interface.md rename to docs/framework/unmanaged-api/hosting/ihostmalloc-interface.md index 1a7e6d27cd7a1..7e33b1bf0cf93 100644 --- a/docs/core/unmanaged-api/hosting/ihostmalloc-interface.md +++ b/docs/framework/unmanaged-api/hosting/ihostmalloc-interface.md @@ -2,45 +2,46 @@ description: "Learn more about: IHostMalloc Interface" title: "IHostMalloc Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMAlloc" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMAlloc" -helpviewer_keywords: +helpviewer_keywords: - "IHostMAlloc interface [.NET Framework hosting]" -topic_type: +ms.assetid: e3c6643b-6fc7-4a99-959d-4b7b4e63fdee +topic_type: - "apiref" --- # IHostMalloc Interface -Provides methods that allow the common language runtime (CLR) to request fine-grained allocations from the heap through the host. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Alloc Method](ihostmalloc-alloc-method.md)|Requests that the host allocate the requested amount of memory from the heap.| -|[DebugAlloc Method](ihostmalloc-debugalloc-method.md)|Requests that the host allocate the requested amount of memory from the heap, and additionally track where the memory was allocated.| -|[Free Method](ihostmalloc-free-method.md)|Frees memory that was allocated by using the `Alloc` method.| - -## Remarks - - The CLR gets an interface pointer to an `IHostMalloc` instance by calling the [IHostMemoryManager::CreateMalloc](ihostmemorymanager-createmalloc-method.md) method. - -## 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 2.0 - +Provides methods that allow the common language runtime (CLR) to request fine-grained allocations from the heap through the host. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Alloc Method](ihostmalloc-alloc-method.md)|Requests that the host allocate the requested amount of memory from the heap.| +|[DebugAlloc Method](ihostmalloc-debugalloc-method.md)|Requests that the host allocate the requested amount of memory from the heap, and additionally track where the memory was allocated.| +|[Free Method](ihostmalloc-free-method.md)|Frees memory that was allocated by using the `Alloc` method.| + +## Remarks + + The CLR gets an interface pointer to an `IHostMalloc` instance by calling the [IHostMemoryManager::CreateMalloc](ihostmemorymanager-createmalloc-method.md) method. + +## 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 - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md b/docs/framework/unmanaged-api/hosting/ihostmanualevent-interface.md similarity index 57% rename from docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md rename to docs/framework/unmanaged-api/hosting/ihostmanualevent-interface.md index dc7362619a1e3..510435aa87f86 100644 --- a/docs/core/unmanaged-api/hosting/ihostmanualevent-interface.md +++ b/docs/framework/unmanaged-api/hosting/ihostmanualevent-interface.md @@ -2,41 +2,42 @@ description: "Learn more about: IHostManualEvent Interface" title: "IHostManualEvent Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostManualEvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostManualEvent" -helpviewer_keywords: +helpviewer_keywords: - "IHostManualEvent interface [.NET Framework hosting]" -topic_type: +ms.assetid: 300c2661-b7d1-4c39-b080-9ebdef0fd523 +topic_type: - "apiref" --- # IHostManualEvent Interface -Provides the host's implementation of a representation of a manual reset event. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Reset Method](ihostmanualevent-reset-method.md)|Resets the current `IHostManualEvent` instance to a non-signaled state.| -|[Set Method](ihostmanualevent-set-method.md)|Sets the current `IHostManualEvent` instance to a signaled state.| -|[Wait Method](ihostmanualevent-wait-method.md)|Causes the current `IHostManualEvent` instance to wait until it is owned, or a specified amount of time elapses.| - -## 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 2.0 - +Provides the host's implementation of a representation of a manual reset event. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Reset Method](ihostmanualevent-reset-method.md)|Resets the current `IHostManualEvent` instance to a non-signaled state.| +|[Set Method](ihostmanualevent-set-method.md)|Sets the current `IHostManualEvent` instance to a signaled state.| +|[Wait Method](ihostmanualevent-wait-method.md)|Causes the current `IHostManualEvent` instance to wait until it is owned, or a specified amount of time elapses.| + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmanualevent-reset-method.md b/docs/framework/unmanaged-api/hosting/ihostmanualevent-reset-method.md similarity index 57% rename from docs/core/unmanaged-api/hosting/ihostmanualevent-reset-method.md rename to docs/framework/unmanaged-api/hosting/ihostmanualevent-reset-method.md index 6c0de81494e6b..7eeacf969a76f 100644 --- a/docs/core/unmanaged-api/hosting/ihostmanualevent-reset-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostmanualevent-reset-method.md @@ -2,51 +2,52 @@ description: "Learn more about: IHostManualEvent::Reset Method" title: "IHostManualEvent::Reset Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostManualEvent.Reset" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostManualEvent::Reset" -helpviewer_keywords: +helpviewer_keywords: - "Reset method, IHostManualEvent interface [.NET Framework hosting]" - "IHostManualEvent::Reset method [.NET Framework hosting]" -topic_type: +ms.assetid: 0d101168-b5e3-49ce-90c7-85cf2db83c4c +topic_type: - "apiref" --- # IHostManualEvent::Reset Method -Resets the current [IHostManualEvent](ihostmanualevent-interface.md) instance to a non-signaled state. - -## Syntax - -```cpp -HRESULT Reset (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Reset` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## 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 2.0 - +Resets the current [IHostManualEvent](ihostmanualevent-interface.md) instance to a non-signaled state. + +## Syntax + +```cpp +HRESULT Reset (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Reset` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md b/docs/framework/unmanaged-api/hosting/ihostmanualevent-set-method.md similarity index 57% rename from docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md rename to docs/framework/unmanaged-api/hosting/ihostmanualevent-set-method.md index 8eb1680a965eb..e37ba3e8eb18e 100644 --- a/docs/core/unmanaged-api/hosting/ihostmanualevent-set-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostmanualevent-set-method.md @@ -2,51 +2,52 @@ description: "Learn more about: IHostManualEvent::Set Method" title: "IHostManualEvent::Set Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostManualEvent.Set" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostManualEvent::Set" -helpviewer_keywords: +helpviewer_keywords: - "Set method, IHostManualEvent interface [.NET Framework hosting]" - "IHostManualEvent::Set method [.NET Framework hosting]" -topic_type: +ms.assetid: e930c174-f71d-4faa-bb59-f0fb3df4d77b +topic_type: - "apiref" --- # IHostManualEvent::Set Method -Sets the current [IHostManualEvent](ihostmanualevent-interface.md) instance to a signaled state. - -## Syntax - -```cpp -HRESULT Set (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Set` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## 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 2.0 - +Sets the current [IHostManualEvent](ihostmanualevent-interface.md) instance to a signaled state. + +## Syntax + +```cpp +HRESULT Set (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Set` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md b/docs/framework/unmanaged-api/hosting/ihostmanualevent-wait-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md rename to docs/framework/unmanaged-api/hosting/ihostmanualevent-wait-method.md index dfebb3aac34c3..df261e912b075 100644 --- a/docs/core/unmanaged-api/hosting/ihostmanualevent-wait-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostmanualevent-wait-method.md @@ -2,63 +2,64 @@ description: "Learn more about: IHostManualEvent::Wait Method" title: "IHostManualEvent::Wait Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostManualEvent.Wait" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostManualEvent::Wait" -helpviewer_keywords: +helpviewer_keywords: - "IHostManualEvent::Wait method [.NET Framework hosting]" - "Wait method, IHostManualEvent interface [.NET Framework hosting]" -topic_type: +ms.assetid: 1fbb7d8b-8a23-4c2b-8376-1a70cd2d6030 +topic_type: - "apiref" --- # IHostManualEvent::Wait Method -Causes the current [IHostManualEvent](ihostmanualevent-interface.md) instance to wait until it is owned, or a specified amount of time elapses. +Causes the current [IHostManualEvent](ihostmanualevent-interface.md) instance to wait until it is owned, or a specified amount of time elapses. + +## Syntax + +```cpp +HRESULT Wait ( + [in] DWORD dwMilliseconds, + [in] DWORD option +); +``` + +## Parameters -## Syntax - -```cpp -HRESULT Wait ( - [in] DWORD dwMilliseconds, - [in] DWORD option -); -``` - -## Parameters - - `dwMilliseconds` - [in] The number of milliseconds to wait before returning, if the current `IHostManualEvent` instance is not owned. - - `option` - [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values, indicating the action the host should take if this operation blocks. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Wait` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|HOST_E_DEADLOCK|The host detected a deadlock during the wait interval, and chose the current `IHostManualEvent` instance as the deadlock victim.| - -## 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 2.0 + `dwMilliseconds` + [in] The number of milliseconds to wait before returning, if the current `IHostManualEvent` instance is not owned. + + `option` + [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values, indicating the action the host should take if this operation blocks. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Wait` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|HOST_E_DEADLOCK|The host detected a deadlock during the wait interval, and chose the current `IHostManualEvent` instance as the deadlock victim.| + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md b/docs/framework/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md new file mode 100644 index 0000000000000..b549bbba2ec4e --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/ihostmemorymanager-acquiredvirtualaddressspace-method.md @@ -0,0 +1,57 @@ +--- +description: "Learn more about: IHostMemoryManager::AcquiredVirtualAddressSpace Method" +title: "IHostMemoryManager::AcquiredVirtualAddressSpace Method" +ms.date: "03/30/2017" +api_name: + - "IHostMemoryManager.AcquiredVirtualAddressSpace" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IHostMemoryManager::AcquiredVirtualAddressSpace" +helpviewer_keywords: + - "IHostMemoryManager::AcquiredVirtualAddressSpace method [.NET Framework hosting]" + - "AcquiredVirtualAddressSpace method [.NET Framework hosting]" +ms.assetid: ef2f83c2-127e-4c38-8385-306c03cd2167 +topic_type: + - "apiref" +--- +# IHostMemoryManager::AcquiredVirtualAddressSpace Method + +Notifies the host that the common language runtime (CLR) has acquired the specified memory from the operating system. + +## Syntax + +```cpp +HRESULT AcquiredVirtualAddressSpace( + [in] LPVOID startAddress, + [in] SIZE_T size +); +``` + +## Parameters + + `startAddress` + [in] The starting address of the memory. + + `size` + [in] The size, in bytes, of the memory. + +## Remarks + + The `AcquiredVirtualAddressSpace` method is a callback method and must be implemented by the writer of the hosting application. It is called by the CLR. + +## 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 + +- [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md b/docs/framework/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md similarity index 57% rename from docs/core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md rename to docs/framework/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md index 15fc943e5b344..6046a11591af0 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostmemorymanager-createmalloc-method.md @@ -2,67 +2,68 @@ description: "Learn more about: IHostMemoryManager::CreateMAlloc Method" title: "IHostMemoryManager::CreateMAlloc Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMemoryManager.CreateMAlloc" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMemoryManager::CreateMAlloc" -helpviewer_keywords: +helpviewer_keywords: - "CreateAlloc method [.NET Framework hosting]" - "IHostMemoryManager::CreateMAlloc method [.NET Framework hosting]" -topic_type: +ms.assetid: 9ee6e052-bef7-4350-9e4f-edfffd99ad6f +topic_type: - "apiref" --- # IHostMemoryManager::CreateMAlloc Method -Gets an interface pointer to an [IHostMAlloc](ihostmalloc-interface.md) instance that is used to make allocation requests from a heap created by the host. - -## Syntax - -```cpp -HRESULT CreateMalloc ( - [in] DWORD dwMallocType, - [out] IHostMalloc **ppMalloc -); -``` - -## Parameters - - `dwMallocType` - [in] A combination of [MALLOC_TYPE](malloc-type-enumeration.md) flags that specifies the characteristics of the memory that is being allocated. - - `ppMAlloc` - [out] A pointer to the address of an `IHostMAlloc` instance provided by the host. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateMAlloc` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough physical memory was available to complete the allocation request.| - -## Remarks - - `CreateMAlloc` returns an object that allows the CLR to make allocation requests through the host instead of using the standard Win32 functions. - -## 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 2.0 - +Gets an interface pointer to an [IHostMAlloc](ihostmalloc-interface.md) instance that is used to make allocation requests from a heap created by the host. + +## Syntax + +```cpp +HRESULT CreateMalloc ( + [in] DWORD dwMallocType, + [out] IHostMalloc **ppMalloc +); +``` + +## Parameters + + `dwMallocType` + [in] A combination of [MALLOC_TYPE](malloc-type-enumeration.md) flags that specifies the characteristics of the memory that is being allocated. + + `ppMAlloc` + [out] A pointer to the address of an `IHostMAlloc` instance provided by the host. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateMAlloc` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough physical memory was available to complete the allocation request.| + +## Remarks + + `CreateMAlloc` returns an object that allows the CLR to make allocation requests through the host instead of using the standard Win32 functions. + +## 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 - [IHostMalloc Interface](ihostmalloc-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md b/docs/framework/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md rename to docs/framework/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md index ef78f9e409f5a..9d7c62ba3c144 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostmemorymanager-getmemoryload-method.md @@ -2,68 +2,69 @@ description: "Learn more about: IHostMemoryManager::GetMemoryLoad Method" title: "IHostMemoryManager::GetMemoryLoad Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMemoryManager.GetMemoryLoad" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMemoryManager::GetMemoryLoad" -helpviewer_keywords: +helpviewer_keywords: - "IHostMemoryManager::GetMemoryLoad method [.NET Framework hosting]" - "GetMemoryLoad method [.NET Framework hosting]" -topic_type: +ms.assetid: e8138f6e-a0a4-48d4-8dae-9466b4dc6180 +topic_type: - "apiref" --- # IHostMemoryManager::GetMemoryLoad Method -Gets the amount of physical memory that is currently in use, and therefore unavailable, as reported by the host. - -## Syntax - -```cpp -HRESULT GetMemoryLoad ( +Gets the amount of physical memory that is currently in use, and therefore unavailable, as reported by the host. + +## Syntax + +```cpp +HRESULT GetMemoryLoad ( [out] DWORD* pMemoryLoad, - [out] SIZE_T *pAvailableBytes -); -``` - -## Parameters - - `pMemoryLoad` - [out] A pointer to the approximate percentage of total physical memory that is currently in use. - - `pAvailableBytes` - [out] A pointer to the number of bytes available to the common language runtime (CLR). - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetMemoryLoad` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `GetMemoryLoad` wraps the Win32 `GlobalMemoryStatus` function. The value of `pMemoryLoad` is the equivalent of the `dwMemoryLoad` field in the `MEMORYSTATUS` structure returned from `GlobalMemoryStatus`. - - The runtime uses the return value as a heuristic for the garbage collector. For example, if the host reports that the majority of memory is in use, the garbage collector may elect to collect from multiple generations to increase the amount of memory that can potentially become available. - -## 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 2.0 - + [out] SIZE_T *pAvailableBytes +); +``` + +## Parameters + + `pMemoryLoad` + [out] A pointer to the approximate percentage of total physical memory that is currently in use. + + `pAvailableBytes` + [out] A pointer to the number of bytes available to the common language runtime (CLR). + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetMemoryLoad` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `GetMemoryLoad` wraps the Win32 `GlobalMemoryStatus` function. The value of `pMemoryLoad` is the equivalent of the `dwMemoryLoad` field in the `MEMORYSTATUS` structure returned from `GlobalMemoryStatus`. + + The runtime uses the return value as a heuristic for the garbage collector. For example, if the host reports that the majority of memory is in use, the garbage collector may elect to collect from multiple generations to increase the amount of memory that can potentially become available. + +## 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 - diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md b/docs/framework/unmanaged-api/hosting/ihostmemorymanager-interface.md similarity index 72% rename from docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md rename to docs/framework/unmanaged-api/hosting/ihostmemorymanager-interface.md index 109944547f585..496ca36a31a68 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-interface.md +++ b/docs/framework/unmanaged-api/hosting/ihostmemorymanager-interface.md @@ -2,52 +2,53 @@ description: "Learn more about: IHostMemoryManager Interface" title: "IHostMemoryManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMemoryManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMemoryManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostMemoryManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: a945d439-3b34-4aa4-b575-8413dd7806ce +topic_type: - "apiref" --- # IHostMemoryManager Interface -Provides methods that allow the common language runtime (CLR) to make virtual memory requests through the host, instead of using the standard Win32 virtual memory functions. - -## Methods - -|Method|Description| -|------------|-----------------| -|[AcquiredVirtualAddressSpace Method](ihostmemorymanager-acquiredvirtualaddressspace-method.md)|Notifies the host that the common language runtime (CLR) has acquired the specified memory from the operating system.| -|[CreateMAlloc Method](ihostmemorymanager-createmalloc-method.md)|Gets an interface pointer to an [IHostMAlloc](ihostmalloc-interface.md) instance that is used to request memory allocations from a heap created by the host.| -|[GetMemoryLoad Method](ihostmemorymanager-getmemoryload-method.md)|Gets the amount of physical memory that is currently being used, as reported by the host.| -|[NeedsVirtualAddressSpace Method](ihostmemorymanager-needsvirtualaddressspace-method.md)|Notifies the host that the CLR is going to attempt to use the specified memory.| -|[RegisterMemoryNotificationCallback Method](ihostmemorymanager-registermemorynotificationcallback-method.md)|Registers a pointer to a callback function that the host invokes to notify the CLR of the current memory load on the computer.| -|[ReleasedVirtualAddressSpace Method](ihostmemorymanager-releasedvirtualaddressspace-method.md)|Notifies the host that the CLR has finished using the specified memory.| -|[VirtualAlloc Method](ihostmemorymanager-virtualalloc-method.md)|Serves as a logical wrapper for the corresponding Win32 function, which reserves or commits a region of pages in the virtual address space of the calling process.| -|[VirtualFree Method](ihostmemorymanager-virtualfree-method.md)|Serves as a logical wrapper for the corresponding Win32 function, which releases, decommits, or releases and decommits a region of pages within the virtual address space of the calling process.| -|[VirtualProtect Method](ihostmemorymanager-virtualprotect-method.md)|Serves as a logical wrapper for the corresponding Win32 function, which changes the protection on a region of committed pages in the virtual address space of the calling process.| -|[VirtualQuery Method](ihostmemorymanager-virtualquery-method.md)|Serves as a logical wrapper for the corresponding Win32 function, which retrieves information about a range of pages in the virtual address space of the calling process.| - -## Remarks - - `IHostMemoryManager` also provides methods for the CLR to obtain a pointer through which to make memory requests on the heap and to get the level of memory pressure in the process, as reported by the host. - -## 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 2.0 - +Provides methods that allow the common language runtime (CLR) to make virtual memory requests through the host, instead of using the standard Win32 virtual memory functions. + +## Methods + +|Method|Description| +|------------|-----------------| +|[AcquiredVirtualAddressSpace Method](ihostmemorymanager-acquiredvirtualaddressspace-method.md)|Notifies the host that the common language runtime (CLR) has acquired the specified memory from the operating system.| +|[CreateMAlloc Method](ihostmemorymanager-createmalloc-method.md)|Gets an interface pointer to an [IHostMAlloc](ihostmalloc-interface.md) instance that is used to request memory allocations from a heap created by the host.| +|[GetMemoryLoad Method](ihostmemorymanager-getmemoryload-method.md)|Gets the amount of physical memory that is currently being used, as reported by the host.| +|[NeedsVirtualAddressSpace Method](ihostmemorymanager-needsvirtualaddressspace-method.md)|Notifies the host that the CLR is going to attempt to use the specified memory.| +|[RegisterMemoryNotificationCallback Method](ihostmemorymanager-registermemorynotificationcallback-method.md)|Registers a pointer to a callback function that the host invokes to notify the CLR of the current memory load on the computer.| +|[ReleasedVirtualAddressSpace Method](ihostmemorymanager-releasedvirtualaddressspace-method.md)|Notifies the host that the CLR has finished using the specified memory.| +|[VirtualAlloc Method](ihostmemorymanager-virtualalloc-method.md)|Serves as a logical wrapper for the corresponding Win32 function, which reserves or commits a region of pages in the virtual address space of the calling process.| +|[VirtualFree Method](ihostmemorymanager-virtualfree-method.md)|Serves as a logical wrapper for the corresponding Win32 function, which releases, decommits, or releases and decommits a region of pages within the virtual address space of the calling process.| +|[VirtualProtect Method](ihostmemorymanager-virtualprotect-method.md)|Serves as a logical wrapper for the corresponding Win32 function, which changes the protection on a region of committed pages in the virtual address space of the calling process.| +|[VirtualQuery Method](ihostmemorymanager-virtualquery-method.md)|Serves as a logical wrapper for the corresponding Win32 function, which retrieves information about a range of pages in the virtual address space of the calling process.| + +## Remarks + + `IHostMemoryManager` also provides methods for the CLR to obtain a pointer through which to make memory requests on the heap and to get the level of memory pressure in the process, as reported by the host. + +## 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 - [IHostMalloc Interface](ihostmalloc-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md b/docs/framework/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md similarity index 50% rename from docs/core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md rename to docs/framework/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md index 1a23a3d293c3f..6fb4597066c61 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostmemorymanager-needsvirtualaddressspace-method.md @@ -2,57 +2,58 @@ description: "Learn more about: IHostMemoryManager::NeedsVirtualAddressSpace Method" title: "IHostMemoryManager::NeedsVirtualAddressSpace Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMemoryManager.NeedsVirtualAddressSpace" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMemoryManager::NeedsVirtualAddressSpace" -helpviewer_keywords: +helpviewer_keywords: - "IHostMemoryManager::NeedsVirtualAddressSpace method [.NET Framework hosting]" - "NeedsVirtualAddressSpace method [.NET Framework hosting]" -topic_type: +ms.assetid: 71f0eab5-0170-46f8-9f88-1df5abdeb34a +topic_type: - "apiref" --- # IHostMemoryManager::NeedsVirtualAddressSpace Method -Notifies the host that the common language runtime (CLR) is going to attempt to use the specified memory. - -## Syntax - -```cpp -HRESULT NeedsVirtualAddressSpace ( - [in] LPVOID startAddress, - [in] SIZE_T size -); -``` - -## Parameters - - `startAddress` - [in] The starting address of the memory. - - `size` - [in] The size, in bytes, of the memory. - -## Remarks - - The `NeedsVirtualAddressSpace` method is a callback method and must be implemented by the writer of the hosting application. It is called by the CLR. - - If the host does not want the CLR to use the specified memory, it may return an E_OUTOFMEMORY HRESULT. - -## 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 2.0 - +Notifies the host that the common language runtime (CLR) is going to attempt to use the specified memory. + +## Syntax + +```cpp +HRESULT NeedsVirtualAddressSpace ( + [in] LPVOID startAddress, + [in] SIZE_T size +); +``` + +## Parameters + + `startAddress` + [in] The starting address of the memory. + + `size` + [in] The size, in bytes, of the memory. + +## Remarks + + The `NeedsVirtualAddressSpace` method is a callback method and must be implemented by the writer of the hosting application. It is called by the CLR. + + If the host does not want the CLR to use the specified memory, it may return an E_OUTOFMEMORY HRESULT. + +## 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 - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md b/docs/framework/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md similarity index 68% rename from docs/core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md rename to docs/framework/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md index be3453691eccd..b4244f7690709 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostmemorymanager-registermemorynotificationcallback-method.md @@ -2,65 +2,66 @@ description: "Learn more about: IHostMemoryManager::RegisterMemoryNotificationCallback Method" title: "IHostMemoryManager::RegisterMemoryNotificationCallback Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMemoryManager.RegisterMemoryNotificationCallback" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMemoryManager::RegisterMemoryNotificationCallback" -helpviewer_keywords: +helpviewer_keywords: - "IHostMemoryManager::RegisterMemoryNotificationCallback method [.NET Framework hosting]" - "RegisterMemoryNotificationCallback method [.NET Framework hosting]" -topic_type: +ms.assetid: 65d301f6-4dbb-4b5f-8eff-82540e2b6465 +topic_type: - "apiref" --- # IHostMemoryManager::RegisterMemoryNotificationCallback Method -Registers a pointer to a callback function that the host invokes to notify the common language runtime (CLR) of the current memory load on the computer. - -## Syntax - -```cpp -HRESULT RegisterMemoryNotificationCallback ( - [in] ICLRMemoryNotificationCallback* pCallback -); -``` - -## Parameters - - `pCallback` - [in] An interface pointer to an [ICLRMemoryNotificationCallback](iclrmemorynotificationcallback-interface.md) instance that is implemented by the CLR. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`RegisterMemoryNotificationCallback` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - Because the `ICLRMemoryNotificationCallback` interface defines only one method ([ICLRMemoryNotificationCallback::OnMemoryNotification](iclrmemorynotificationcallback-onmemorynotification-method.md)), and because `pCallback` is a pointer to an `ICLRMemoryNotificationCallback` instance provided by the CLR, the registration is effectively for the callback function itself. The host invokes `OnMemoryNotification` to report memory pressure conditions, rather than using the standard Win32 `CreateMemoryResourceNotification` function. For more information, see the Windows Platform documentation. - +Registers a pointer to a callback function that the host invokes to notify the common language runtime (CLR) of the current memory load on the computer. + +## Syntax + +```cpp +HRESULT RegisterMemoryNotificationCallback ( + [in] ICLRMemoryNotificationCallback* pCallback +); +``` + +## Parameters + + `pCallback` + [in] An interface pointer to an [ICLRMemoryNotificationCallback](iclrmemorynotificationcallback-interface.md) instance that is implemented by the CLR. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`RegisterMemoryNotificationCallback` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + Because the `ICLRMemoryNotificationCallback` interface defines only one method ([ICLRMemoryNotificationCallback::OnMemoryNotification](iclrmemorynotificationcallback-onmemorynotification-method.md)), and because `pCallback` is a pointer to an `ICLRMemoryNotificationCallback` instance provided by the CLR, the registration is effectively for the callback function itself. The host invokes `OnMemoryNotification` to report memory pressure conditions, rather than using the standard Win32 `CreateMemoryResourceNotification` function. For more information, see the Windows Platform documentation. + > [!NOTE] -> Calls to `OnMemoryNotification` never block. They always return immediately. - -## 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 2.0 - +> Calls to `OnMemoryNotification` never block. They always return immediately. + +## 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 - [ICLRMemoryNotificationCallback Interface](iclrmemorynotificationcallback-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md b/docs/framework/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md similarity index 56% rename from docs/core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md rename to docs/framework/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md index 237f20472599f..5d8eead6209f0 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostmemorymanager-releasedvirtualaddressspace-method.md @@ -2,51 +2,52 @@ description: "Learn more about: IHostMemoryManager::ReleasedVirtualAddressSpace Method" title: "IHostMemoryManager::ReleasedVirtualAddressSpace Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMemoryManager.ReleasedVirtualAddressSpace" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMemoryManager::ReleasedVirtualAddressSpace" -helpviewer_keywords: +helpviewer_keywords: - "ReleasedVirtualAddressSpace method [.NET Framework hosting]" - "IHostMemoryManager::ReleasedVirtualAddressSpace method [.NET Framework hosting]" -topic_type: +ms.assetid: d1876601-6ab9-48e1-8ebd-184af1d0cd76 +topic_type: - "apiref" --- # IHostMemoryManager::ReleasedVirtualAddressSpace Method -Notifies the host that the common language runtime (CLR) has finished using the specified memory. - -## Syntax - -```cpp -HRESULT ReleasedVirtualAddressSpace( - [in] LPVOID startAddress -); -``` - -## Parameters - - `startAddress` - [in] Pointer to the starting address of the memory to be released. - -## Remarks - - The `ReleasedVirtualAddressSpace` method is a callback method and must be implemented by the writer of the hosting application. It is called by the CLR. - -## 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 2.0 - +Notifies the host that the common language runtime (CLR) has finished using the specified memory. + +## Syntax + +```cpp +HRESULT ReleasedVirtualAddressSpace( + [in] LPVOID startAddress +); +``` + +## Parameters + + `startAddress` + [in] Pointer to the starting address of the memory to be released. + +## Remarks + + The `ReleasedVirtualAddressSpace` method is a callback method and must be implemented by the writer of the hosting application. It is called by the CLR. + +## 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 - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md b/docs/framework/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md similarity index 58% rename from docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md rename to docs/framework/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md index d825222042244..1c23338322273 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostmemorymanager-virtualalloc-method.md @@ -2,85 +2,86 @@ description: "Learn more about: IHostMemoryManager::VirtualAlloc Method" title: "IHostMemoryManager::VirtualAlloc Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMemoryManager.VirtualAlloc" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMemoryManager::VirtualAlloc" -helpviewer_keywords: +helpviewer_keywords: - "VirtualAlloc method [.NET Framework hosting]" - "IHostMemoryManager::VirtualAlloc method [.NET Framework hosting]" -topic_type: +ms.assetid: 4dff3646-a050-4bd9-ac31-fe307e8637ec +topic_type: - "apiref" --- # IHostMemoryManager::VirtualAlloc Method -Serves as a logical wrapper for the corresponding Win32 function. The Win32 implementation of `VirtualAlloc` reserves or commits a region of pages in the virtual address space of the calling process. - -## Syntax - -```cpp -HRESULT VirtualAlloc ( - [in] void* pAddress, - [in] SIZE_T dwSize, - [in] DWORD flAllocationType, - [in] DWORD flProtect, - [in] EMemoryCriticalLevel dwCriticalLevel, - [out] void** ppMem -); -``` - -## Parameters - - `pAddress` - [in] A pointer to the starting address of the region to allocate. - - `dwSize` - [in] The size, in bytes, of the region. - - `flAllocationType` - [in] The type of memory allocation. - - `flProtect` - [in] Memory protection for the region of pages to be allocated. - - `dwCriticalLevel` - [in] An [EMemoryCriticalLevel](ememorycriticallevel-enumeration.md) value that indicates the impact of an allocation failure. - - `ppMem` - [out] Pointer to the starting address of the allocated memory, or null if the request could not be satisfied. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`VirtualAlloc` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to complete the allocation request| - -## Remarks - - You reserve a region in the address space of your process by calling `VirtualAlloc`. The `pAddress` parameter contains the beginning address of the memory block you want. This parameter is typically set to null. The operating system keeps a record of free address ranges available to your process. A `pAddress` value of null instructs the system to reserve the region wherever it sees fit. Alternatively, you can provide a specific starting address for the memory block. In both cases, the output parameter `ppMem` is returned as a pointer to the allocated memory. The function itself returns an HRESULT value. - - The Win32 `VirtualAlloc` function does not have a `ppMem` parameter, and returns the pointer to the allocated memory instead. For more information, see the Windows Platform documentation. - -## 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 2.0 - +Serves as a logical wrapper for the corresponding Win32 function. The Win32 implementation of `VirtualAlloc` reserves or commits a region of pages in the virtual address space of the calling process. + +## Syntax + +```cpp +HRESULT VirtualAlloc ( + [in] void* pAddress, + [in] SIZE_T dwSize, + [in] DWORD flAllocationType, + [in] DWORD flProtect, + [in] EMemoryCriticalLevel dwCriticalLevel, + [out] void** ppMem +); +``` + +## Parameters + + `pAddress` + [in] A pointer to the starting address of the region to allocate. + + `dwSize` + [in] The size, in bytes, of the region. + + `flAllocationType` + [in] The type of memory allocation. + + `flProtect` + [in] Memory protection for the region of pages to be allocated. + + `dwCriticalLevel` + [in] An [EMemoryCriticalLevel](ememorycriticallevel-enumeration.md) value that indicates the impact of an allocation failure. + + `ppMem` + [out] Pointer to the starting address of the allocated memory, or null if the request could not be satisfied. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`VirtualAlloc` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to complete the allocation request| + +## Remarks + + You reserve a region in the address space of your process by calling `VirtualAlloc`. The `pAddress` parameter contains the beginning address of the memory block you want. This parameter is typically set to null. The operating system keeps a record of free address ranges available to your process. A `pAddress` value of null instructs the system to reserve the region wherever it sees fit. Alternatively, you can provide a specific starting address for the memory block. In both cases, the output parameter `ppMem` is returned as a pointer to the allocated memory. The function itself returns an HRESULT value. + + The Win32 `VirtualAlloc` function does not have a `ppMem` parameter, and returns the pointer to the allocated memory instead. For more information, see the Windows Platform documentation. + +## 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 - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md b/docs/framework/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md similarity index 56% rename from docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md rename to docs/framework/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md index 3e6051599aba5..574909076bece 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostmemorymanager-virtualfree-method.md @@ -2,73 +2,74 @@ description: "Learn more about: IHostMemoryManager::VirtualFree Method" title: "IHostMemoryManager::VirtualFree Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMemoryManager.VirtualFree" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMemoryManager::VirtualFree" -helpviewer_keywords: +helpviewer_keywords: - "IHostMemoryManager::VirtualFree method [.NET Framework hosting]" - "VirtualFree method [.NET Framework hosting]" -topic_type: +ms.assetid: 1a436e89-eb28-4d15-bcf1-a072f86dbd99 +topic_type: - "apiref" --- # IHostMemoryManager::VirtualFree Method -Serves as a logical wrapper for the corresponding Win32 function. The Win32 implementation of `VirtualFree` releases, decommits, or releases and decommits a region of pages within the virtual address space of the calling process. - -## Syntax - -```cpp -HRESULT VirtualFree ( - [in] LPVOID lpAddress, - [in] SIZE_T dwSize, - [in] DWORD dwFreeType -); -``` - -## Parameters - - `lpAddress` - [in] A pointer to the base address of the virtual memory pages to be freed. - - `dwSize` - [in] The size, in bytes, of the region to be freed. - - `dwFreeType` - [in] The type of freeing operation. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`VirtualFree` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|HOST_E_INVALIDOPERATION|An attempt was made to free memory that was not allocated through the host.| - -## Remarks - - `VirtualFree` frees virtual memory pages associated with the `lpAddress` parameter through an earlier call to the [IHostMemoryManager::VirtualAlloc](ihostmemorymanager-virtualalloc-method.md) function. Attempts to free memory that was not allocated through the host should return HOST_E_INVALIDOPERATION. - - The semantics are identical to those of the Win32 implementation of `VirtualFree`. For more information, see the Windows Platform documentation. - -## 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 2.0 - +Serves as a logical wrapper for the corresponding Win32 function. The Win32 implementation of `VirtualFree` releases, decommits, or releases and decommits a region of pages within the virtual address space of the calling process. + +## Syntax + +```cpp +HRESULT VirtualFree ( + [in] LPVOID lpAddress, + [in] SIZE_T dwSize, + [in] DWORD dwFreeType +); +``` + +## Parameters + + `lpAddress` + [in] A pointer to the base address of the virtual memory pages to be freed. + + `dwSize` + [in] The size, in bytes, of the region to be freed. + + `dwFreeType` + [in] The type of freeing operation. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`VirtualFree` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|HOST_E_INVALIDOPERATION|An attempt was made to free memory that was not allocated through the host.| + +## Remarks + + `VirtualFree` frees virtual memory pages associated with the `lpAddress` parameter through an earlier call to the [IHostMemoryManager::VirtualAlloc](ihostmemorymanager-virtualalloc-method.md) function. Attempts to free memory that was not allocated through the host should return HOST_E_INVALIDOPERATION. + + The semantics are identical to those of the Win32 implementation of `VirtualFree`. For more information, see the Windows Platform documentation. + +## 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 - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md b/docs/framework/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md similarity index 52% rename from docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md rename to docs/framework/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md index 293a4a785b879..373d7eedfa581 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostmemorymanager-virtualprotect-method.md @@ -2,74 +2,75 @@ description: "Learn more about: IHostMemoryManager::VirtualProtect Method" title: "IHostMemoryManager::VirtualProtect Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMemoryManager.VirtualProtect" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMemoryManager::VirtualProtect" -helpviewer_keywords: +helpviewer_keywords: - "IHostMemoryManager::VirtualProtect method [.NET Framework hosting]" - "VirtualProtect method [.NET Framework hosting]" -topic_type: +ms.assetid: 13be0299-df0d-4951-aabf-0676a30b385f +topic_type: - "apiref" --- # IHostMemoryManager::VirtualProtect Method -Serves as a logical wrapper for the corresponding Win32 function. The Win32 implementation of `VirtualProtect` changes the protection on a region of committed pages in the virtual address space of the calling process. - -## Syntax - -```cpp -HRESULT VirtualProtect ( - [in] void* lpAddress, - [in] SIZE_T dwSize, - [in] DWORD flNewProtect, - [out] DWORD* pflOldProtect -); -``` - -## Parameters - - `lpAddress` - [in] A pointer to the base address of the virtual memory whose protection attributes are to be changed. - - `dwSize` - [in] The size, in bytes, of the region of memory pages to be changed. - - `flNewProtect` - [in] The type of memory protection to apply. - - `pflOldProtect` - [out] A pointer to the previous memory protection value. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`VirtualProtect` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - This implementation of `VirtualProtect` returns an HRESULT value, while the Win32 implementation returns a non-zero value to indicate success, and a zero value to indicate failure. For more information, see the Windows Platform documentation. - -## 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 2.0 - +Serves as a logical wrapper for the corresponding Win32 function. The Win32 implementation of `VirtualProtect` changes the protection on a region of committed pages in the virtual address space of the calling process. + +## Syntax + +```cpp +HRESULT VirtualProtect ( + [in] void* lpAddress, + [in] SIZE_T dwSize, + [in] DWORD flNewProtect, + [out] DWORD* pflOldProtect +); +``` + +## Parameters + + `lpAddress` + [in] A pointer to the base address of the virtual memory whose protection attributes are to be changed. + + `dwSize` + [in] The size, in bytes, of the region of memory pages to be changed. + + `flNewProtect` + [in] The type of memory protection to apply. + + `pflOldProtect` + [out] A pointer to the previous memory protection value. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`VirtualProtect` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + This implementation of `VirtualProtect` returns an HRESULT value, while the Win32 implementation returns a non-zero value to indicate success, and a zero value to indicate failure. For more information, see the Windows Platform documentation. + +## 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 - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md b/docs/framework/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md similarity index 60% rename from docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md rename to docs/framework/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md index cefb0e1e5a959..319bc13014cce 100644 --- a/docs/core/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostmemorymanager-virtualquery-method.md @@ -2,77 +2,78 @@ description: "Learn more about: IHostMemoryManager::VirtualQuery Method" title: "IHostMemoryManager::VirtualQuery Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostMemoryManager.VirtualQuery" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostMemoryManager::VirtualQuery" -helpviewer_keywords: +helpviewer_keywords: - "IHostMemoryManager::VirtualQuery method [.NET Framework hosting]" - "VirtualQuery method [.NET Framework hosting]" -topic_type: +ms.assetid: 757af1e6-b9e8-49e7-b5db-342be3aa205f +topic_type: - "apiref" --- # IHostMemoryManager::VirtualQuery Method -Serves as a logical wrapper for the corresponding Win32 function. The Win32 implementation of `VirtualQuery` retrieves information about a range of pages in the virtual address space of the calling process. - -## Syntax - -```cpp -HRESULT VirtualQuery ( - [in] void* lpAddress, - [out] void* lpBuffer, - [in] SIZE_T dwLength, - [out] SIZE_T* pResult -); -``` - -## Parameters - - `lpAddress` - [in] A pointer to the address in virtual memory to be queried. - - `lpBuffer` - [out] A pointer to a structure that contains information about the specified memory region. - - `dwLength` - [in] The size, in bytes, of the buffer that `lpBuffer` points to. - - `pResult` - [out] A pointer to the number of bytes returned by the information buffer. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`VirtualQuery` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `VirtualQuery` provides information about a range of pages in the virtual address space of the calling process. This implementation sets the value of the `pResult` parameter to the number of bytes returned in the information buffer, and returns an HRESULT value. In the Win32 `VirtualQuery` function, the return value is the buffer size. For more information, see the Windows Platform documentation. - +Serves as a logical wrapper for the corresponding Win32 function. The Win32 implementation of `VirtualQuery` retrieves information about a range of pages in the virtual address space of the calling process. + +## Syntax + +```cpp +HRESULT VirtualQuery ( + [in] void* lpAddress, + [out] void* lpBuffer, + [in] SIZE_T dwLength, + [out] SIZE_T* pResult +); +``` + +## Parameters + + `lpAddress` + [in] A pointer to the address in virtual memory to be queried. + + `lpBuffer` + [out] A pointer to a structure that contains information about the specified memory region. + + `dwLength` + [in] The size, in bytes, of the buffer that `lpBuffer` points to. + + `pResult` + [out] A pointer to the number of bytes returned by the information buffer. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`VirtualQuery` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `VirtualQuery` provides information about a range of pages in the virtual address space of the calling process. This implementation sets the value of the `pResult` parameter to the number of bytes returned in the information buffer, and returns an HRESULT value. In the Win32 `VirtualQuery` function, the return value is the buffer size. For more information, see the Windows Platform documentation. + > [!IMPORTANT] -> The operating system's implementation of `VirtualQuery` does not incur deadlock and can run to completion with random threads suspended in user code. Use great caution when implementing a hosted version of this method. - -## 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 2.0 - +> The operating system's implementation of `VirtualQuery` does not incur deadlock and can run to completion with random threads suspended in user code. Use great caution when implementing a hosted version of this method. + +## 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 - [IHostMemoryManager Interface](ihostmemorymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md b/docs/framework/unmanaged-api/hosting/ihostpolicymanager-interface.md similarity index 70% rename from docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md rename to docs/framework/unmanaged-api/hosting/ihostpolicymanager-interface.md index 76d501b086658..9ac76b87bb798 100644 --- a/docs/core/unmanaged-api/hosting/ihostpolicymanager-interface.md +++ b/docs/framework/unmanaged-api/hosting/ihostpolicymanager-interface.md @@ -2,41 +2,42 @@ description: "Learn more about: IHostPolicyManager Interface" title: "IHostPolicyManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostPolicyManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostPolicyManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostPolicyManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: 8c4aa124-5e00-46d9-b1e8-57ba6574bb0d +topic_type: - "apiref" --- # IHostPolicyManager Interface -Provides methods that notify the host of the actions the common language runtime (CLR) performs in case of aborts, timeouts, or failures. - -## Methods - -|Method|Description| -|------------|-----------------| -|[OnDefaultAction Method](ihostpolicymanager-ondefaultaction-method.md)|Notifies the host that the CLR is about to take the default action specified by a call to [ICLRPolicyManager::SetDefaultAction](iclrpolicymanager-setdefaultaction-method.md) in response to a thread abort or unload.| -|[OnFailure Method](ihostpolicymanager-onfailure-method.md)|Notifies the host that the CLR is about to take the action specified by a call to [ICLRPolicyManager::SetActionOnFailure](iclrpolicymanager-setactiononfailure-method.md) in response to a resource allocation or reclamation failure.| -|[OnTimeout Method](ihostpolicymanager-ontimeout-method.md)|Notifies the host that the CLR is about to take the action specified by a call to [ICLRPolicyManager::SetActionOnTimeout](iclrpolicymanager-setactionontimeout-method.md) in response to a timeout.| - -## 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 2.0 - +Provides methods that notify the host of the actions the common language runtime (CLR) performs in case of aborts, timeouts, or failures. + +## Methods + +|Method|Description| +|------------|-----------------| +|[OnDefaultAction Method](ihostpolicymanager-ondefaultaction-method.md)|Notifies the host that the CLR is about to take the default action specified by a call to [ICLRPolicyManager::SetDefaultAction](iclrpolicymanager-setdefaultaction-method.md) in response to a thread abort or unload.| +|[OnFailure Method](ihostpolicymanager-onfailure-method.md)|Notifies the host that the CLR is about to take the action specified by a call to [ICLRPolicyManager::SetActionOnFailure](iclrpolicymanager-setactiononfailure-method.md) in response to a resource allocation or reclamation failure.| +|[OnTimeout Method](ihostpolicymanager-ontimeout-method.md)|Notifies the host that the CLR is about to take the action specified by a call to [ICLRPolicyManager::SetActionOnTimeout](iclrpolicymanager-setactionontimeout-method.md) in response to a timeout.| + +## 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 - [EClrFailure Enumeration](eclrfailure-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md b/docs/framework/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md similarity index 63% rename from docs/core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md rename to docs/framework/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md index 57b57c91761d9..30ce27fb67779 100644 --- a/docs/core/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostpolicymanager-ondefaultaction-method.md @@ -2,62 +2,63 @@ description: "Learn more about: IHostPolicyManager::OnDefaultAction Method" title: "IHostPolicyManager::OnDefaultAction Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostPolicyManager.OnDefaultAction" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostPolicyManager::OnDefaultAction" -helpviewer_keywords: +helpviewer_keywords: - "OnDefaultAction method [.NET Framework hosting]" - "IHostPolicyManager::OnDefaultAction method [.NET Framework hosting]" -topic_type: +ms.assetid: 071e73bd-4795-470f-9373-cfaef553b7f2 +topic_type: - "apiref" --- # IHostPolicyManager::OnDefaultAction Method -Notifies the host that the common language runtime (CLR) is about to take the default action that was set by a call to the [ICLRPolicyManager::SetDefaultAction](iclrpolicymanager-setdefaultaction-method.md) method in response to a thread abort or unload. - -## Syntax - -```cpp -HRESULT OnDefaultAction ( +Notifies the host that the common language runtime (CLR) is about to take the default action that was set by a call to the [ICLRPolicyManager::SetDefaultAction](iclrpolicymanager-setdefaultaction-method.md) method in response to a thread abort or unload. + +## Syntax + +```cpp +HRESULT OnDefaultAction ( [in] EClrOperation operation, - [in] EPolicyAction action -); -``` - -## Parameters - - `operation` - [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the kind of event to which the CLR is responding. - - `action` - [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the action that the CLR is taking in response to the event. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`OnDefaultAction` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll + [in] EPolicyAction action +); +``` + +## Parameters - **.NET versions:** Available since .NET Framework 2.0 + `operation` + [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the kind of event to which the CLR is responding. + + `action` + [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the action that the CLR is taking in response to the event. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`OnDefaultAction` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 - [EClrOperation Enumeration](eclroperation-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md b/docs/framework/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md similarity index 62% rename from docs/core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md rename to docs/framework/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md index eee9d62d62d7f..b12757c62610b 100644 --- a/docs/core/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostpolicymanager-onfailure-method.md @@ -2,62 +2,63 @@ description: "Learn more about: IHostPolicyManager::OnFailure Method" title: "IHostPolicyManager::OnFailure Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostPolicyManager.OnFailure" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostPolicyManager::OnFailure" -helpviewer_keywords: +helpviewer_keywords: - "OnFailure method [.NET Framework hosting]" - "IHostPolicyManager::OnFailure method [.NET Framework hosting]" -topic_type: +ms.assetid: 77d3f31e-9a53-4349-9c02-610a71736d42 +topic_type: - "apiref" --- # IHostPolicyManager::OnFailure Method -Notifies the host that the common language runtime (CLR) is about to take the action specified by a call to the [ICLRPolicyManager::SetActionOnFailure](iclrpolicymanager-setactiononfailure-method.md) method in response to a resource allocation or reclamation failure. +Notifies the host that the common language runtime (CLR) is about to take the action specified by a call to the [ICLRPolicyManager::SetActionOnFailure](iclrpolicymanager-setactiononfailure-method.md) method in response to a resource allocation or reclamation failure. + +## Syntax + +```cpp +HRESULT OnFailure( + [in] EClrFailure failure, + [in] EPolicyAction action +); +``` + +## Parameters -## Syntax - -```cpp -HRESULT OnFailure( - [in] EClrFailure failure, - [in] EPolicyAction action -); -``` - -## Parameters - - `failure` - [in] One of the [EClrFailure](eclrfailure-enumeration.md) values, indicating the kind of failure to which the CLR is responding. - - `action` - [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the action the CLR is taking in response to `failure`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`OnFailure` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## 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 2.0 + `failure` + [in] One of the [EClrFailure](eclrfailure-enumeration.md) values, indicating the kind of failure to which the CLR is responding. + + `action` + [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the action the CLR is taking in response to `failure`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`OnFailure` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 - [EClrFailure Enumeration](eclrfailure-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md b/docs/framework/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md rename to docs/framework/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md index b826e0bd2454c..d7c84d16935c0 100644 --- a/docs/core/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostpolicymanager-ontimeout-method.md @@ -2,62 +2,63 @@ description: "Learn more about: IHostPolicyManager::OnTimeout Method" title: "IHostPolicyManager::OnTimeout Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostPolicyManager.OnTimeout" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostPolicyManager::OnTimeout" -helpviewer_keywords: +helpviewer_keywords: - "IHostPolicyManager::OnTimeout method [.NET Framework hosting]" - "OnTimeout method [.NET Framework hosting]" -topic_type: +ms.assetid: 0a313b51-5e4d-4714-a86b-af75cf3902e6 +topic_type: - "apiref" --- # IHostPolicyManager::OnTimeout Method -Notifies the host that the common language runtime (CLR) is about to take the action specified by a call to the [ICLRPolicyManager::SetActionOnTimeout](iclrpolicymanager-setactionontimeout-method.md) method in response to a timeout. - -## Syntax - -```cpp -HRESULT OnTimeout ( +Notifies the host that the common language runtime (CLR) is about to take the action specified by a call to the [ICLRPolicyManager::SetActionOnTimeout](iclrpolicymanager-setactionontimeout-method.md) method in response to a timeout. + +## Syntax + +```cpp +HRESULT OnTimeout ( [in] EClrOperation operation, - [in] EPolicyAction action -); -``` - -## Parameters - - `operation` - [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the kind of operation that timed out. - - `action` - [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the action the CLR is taking in response to the timeout. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`OnTimeout` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** Included as a resource in MSCorEE.dll + [in] EPolicyAction action +); +``` + +## Parameters - **.NET versions:** Available since .NET Framework 2.0 + `operation` + [in] One of the [EClrOperation](eclroperation-enumeration.md) values, indicating the kind of operation that timed out. + + `action` + [in] One of the [EPolicyAction](epolicyaction-enumeration.md) values, indicating the action the CLR is taking in response to the timeout. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`OnTimeout` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 - [EClrOperation Enumeration](eclroperation-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md b/docs/framework/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md rename to docs/framework/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md index 39461cab9d2d0..ab765d40e3ee1 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostsecuritycontext-capture-method.md @@ -2,62 +2,63 @@ description: "Learn more about: IHostSecurityContext::Capture Method" title: "IHostSecurityContext::Capture Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSecurityContext.Capture" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSecurityContext::Capture" -helpviewer_keywords: +helpviewer_keywords: - "Capture method [.NET Framework hosting]" - "IHostSecurityContext::Capture method [.NET Framework hosting]" -topic_type: +ms.assetid: ae0836d0-1170-4494-bac5-d0e809df51a2 +topic_type: - "apiref" --- # IHostSecurityContext::Capture Method -Gets a clone of the [IHostSecurityContext](ihostsecuritycontext-interface.md) instance returned from a call to [IHostSecurityManager::GetSecurityContext](ihostsecuritymanager-getsecuritycontext-method.md). - -## Syntax - +Gets a clone of the [IHostSecurityContext](ihostsecuritycontext-interface.md) instance returned from a call to [IHostSecurityManager::GetSecurityContext](ihostsecuritymanager-getsecuritycontext-method.md). + +## Syntax + ```cpp -HRESULT Capture ( - [out] IHostSecurityContext** ppClonedContext -); -``` - -## Parameters - - `ppClonedContext` - [out] A pointer to the address of a clone of the `IHostSecurityContext` object to be captured. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Capture` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The interface pointer returned from `Capture` is a clone of the captured context. When this information is moved across an asynchronous code point, its lifetime is separated from that of the pointer against which the call was made. The original pointer can therefore be released. - -## 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 2.0 - +HRESULT Capture ( + [out] IHostSecurityContext** ppClonedContext +); +``` + +## Parameters + + `ppClonedContext` + [out] A pointer to the address of a clone of the `IHostSecurityContext` object to be captured. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Capture` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The interface pointer returned from `Capture` is a clone of the captured context. When this information is moved across an asynchronous code point, its lifetime is separated from that of the pointer against which the call was made. The original pointer can therefore be released. + +## 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 - [IHostSecurityContext Interface](ihostsecuritycontext-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritycontext-interface.md b/docs/framework/unmanaged-api/hosting/ihostsecuritycontext-interface.md similarity index 64% rename from docs/core/unmanaged-api/hosting/ihostsecuritycontext-interface.md rename to docs/framework/unmanaged-api/hosting/ihostsecuritycontext-interface.md index 4bd462e0d39de..dd6891aaf71d3 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritycontext-interface.md +++ b/docs/framework/unmanaged-api/hosting/ihostsecuritycontext-interface.md @@ -2,43 +2,44 @@ description: "Learn more about: IHostSecurityContext Interface" title: "IHostSecurityContext Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSecurityContext" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSecurityContext" -helpviewer_keywords: +helpviewer_keywords: - "IHostSecurityContext interface [.NET Framework hosting]" -topic_type: +ms.assetid: 88e2eac0-8ccb-404f-abbc-287d55159842 +topic_type: - "apiref" --- # IHostSecurityContext Interface -Allows the common language runtime (CLR) to maintain security context information implemented by the host. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Capture Method](ihostsecuritycontext-capture-method.md)|Gets a clone of the `IHostSecurityContext` instance returned from a call to [IHostSecurityManager::GetSecurityContext](ihostsecuritymanager-getsecuritycontext-method.md).| - -## Remarks - - A host can control all code access to thread tokens by both the CLR and user code. It can also ensure that complete security context information is passed across asynchronous operations or code points with restricted code access. `IHostSecurityContext` encapsulates this security context information, which is opaque to the runtime. The runtime captures this information using `Capture`, and moves it across thread pool worker item dispatch, finalizer execution, and module and class constructors. - -## 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 2.0 - +Allows the common language runtime (CLR) to maintain security context information implemented by the host. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Capture Method](ihostsecuritycontext-capture-method.md)|Gets a clone of the `IHostSecurityContext` instance returned from a call to [IHostSecurityManager::GetSecurityContext](ihostsecuritymanager-getsecuritycontext-method.md).| + +## Remarks + + A host can control all code access to thread tokens by both the CLR and user code. It can also ensure that complete security context information is passed across asynchronous operations or code points with restricted code access. `IHostSecurityContext` encapsulates this security context information, which is opaque to the runtime. The runtime captures this information using `Capture`, and moves it across thread pool worker item dispatch, finalizer execution, and module and class constructors. + +## 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 - [ICLRHostProtectionManager Interface](iclrhostprotectionmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md b/docs/framework/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md similarity index 61% rename from docs/core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md rename to docs/framework/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md index c19e41627a66a..ec44a870bbb13 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostsecuritymanager-getsecuritycontext-method.md @@ -2,66 +2,67 @@ description: "Learn more about: IHostSecurityManager::GetSecurityContext Method" title: "IHostSecurityManager::GetSecurityContext Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSecurityManager.GetSecurityContext" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSecurityManager::GetSecurityContext" -helpviewer_keywords: +helpviewer_keywords: - "GetSecurityContext method [.NET Framework hosting]" - "IHostSecurityManager::GetSecurityContext method [.NET Framework hosting]" -topic_type: +ms.assetid: 958970d6-f6a2-4b84-b32a-f555cbaf8f61 +topic_type: - "apiref" --- # IHostSecurityManager::GetSecurityContext Method -Gets the requested [IHostSecurityContext](ihostsecuritycontext-interface.md) from the host. - -## Syntax - +Gets the requested [IHostSecurityContext](ihostsecuritycontext-interface.md) from the host. + +## Syntax + ```cpp -HRESULT GetSecurityContext ( +HRESULT GetSecurityContext ( [in] EContextType eContextType, - [out] IHostSecurityContext** ppSecurityContext -); -``` - -## Parameters - - `eContextType` - [in] One of the [EContextType](econtexttype-enumeration.md) values, indicating what type of security context to return. - - `ppSecurityContext` - [out] The address of an interface pointer to the `IHostSecurityContext` of `eContextType`. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetSecurityContext` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - A host can control all code access to thread tokens by both the CLR and user code. It can also ensure that complete security context information is passed across asynchronous operations or code points with restricted code access. `IHostSecurityContext` encapsulates this security context information, which is opaque to the CLR. The CLR captures this information and moves it across thread pool worker item dispatch, finalizer execution, and module and class construction. - -## 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 2.0 - + [out] IHostSecurityContext** ppSecurityContext +); +``` + +## Parameters + + `eContextType` + [in] One of the [EContextType](econtexttype-enumeration.md) values, indicating what type of security context to return. + + `ppSecurityContext` + [out] The address of an interface pointer to the `IHostSecurityContext` of `eContextType`. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetSecurityContext` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + A host can control all code access to thread tokens by both the CLR and user code. It can also ensure that complete security context information is passed across asynchronous operations or code points with restricted code access. `IHostSecurityContext` encapsulates this security context information, which is opaque to the CLR. The CLR captures this information and moves it across thread pool worker item dispatch, finalizer execution, and module and class construction. + +## 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 - [EContextType Enumeration](econtexttype-enumeration.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md b/docs/framework/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md rename to docs/framework/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md index 08c6f55739be5..74bff93ef58c9 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostsecuritymanager-impersonateloggedonuser-method.md @@ -2,64 +2,65 @@ description: "Learn more about: IHostSecurityManager::ImpersonateLoggedOnUser Method" title: "IHostSecurityManager::ImpersonateLoggedOnUser Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSecurityManager.ImpersonateLoggedOnUser" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSecurityManager::ImpersonateLoggedOnUser" -helpviewer_keywords: +helpviewer_keywords: - "ImpersonateLoggedOnUser method [.NET Framework hosting]" - "IHostSecurityManager::ImpersonateLoggedOnUser method [.NET Framework hosting]" -topic_type: +ms.assetid: acc49ba0-f1d9-45ad-871f-9d053a89dcbe +topic_type: - "apiref" --- # IHostSecurityManager::ImpersonateLoggedOnUser Method -Requests that code be executed using the credentials of the current user identity. - -## Syntax - -```cpp -HRESULT ImpersonateLoggedOnUser ( - [in] HANDLE hToken -); -``` - -## Parameters - - `hToken` - [in] A token representing the credentials of the user to be impersonated. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`ImpersonateLoggedOnUser` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - Call `LogonUser` or a related Win32 function to get a handle to the credentials of the current user identity. - - The `HANDLE` type is not COM-compliant, that is, its size is specific to an operating system, and it requires custom marshalling. Thus, this token is for use only within the process, between the CLR and the host. - -## 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 2.0 - +Requests that code be executed using the credentials of the current user identity. + +## Syntax + +```cpp +HRESULT ImpersonateLoggedOnUser ( + [in] HANDLE hToken +); +``` + +## Parameters + + `hToken` + [in] A token representing the credentials of the user to be impersonated. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`ImpersonateLoggedOnUser` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + Call `LogonUser` or a related Win32 function to get a handle to the credentials of the current user identity. + + The `HANDLE` type is not COM-compliant, that is, its size is specific to an operating system, and it requires custom marshalling. Thus, this token is for use only within the process, between the CLR and the host. + +## 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 - [IHostSecurityContext Interface](ihostsecuritycontext-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-interface.md b/docs/framework/unmanaged-api/hosting/ihostsecuritymanager-interface.md similarity index 62% rename from docs/core/unmanaged-api/hosting/ihostsecuritymanager-interface.md rename to docs/framework/unmanaged-api/hosting/ihostsecuritymanager-interface.md index ecfaaf5402d58..469041376bef0 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-interface.md +++ b/docs/framework/unmanaged-api/hosting/ihostsecuritymanager-interface.md @@ -2,58 +2,59 @@ description: "Learn more about: IHostSecurityManager Interface" title: "IHostSecurityManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSecurityManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSecurityManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostSecurityManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: c3be2cbd-2d93-438b-9888-9a0251b63c03 +topic_type: - "apiref" --- # IHostSecurityManager Interface -Provides methods that allow access to and control over the security context of the currently executing thread. - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetSecurityContext Method](ihostsecuritymanager-getsecuritycontext-method.md)|Gets the requested [IHostSecurityContext](ihostsecuritycontext-interface.md) from the host.| -|[ImpersonateLoggedOnUser Method](ihostsecuritymanager-impersonateloggedonuser-method.md)|Requests that code be executed using the credentials of the current user identity.| -|[OpenThreadToken Method](ihostsecuritymanager-openthreadtoken-method.md)|Opens the discretionary access token associated with the current thread.| -|[RevertToSelf Method](ihostsecuritymanager-reverttoself-method.md)|Terminates impersonation of the current user identity and returns the original thread token.| -|[SetSecurityContext Method](ihostsecuritymanager-setsecuritycontext-method.md)|Sets the security context for the currently executing thread.| -|[SetThreadToken Method](ihostsecuritymanager-setthreadtoken-method.md)|Sets a handle for the currently executing thread.| - -## Remarks - - A host can control all code access to thread tokens by both the common language runtime (CLR) and user code. It can also ensure that complete security context information is passed across asynchronous operations or code points with restricted code access. `IHostSecurityContext` encapsulates this security context information, which is opaque to the CLR. - - The CLR handles managed thread context internally. It queries the process-specific `IHostSecurityManager` in the following situations: - -- On the finalizer thread, during finalizer execution. - -- During class and module constructor execution. - -- At asynchronous points on the worker thread, in calls to the [IHostThreadPoolManager::QueueUserWorkItem](ihostthreadpoolmanager-queueuserworkitem-method.md) method. - -- In servicing of I/O completion ports. - -## 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 2.0 - +Provides methods that allow access to and control over the security context of the currently executing thread. + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetSecurityContext Method](ihostsecuritymanager-getsecuritycontext-method.md)|Gets the requested [IHostSecurityContext](ihostsecuritycontext-interface.md) from the host.| +|[ImpersonateLoggedOnUser Method](ihostsecuritymanager-impersonateloggedonuser-method.md)|Requests that code be executed using the credentials of the current user identity.| +|[OpenThreadToken Method](ihostsecuritymanager-openthreadtoken-method.md)|Opens the discretionary access token associated with the current thread.| +|[RevertToSelf Method](ihostsecuritymanager-reverttoself-method.md)|Terminates impersonation of the current user identity and returns the original thread token.| +|[SetSecurityContext Method](ihostsecuritymanager-setsecuritycontext-method.md)|Sets the security context for the currently executing thread.| +|[SetThreadToken Method](ihostsecuritymanager-setthreadtoken-method.md)|Sets a handle for the currently executing thread.| + +## Remarks + + A host can control all code access to thread tokens by both the common language runtime (CLR) and user code. It can also ensure that complete security context information is passed across asynchronous operations or code points with restricted code access. `IHostSecurityContext` encapsulates this security context information, which is opaque to the CLR. + + The CLR handles managed thread context internally. It queries the process-specific `IHostSecurityManager` in the following situations: + +- On the finalizer thread, during finalizer execution. + +- During class and module constructor execution. + +- At asynchronous points on the worker thread, in calls to the [IHostThreadPoolManager::QueueUserWorkItem](ihostthreadpoolmanager-queueuserworkitem-method.md) method. + +- In servicing of I/O completion ports. + +## 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 - [IHostSecurityContext Interface](ihostsecuritycontext-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md b/docs/framework/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md similarity index 63% rename from docs/core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md rename to docs/framework/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md index 1018a607f4aee..fb8d49e190fbf 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostsecuritymanager-openthreadtoken-method.md @@ -2,72 +2,73 @@ description: "Learn more about: IHostSecurityManager::OpenThreadToken Method" title: "IHostSecurityManager::OpenThreadToken Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSecurityManager.OpenThreadToken" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSecurityManager::OpenThreadToken" -helpviewer_keywords: +helpviewer_keywords: - "IHostSecurityManager::OpenThreadToken method [.NET Framework hosting]" - "OpenThreadToken method [.NET Framework hosting]" -topic_type: +ms.assetid: d5999052-8bf0-4a9e-8621-da6284406b18 +topic_type: - "apiref" --- # IHostSecurityManager::OpenThreadToken Method -Opens the discretionary access token associated with the currently executing thread. - -## Syntax - -```cpp -HRESULT OpenThreadToken ( +Opens the discretionary access token associated with the currently executing thread. + +## Syntax + +```cpp +HRESULT OpenThreadToken ( [in] DWORD dwDesiredAccess, [in] BOOL bOpenAsSelf, - [out] HANDLE *phThreadToken -); -``` - -## Parameters - - `dwDesiredAccess` - [in] A mask of access values that specify the requested types of access to the thread token. These values are defined in the Win32 `OpenThreadToken` function. The requested access types are reconciled against the token's discretionary access control list (DACL) to determine which types of access to grant or deny. - - `bOpenAsSelf` - [in] `true` to specify that the access check should be made using the security context of the process for the calling thread; `false` to specify that the access check should be performed using the security context for the calling thread itself. If the thread is impersonating a client, the security context can be that of a client process. - - `phThreadToken` - [out] A pointer to the newly opened access token. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`OpenThreadToken` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `IHostSecurityManager::OpenThreadToken` behaves similarly to the corresponding Win32 function of the same name, except that the Win32 function allows the caller to pass in a handle to an arbitrary thread, while `IHostSecurityManager::OpenThreadToken` opens only the token associated with the calling thread. - - The `HANDLE` type is not COM-compliant, that is, its size is specific to the operating system, and it requires custom marshalling. Thus, this token is for use only within the process, between the CLR and the host. - -## 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 2.0 - + [out] HANDLE *phThreadToken +); +``` + +## Parameters + + `dwDesiredAccess` + [in] A mask of access values that specify the requested types of access to the thread token. These values are defined in the Win32 `OpenThreadToken` function. The requested access types are reconciled against the token's discretionary access control list (DACL) to determine which types of access to grant or deny. + + `bOpenAsSelf` + [in] `true` to specify that the access check should be made using the security context of the process for the calling thread; `false` to specify that the access check should be performed using the security context for the calling thread itself. If the thread is impersonating a client, the security context can be that of a client process. + + `phThreadToken` + [out] A pointer to the newly opened access token. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`OpenThreadToken` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `IHostSecurityManager::OpenThreadToken` behaves similarly to the corresponding Win32 function of the same name, except that the Win32 function allows the caller to pass in a handle to an arbitrary thread, while `IHostSecurityManager::OpenThreadToken` opens only the token associated with the calling thread. + + The `HANDLE` type is not COM-compliant, that is, its size is specific to the operating system, and it requires custom marshalling. Thus, this token is for use only within the process, between the CLR and the host. + +## 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 - [IHostSecurityContext Interface](ihostsecuritycontext-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md b/docs/framework/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md similarity index 57% rename from docs/core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md rename to docs/framework/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md index a53e67760f94d..248adae2efe7f 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostsecuritymanager-reverttoself-method.md @@ -2,55 +2,56 @@ description: "Learn more about: IHostSecurityManager::RevertToSelf Method" title: "IHostSecurityManager::RevertToSelf Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSecurityManager.RevertToSelf" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSecurityManager::RevertToSelf" -helpviewer_keywords: +helpviewer_keywords: - "RevertToSelf method [.NET Framework hosting]" - "IHostSecurityManager::RevertToSelf method [.NET Framework hosting]" -topic_type: +ms.assetid: 189f28f8-f9a1-4192-aedc-91084e4f8b99 +topic_type: - "apiref" --- # IHostSecurityManager::RevertToSelf Method -Terminates impersonation of the current user identity and returns the original thread token. - -## Syntax - -```cpp -HRESULT RevertToSelf (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`RevertToSelf` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `RevertToSelf` is called to return to the original thread token, after an earlier call to the [ImpersonateLoggedOnUser](ihostsecuritymanager-impersonateloggedonuser-method.md) method. - -## 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 2.0 - +Terminates impersonation of the current user identity and returns the original thread token. + +## Syntax + +```cpp +HRESULT RevertToSelf (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`RevertToSelf` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `RevertToSelf` is called to return to the original thread token, after an earlier call to the [ImpersonateLoggedOnUser](ihostsecuritymanager-impersonateloggedonuser-method.md) method. + +## 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 - [IHostSecurityContext Interface](ihostsecuritycontext-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md b/docs/framework/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md similarity index 66% rename from docs/core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md rename to docs/framework/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md index 1f879ad5128fa..af82fb7c9b07f 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostsecuritymanager-setsecuritycontext-method.md @@ -2,68 +2,69 @@ description: "Learn more about: IHostSecurityManager::SetSecurityContext Method" title: "IHostSecurityManager::SetSecurityContext Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSecurityManager.SetSecurityContext" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSecurityManager::SetSecurityContext" -helpviewer_keywords: +helpviewer_keywords: - "SetSecurityContext method [.NET Framework hosting]" - "IHostSecurityManager::SetSecurityContext method [.NET Framework hosting]" -topic_type: +ms.assetid: e4372384-ee69-48d7-97e0-8fab7866597a +topic_type: - "apiref" --- # IHostSecurityManager::SetSecurityContext Method -Sets the security context of the currently executing thread. - -## Syntax - -```cpp -HRESULT SetSecurityContext ( - [in] EContextType eContextType, - [out] IHostSecurityContext** ppSecurityContext -); -``` - -## Parameters - - `eContextType` - [in] One of the [EContextType](econtexttype-enumeration.md) values, indicating what type of context the common language runtime (CLR) is placing on the host. - - `ppSecurityContext` - [out] A pointer to the address of a new [IHostSecurityContext](ihostsecuritycontext-interface.md) object. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetSecurityContext` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR calls `SetSecurityContext` in several scenarios. Before it executes class and module constructors and finalizers, the CLR calls `SetSecurityContext` to protect the host from execution failures. It then resets the security context to its original state after execution of the constructor or finalizer, by using another call to `SetSecurityContext`. A similar pattern occurs with I/O completion. If the host implements [IHostIoCompletionManager](ihostiocompletionmanager-interface.md), the CLR calls `SetSecurityContext` after the host calls [ICLRIoCompletionManager::OnComplete](iclriocompletionmanager-oncomplete-method.md). - - At asynchronous points in worker threads, the CLR calls `SetSecurityContext` within or within [IHostThreadPoolManager::QueueUserWorkItem](ihostthreadpoolmanager-queueuserworkitem-method.md), depending on whether the host or the CLR is implementing the thread pool. - -## 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 2.0 - +Sets the security context of the currently executing thread. + +## Syntax + +```cpp +HRESULT SetSecurityContext ( + [in] EContextType eContextType, + [out] IHostSecurityContext** ppSecurityContext +); +``` + +## Parameters + + `eContextType` + [in] One of the [EContextType](econtexttype-enumeration.md) values, indicating what type of context the common language runtime (CLR) is placing on the host. + + `ppSecurityContext` + [out] A pointer to the address of a new [IHostSecurityContext](ihostsecuritycontext-interface.md) object. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetSecurityContext` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR calls `SetSecurityContext` in several scenarios. Before it executes class and module constructors and finalizers, the CLR calls `SetSecurityContext` to protect the host from execution failures. It then resets the security context to its original state after execution of the constructor or finalizer, by using another call to `SetSecurityContext`. A similar pattern occurs with I/O completion. If the host implements [IHostIoCompletionManager](ihostiocompletionmanager-interface.md), the CLR calls `SetSecurityContext` after the host calls [ICLRIoCompletionManager::OnComplete](iclriocompletionmanager-oncomplete-method.md). + + At asynchronous points in worker threads, the CLR calls `SetSecurityContext` within or within [IHostThreadPoolManager::QueueUserWorkItem](ihostthreadpoolmanager-queueuserworkitem-method.md), depending on whether the host or the CLR is implementing the thread pool. + +## 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 - diff --git a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md b/docs/framework/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md similarity index 58% rename from docs/core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md rename to docs/framework/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md index c231b31464d99..82eccc9d768bd 100644 --- a/docs/core/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostsecuritymanager-setthreadtoken-method.md @@ -2,64 +2,65 @@ description: "Learn more about: IHostSecurityManager::SetThreadToken Method" title: "IHostSecurityManager::SetThreadToken Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSecurityManager.SetThreadToken" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSecurityManager::SetThreadToken" -helpviewer_keywords: +helpviewer_keywords: - "SetThreadToken method [.NET Framework hosting]" - "IHostSecurityManager::SetThreadToken method [.NET Framework hosting]" -topic_type: +ms.assetid: e951c345-8a86-4587-911b-a1a57bc6428a +topic_type: - "apiref" --- # IHostSecurityManager::SetThreadToken Method -Sets a handle for the currently executing thread. - -## Syntax - -```cpp -HRESULT SetThreadToken ( - [in] HANDLE hToken -); -``` - -## Parameters - - `hToken` - [in] A handle to the token to set for the currently executing thread. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetThreadToken` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `IHostSecurityManager::SetThreadToken` behaves similarly to the corresponding Win32 function of the same name, except that the Win32 function allows the caller to pass in a handle to an arbitrary thread, while `IHostSecurityManager::SetThreadToken` can associate a token only with the currently executing thread. - - The `HANDLE` type is not COM-compliant; that is, its size is specific to an operating system and it requires custom marshalling. Thus, this token is for use only within the process, between the CLR and the host. - -## 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 2.0 - +Sets a handle for the currently executing thread. + +## Syntax + +```cpp +HRESULT SetThreadToken ( + [in] HANDLE hToken +); +``` + +## Parameters + + `hToken` + [in] A handle to the token to set for the currently executing thread. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetThreadToken` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `IHostSecurityManager::SetThreadToken` behaves similarly to the corresponding Win32 function of the same name, except that the Win32 function allows the caller to pass in a handle to an arbitrary thread, while `IHostSecurityManager::SetThreadToken` can associate a token only with the currently executing thread. + + The `HANDLE` type is not COM-compliant; that is, its size is specific to an operating system and it requires custom marshalling. Thus, this token is for use only within the process, between the CLR and the host. + +## 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 - [IHostSecurityManager Interface](ihostsecuritymanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md b/docs/framework/unmanaged-api/hosting/ihostsemaphore-interface.md similarity index 60% rename from docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md rename to docs/framework/unmanaged-api/hosting/ihostsemaphore-interface.md index 165fa52221987..46539d7ad7f3d 100644 --- a/docs/core/unmanaged-api/hosting/ihostsemaphore-interface.md +++ b/docs/framework/unmanaged-api/hosting/ihostsemaphore-interface.md @@ -2,40 +2,41 @@ description: "Learn more about: IHostSemaphore Interface" title: "IHostSemaphore Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSemaphore" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSemaphore" -helpviewer_keywords: +helpviewer_keywords: - "IHostSemaphore interface [.NET Framework hosting]" -topic_type: +ms.assetid: c0765321-656c-441e-bab5-58176292be1e +topic_type: - "apiref" --- # IHostSemaphore Interface -Represents the host's implementation of a semaphore for threading. - -## Methods - -|Method|Description| -|------------|-----------------| -|[ReleaseSemaphore Method](ihostsemaphore-releasesemaphore-method.md)|Increases the count of the current `IHostSemaphore` instance by the specified amount.| -|[Wait Method](ihostsemaphore-wait-method.md)|Causes the current `IHostSemaphore` instance to wait until it is owned or the specified amount of time elapses.| - -## 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 2.0 - +Represents the host's implementation of a semaphore for threading. + +## Methods + +|Method|Description| +|------------|-----------------| +|[ReleaseSemaphore Method](ihostsemaphore-releasesemaphore-method.md)|Increases the count of the current `IHostSemaphore` instance by the specified amount.| +|[Wait Method](ihostsemaphore-wait-method.md)|Causes the current `IHostSemaphore` instance to wait until it is owned or the specified amount of time elapses.| + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md b/docs/framework/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md similarity index 57% rename from docs/core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md rename to docs/framework/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md index fcb329c50a4b1..fc6ba454ac13a 100644 --- a/docs/core/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostsemaphore-releasesemaphore-method.md @@ -2,66 +2,67 @@ description: "Learn more about: IHostSemaphore::ReleaseSemaphore Method" title: "IHostSemaphore::ReleaseSemaphore Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSemaphore.ReleaseSemaphore" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSemaphore::ReleaseSemaphore" -helpviewer_keywords: +helpviewer_keywords: - "ReleaseSemaphore method [.NET Framework hosting]" - "IHostSemaphore::ReleaseSemaphore method [.NET Framework hosting]" -topic_type: +ms.assetid: a343d197-979a-4ac6-ab8c-cb8a05f3120e +topic_type: - "apiref" --- # IHostSemaphore::ReleaseSemaphore Method -Increases the count of the current [IHostSemaphore](ihostsemaphore-interface.md) instance by the specified amount. - -## Syntax - -```cpp -HRESULT ReleaseSemaphore ( - [in] LONG lReleaseCount, - [out] LONG *lpPreviousCount -); -``` - -## Parameters - - `lReleaseCount` - [in] The amount by which to increase the count of the current `IHostSemaphore` instance. This amount must be greater than zero. - - `lpPreviousCount` - [out] A pointer to the previous count, or null if the caller does not require the previous count. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`ReleaseSemaphore` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR typically calls `ReleaseSemaphore` to notify the host that it has finished using a resource, passing a value of 1 for the `lReleaseCount` parameter. - -## 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 2.0 - +Increases the count of the current [IHostSemaphore](ihostsemaphore-interface.md) instance by the specified amount. + +## Syntax + +```cpp +HRESULT ReleaseSemaphore ( + [in] LONG lReleaseCount, + [out] LONG *lpPreviousCount +); +``` + +## Parameters + + `lReleaseCount` + [in] The amount by which to increase the count of the current `IHostSemaphore` instance. This amount must be greater than zero. + + `lpPreviousCount` + [out] A pointer to the previous count, or null if the caller does not require the previous count. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`ReleaseSemaphore` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR typically calls `ReleaseSemaphore` to notify the host that it has finished using a resource, passing a value of 1 for the `lReleaseCount` parameter. + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md b/docs/framework/unmanaged-api/hosting/ihostsemaphore-wait-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md rename to docs/framework/unmanaged-api/hosting/ihostsemaphore-wait-method.md index 851199bdd8031..e8516caed6bbd 100644 --- a/docs/core/unmanaged-api/hosting/ihostsemaphore-wait-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostsemaphore-wait-method.md @@ -2,63 +2,64 @@ description: "Learn more about: IHostSemaphore::Wait Method" title: "IHostSemaphore::Wait Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSemaphore.Wait" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSemaphore::Wait" -helpviewer_keywords: +helpviewer_keywords: - "IHostSemaphore::Wait method [.NET Framework hosting]" - "Wait method, IHostSemaphore interface [.NET Framework hosting]" -topic_type: +ms.assetid: 0da962a3-ce55-44dd-ab7a-14ad7105af4a +topic_type: - "apiref" --- # IHostSemaphore::Wait Method -Causes the current [IHostSemaphore](ihostsemaphore-interface.md) instance to wait until it is owned or the specified amount of time elapses. +Causes the current [IHostSemaphore](ihostsemaphore-interface.md) instance to wait until it is owned or the specified amount of time elapses. + +## Syntax + +```cpp +HRESULT Wait ( + [in] DWORD dwMilliseconds, + [in] DWORD option +); +``` + +## Parameters -## Syntax - -```cpp -HRESULT Wait ( - [in] DWORD dwMilliseconds, - [in] DWORD option -); -``` - -## Parameters - - `dwMilliseconds` - [in] The number of milliseconds to wait before returning, if the current `IHostSemaphore` instance is not owned. - - `option` - [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values, specifying what action the host should take if this operation blocks. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Wait` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|HOST_E_DEADLOCK|The host detected a deadlock during the wait interval, and chose the current `IHostSemaphore` instance as a deadlock victim.| - -## 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 2.0 + `dwMilliseconds` + [in] The number of milliseconds to wait before returning, if the current `IHostSemaphore` instance is not owned. + + `option` + [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values, specifying what action the host should take if this operation blocks. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Wait` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|HOST_E_DEADLOCK|The host detected a deadlock during the wait interval, and chose the current `IHostSemaphore` instance as a deadlock victim.| + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md b/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md rename to docs/framework/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md index e8ed66094c355..c2cc267add966 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createautoevent-method.md @@ -2,63 +2,64 @@ description: "Learn more about: IHostSyncManager::CreateAutoEvent Method" title: "IHostSyncManager::CreateAutoEvent Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSyncManager.CreateAutoEvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSyncManager::CreateAutoEvent" -helpviewer_keywords: +helpviewer_keywords: - "IHostSyncManager::CreateAutoEvent method [.NET Framework hosting]" - "CreateAutoEvent method [.NET Framework hosting]" -topic_type: +ms.assetid: 3153643e-cf5c-4b44-8e0e-c2b22cb08208 +topic_type: - "apiref" --- # IHostSyncManager::CreateAutoEvent Method -Creates an auto-reset event object. - -## Syntax - -```cpp -HRESULT CreateAutoEvent ( - [out] IHostAutoEvent **ppEvent -); -``` - -## Parameters - - `ppEvent` - [out] A pointer to the address of an [IHostAutoEvent](ihostautoevent-interface.md) instance implemented by the host, or null if the event object could not be created. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateAutoEvent` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| - -## Remarks - - `CreateAutoEvent` creates an auto-event object whose state is automatically changed to non-signaled after the waiting thread has been released. This method mirrors the Win32 `CreateEvent` function with a value of `false` specified for the `bManualReset` parameter - -## 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 2.0 - +Creates an auto-reset event object. + +## Syntax + +```cpp +HRESULT CreateAutoEvent ( + [out] IHostAutoEvent **ppEvent +); +``` + +## Parameters + + `ppEvent` + [out] A pointer to the address of an [IHostAutoEvent](ihostautoevent-interface.md) instance implemented by the host, or null if the event object could not be created. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateAutoEvent` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| + +## Remarks + + `CreateAutoEvent` creates an auto-event object whose state is automatically changed to non-signaled after the waiting thread has been released. This method mirrors the Win32 `CreateEvent` function with a value of `false` specified for the `bManualReset` parameter + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md b/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md rename to docs/framework/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md index 9663b5d040a03..38bd999bb504f 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createcrst-method.md @@ -2,63 +2,64 @@ description: "Learn more about: IHostSyncManager::CreateCrst Method" title: "IHostSyncManager::CreateCrst Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSyncManager.CreateCrst" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSyncManager::CreateCrst" -helpviewer_keywords: +helpviewer_keywords: - "CreateCrst method [.NET Framework hosting]" - "IHostSyncManager::CreateCrst method [.NET Framework hosting]" -topic_type: +ms.assetid: ac278cc8-2540-4a6c-b5c6-b90c3970b4f4 +topic_type: - "apiref" --- # IHostSyncManager::CreateCrst Method -Creates a critical section object for synchronization. - -## Syntax - -```cpp -HRESULT CreateCrst ( - [out] IHostCrst** ppCrst -); -``` - -## Parameters - - `ppCrst` - [out] A pointer to the address of an [IHostCrst](ihostcrst-interface.md) instance implemented by the host, or null if the critical section could not be created. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateCrst` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to create the requested critical section.| - -## Remarks - - Critical section objects provide synchronization similar to that provided by a mutex object, except that critical sections can be used only by the threads of a single process. `CreateCrst` mirrors the Win32 `InitializeCriticalSection` function. - -## 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 2.0 - +Creates a critical section object for synchronization. + +## Syntax + +```cpp +HRESULT CreateCrst ( + [out] IHostCrst** ppCrst +); +``` + +## Parameters + + `ppCrst` + [out] A pointer to the address of an [IHostCrst](ihostcrst-interface.md) instance implemented by the host, or null if the critical section could not be created. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateCrst` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to create the requested critical section.| + +## Remarks + + Critical section objects provide synchronization similar to that provided by a mutex object, except that critical sections can be used only by the threads of a single process. `CreateCrst` mirrors the Win32 `InitializeCriticalSection` function. + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md b/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md rename to docs/framework/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md index 1204ab19de703..e1da373d744e5 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createcrstwithspincount-method.md @@ -2,67 +2,68 @@ description: "Learn more about: IHostSyncManager::CreateCrstWithSpinCount Method" title: "IHostSyncManager::CreateCrstWithSpinCount Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSyncManager.CreateCrstWithSpinCount" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSyncManager::CreateCrstWithSpinCount" -helpviewer_keywords: +helpviewer_keywords: - "CreateCrstWithSpinCount method [.NET Framework hosting]" - "IHostSyncManager::CreateCrstWithSpinCount method [.NET Framework hosting]" -topic_type: +ms.assetid: 7280fa8c-3639-4abf-91cb-bc343da742d1 +topic_type: - "apiref" --- # IHostSyncManager::CreateCrstWithSpinCount Method -Creates a critical section object with spin count for synchronization. - -## Syntax - -```cpp -HRESULT CreateCrstWithSpinCount ( - [in] DWORD dwSpinCount, - [out] IHostCrst** ppCrst -); -``` - -## Parameters - - `dwSpinCount` - [in] Specifies the spin count for the critical section object. - - `ppCrst` - [out] A pointer to the address of an [IHostCrst](ihostcrst-interface.md) instance, or null if the critical section could not be created. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateCrstWithSpinCount` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to create the requested critical section.| - -## Remarks - - A spin count is used only on a multi-processor system. The spin count specifies the number of times a calling thread must spin before it performs a wait operation on a semaphore that is associated with an unavailable critical section. If the critical section becomes free during the spin operation, the calling thread avoids the wait operation. `CreateCrstWithSpinCount` mirrors the Win32 `InitializeCriticalSectionAndSpinCount` function. - -## 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 2.0 - +Creates a critical section object with spin count for synchronization. + +## Syntax + +```cpp +HRESULT CreateCrstWithSpinCount ( + [in] DWORD dwSpinCount, + [out] IHostCrst** ppCrst +); +``` + +## Parameters + + `dwSpinCount` + [in] Specifies the spin count for the critical section object. + + `ppCrst` + [out] A pointer to the address of an [IHostCrst](ihostcrst-interface.md) instance, or null if the critical section could not be created. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateCrstWithSpinCount` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to create the requested critical section.| + +## Remarks + + A spin count is used only on a multi-processor system. The spin count specifies the number of times a calling thread must spin before it performs a wait operation on a semaphore that is associated with an unavailable critical section. If the critical section becomes free during the spin operation, the calling thread avoids the wait operation. `CreateCrstWithSpinCount` mirrors the Win32 `InitializeCriticalSectionAndSpinCount` function. + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md b/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md similarity index 57% rename from docs/core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md rename to docs/framework/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md index d6ed4fac761aa..0296a135f1f76 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createmanualevent-method.md @@ -2,67 +2,68 @@ description: "Learn more about: IHostSyncManager::CreateManualEvent Method" title: "IHostSyncManager::CreateManualEvent Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSyncManager.CreateManualEvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSyncManager::CreateManualEvent" -helpviewer_keywords: +helpviewer_keywords: - "CreateManualEvent method [.NET Framework hosting]" - "IHostSyncManager::CreateManualEvent method [.NET Framework hosting]" -topic_type: +ms.assetid: 68661fbd-09cf-46dc-890b-e694f8a3880a +topic_type: - "apiref" --- # IHostSyncManager::CreateManualEvent Method -Creates a manual-reset event object. - -## Syntax - -```cpp -HRESULT CreateManualEvent ( - [in] BOOL bInitialState, - [out] IHostManualEvent **ppEvent -); -``` - -## Parameters - - `bInitialState` - [in] `true`, if the object is signaled; otherwise, `false`. - - `ppEvent` - [out] A pointer to the address of an [IHostManualEvent](ihostmanualevent-interface.md) instance, or null if the event could not be created. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateManualEvent` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| - -## Remarks - - `CreateManualEvent` creates an `IHostManualEvent`, a manual-reset event object that requires a call to the [IHostManualEvent::Reset](ihostmanualevent-reset-method.md) method to set it to a non-signaled state. `CreateManualEvent` mirrors the Win32 `CreateEvent` function with a value of `true` specified for the `bManualReset` parameter. - -## 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 2.0 - +Creates a manual-reset event object. + +## Syntax + +```cpp +HRESULT CreateManualEvent ( + [in] BOOL bInitialState, + [out] IHostManualEvent **ppEvent +); +``` + +## Parameters + + `bInitialState` + [in] `true`, if the object is signaled; otherwise, `false`. + + `ppEvent` + [out] A pointer to the address of an [IHostManualEvent](ihostmanualevent-interface.md) instance, or null if the event could not be created. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateManualEvent` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| + +## Remarks + + `CreateManualEvent` creates an `IHostManualEvent`, a manual-reset event object that requires a call to the [IHostManualEvent::Reset](ihostmanualevent-reset-method.md) method to set it to a non-signaled state. `CreateManualEvent` mirrors the Win32 `CreateEvent` function with a value of `true` specified for the `bManualReset` parameter. + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md b/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md similarity index 57% rename from docs/core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md rename to docs/framework/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md index 5c38b55673449..50bb1a8e8978f 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createmonitorevent-method.md @@ -2,69 +2,70 @@ description: "Learn more about: IHostSyncManager::CreateMonitorEvent Method" title: "IHostSyncManager::CreateMonitorEvent Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSyncManager.CreateMonitorEvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSyncManager::CreateMonitorEvent" -helpviewer_keywords: +helpviewer_keywords: - "CreateMonitorEvent method [.NET Framework hosting]" - "IHostSyncManager::CreateMonitorEvent method [.NET Framework hosting]" -topic_type: +ms.assetid: 524c7fd3-9b5c-46e7-99ba-555fd2fe33f0 +topic_type: - "apiref" --- # IHostSyncManager::CreateMonitorEvent Method -Creates a monitored auto-reset event object. - -## Syntax - -```cpp -HRESULT CreateMonitorEvent ( - [in] SIZE_T cookie, - [out] IHostAutoEvent **ppEvent -); -``` - -## Parameters - - `cookie` - [in] A cookie to associate with the event object. - - `ppEvent` - [out] A pointer to the address of an [IHostAutoEvent](ihostautoevent-interface.md) instance, or null if the event object could not be created. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateMonitorEvent` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| - -## Remarks - - `CreateMonitorEvent` returns an `IHostAutoEvent` that the CLR uses in its implementation of the managed type. This method mirrors the Win32 `CreateEvent` function, with a value of `false` specified for the `bManualReset` parameter. - - The host can use the cookie to determine which task is waiting on the monitor by calling the [ICLRSyncManager::GetMonitorOwner](iclrsyncmanager-getmonitorowner-method.md) method. - -## 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 2.0 - +Creates a monitored auto-reset event object. + +## Syntax + +```cpp +HRESULT CreateMonitorEvent ( + [in] SIZE_T cookie, + [out] IHostAutoEvent **ppEvent +); +``` + +## Parameters + + `cookie` + [in] A cookie to associate with the event object. + + `ppEvent` + [out] A pointer to the address of an [IHostAutoEvent](ihostautoevent-interface.md) instance, or null if the event object could not be created. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateMonitorEvent` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| + +## Remarks + + `CreateMonitorEvent` returns an `IHostAutoEvent` that the CLR uses in its implementation of the managed type. This method mirrors the Win32 `CreateEvent` function, with a value of `false` specified for the `bManualReset` parameter. + + The host can use the cookie to determine which task is waiting on the monitor by calling the [ICLRSyncManager::GetMonitorOwner](iclrsyncmanager-getmonitorowner-method.md) method. + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md b/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md similarity index 58% rename from docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md rename to docs/framework/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md index 71a0a4171828c..cb4d67f41f5cd 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createrwlockreaderevent-method.md @@ -2,71 +2,72 @@ description: "Learn more about: IHostSyncManager::CreateRWLockReaderEvent Method" title: "IHostSyncManager::CreateRWLockReaderEvent Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSyncManager.CreateRWLockReaderEvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSyncManager::CreateRWLockReaderEvent" -helpviewer_keywords: +helpviewer_keywords: - "CreateRWLockReaderEvent method [.NET Framework hosting]" - "IHostSyncManager::CreateRWLockReaderEvent method [.NET Framework hosting]" -topic_type: +ms.assetid: 68c4ea19-c47c-45c6-b420-d3a2ba1c2d50 +topic_type: - "apiref" --- # IHostSyncManager::CreateRWLockReaderEvent Method -Creates a manual-reset event object for the implementation of a reader lock. - -## Syntax - -```cpp -HRESULT CreateRWLockReaderEvent ( - [in] BOOL bInitialState, - [in] SIZE_T cookie, - [out] IHostManualEvent **ppEvent -); -``` - -## Parameters - - `bInitialState` - [in] `true`, if `ppEvent` should be signaled; otherwise, `false`. - - `cookie` - [in] A cookie to associate with the reader lock. - - `ppEvent` - [out] A pointer to the address of an [IHostManualEvent](ihostmanualevent-interface.md) instance, or null if the event object could not be created. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateRWLockReaderEvent` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| - -## Remarks - - The CLR calls `CreateRWLockReaderEvent` to get a reference to an `IHostManualEvent` instance to use in its implementation of a reader lock. The host can use the cookie to determine which tasks are waiting on the reader lock by querying the [ICLRSyncManager](iclrsyncmanager-interface.md) interface. - -## 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 2.0 - +Creates a manual-reset event object for the implementation of a reader lock. + +## Syntax + +```cpp +HRESULT CreateRWLockReaderEvent ( + [in] BOOL bInitialState, + [in] SIZE_T cookie, + [out] IHostManualEvent **ppEvent +); +``` + +## Parameters + + `bInitialState` + [in] `true`, if `ppEvent` should be signaled; otherwise, `false`. + + `cookie` + [in] A cookie to associate with the reader lock. + + `ppEvent` + [out] A pointer to the address of an [IHostManualEvent](ihostmanualevent-interface.md) instance, or null if the event object could not be created. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateRWLockReaderEvent` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| + +## Remarks + + The CLR calls `CreateRWLockReaderEvent` to get a reference to an `IHostManualEvent` instance to use in its implementation of a reader lock. The host can use the cookie to determine which tasks are waiting on the reader lock by querying the [ICLRSyncManager](iclrsyncmanager-interface.md) interface. + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md b/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md similarity index 60% rename from docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md rename to docs/framework/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md index 15441ec0db6cb..f6148f00aa516 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createrwlockwriterevent-method.md @@ -2,67 +2,68 @@ description: "Learn more about: IHostSyncManager::CreateRWLockWriterEvent Method" title: "IHostSyncManager::CreateRWLockWriterEvent Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSyncManager.CreateRWLockWriterEvent" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSyncManager::CreateRWLockWriterEvent" -helpviewer_keywords: +helpviewer_keywords: - "CreateRWLockWriterEvent method [.NET Framework hosting]" - "IHostSyncManager::CreateRWLockWriterEvent method [.NET Framework hosting]" -topic_type: +ms.assetid: 70e488c2-cf53-4dc0-ba52-74372d215c41 +topic_type: - "apiref" --- # IHostSyncManager::CreateRWLockWriterEvent Method -Creates an auto-reset event object for the implementation of a writer lock. - -## Syntax - -```cpp -HRESULT CreateRWLockWriterEvent ( - [in] SIZE_T cookie, - [out] IHostAutoEvent **ppEvent -); -``` - -## Parameters - - `cookie` - [in] A cookie to associate with the auto-reset event. - - `ppEvent` - [out] A pointer to the address of an [IHostAutoEvent](ihostautoevent-interface.md) instance, or null if the event object could not be created. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateRWLockWriterEvent` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| - -## Remarks - - The CLR calls the `CreateRWLockWriterEvent` method to get a reference to an `IHostAutoEvent` instance to use in its implementation of a writer lock. The host can use the specified cookie to determine which tasks are waiting on the lock by calling the iteration methods of the [ICLRSyncManager](iclrsyncmanager-interface.md) interface. - -## 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 2.0 - +Creates an auto-reset event object for the implementation of a writer lock. + +## Syntax + +```cpp +HRESULT CreateRWLockWriterEvent ( + [in] SIZE_T cookie, + [out] IHostAutoEvent **ppEvent +); +``` + +## Parameters + + `cookie` + [in] A cookie to associate with the auto-reset event. + + `ppEvent` + [out] A pointer to the address of an [IHostAutoEvent](ihostautoevent-interface.md) instance, or null if the event object could not be created. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateRWLockWriterEvent` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| + +## Remarks + + The CLR calls the `CreateRWLockWriterEvent` method to get a reference to an `IHostAutoEvent` instance to use in its implementation of a writer lock. The host can use the specified cookie to determine which tasks are waiting on the lock by calling the iteration methods of the [ICLRSyncManager](iclrsyncmanager-interface.md) interface. + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md b/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md similarity index 57% rename from docs/core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md rename to docs/framework/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md index 0d3fe1e1f8e76..96c3bd14f1064 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostsyncmanager-createsemaphore-method.md @@ -2,71 +2,72 @@ description: "Learn more about: IHostSyncManager::CreateSemaphore Method" title: "IHostSyncManager::CreateSemaphore Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSyncManager.CreateSemaphore" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSyncManager::CreateSemaphore" -helpviewer_keywords: +helpviewer_keywords: - "CreateSemaphore method [.NET Framework hosting]" - "IHostSyncManager::CreateSemaphore method [.NET Framework hosting]" -topic_type: +ms.assetid: 37679e94-5ff9-4173-8fa5-457febeb89bf +topic_type: - "apiref" --- # IHostSyncManager::CreateSemaphore Method -Creates an [IHostSemaphore](ihostsemaphore-interface.md) object for the common language runtime (CLR) to use as a semaphore for wait events. - -## Syntax - -```cpp -HRESULT CreateSemaphore ( - [in] DWORD dwInitial, - [in] DWORD dwMax, - [out] IHostSemaphore **ppSemaphore -); -``` - -## Parameters - - `dwInitial` - [in] The initial count for `ppSemaphore`. - - `dwMax` - [in] The maximum count for `ppSemaphore`. - - `ppSemaphore` - [out] A pointer to the address of an `IHostSemaphore` instance, or null if the semaphore could not be created. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateSemaphore` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| - -## Remarks - - `CreateSemaphore` mirrors the Win32 function that has the same name. The `dwInitial` and `dwMax` parameters use the same semantics for the semaphore count as the Win32 `lInitialCount` and `lMaximumCount` parameters, respectively. `dwInitial` must be between zero and `dwMax`, inclusive. `dwMax` must be greater than zero. - -## 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 2.0 - +Creates an [IHostSemaphore](ihostsemaphore-interface.md) object for the common language runtime (CLR) to use as a semaphore for wait events. + +## Syntax + +```cpp +HRESULT CreateSemaphore ( + [in] DWORD dwInitial, + [in] DWORD dwMax, + [out] IHostSemaphore **ppSemaphore +); +``` + +## Parameters + + `dwInitial` + [in] The initial count for `ppSemaphore`. + + `dwMax` + [in] The maximum count for `ppSemaphore`. + + `ppSemaphore` + [out] A pointer to the address of an `IHostSemaphore` instance, or null if the semaphore could not be created. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateSemaphore` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to create the requested event object.| + +## Remarks + + `CreateSemaphore` mirrors the Win32 function that has the same name. The `dwInitial` and `dwMax` parameters use the same semantics for the semaphore count as the Win32 `lInitialCount` and `lMaximumCount` parameters, respectively. `dwInitial` must be between zero and `dwMax`, inclusive. `dwMax` must be greater than zero. + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md b/docs/framework/unmanaged-api/hosting/ihostsyncmanager-interface.md similarity index 63% rename from docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md rename to docs/framework/unmanaged-api/hosting/ihostsyncmanager-interface.md index 7e4f1393e22c6..ed889a294d9e9 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-interface.md +++ b/docs/framework/unmanaged-api/hosting/ihostsyncmanager-interface.md @@ -2,51 +2,52 @@ description: "Learn more about: IHostSyncManager Interface" title: "IHostSyncManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSyncManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSyncManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostSyncManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: 2e081a37-6a28-4c93-b7ab-1c96a464637c +topic_type: - "apiref" --- # IHostSyncManager Interface -Provides methods that allow the common language runtime (CLR) to create synchronization primitives by calling the host instead of using the Win32 synchronization functions. - -## Methods - -|Method|Description| -|------------|-----------------| -|[CreateAutoEvent Method](ihostsyncmanager-createautoevent-method.md)|Creates an auto-reset event object.| -|[CreateCrst Method](ihostsyncmanager-createcrst-method.md)|Creates a critical section object for synchronization.| -|[CreateCrstWithSpinCount Method](ihostsyncmanager-createcrstwithspincount-method.md)|Creates a critical section object with spin count for synchronization.| -|[CreateManualEvent Method](ihostsyncmanager-createmanualevent-method.md)|Creates a manual-reset event object.| -|[CreateMonitorEvent Method](ihostsyncmanager-createmonitorevent-method.md)|Creates a monitored auto-reset event object.| -|[CreateRWLockReaderEvent Method](ihostsyncmanager-createrwlockreaderevent-method.md)|Creates a manual-reset event object for the implementation of a reader lock.| -|[CreateRWLockWriterEvent Method](ihostsyncmanager-createrwlockwriterevent-method.md)|Creates an auto-reset event object for the implementation of a writer lock.| -|[CreateSemaphore Method](ihostsyncmanager-createsemaphore-method.md)|Creates an [IHostSemaphore](ihostsemaphore-interface.md) object for the CLR to use as a semaphore for wait events.| -|[SetCLRSyncManager Method](ihostsyncmanager-setclrsyncmanager-method.md)|Sets the [ICLRSyncManager](iclrsyncmanager-interface.md) instance to associate with the current `IHostSyncManager` instance.| - -## Remarks - - The CLR discovers the host's implementation of `IHostSyncManager` by calling the [IHostControl::GetHostManager](ihostcontrol-gethostmanager-method.md) method with an `IID` of IID_IHostSyncManager. - -## 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 2.0 - +Provides methods that allow the common language runtime (CLR) to create synchronization primitives by calling the host instead of using the Win32 synchronization functions. + +## Methods + +|Method|Description| +|------------|-----------------| +|[CreateAutoEvent Method](ihostsyncmanager-createautoevent-method.md)|Creates an auto-reset event object.| +|[CreateCrst Method](ihostsyncmanager-createcrst-method.md)|Creates a critical section object for synchronization.| +|[CreateCrstWithSpinCount Method](ihostsyncmanager-createcrstwithspincount-method.md)|Creates a critical section object with spin count for synchronization.| +|[CreateManualEvent Method](ihostsyncmanager-createmanualevent-method.md)|Creates a manual-reset event object.| +|[CreateMonitorEvent Method](ihostsyncmanager-createmonitorevent-method.md)|Creates a monitored auto-reset event object.| +|[CreateRWLockReaderEvent Method](ihostsyncmanager-createrwlockreaderevent-method.md)|Creates a manual-reset event object for the implementation of a reader lock.| +|[CreateRWLockWriterEvent Method](ihostsyncmanager-createrwlockwriterevent-method.md)|Creates an auto-reset event object for the implementation of a writer lock.| +|[CreateSemaphore Method](ihostsyncmanager-createsemaphore-method.md)|Creates an [IHostSemaphore](ihostsemaphore-interface.md) object for the CLR to use as a semaphore for wait events.| +|[SetCLRSyncManager Method](ihostsyncmanager-setclrsyncmanager-method.md)|Sets the [ICLRSyncManager](iclrsyncmanager-interface.md) instance to associate with the current `IHostSyncManager` instance.| + +## Remarks + + The CLR discovers the host's implementation of `IHostSyncManager` by calling the [IHostControl::GetHostManager](ihostcontrol-gethostmanager-method.md) method with an `IID` of IID_IHostSyncManager. + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md b/docs/framework/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md similarity index 61% rename from docs/core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md rename to docs/framework/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md index a1a922c2c86ce..9a70748f2fa20 100644 --- a/docs/core/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostsyncmanager-setclrsyncmanager-method.md @@ -2,62 +2,63 @@ description: "Learn more about: IHostSyncManager::SetCLRSyncManager Method" title: "IHostSyncManager::SetCLRSyncManager Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostSyncManager.SetCLRSyncManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostSyncManager::SetCLRSyncManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostSyncManager::SetCLRSyncManager method [.NET Framework hosting]" - "SetCLRSyncManager method [.NET Framework hosting]" -topic_type: +ms.assetid: 2b8bbe76-a45d-4989-bacb-11df42f8798c +topic_type: - "apiref" --- # IHostSyncManager::SetCLRSyncManager Method -Sets the [ICLRSyncManager](iclrsyncmanager-interface.md) instance to associate with the current [IHostSyncManager](ihostsyncmanager-interface.md) instance. - -## Syntax - -```cpp -HRESULT SetCLRSyncManager ( - [in] ICLRSyncManager *pManager -); -``` - -## Parameters - - `pManager` - [in] A pointer to an `ICLRSyncManager` instance supplied by the common language runtime (CLR). - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetCLRSyncManager` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - To facilitate communication between the host and the CLR, hosting interfaces generally come in pairs. One member of the pair is implemented by the host, and the other member is implemented by the CLR. As a host-side implementation, the `IHostSyncManager` interface corresponds to the `ICLRSyncManager` interface implemented by the CLR. The CLR calls `SetCLRSyncManager` to supply an `ICLRSyncManager` instance for the host to associate with the current `IHostSyncManager` instance. - -## 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 2.0 - +Sets the [ICLRSyncManager](iclrsyncmanager-interface.md) instance to associate with the current [IHostSyncManager](ihostsyncmanager-interface.md) instance. + +## Syntax + +```cpp +HRESULT SetCLRSyncManager ( + [in] ICLRSyncManager *pManager +); +``` + +## Parameters + + `pManager` + [in] A pointer to an `ICLRSyncManager` instance supplied by the common language runtime (CLR). + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetCLRSyncManager` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + To facilitate communication between the host and the CLR, hosting interfaces generally come in pairs. One member of the pair is implemented by the host, and the other member is implemented by the CLR. As a host-side implementation, the `IHostSyncManager` interface corresponds to the `ICLRSyncManager` interface implemented by the CLR. The CLR calls `SetCLRSyncManager` to supply an `ICLRSyncManager` instance for the host to associate with the current `IHostSyncManager` instance. + +## 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 - [ICLRSyncManager Interface](iclrsyncmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttask-alert-method.md b/docs/framework/unmanaged-api/hosting/ihosttask-alert-method.md similarity index 62% rename from docs/core/unmanaged-api/hosting/ihosttask-alert-method.md rename to docs/framework/unmanaged-api/hosting/ihosttask-alert-method.md index d56d928476316..dc4da783ba4cc 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-alert-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttask-alert-method.md @@ -2,58 +2,59 @@ description: "Learn more about: IHostTask::Alert Method" title: "IHostTask::Alert Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTask.Alert" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTask::Alert" -helpviewer_keywords: +helpviewer_keywords: - "IHostTask::Alert method [.NET Framework hosting]" - "Alert method, IHostTask interface [.NET Framework hosting]" -topic_type: +ms.assetid: 5245d4b5-b6c3-48df-9cb9-8caf059f43fb +topic_type: - "apiref" --- # IHostTask::Alert Method -Requests that the host wake the task represented by the current [IHostTask](ihosttask-interface.md) instance, so the task can be aborted. - -## Syntax - -```cpp -HRESULT Alert (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|The method returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR calls the `Alert` method when is called from user code, or when the associated with the current shuts down. The host must return immediately, because the call is made asynchronously. If the host cannot alert the task immediately, it must wake up the next time it enters a state in which it can be alerted. - +Requests that the host wake the task represented by the current [IHostTask](ihosttask-interface.md) instance, so the task can be aborted. + +## Syntax + +```cpp +HRESULT Alert (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|The method returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR calls the `Alert` method when is called from user code, or when the associated with the current shuts down. The host must return immediately, because the call is made asynchronously. If the host cannot alert the task immediately, it must wake up the next time it enters a state in which it can be alerted. + > [!NOTE] -> `Alert` affects only those tasks to which the runtime has passed a [WAIT_OPTION](wait-option-enumeration.md) value of WAIT_ALERTABLE to methods such as [Join](ihosttask-join-method.md). - -## 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 2.0 - +> `Alert` affects only those tasks to which the runtime has passed a [WAIT_OPTION](wait-option-enumeration.md) value of WAIT_ALERTABLE to methods such as [Join](ihosttask-join-method.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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md b/docs/framework/unmanaged-api/hosting/ihosttask-getpriority-method.md similarity index 55% rename from docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md rename to docs/framework/unmanaged-api/hosting/ihosttask-getpriority-method.md index 3a7479d1fda36..c1686de7339fb 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-getpriority-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttask-getpriority-method.md @@ -2,62 +2,63 @@ description: "Learn more about: IHostTask::GetPriority Method" title: "IHostTask::GetPriority Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTask.GetPriority" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTask::GetPriority" -helpviewer_keywords: +helpviewer_keywords: - "GetPriority method [.NET Framework hosting]" - "IHostTask::GetPriority method [.NET Framework hosting]" -topic_type: +ms.assetid: 4b463cd6-77c1-4f9a-8518-346ad8fc4b70 +topic_type: - "apiref" --- # IHostTask::GetPriority Method -Gets the thread priority level of the task represented by the current [IHostTask](ihosttask-interface.md) instance. - -## Syntax - -```cpp -HRESULT GetPriority ( - [out] int *pPriority -); -``` - -## Parameters - - `pPriority` - [out] A pointer to an integer that indicates the thread priority level of the task represented by the current `IHostTask` instance. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetPriority` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - Thread priority level values are defined by the Win32 `SetThreadPriority` function. - -## 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 2.0 - +Gets the thread priority level of the task represented by the current [IHostTask](ihosttask-interface.md) instance. + +## Syntax + +```cpp +HRESULT GetPriority ( + [out] int *pPriority +); +``` + +## Parameters + + `pPriority` + [out] A pointer to an integer that indicates the thread priority level of the task represented by the current `IHostTask` instance. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetPriority` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + Thread priority level values are defined by the Win32 `SetThreadPriority` function. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttask-interface.md b/docs/framework/unmanaged-api/hosting/ihosttask-interface.md similarity index 64% rename from docs/core/unmanaged-api/hosting/ihosttask-interface.md rename to docs/framework/unmanaged-api/hosting/ihosttask-interface.md index 05bdc62ad4096..e3f8bb48f374f 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-interface.md +++ b/docs/framework/unmanaged-api/hosting/ihosttask-interface.md @@ -2,48 +2,49 @@ description: "Learn more about: IHostTask Interface" title: "IHostTask Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTask" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTask" -helpviewer_keywords: +helpviewer_keywords: - "IHostTask interface [.NET Framework hosting]" -topic_type: +ms.assetid: a71dbbd5-64b8-47eb-9f03-8e8c85fbe2bc +topic_type: - "apiref" --- # IHostTask Interface -Provides methods that allow the common language runtime (CLR) to communicate with the host to manage tasks. - -## Methods - -|Method|Description| -|------------|-----------------| -|[Alert Method](ihosttask-alert-method.md)|Requests that the host wake the task represented by the current `IHostTask` instance, so the task can be aborted.| -|[GetPriority Method](ihosttask-getpriority-method.md)|Gets the thread priority level of the task represented by the current `IHostTask` instance.| -|[Join Method](ihosttask-join-method.md)|Blocks the calling task until the task represented by the current `IHostTask` instance completes, the specified time interval elapses, or [IHostTask::Alert](ihosttask-alert-method.md) is called.| -|[SetCLRTask Method](ihosttask-setclrtask-method.md)|Associates an [ICLRTask Interface](iclrtask-interface.md) instance with the current `IHostTask` instance.| -|[SetPriority Method](ihosttask-setpriority-method.md)|Requests that the host adjust the thread priority level for the task represented by the current `IHostTask` instance.| -|[Start Method](ihosttask-start-method.md)|Requests that the host move the task represented by the current `IHostTask` instance from a suspended state to a live state, in which code can be executed.| - -## Remarks - - The CLR calls methods defined by `IHostTask` to start a task, set its thread priority level, and so on. - -## 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 2.0 - +Provides methods that allow the common language runtime (CLR) to communicate with the host to manage tasks. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Alert Method](ihosttask-alert-method.md)|Requests that the host wake the task represented by the current `IHostTask` instance, so the task can be aborted.| +|[GetPriority Method](ihosttask-getpriority-method.md)|Gets the thread priority level of the task represented by the current `IHostTask` instance.| +|[Join Method](ihosttask-join-method.md)|Blocks the calling task until the task represented by the current `IHostTask` instance completes, the specified time interval elapses, or [IHostTask::Alert](ihosttask-alert-method.md) is called.| +|[SetCLRTask Method](ihosttask-setclrtask-method.md)|Associates an [ICLRTask Interface](iclrtask-interface.md) instance with the current `IHostTask` instance.| +|[SetPriority Method](ihosttask-setpriority-method.md)|Requests that the host adjust the thread priority level for the task represented by the current `IHostTask` instance.| +|[Start Method](ihosttask-start-method.md)|Requests that the host move the task represented by the current `IHostTask` instance from a suspended state to a live state, in which code can be executed.| + +## Remarks + + The CLR calls methods defined by `IHostTask` to start a task, set its thread priority level, and so on. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttask-join-method.md b/docs/framework/unmanaged-api/hosting/ihosttask-join-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/ihosttask-join-method.md rename to docs/framework/unmanaged-api/hosting/ihosttask-join-method.md index acdb60924ad46..973f76f116cd1 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-join-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttask-join-method.md @@ -2,62 +2,63 @@ description: "Learn more about: IHostTask::Join Method" title: "IHostTask::Join Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTask.Join" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTask::Join" -helpviewer_keywords: +helpviewer_keywords: - "IHostTask::Join method [.NET Framework hosting]" - "Join method, IHostTask interface [.NET Framework hosting]" -topic_type: +ms.assetid: 2cffcc52-19e0-4ced-a440-fc7375078ac9 +topic_type: - "apiref" --- # IHostTask::Join Method -Blocks the calling task until the task represented by the current [IHostTask](ihosttask-interface.md) instance completes, the specified time interval elapses, or [IHostTask::Alert](ihosttask-alert-method.md) is called. +Blocks the calling task until the task represented by the current [IHostTask](ihosttask-interface.md) instance completes, the specified time interval elapses, or [IHostTask::Alert](ihosttask-alert-method.md) is called. + +## Syntax + +```cpp +HRESULT Join ( + [in] DWORD milliseconds, + [in] DWORD option +); +``` + +## Parameters -## Syntax - -```cpp -HRESULT Join ( - [in] DWORD milliseconds, - [in] DWORD option -); -``` - -## Parameters - - `milliseconds` - [in] The time interval, in milliseconds, to wait for the task to terminate. If this interval elapses before the task terminates, the calling task unblocks. - - `option` - [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values. A value of WAIT_ALERTABLE instructs the host to wake the task if `Alert` is called before `milliseconds` elapses. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Join` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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, or the current `IHostTask` instance is not associated with a task.| -|E_FAIL|An unknown catastrophic failure occurred. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## 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 2.0 + `milliseconds` + [in] The time interval, in milliseconds, to wait for the task to terminate. If this interval elapses before the task terminates, the calling task unblocks. + + `option` + [in] One of the [WAIT_OPTION](wait-option-enumeration.md) values. A value of WAIT_ALERTABLE instructs the host to wake the task if `Alert` is called before `milliseconds` elapses. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Join` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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, or the current `IHostTask` instance is not associated with a task.| +|E_FAIL|An unknown catastrophic failure occurred. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md b/docs/framework/unmanaged-api/hosting/ihosttask-setclrtask-method.md similarity index 56% rename from docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md rename to docs/framework/unmanaged-api/hosting/ihosttask-setclrtask-method.md index 6b12ccf38b035..30cdb85ca8829 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-setclrtask-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttask-setclrtask-method.md @@ -2,62 +2,63 @@ description: "Learn more about: IHostTask::SetCLRTask Method" title: "IHostTask::SetCLRTask Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTask.SetCLRTask" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTask::SetCLRTask" -helpviewer_keywords: +helpviewer_keywords: - "SetCLRTask method [.NET Framework hosting]" - "IHostTask::SetCLRTask method [.NET Framework hosting]" -topic_type: +ms.assetid: e9d39c80-41a1-49e7-bb5e-ea3433bfb5d7 +topic_type: - "apiref" --- # IHostTask::SetCLRTask Method -Associates an `ICLRTask` instance with the current [IHostTask](ihosttask-interface.md) instance. - -## Syntax - -```cpp -HRESULT SetCLRTask ( - [in] ICLRTask *pCLRTask -); -``` - -## Parameters - - `pCLRTask` - [in] An interface pointer to the `ICLRTask` instance to be associated with the current `IHostTask` instance. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetCLRTask` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR calls `SetCLRTask` to associate an `ICLRTask` instance with the current `IHostTask` instance, which was created by a call to [IHostTaskManager::CreateTask](ihosttaskmanager-createtask-method.md). - -## 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 2.0 - +Associates an `ICLRTask` instance with the current [IHostTask](ihosttask-interface.md) instance. + +## Syntax + +```cpp +HRESULT SetCLRTask ( + [in] ICLRTask *pCLRTask +); +``` + +## Parameters + + `pCLRTask` + [in] An interface pointer to the `ICLRTask` instance to be associated with the current `IHostTask` instance. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetCLRTask` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR calls `SetCLRTask` to associate an `ICLRTask` instance with the current `IHostTask` instance, which was created by a call to [IHostTaskManager::CreateTask](ihosttaskmanager-createtask-method.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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md b/docs/framework/unmanaged-api/hosting/ihosttask-setpriority-method.md similarity index 60% rename from docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md rename to docs/framework/unmanaged-api/hosting/ihosttask-setpriority-method.md index 41d4a56bef399..38339d6999b2c 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-setpriority-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttask-setpriority-method.md @@ -2,83 +2,84 @@ description: "Learn more about: IHostTask::SetPriority Method" title: "IHostTask::SetPriority Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTask.SetPriority" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTask::SetPriority" -helpviewer_keywords: +helpviewer_keywords: - "IHostTask::SetPriority method [.NET Framework hosting]" - "SetPriority method [.NET Framework hosting]" -topic_type: +ms.assetid: cd8c379b-c7a0-434f-8e23-899bd26be75d +topic_type: - "apiref" --- # IHostTask::SetPriority Method -Requests that the host adjust the thread priority level for the task represented by the current [IHostTask](ihosttask-interface.md) instance. - -## Syntax - -```cpp -HRESULT SetPriority ( - [in] int newPriority -); -``` - -## Parameters - - `newPriority` - [in] An integer that represents the requested thread priority value for the task represented by the current `IHostTask` instance. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetPriority` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - Threads are granted processing time using a round-robin system that is partly based on a thread's priority level. `SetPriority` allows the CLR to set that thread priority level for the current task. The following `newPriority` values are supported. - -- THREAD_PRIORITY_ABOVE_NORMAL - -- THREAD_PRIORITY_BELOW_NORMAL - -- THREAD_PRIORITY_HIGHEST - -- THREAD_PRIORITY_IDLE - -- THREAD_PRIORITY_LOWEST - -- THREAD_PRIORITY_NORMAL - -- THREAD_PRIORITY_TIME_CRITICAL - - The CLR calls `SetPriority` when the value of the is modified by user code. A host can define its own algorithms for thread priority assignment, and is free to ignore this request. - +Requests that the host adjust the thread priority level for the task represented by the current [IHostTask](ihosttask-interface.md) instance. + +## Syntax + +```cpp +HRESULT SetPriority ( + [in] int newPriority +); +``` + +## Parameters + + `newPriority` + [in] An integer that represents the requested thread priority value for the task represented by the current `IHostTask` instance. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetPriority` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + Threads are granted processing time using a round-robin system that is partly based on a thread's priority level. `SetPriority` allows the CLR to set that thread priority level for the current task. The following `newPriority` values are supported. + +- THREAD_PRIORITY_ABOVE_NORMAL + +- THREAD_PRIORITY_BELOW_NORMAL + +- THREAD_PRIORITY_HIGHEST + +- THREAD_PRIORITY_IDLE + +- THREAD_PRIORITY_LOWEST + +- THREAD_PRIORITY_NORMAL + +- THREAD_PRIORITY_TIME_CRITICAL + + The CLR calls `SetPriority` when the value of the is modified by user code. A host can define its own algorithms for thread priority assignment, and is free to ignore this request. + > [!NOTE] -> `SetPriority` does not report whether the thread priority level was changed. Call [IHostTask::GetPriority](ihosttask-getpriority-method.md) to determine the value of the task's thread priority level. - - Thread priority level values are defined by the Win32 `SetThreadPriority` function. For more information about thread priority, see the Windows Platform documentation. - -## 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 2.0 - +> `SetPriority` does not report whether the thread priority level was changed. Call [IHostTask::GetPriority](ihosttask-getpriority-method.md) to determine the value of the task's thread priority level. + + Thread priority level values are defined by the Win32 `SetThreadPriority` function. For more information about thread priority, see the Windows Platform documentation. + +## 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 - diff --git a/docs/core/unmanaged-api/hosting/ihosttask-start-method.md b/docs/framework/unmanaged-api/hosting/ihosttask-start-method.md similarity index 55% rename from docs/core/unmanaged-api/hosting/ihosttask-start-method.md rename to docs/framework/unmanaged-api/hosting/ihosttask-start-method.md index 58e14371ba4ee..67fcf1ca7a6da 100644 --- a/docs/core/unmanaged-api/hosting/ihosttask-start-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttask-start-method.md @@ -2,51 +2,52 @@ description: "Learn more about: IHostTask::Start Method" title: "IHostTask::Start Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTask.Start" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTask::Start" -helpviewer_keywords: +helpviewer_keywords: - "IHostTask::Start method [.NET Framework hosting]" - "Start method, IHostTask interface [.NET Framework hosting]" -topic_type: +ms.assetid: b18742b0-d8c4-401c-ae89-e6eccdaa81d0 +topic_type: - "apiref" --- # IHostTask::Start Method -Requests that the host move the task represented by the current [IHostTask](ihosttask-interface.md) instance from a suspended to a live state, in which code can be executed. - -## Syntax - -```cpp -HRESULT Start (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|Start returned successfully.| -|E_FAIL|An unknown catastrophic failure occurred. When a method returns E_FAIL, the common language runtime (CLR) is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `Start` always returns an HRESULT value of S_OK, except in cases where a catastrophic failure has occurred. - -## 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 2.0 - +Requests that the host move the task represented by the current [IHostTask](ihosttask-interface.md) instance from a suspended to a live state, in which code can be executed. + +## Syntax + +```cpp +HRESULT Start (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|Start returned successfully.| +|E_FAIL|An unknown catastrophic failure occurred. When a method returns E_FAIL, the common language runtime (CLR) is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `Start` always returns an HRESULT value of S_OK, except in cases where a catastrophic failure has occurred. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md similarity index 58% rename from docs/core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md rename to docs/framework/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md index 0a636880a2da9..97adb26488850 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-begindelayabort-method.md @@ -2,56 +2,57 @@ description: "Learn more about: IHostTaskManager::BeginDelayAbort Method" title: "IHostTaskManager::BeginDelayAbort Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.BeginDelayAbort" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::BeginDelayAbort" -helpviewer_keywords: +helpviewer_keywords: - "BeginDelayAbort method [.NET Framework hosting]" - "IHostTaskManager::BeginDelayAbort method [.NET Framework hosting]" -topic_type: +ms.assetid: 75f42a8b-ed68-4718-a030-a179cfba7d72 +topic_type: - "apiref" --- # IHostTaskManager::BeginDelayAbort Method -Notifies the host that managed code is entering a period in which the current task must not be aborted. - -## Syntax - -```cpp -HRESULT BeginDelayAbort (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`BeginDelayAbort` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_UNEXPECTED|`BeginDelayAbort` has already been called, but the corresponding call to [EndDelayAbort](ihosttaskmanager-enddelayabort-method.md) has not yet been received.| - -## Remarks - - The host must not abort the current task until `EndDelayAbort` is called. If another call to `BeginDelayAbort` is made without an intervening call to `EndDelayAbort`, the host should return E_UNEXPECTED from `BeginDelayAbort`, and should take no action. - -## 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 2.0 - +Notifies the host that managed code is entering a period in which the current task must not be aborted. + +## Syntax + +```cpp +HRESULT BeginDelayAbort (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`BeginDelayAbort` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_UNEXPECTED|`BeginDelayAbort` has already been called, but the corresponding call to [EndDelayAbort](ihosttaskmanager-enddelayabort-method.md) has not yet been received.| + +## Remarks + + The host must not abort the current task until `EndDelayAbort` is called. If another call to `BeginDelayAbort` is made without an intervening call to `EndDelayAbort`, the host should return E_UNEXPECTED from `BeginDelayAbort`, and should take no action. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md similarity index 66% rename from docs/core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md rename to docs/framework/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md index 369e821d0a771..aff2ba4d2c6b8 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-beginthreadaffinity-method.md @@ -2,55 +2,56 @@ description: "Learn more about: IHostTaskManager::BeginThreadAffinity Method" title: "IHostTaskManager::BeginThreadAffinity Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.BeginThreadAffinity" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::BeginThreadAffinity" -helpviewer_keywords: +helpviewer_keywords: - "IHostTaskManager::BeginThreadAffinity method [.NET Framework hosting]" - "BeginThreadAffinity method [.NET Framework hosting]" -topic_type: +ms.assetid: fea3ab88-ce41-4c5a-847b-bb78cd748da6 +topic_type: - "apiref" --- # IHostTaskManager::BeginThreadAffinity Method -Notifies the host that managed code is entering a period in which the current task must not be moved to another operating system thread. - -## Syntax - -```cpp -HRESULT BeginThreadAffinity (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`BeginThreadAffinity` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR typically calls `IHostTaskManager::BeginThreadAffinity` in the context of a call to . The current task must not be rescheduled until a corresponding call is made to [IHostTaskManager::EndThreadAffinity](ihosttaskmanager-endthreadaffinity-method.md). Tasks can be switched out, but when they are switched back in, they must be assigned to the same operating system thread from which they were switched out. Nested calls to `BeginThreadAffinity` have no effect, because the call refers to the current task. - -## 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 2.0 - +Notifies the host that managed code is entering a period in which the current task must not be moved to another operating system thread. + +## Syntax + +```cpp +HRESULT BeginThreadAffinity (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`BeginThreadAffinity` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR typically calls `IHostTaskManager::BeginThreadAffinity` in the context of a call to . The current task must not be rescheduled until a corresponding call is made to [IHostTaskManager::EndThreadAffinity](ihosttaskmanager-endthreadaffinity-method.md). Tasks can be switched out, but when they are switched back in, they must be assigned to the same operating system thread from which they were switched out. Nested calls to `BeginThreadAffinity` have no effect, because the call refers to the current task. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md similarity index 65% rename from docs/core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md rename to docs/framework/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md index a31581e23b960..15f25beee0d3b 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-callneedshosthook-method.md @@ -2,68 +2,69 @@ description: "Learn more about: IHostTaskManager::CallNeedsHostHook Method" title: "IHostTaskManager::CallNeedsHostHook Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.CallNeedsHostHook" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::CallNeedsHostHook" -helpviewer_keywords: +helpviewer_keywords: - "CallNeedsHostHook method [.NET Framework hosting]" - "IHostTaskManager::CallNeedsHostHook method [.NET Framework hosting]" -topic_type: +ms.assetid: b60f1f59-9825-4b57-961f-d2979518e6a7 +topic_type: - "apiref" --- # IHostTaskManager::CallNeedsHostHook Method -Enables the host to specify whether the common language runtime (CLR) can inline the specified call to an unmanaged function. - -## Syntax - -```cpp -HRESULT CallNeedsHostHook ( +Enables the host to specify whether the common language runtime (CLR) can inline the specified call to an unmanaged function. + +## Syntax + +```cpp +HRESULT CallNeedsHostHook ( [in] SIZE_T target, - [out] BOOL *pbCallNeedsHostHook -); -``` - -## Parameters - - `target` - [in] The address within the mapped portable executable (PE) file of the unmanaged function that is to be called. - - `pbCallNeedsHostHook` - [out] A pointer to a Boolean value that indicates whether the host requires the call to be hooked. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CallNeedsHostHook` 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 has occurred. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - To help optimize code execution, the CLR performs an analysis of each platform invoke call during compilation to determine whether the call can be inlined. `CallNeedsHostHook` enables the host to override that decision by requiring that a call to an unmanaged function be hooked. If the host requires a hook, the runtime does not inline the call. - - The host typically would require a hook where it must adjust a floating-point state, or upon receiving notification that a call is entering a state where the host cannot track the runtime's requests for memory or any locks taken. When the host requires that the call be hooked, the runtime notifies the host of transitions to and from managed code by using calls to [EnterRuntime](ihosttaskmanager-enterruntime-method.md), [LeaveRuntime](ihosttaskmanager-leaveruntime-method.md), [ReverseEnterRuntime](ihosttaskmanager-reverseenterruntime-method.md), and [ReverseLeaveRuntime](ihosttaskmanager-reverseleaveruntime-method.md). - -## 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 2.0 - + [out] BOOL *pbCallNeedsHostHook +); +``` + +## Parameters + + `target` + [in] The address within the mapped portable executable (PE) file of the unmanaged function that is to be called. + + `pbCallNeedsHostHook` + [out] A pointer to a Boolean value that indicates whether the host requires the call to be hooked. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CallNeedsHostHook` 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 has occurred. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + To help optimize code execution, the CLR performs an analysis of each platform invoke call during compilation to determine whether the call can be inlined. `CallNeedsHostHook` enables the host to override that decision by requiring that a call to an unmanaged function be hooked. If the host requires a hook, the runtime does not inline the call. + + The host typically would require a hook where it must adjust a floating-point state, or upon receiving notification that a call is entering a state where the host cannot track the runtime's requests for memory or any locks taken. When the host requires that the call be hooked, the runtime notifies the host of transitions to and from managed code by using calls to [EnterRuntime](ihosttaskmanager-enterruntime-method.md), [LeaveRuntime](ihosttaskmanager-leaveruntime-method.md), [ReverseEnterRuntime](ihosttaskmanager-reverseenterruntime-method.md), and [ReverseLeaveRuntime](ihosttaskmanager-reverseleaveruntime-method.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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md similarity index 56% rename from docs/core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md rename to docs/framework/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md index e7b855ad35450..77cac9fb4f794 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-createtask-method.md @@ -2,75 +2,76 @@ description: "Learn more about: IHostTaskManager::CreateTask Method" title: "IHostTaskManager::CreateTask Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.CreateTask" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::CreateTask" -helpviewer_keywords: +helpviewer_keywords: - "CreateTask method, IHostTaskManager interface [.NET Framework hosting]" - "IHostTaskManager::CreateTask method [.NET Framework hosting]" -topic_type: +ms.assetid: a6f8ad36-61e1-42b0-9db2-add575646d18 +topic_type: - "apiref" --- # IHostTaskManager::CreateTask Method -Requests that the host create a new task. - -## Syntax - -```cpp -HRESULT CreateTask ( +Requests that the host create a new task. + +## Syntax + +```cpp +HRESULT CreateTask ( [in] DWORD stacksize, - [in] LPTHREAD_START_ROUTINE pStartAddress, - [in] PVOID pParameter, - [out] IHostTask **ppTask -); -``` - -## Parameters - - `stacksize` - [in] The requested size, in bytes, of the requested stack, or 0 (zero) for the default size. - - `pStartAddress` - [in] A pointer to the function the task is to execute. - - `pParameter` - [in] A pointer to the user data to be passed to the function, or null if the function takes no parameters. - - `ppTask` - [out] A pointer to the address of an [IHostTask](ihosttask-interface.md) instance created by the host, or null if the task cannot be created. The task remains in a suspended state until it is explicitly started by a call to [IHostTask::Start](ihosttask-start-method.md). - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`CreateTask` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to create the requested task.| - -## Remarks - - The CLR calls `CreateTask` to request that the host create a new task. The host returns an interface pointer to an `IHostTask` instance. The returned task must remain suspended until it is explicitly started by a call to `IHostTask::Start`. - -## 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 2.0 - + [in] LPTHREAD_START_ROUTINE pStartAddress, + [in] PVOID pParameter, + [out] IHostTask **ppTask +); +``` + +## Parameters + + `stacksize` + [in] The requested size, in bytes, of the requested stack, or 0 (zero) for the default size. + + `pStartAddress` + [in] A pointer to the function the task is to execute. + + `pParameter` + [in] A pointer to the user data to be passed to the function, or null if the function takes no parameters. + + `ppTask` + [out] A pointer to the address of an [IHostTask](ihosttask-interface.md) instance created by the host, or null if the task cannot be created. The task remains in a suspended state until it is explicitly started by a call to [IHostTask::Start](ihosttask-start-method.md). + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`CreateTask` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to create the requested task.| + +## Remarks + + The CLR calls `CreateTask` to request that the host create a new task. The host returns an interface pointer to an `IHostTask` instance. The returned task must remain suspended until it is explicitly started by a call to `IHostTask::Start`. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md similarity index 62% rename from docs/core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md rename to docs/framework/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md index 700e0fc403226..463f083bfee9f 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-enddelayabort-method.md @@ -2,56 +2,57 @@ description: "Learn more about: IHostTaskManager::EndDelayAbort Method" title: "IHostTaskManager::EndDelayAbort Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.EndDelayAbort" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::EndDelayAbort" -helpviewer_keywords: +helpviewer_keywords: - "EndDelayAbort method [.NET Framework hosting]" - "IHostTaskManager::EndDelayAbort method [.NET Framework hosting]" -topic_type: +ms.assetid: 6e02facb-2504-4356-9af5-0cee1f8436a7 +topic_type: - "apiref" --- # IHostTaskManager::EndDelayAbort Method -Notifies the host that managed code is exiting the period in which the current task must not be aborted, following an earlier call to [IHostTaskManager::BeginDelayAbort](ihosttaskmanager-begindelayabort-method.md). - -## Syntax - -```cpp -HRESULT EndDelayAbort (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`EndDelayAbort` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_UNEXPECTED|`EndDelayAbort` was called without a corresponding call to `BeginDelayAbort`.| - -## Remarks - - The CLR makes a corresponding call to `BeginDelayAbort` on the current task before calling `EndDelayAbort`. In the absence of such a corresponding call, the host's implementation of [IHostTaskManager](ihosttaskmanager-interface.md) should return E_UNEXPECTED from `EndDelayAbort`, and should take no action. - -## 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 2.0 - +Notifies the host that managed code is exiting the period in which the current task must not be aborted, following an earlier call to [IHostTaskManager::BeginDelayAbort](ihosttaskmanager-begindelayabort-method.md). + +## Syntax + +```cpp +HRESULT EndDelayAbort (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`EndDelayAbort` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_UNEXPECTED|`EndDelayAbort` was called without a corresponding call to `BeginDelayAbort`.| + +## Remarks + + The CLR makes a corresponding call to `BeginDelayAbort` on the current task before calling `EndDelayAbort`. In the absence of such a corresponding call, the host's implementation of [IHostTaskManager](ihosttaskmanager-interface.md) should return E_UNEXPECTED from `EndDelayAbort`, and should take no action. + +## 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 - diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md similarity index 61% rename from docs/core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md rename to docs/framework/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md index a92faff6a3bff..989ace5baef27 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-endthreadaffinity-method.md @@ -2,56 +2,57 @@ description: "Learn more about: IHostTaskManager::EndThreadAffinity Method" title: "IHostTaskManager::EndThreadAffinity Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.EndThreadAffinity" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::EndThreadAffinity" -helpviewer_keywords: +helpviewer_keywords: - "EndThreadAffinity method [.NET Framework hosting]" - "IHostTaskManager::EndThreadAffinity method [.NET Framework hosting]" -topic_type: +ms.assetid: 7738a904-0cd7-4fde-a3eb-2323a5533157 +topic_type: - "apiref" --- # IHostTaskManager::EndThreadAffinity Method -Notifies the host that managed code is exiting the period in which the current task must not be moved to another operating system thread, following an earlier call to [IHostTaskManager::BeginThreadAffinity](ihosttaskmanager-beginthreadaffinity-method.md). - -## Syntax - -```cpp -HRESULT EndThreadAffinity (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`EndThreadAffinity` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_UNEXPECTED|`EndThreadAffinity` was called without an earlier corresponding call to `BeginThreadAffinity`.| - -## Remarks - - The CLR makes a corresponding call to `BeginThreadAffinity` on the current task before calling `EndThreadAffinity`. In the absence of such a corresponding call, the host's implementation of [IHostTaskManager](ihosttaskmanager-interface.md) should return E_UNEXPECTED, and take no action. - -## 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 2.0 - +Notifies the host that managed code is exiting the period in which the current task must not be moved to another operating system thread, following an earlier call to [IHostTaskManager::BeginThreadAffinity](ihosttaskmanager-beginthreadaffinity-method.md). + +## Syntax + +```cpp +HRESULT EndThreadAffinity (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`EndThreadAffinity` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_UNEXPECTED|`EndThreadAffinity` was called without an earlier corresponding call to `BeginThreadAffinity`.| + +## Remarks + + The CLR makes a corresponding call to `BeginThreadAffinity` on the current task before calling `EndThreadAffinity`. In the absence of such a corresponding call, the host's implementation of [IHostTaskManager](ihosttaskmanager-interface.md) should return E_UNEXPECTED, and take no action. + +## 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 - diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md similarity index 66% rename from docs/core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md rename to docs/framework/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md index f738161d652fa..913726252ac08 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-enterruntime-method.md @@ -2,59 +2,60 @@ description: "Learn more about: IHostTaskManager::EnterRuntime Method" title: "IHostTaskManager::EnterRuntime Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.EnterRuntime" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::EnterRuntime" -helpviewer_keywords: +helpviewer_keywords: - "IHostTaskManager::EnterRuntime method [.NET Framework hosting]" - "EnterRuntime method [.NET Framework hosting]" -topic_type: +ms.assetid: 1aa7a4b1-636a-4f5e-b834-b406d72f7120 +topic_type: - "apiref" --- # IHostTaskManager::EnterRuntime Method -Notifies the host that a call to an unmanaged method, such as a platform invoke method, is returning execution control to the common language runtime (CLR). - -## Syntax - -```cpp -HRESULT EnterRuntime (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`EnterRuntime` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory was available to complete the requested allocation.| - -## Remarks - - `EnterRuntime` is called to notify the host that an unmanaged function, for which an earlier call to the [LeaveRuntime](ihosttaskmanager-leaveruntime-method.md) method was made, has finished executing, and is returning execution control to the runtime. +Notifies the host that a call to an unmanaged method, such as a platform invoke method, is returning execution control to the common language runtime (CLR). + +## Syntax + +```cpp +HRESULT EnterRuntime (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`EnterRuntime` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory was available to complete the requested allocation.| + +## Remarks + `EnterRuntime` is called to notify the host that an unmanaged function, for which an earlier call to the [LeaveRuntime](ihosttaskmanager-leaveruntime-method.md) method was made, has finished executing, and is returning execution control to the runtime. + > [!NOTE] -> [ReverseEnterRuntime](ihosttaskmanager-reverseenterruntime-method.md) is called to notify the host that an unmanaged function, for which an earlier call to `LeaveRuntime` was made, is making a call into managed code. - -## 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 2.0 +> [ReverseEnterRuntime](ihosttaskmanager-reverseenterruntime-method.md) is called to notify the host that an unmanaged function, for which an earlier call to `LeaveRuntime` was made, is making a call into managed code. + +## 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 - [Advanced COM Interoperability](/previous-versions/dotnet/netframework-4.0/bd9cdfyx(v=vs.100)) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md similarity index 55% rename from docs/core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md rename to docs/framework/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md index 152645e53c6a7..da5c7afe156e0 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-getcurrenttask-method.md @@ -2,63 +2,64 @@ description: "Learn more about: IHostTaskManager::GetCurrentTask Method" title: "IHostTaskManager::GetCurrentTask Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.GetCurrentTask" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::GetCurrentTask" -helpviewer_keywords: +helpviewer_keywords: - "GetCurrentTask method, IHostTaskManager interface [.NET Framework hosting]" - "IHostTaskManager::GetCurrentTask method [.NET Framework hosting]" -topic_type: +ms.assetid: f17bca49-90bd-4dee-a5e1-b9a57ea46f85 +topic_type: - "apiref" --- # IHostTaskManager::GetCurrentTask Method -Gets an interface pointer to the task that is currently executing on the operating system thread from which this call is made. - -## Syntax - -```cpp -HRESULT GetCurrentTask ( - [out] IHostTask **pTask -); -``` - -## Parameters - - `pTask` - [out] A pointer to the address of an [IHostTask](ihosttask-interface.md) instance that represents the currently executing task, or null, if no task is currently executing. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetCurrentTask` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|HOST_E_INVALIDOPERATION|`GetCurrentTask` was called on an operating system thread outside the control of the host.| - -## Remarks - - The host can also set the `pTask` parameter to null to prevent a task that it did not initiate from entering the CLR. - -## 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 2.0 - +Gets an interface pointer to the task that is currently executing on the operating system thread from which this call is made. + +## Syntax + +```cpp +HRESULT GetCurrentTask ( + [out] IHostTask **pTask +); +``` + +## Parameters + + `pTask` + [out] A pointer to the address of an [IHostTask](ihosttask-interface.md) instance that represents the currently executing task, or null, if no task is currently executing. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetCurrentTask` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|HOST_E_INVALIDOPERATION|`GetCurrentTask` was called on an operating system thread outside the control of the host.| + +## Remarks + + The host can also set the `pTask` parameter to null to prevent a task that it did not initiate from entering the CLR. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md similarity index 50% rename from docs/core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md rename to docs/framework/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md index 153d75aea54db..bc4225b09f520 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-getstackguarantee-method.md @@ -2,47 +2,48 @@ description: "Learn more about: IHostTaskManager::GetStackGuarantee Method" title: "IHostTaskManager::GetStackGuarantee Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.GetStackGuarantee" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::GetStackGuarantee" -helpviewer_keywords: +helpviewer_keywords: - "GetStackGuarantee method [.NET Framework hosting]" - "IHostTaskManager::GetStackGuarantee method [.NET Framework hosting]" -topic_type: +ms.assetid: 8176d732-c25c-4520-811d-e3310f339947 +topic_type: - "apiref" --- # IHostTaskManager::GetStackGuarantee Method -Gets the amount of stack space that is guaranteed to be available after a stack operation completes, but before the closing of a process. - -## Syntax - -```cpp -HRESULT GetStackGuarantee( - [out] ULONG *pGuarantee -); -``` - -## Parameters - - `pGuarantee` - [out] A pointer to the number of bytes that are available. - -## 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 2.0 - +Gets the amount of stack space that is guaranteed to be available after a stack operation completes, but before the closing of a process. + +## Syntax + +```cpp +HRESULT GetStackGuarantee( + [out] ULONG *pGuarantee +); +``` + +## Parameters + + `pGuarantee` + [out] A pointer to the number of bytes that are available. + +## 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 - [IHostTaskManager Interface](ihosttaskmanager-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-interface.md similarity index 77% rename from docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md rename to docs/framework/unmanaged-api/hosting/ihosttaskmanager-interface.md index 4956d31841e7b..d78df4e114078 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-interface.md +++ b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-interface.md @@ -2,60 +2,61 @@ description: "Learn more about: IHostTaskManager Interface" title: "IHostTaskManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostTaskManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: 4a0b05b9-3ef1-4607-b7c8-bd4dd43647a0 +topic_type: - "apiref" --- # IHostTaskManager Interface -Provides methods that allow the common language runtime (CLR) to work with tasks through the host instead of using the standard operating system threading or fiber functions. +Provides methods that allow the common language runtime (CLR) to work with tasks through the host instead of using the standard operating system threading or fiber functions. + +## Methods + +|Method|Description| +|------------|-----------------| +|[BeginDelayAbort Method](ihosttaskmanager-begindelayabort-method.md)|Notifies the host that managed code is entering a period in which the current task must not be aborted.| +|[BeginThreadAffinity Method](ihosttaskmanager-beginthreadaffinity-method.md)|Notifies the host that managed code is entering a period in which the current task must not be moved to another operating system thread.| +|[CallNeedsHostHook Method](ihosttaskmanager-callneedshosthook-method.md)|Enables the host to specify whether the common language runtime can inline the specified call to an unmanaged function.| +|[CreateTask Method](ihosttaskmanager-createtask-method.md)|Requests that the host create a new task.| +|[EndDelayAbort Method](ihosttaskmanager-enddelayabort-method.md)|Notifies the host that managed code is exiting the period in which the current task must not be aborted, following an earlier call to `BeginDelayAbort`.| +|[EndThreadAffinity Method](ihosttaskmanager-endthreadaffinity-method.md)|Notifies the host that managed code is exiting the period in which the current task must not be moved to another operating system thread, following an earlier call to `BeginThreadAffinity`.| +|[EnterRuntime Method](ihosttaskmanager-enterruntime-method.md)|Notifies the host that a call to an unmanaged method, such as a platform invoke method, is returning execution control to the CLR.| +|[GetCurrentTask Method](ihosttaskmanager-getcurrenttask-method.md)|Gets an interface pointer to the task that is currently executing on the operating system thread from which this call is made.| +|[GetStackGuarantee Method](ihosttaskmanager-getstackguarantee-method.md)|Gets the amount of stack space that is guaranteed to be available after a stack operation completes, but before the closing of a process.| +|[LeaveRuntime Method](ihosttaskmanager-leaveruntime-method.md)|Notifies the host that managed code is about to make a call to an unmanaged function.| +|[ReverseEnterRuntime Method](ihosttaskmanager-reverseenterruntime-method.md)|Notifies the host that a call is being made into the common language runtime (CLR) from unmanaged code.| +|[ReverseLeaveRuntime Method](ihosttaskmanager-reverseleaveruntime-method.md)|Notifies the host that control is leaving the CLR and entering an unmanaged function that was, in turn, called from managed code.| +|[SetCLRTaskManager Method](ihosttaskmanager-setclrtaskmanager-method.md)|Provides the host with an interface pointer to an [ICLRTaskManager](iclrtaskmanager-interface.md) instance implemented by the CLR.| +|[SetLocale Method](ihosttaskmanager-setlocale-method.md)|Notifies the host that the CLR has changed the locale on the current task.| +|[SetStackGuarantee Method](ihosttaskmanager-setstackguarantee-method.md)|Reserved for internal use only.| +|[SetUILocale Method](ihosttaskmanager-setuilocale-method.md)|Notifies the host that the user interface locale has been changed on the current task.| +|[Sleep Method](ihosttaskmanager-sleep-method.md)|Notifies the host that the current task is going to sleep.| +|[SwitchToTask Method](ihosttaskmanager-switchtotask-method.md)|Notifies the host that it should switch out the current task.| + +## Remarks -## Methods - -|Method|Description| -|------------|-----------------| -|[BeginDelayAbort Method](ihosttaskmanager-begindelayabort-method.md)|Notifies the host that managed code is entering a period in which the current task must not be aborted.| -|[BeginThreadAffinity Method](ihosttaskmanager-beginthreadaffinity-method.md)|Notifies the host that managed code is entering a period in which the current task must not be moved to another operating system thread.| -|[CallNeedsHostHook Method](ihosttaskmanager-callneedshosthook-method.md)|Enables the host to specify whether the common language runtime can inline the specified call to an unmanaged function.| -|[CreateTask Method](ihosttaskmanager-createtask-method.md)|Requests that the host create a new task.| -|[EndDelayAbort Method](ihosttaskmanager-enddelayabort-method.md)|Notifies the host that managed code is exiting the period in which the current task must not be aborted, following an earlier call to `BeginDelayAbort`.| -|[EndThreadAffinity Method](ihosttaskmanager-endthreadaffinity-method.md)|Notifies the host that managed code is exiting the period in which the current task must not be moved to another operating system thread, following an earlier call to `BeginThreadAffinity`.| -|[EnterRuntime Method](ihosttaskmanager-enterruntime-method.md)|Notifies the host that a call to an unmanaged method, such as a platform invoke method, is returning execution control to the CLR.| -|[GetCurrentTask Method](ihosttaskmanager-getcurrenttask-method.md)|Gets an interface pointer to the task that is currently executing on the operating system thread from which this call is made.| -|[GetStackGuarantee Method](ihosttaskmanager-getstackguarantee-method.md)|Gets the amount of stack space that is guaranteed to be available after a stack operation completes, but before the closing of a process.| -|[LeaveRuntime Method](ihosttaskmanager-leaveruntime-method.md)|Notifies the host that managed code is about to make a call to an unmanaged function.| -|[ReverseEnterRuntime Method](ihosttaskmanager-reverseenterruntime-method.md)|Notifies the host that a call is being made into the common language runtime (CLR) from unmanaged code.| -|[ReverseLeaveRuntime Method](ihosttaskmanager-reverseleaveruntime-method.md)|Notifies the host that control is leaving the CLR and entering an unmanaged function that was, in turn, called from managed code.| -|[SetCLRTaskManager Method](ihosttaskmanager-setclrtaskmanager-method.md)|Provides the host with an interface pointer to an [ICLRTaskManager](iclrtaskmanager-interface.md) instance implemented by the CLR.| -|[SetLocale Method](ihosttaskmanager-setlocale-method.md)|Notifies the host that the CLR has changed the locale on the current task.| -|[SetStackGuarantee Method](ihosttaskmanager-setstackguarantee-method.md)|Reserved for internal use only.| -|[SetUILocale Method](ihosttaskmanager-setuilocale-method.md)|Notifies the host that the user interface locale has been changed on the current task.| -|[Sleep Method](ihosttaskmanager-sleep-method.md)|Notifies the host that the current task is going to sleep.| -|[SwitchToTask Method](ihosttaskmanager-switchtotask-method.md)|Notifies the host that it should switch out the current task.| - -## Remarks - - `IHostTaskManager` allows the CLR to create and manage tasks, to provide hooks for the host to take action when control transfers from managed to unmanaged code and vice versa, and to specify certain actions the host can and cannot take during code execution. - -## 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 2.0 + `IHostTaskManager` allows the CLR to create and manage tasks, to provide hooks for the host to take action when control transfers from managed to unmanaged code and vice versa, and to specify certain actions the host can and cannot take during code execution. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md similarity index 63% rename from docs/core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md rename to docs/framework/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md index 126ccd6a0033f..ae46379cf3b69 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-leaveruntime-method.md @@ -2,75 +2,76 @@ description: "Learn more about: IHostTaskManager::LeaveRuntime Method" title: "IHostTaskManager::LeaveRuntime Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.LeaveRuntime" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::LeaveRuntime" -helpviewer_keywords: +helpviewer_keywords: - "IHostTaskManager::LeaveRuntime method [.NET Framework hosting]" - "LeaveRuntime method [.NET Framework hosting]" -topic_type: +ms.assetid: 43689cc4-e48e-46e5-a22d-bafd768b8759 +topic_type: - "apiref" --- # IHostTaskManager::LeaveRuntime Method -Notifies the host that the currently executing task is about to leave the common language runtime (CLR) and enter unmanaged code. - +Notifies the host that the currently executing task is about to leave the common language runtime (CLR) and enter unmanaged code. + > [!IMPORTANT] -> A corresponding call to [IHostTaskManager::EnterRuntime](ihosttaskmanager-enterruntime-method.md) notifies the host that the currently executing task is reentering managed code. - -## Syntax - -```cpp -HRESULT LeaveRuntime ( - [in] SIZE_T target -); -``` - -## Parameters - - `target` - [in] The address within the mapped portable executable file of the unmanaged function to be called. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`LeaveRuntime` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory is available to complete the requested allocation.| - -## Remarks - - Call sequences to and from unmanaged code can be nested. For example, the list below describes a hypothetical situation in which the sequence of calls to `LeaveRuntime`, [IHostTaskManager::ReverseEnterRuntime](ihosttaskmanager-reverseenterruntime-method.md), [IHostTaskManager::ReverseLeaveRuntime](ihosttaskmanager-reverseleaveruntime-method.md), and `IHostTaskManager::EnterRuntime` allows the host to identify the nested layers. - -|Action|Corresponding Method Call| -|------------|-------------------------------| -|A managed Visual Basic executable calls an unmanaged function written in C by using platform invoke.|`IHostTaskManager::LeaveRuntime`| -|The unmanaged C function calls a method in a managed DLL written in C#.|`IHostTaskManager::ReverseEnterRuntime`| -|The managed C# function calls another unmanaged function written in C, also using platform invoke.|`IHostTaskManager::LeaveRuntime`| -|The second unmanaged function returns execution to the C# function.|`IHostTaskManager::EnterRuntime`| -|The C# function returns execution to the first unmanaged function.|`IHostTaskManager::ReverseLeaveRuntime`| -|The first unmanaged function returns execution to the Visual Basic program.|`IHostTaskManager::EnterRuntime`| - -## 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 2.0 - +> A corresponding call to [IHostTaskManager::EnterRuntime](ihosttaskmanager-enterruntime-method.md) notifies the host that the currently executing task is reentering managed code. + +## Syntax + +```cpp +HRESULT LeaveRuntime ( + [in] SIZE_T target +); +``` + +## Parameters + + `target` + [in] The address within the mapped portable executable file of the unmanaged function to be called. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`LeaveRuntime` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory is available to complete the requested allocation.| + +## Remarks + + Call sequences to and from unmanaged code can be nested. For example, the list below describes a hypothetical situation in which the sequence of calls to `LeaveRuntime`, [IHostTaskManager::ReverseEnterRuntime](ihosttaskmanager-reverseenterruntime-method.md), [IHostTaskManager::ReverseLeaveRuntime](ihosttaskmanager-reverseleaveruntime-method.md), and `IHostTaskManager::EnterRuntime` allows the host to identify the nested layers. + +|Action|Corresponding Method Call| +|------------|-------------------------------| +|A managed Visual Basic executable calls an unmanaged function written in C by using platform invoke.|`IHostTaskManager::LeaveRuntime`| +|The unmanaged C function calls a method in a managed DLL written in C#.|`IHostTaskManager::ReverseEnterRuntime`| +|The managed C# function calls another unmanaged function written in C, also using platform invoke.|`IHostTaskManager::LeaveRuntime`| +|The second unmanaged function returns execution to the C# function.|`IHostTaskManager::EnterRuntime`| +|The C# function returns execution to the first unmanaged function.|`IHostTaskManager::ReverseLeaveRuntime`| +|The first unmanaged function returns execution to the Visual Basic program.|`IHostTaskManager::EnterRuntime`| + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md similarity index 64% rename from docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md rename to docs/framework/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md index 6cb8b3651f1ae..231e0ee0e1df3 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-reverseenterruntime-method.md @@ -2,59 +2,60 @@ description: "Learn more about: IHostTaskManager::ReverseEnterRuntime Method" title: "IHostTaskManager::ReverseEnterRuntime Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.ReverseEnterRuntime" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::ReverseEnterRuntime" -helpviewer_keywords: +helpviewer_keywords: - "IHostTaskManager::ReverseEnterRuntime method [.NET Framework hosting]" - "ReverseEnterRuntime method [.NET Framework hosting]" -topic_type: +ms.assetid: b1e26bff-d3ea-436e-9867-29720df999f4 +topic_type: - "apiref" --- # IHostTaskManager::ReverseEnterRuntime Method -Notifies the host that a call is being made into the common language runtime (CLR) from unmanaged code. - -## Syntax - -```cpp -HRESULT ReverseEnterRuntime (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`ReverseEnterRuntime` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory is available to complete the requested resource allocation.| - -## Remarks - - If the call into the CLR is made from a sequence that originated in managed code, each call to `ReverseEnterRuntime` corresponds to a call to [ReverseLeaveRuntime](ihosttaskmanager-reverseleaveruntime-method.md). +Notifies the host that a call is being made into the common language runtime (CLR) from unmanaged code. + +## Syntax + +```cpp +HRESULT ReverseEnterRuntime (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`ReverseEnterRuntime` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory is available to complete the requested resource allocation.| + +## Remarks + If the call into the CLR is made from a sequence that originated in managed code, each call to `ReverseEnterRuntime` corresponds to a call to [ReverseLeaveRuntime](ihosttaskmanager-reverseleaveruntime-method.md). + > [!NOTE] -> Calls can originate from unmanaged code without being nested. In this case, there is no call to [EnterRuntime](ihosttaskmanager-enterruntime-method.md), [LeaveRuntime](ihosttaskmanager-leaveruntime-method.md), or `ReverseLeaveRuntime`, and the number of calls to `ReverseEnterRuntime` does not equal the number of calls to `ReverseLeaveRuntime`. - -## 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 2.0 +> Calls can originate from unmanaged code without being nested. In this case, there is no call to [EnterRuntime](ihosttaskmanager-enterruntime-method.md), [LeaveRuntime](ihosttaskmanager-leaveruntime-method.md), or `ReverseLeaveRuntime`, and the number of calls to `ReverseEnterRuntime` does not equal the number of calls to `ReverseLeaveRuntime`. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md similarity index 67% rename from docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md rename to docs/framework/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md index 7e660b6e38662..4b31053bc8432 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-reverseleaveruntime-method.md @@ -2,56 +2,57 @@ description: "Learn more about: IHostTaskManager::ReverseLeaveRuntime Method" title: "IHostTaskManager::ReverseLeaveRuntime Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.ReverseLeaveRuntime" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::ReverseLeaveRuntime" -helpviewer_keywords: +helpviewer_keywords: - "IHostTaskManager::ReverseLeaveRuntime method [.NET Framework hosting]" - "ReverseLeaveRuntime method [.NET Framework hosting]" -topic_type: +ms.assetid: 4837d398-16a1-4e32-902c-022cd1aad3ca +topic_type: - "apiref" --- # IHostTaskManager::ReverseLeaveRuntime Method -Notifies the host that control is leaving the common language runtime (CLR) and entering an unmanaged function that was, in turn, called from managed code. +Notifies the host that control is leaving the common language runtime (CLR) and entering an unmanaged function that was, in turn, called from managed code. + +## Syntax + +```cpp +HRESULT ReverseLeaveRuntime (); +``` + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`ReverseLeaveRuntime` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_OUTOFMEMORY|Not enough memory is available to complete the requested resource allocation.| + +## Remarks -## Syntax - -```cpp -HRESULT ReverseLeaveRuntime (); -``` - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`ReverseLeaveRuntime` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_OUTOFMEMORY|Not enough memory is available to complete the requested resource allocation.| - -## Remarks - - The CLR calls `ReverseLeaveRuntime` to inform the host that the currently executing task is returning control to an unmanaged function that was, in turn, called from managed code through platform invoke. Each call to `ReverseLeaveRuntime` matches a corresponding call to [ReverseEnterRuntime](ihosttaskmanager-reverseenterruntime-method.md). - -## 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 2.0 + The CLR calls `ReverseLeaveRuntime` to inform the host that the currently executing task is returning control to an unmanaged function that was, in turn, called from managed code through platform invoke. Each call to `ReverseLeaveRuntime` matches a corresponding call to [ReverseEnterRuntime](ihosttaskmanager-reverseenterruntime-method.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 - [CallNeedsHostHook Method](ihosttaskmanager-callneedshosthook-method.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md similarity index 56% rename from docs/core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md rename to docs/framework/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md index f08fe65bc6097..a82fc97029603 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-setclrtaskmanager-method.md @@ -2,62 +2,63 @@ description: "Learn more about: IHostTaskManager::SetCLRTaskManager Method" title: "IHostTaskManager::SetCLRTaskManager Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.SetCLRTaskManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::SetCLRTaskManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostTaskManager::SetCLRTaskManager method [.NET Framework hosting]" - "SetCLRTaskManager method [.NET Framework hosting]" -topic_type: +ms.assetid: ec90ee83-bd4b-408b-9274-62a923ab86a1 +topic_type: - "apiref" --- # IHostTaskManager::SetCLRTaskManager Method -Provides the host with an interface pointer to an [ICLRTaskManager](iclrtaskmanager-interface.md) instance implemented by the common language runtime (CLR). - -## Syntax - -```cpp -HRESULT SetCLRTaskManager ( - [in] ICLRTaskManager *pManager -); -``` - -## Parameters - - `pManager` - [in] A pointer to an `ICLRTaskManager` instance implemented by the common language runtime. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetCLRTaskManager` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The runtime calls `SetCLRTaskManager` to provide the host with an interface pointer to an `ICLRTaskManager` instance. - -## 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 2.0 - +Provides the host with an interface pointer to an [ICLRTaskManager](iclrtaskmanager-interface.md) instance implemented by the common language runtime (CLR). + +## Syntax + +```cpp +HRESULT SetCLRTaskManager ( + [in] ICLRTaskManager *pManager +); +``` + +## Parameters + + `pManager` + [in] A pointer to an `ICLRTaskManager` instance implemented by the common language runtime. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetCLRTaskManager` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The runtime calls `SetCLRTaskManager` to provide the host with an interface pointer to an `ICLRTaskManager` instance. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md similarity index 63% rename from docs/core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md rename to docs/framework/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md index 48077c77f0b5b..fbebea9dd334b 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-setlocale-method.md @@ -2,63 +2,64 @@ description: "Learn more about: IHostTaskManager::SetLocale Method" title: "IHostTaskManager::SetLocale Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.SetLocale" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::SetLocale" -helpviewer_keywords: +helpviewer_keywords: - "SetLocale method, IHostTaskManager interface [.NET Framework hosting]" - "IHostTaskManager::SetLocale method [.NET Framework hosting]" -topic_type: +ms.assetid: 747ee407-ee8c-484d-9583-25089236d2d1 +topic_type: - "apiref" --- # IHostTaskManager::SetLocale Method -Notifies the host that the common language runtime (CLR) has changed the locale, or culture, on the currently executing task. - -## Syntax - -```cpp -HRESULT SetLocale ( - [in] LCID lcid -); -``` - -## Parameters - - `lcid` - [in] The locale identifier value that maps to the newly assigned geographical culture and language. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetLocale` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not allow managed user code to modify the locale.| - -## Remarks - - The runtime calls `SetLocale` when the value of the property is changed by managed code. This method provides an opportunity for the host to execute any mechanisms it might have for synchronization of locales. If a host does not allow the locale to be changed from managed code, or does not implement a mechanism to synchronize locales, it should return E_NOTIMPL from this method. - -## 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 2.0 - +Notifies the host that the common language runtime (CLR) has changed the locale, or culture, on the currently executing task. + +## Syntax + +```cpp +HRESULT SetLocale ( + [in] LCID lcid +); +``` + +## Parameters + + `lcid` + [in] The locale identifier value that maps to the newly assigned geographical culture and language. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetLocale` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not allow managed user code to modify the locale.| + +## Remarks + + The runtime calls `SetLocale` when the value of the property is changed by managed code. This method provides an opportunity for the host to execute any mechanisms it might have for synchronization of locales. If a host does not allow the locale to be changed from managed code, or does not implement a mechanism to synchronize locales, it should return E_NOTIMPL from this method. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md similarity index 51% rename from docs/core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md rename to docs/framework/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md index 4001fe964fc1a..48e3c8e772504 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-setstackguarantee-method.md @@ -2,42 +2,43 @@ description: "Learn more about: IHostTaskManager::SetStackGuarantee Method" title: "IHostTaskManager::SetStackGuarantee Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.SetStackGuarantee" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::SetStackGuarantee" -helpviewer_keywords: +helpviewer_keywords: - "IHostTaskManager::SetStackGuarantee method [.NET Framework hosting]" - "SetStackGuarantee method [.NET Framework hosting]" -topic_type: +ms.assetid: 6dcc4a4b-3a78-4369-bcc7-c0be6dde57d4 +topic_type: - "apiref" --- # IHostTaskManager::SetStackGuarantee Method -Reserved for internal use only. - -## Syntax - -```cpp -HRESULT SetStackGuarantee( - [in] ULONG guarantee -); -``` - -## 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 2.0 - +Reserved for internal use only. + +## Syntax + +```cpp +HRESULT SetStackGuarantee( + [in] ULONG guarantee +); +``` + +## 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 - [GetStackGuarantee Method](ihosttaskmanager-getstackguarantee-method.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md similarity index 65% rename from docs/core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md rename to docs/framework/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md index 87a09db24d311..def8bbb53c686 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-setuilocale-method.md @@ -2,63 +2,64 @@ description: "Learn more about: IHostTaskManager::SetUILocale Method" title: "IHostTaskManager::SetUILocale Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.SetUILocale" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::SetUILocale" -helpviewer_keywords: +helpviewer_keywords: - "SetUILocale method, IHostTaskManager interface [.NET Framework hosting]" - "IHostTaskManager::SetUILocale method [.NET Framework hosting]" -topic_type: +ms.assetid: d0c87a9c-ea81-4237-a16b-c22b36ec9dc8 +topic_type: - "apiref" --- # IHostTaskManager::SetUILocale Method -Notifies the host that the common language runtime (CLR) has changed the user interface (UI) locale, or culture, on the currently executing task. - -## Syntax - -```cpp -HRESULT SetUILocale ( - [in] LCID lcid -); -``` - -## Parameters - - `lcid` - [in] The locale identifier value that maps to the newly assigned geographical culture and language. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetUILocale` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not allow managed user code to change the UI culture.| - -## Remarks - - The runtime calls `SetUILocale` when the value of the property is changed by managed code. This method provides an opportunity for the host to execute any mechanisms it might have for synchronization of locales. If a host does not allow the UI locale to be changed from managed code, or does not implement a mechanism to synchronize locales, it should return E_NOTIMPL from this method. - -## 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 2.0 - +Notifies the host that the common language runtime (CLR) has changed the user interface (UI) locale, or culture, on the currently executing task. + +## Syntax + +```cpp +HRESULT SetUILocale ( + [in] LCID lcid +); +``` + +## Parameters + + `lcid` + [in] The locale identifier value that maps to the newly assigned geographical culture and language. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetUILocale` 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not allow managed user code to change the UI culture.| + +## Remarks + + The runtime calls `SetUILocale` when the value of the property is changed by managed code. This method provides an opportunity for the host to execute any mechanisms it might have for synchronization of locales. If a host does not allow the UI locale to be changed from managed code, or does not implement a mechanism to synchronize locales, it should return E_NOTIMPL from this method. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md similarity index 55% rename from docs/core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md rename to docs/framework/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md index b1a64326f4df5..09e81b678ee41 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-sleep-method.md @@ -2,66 +2,67 @@ description: "Learn more about: IHostTaskManager::Sleep Method" title: "IHostTaskManager::Sleep Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.Sleep" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::Sleep" -helpviewer_keywords: +helpviewer_keywords: - "IHostTaskManager::Sleep method [.NET Framework hosting]" - "Sleep method, IHostTaskManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: f67d25f3-9199-4c5f-b1e8-1c819243cfd5 +topic_type: - "apiref" --- # IHostTaskManager::Sleep Method -Notifies the host that the current task is going to sleep. - -## Syntax - -```cpp -HRESULT Sleep ( - [in] DWORD dwMilliseconds, - [in] DWORD option -); -``` - -## Parameters - - `dwMilliseconds` - [in] The time interval, in milliseconds, that the thread will sleep. - - `option` - [in] One of the [WAIT_OPTION](wait-option-enumeration.md) enumeration values, indicating what action the host should take if this action blocks. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`Sleep` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The CLR typically calls `IHostTaskManager::Sleep` when is called from user code. - -## 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 2.0 - +Notifies the host that the current task is going to sleep. + +## Syntax + +```cpp +HRESULT Sleep ( + [in] DWORD dwMilliseconds, + [in] DWORD option +); +``` + +## Parameters + + `dwMilliseconds` + [in] The time interval, in milliseconds, that the thread will sleep. + + `option` + [in] One of the [WAIT_OPTION](wait-option-enumeration.md) enumeration values, indicating what action the host should take if this action blocks. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`Sleep` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The CLR typically calls `IHostTaskManager::Sleep` when is called from user code. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md similarity index 52% rename from docs/core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md rename to docs/framework/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md index 1890963403b71..f4fe5119a48bc 100644 --- a/docs/core/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md +++ b/docs/framework/unmanaged-api/hosting/ihosttaskmanager-switchtotask-method.md @@ -2,65 +2,66 @@ description: "Learn more about: IHostTaskManager::SwitchToTask Method" title: "IHostTaskManager::SwitchToTask Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostTaskManager.SwitchToTask" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostTaskManager::SwitchToTask" -helpviewer_keywords: +helpviewer_keywords: - "IHostTaskManager::SwitchToTask method [.NET Framework hosting]" - "SwitchToTask method [.NET Framework hosting]" -topic_type: +ms.assetid: 35d0c27e-4b14-49ce-810d-7ab2120177e8 +topic_type: - "apiref" --- # IHostTaskManager::SwitchToTask Method -Notifies the host that it should switch out the current task. - -## Syntax - -```cpp -HRESULT SwitchToTask ( - [in] DWORD option -); -``` - -## Parameters - - `option` - [in] One of the [WAIT_OPTION](wait-option-enumeration.md) enumeration values, indicating the action the host should take if the requested operation blocks. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SwitchToTask` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - The host can switch in another task as desired or needed. - +Notifies the host that it should switch out the current task. + +## Syntax + +```cpp +HRESULT SwitchToTask ( + [in] DWORD option +); +``` + +## Parameters + + `option` + [in] One of the [WAIT_OPTION](wait-option-enumeration.md) enumeration values, indicating the action the host should take if the requested operation blocks. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SwitchToTask` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + The host can switch in another task as desired or needed. + > [!NOTE] -> `SwitchToTask` does not specify which task the host should switch to; it specifies only the task that it should switch from. - -## 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 2.0 - +> `SwitchToTask` does not specify which task the host should switch to; it specifies only the task that it should switch from. + +## 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 - [ICLRTask Interface](iclrtask-interface.md) diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md b/docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md similarity index 55% rename from docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md rename to docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md index b3b9c1b02c3d4..af116bd8a7745 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-getavailablethreads-method.md @@ -2,63 +2,64 @@ description: "Learn more about: IHostThreadPoolManager::GetAvailableThreads Method" title: "IHostThreadPoolManager::GetAvailableThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostThreadPoolManager.GetAvailableThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostThreadPoolManager::GetAvailableThreads" -helpviewer_keywords: +helpviewer_keywords: - "GetAvailableThreads method, IHostThreadPoolManager interface [.NET Framework hosting]" - "IHostThreadPoolManager::GetAvailableThreads method [.NET Framework hosting]" -topic_type: +ms.assetid: 61d26dfd-7f24-4e7d-a63e-b30a463f08e1 +topic_type: - "apiref" --- # IHostThreadPoolManager::GetAvailableThreads Method -Gets the number of threads in the thread pool that are not currently processing work items. - -## Syntax - -```cpp -HRESULT GetAvailableThreads ( - [out] DWORD *pdwAvailableWorkerThreads -); -``` - -## Parameters - - `pdwAvailableWorkerThreads` - [out] Pointer to the number of threads in the thread pool that are not currently processing work items. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetAvailableThreads` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not provide an implementation of `GetAvailableThreads`.| - -## Remarks - - If the host does not provide an implementation of `GetAvailableThreads`, it should return an HRESULT value of E_NOTIMPL. - -## 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 2.0 - +Gets the number of threads in the thread pool that are not currently processing work items. + +## Syntax + +```cpp +HRESULT GetAvailableThreads ( + [out] DWORD *pdwAvailableWorkerThreads +); +``` + +## Parameters + + `pdwAvailableWorkerThreads` + [out] Pointer to the number of threads in the thread pool that are not currently processing work items. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetAvailableThreads` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not provide an implementation of `GetAvailableThreads`.| + +## Remarks + + If the host does not provide an implementation of `GetAvailableThreads`, it should return an HRESULT value of E_NOTIMPL. + +## 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 - diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md b/docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md similarity index 61% rename from docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md rename to docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md index 47ce67d66ac27..0e4e785a92e4a 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-getmaxthreads-method.md @@ -2,65 +2,66 @@ description: "Learn more about: IHostThreadPoolManager::GetMaxThreads Method" title: "IHostThreadPoolManager::GetMaxThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostThreadPoolManager.GetMaxThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostThreadPoolManager::GetMaxThreads" -helpviewer_keywords: +helpviewer_keywords: - "IHostThreadPoolManager::GetMaxThreads method [.NET Framework hosting]" - "GetMaxThreads method, IHostThreadPoolManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: db268876-6178-4a81-aca3-318ee7f96001 +topic_type: - "apiref" --- # IHostThreadPoolManager::GetMaxThreads Method -Gets the maximum number of threads that the host maintains concurrently in the thread pool. - -## Syntax - -```cpp -HRESULT GetMaxThreads ( - [out] DWORD *pdwMaxWorkerThreads -); -``` - -## Parameters - - `pdwMaxWorkerThreads` - [out] A pointer to the maximum number of threads that the host maintains in the thread pool. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetMaxThreads` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not provide an implementation of `GetMaxThreads`.| - -## Remarks - - The CLR calls `GetMaxThreads` to determine the total number of threads in the thread pool. The [GetAvailableThreads](ihostthreadpoolmanager-getavailablethreads-method.md) method gets the number of threads that are not currently processing work items. All requests above the returned value of the `pdwMaxWorkerThreads` parameter remain queued until threads become available. - - If the host does not provide an implementation of `GetMaxThreads`, it should return an HRESULT value of E_NOTIMPL. - -## 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 2.0 - +Gets the maximum number of threads that the host maintains concurrently in the thread pool. + +## Syntax + +```cpp +HRESULT GetMaxThreads ( + [out] DWORD *pdwMaxWorkerThreads +); +``` + +## Parameters + + `pdwMaxWorkerThreads` + [out] A pointer to the maximum number of threads that the host maintains in the thread pool. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetMaxThreads` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not provide an implementation of `GetMaxThreads`.| + +## Remarks + + The CLR calls `GetMaxThreads` to determine the total number of threads in the thread pool. The [GetAvailableThreads](ihostthreadpoolmanager-getavailablethreads-method.md) method gets the number of threads that are not currently processing work items. All requests above the returned value of the `pdwMaxWorkerThreads` parameter remain queued until threads become available. + + If the host does not provide an implementation of `GetMaxThreads`, it should return an HRESULT value of E_NOTIMPL. + +## 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 - diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md b/docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md similarity index 59% rename from docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md rename to docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md index f6180deb7dd1f..b613e84975928 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-getminthreads-method.md @@ -2,63 +2,64 @@ description: "Learn more about: IHostThreadPoolManager::GetMinThreads Method" title: "IHostThreadPoolManager::GetMinThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostThreadPoolManager.GetMinThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostThreadPoolManager::GetMinThreads" -helpviewer_keywords: +helpviewer_keywords: - "IHostThreadPoolManager::GetMinThreads method [.NET Framework hosting]" - "GetMinThreads method, IHostThreadPoolManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: dc07232b-b2e4-4dab-87e2-3c955974ab48 +topic_type: - "apiref" --- # IHostThreadPoolManager::GetMinThreads Method -Gets the minimum number of idle threads that the host maintains in the thread pool in anticipation of requests. - -## Syntax - -```cpp -HRESULT GetMinThreads ( - [out] DWORD *MinThreads -); -``` - -## Parameters - - `MinThreads` - [out] A pointer to the minimum number of idle worker threads that the host currently maintains. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`GetMinThreads` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not provide an implementation of `GetMinThreads`.| - -## Remarks - - The host is not required to provide an implementation of `GetMinThreads`. In this case, it should return an HRESULT value of E_NOTIMPL. - -## 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 2.0 - +Gets the minimum number of idle threads that the host maintains in the thread pool in anticipation of requests. + +## Syntax + +```cpp +HRESULT GetMinThreads ( + [out] DWORD *MinThreads +); +``` + +## Parameters + + `MinThreads` + [out] A pointer to the minimum number of idle worker threads that the host currently maintains. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`GetMinThreads` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not provide an implementation of `GetMinThreads`.| + +## Remarks + + The host is not required to provide an implementation of `GetMinThreads`. In this case, it should return an HRESULT value of E_NOTIMPL. + +## 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 - diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md b/docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md similarity index 64% rename from docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md rename to docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md index 5e7d26ba23c43..cb82b9766dc71 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md +++ b/docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-interface.md @@ -2,48 +2,49 @@ description: "Learn more about: IHostThreadPoolManager Interface" title: "IHostThreadPoolManager Interface" ms.date: "03/30/2017" -api_name: +api_name: - "IHostThreadPoolManager" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostThreadPoolManager" -helpviewer_keywords: +helpviewer_keywords: - "IHostThreadPoolManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: c3a2cd90-7c4e-4374-bb87-b41befb8344f +topic_type: - "apiref" --- # IHostThreadPoolManager Interface -Provides methods that enable the common language runtime (CLR) to configure the thread pool and to queue work items to the thread pool. - -## Methods - -|Method|Description| -|------------|-----------------| -|[GetAvailableThreads Method](ihostthreadpoolmanager-getavailablethreads-method.md)|Gets the number of threads in the thread pool that are not currently processing work items.| -|[GetMaxThreads Method](ihostthreadpoolmanager-getmaxthreads-method.md)|Gets the maximum number of threads that the host maintains concurrently in the thread pool.| -|[GetMinThreads Method](ihostthreadpoolmanager-getminthreads-method.md)|Gets the minimum number of idle threads that the host maintains in anticipation of requests.| -|[QueueUserWorkItem Method](ihostthreadpoolmanager-queueuserworkitem-method.md)|Queues a function for execution, and provides an object containing data to be used by the function.| -|[SetMaxThreads Method](ihostthreadpoolmanager-setmaxthreads-method.md)|Sets the maximum number of threads that the host can maintain in the thread pool.| -|[SetMinThreads Method](ihostthreadpoolmanager-setminthreads-method.md)|Sets the minimum number of idle threads that the host must maintain in anticipation of requests.| - -## Remarks - - The host is not required to configure the thread pool by using the values specified in calls to the `SetMaxThreads` and `SetMinThreads` methods. In this case, the host should return an HRESULT value of E_NOTIMPL from these methods. - -## 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 2.0 - +Provides methods that enable the common language runtime (CLR) to configure the thread pool and to queue work items to the thread pool. + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetAvailableThreads Method](ihostthreadpoolmanager-getavailablethreads-method.md)|Gets the number of threads in the thread pool that are not currently processing work items.| +|[GetMaxThreads Method](ihostthreadpoolmanager-getmaxthreads-method.md)|Gets the maximum number of threads that the host maintains concurrently in the thread pool.| +|[GetMinThreads Method](ihostthreadpoolmanager-getminthreads-method.md)|Gets the minimum number of idle threads that the host maintains in anticipation of requests.| +|[QueueUserWorkItem Method](ihostthreadpoolmanager-queueuserworkitem-method.md)|Queues a function for execution, and provides an object containing data to be used by the function.| +|[SetMaxThreads Method](ihostthreadpoolmanager-setmaxthreads-method.md)|Sets the maximum number of threads that the host can maintain in the thread pool.| +|[SetMinThreads Method](ihostthreadpoolmanager-setminthreads-method.md)|Sets the minimum number of idle threads that the host must maintain in anticipation of requests.| + +## Remarks + + The host is not required to configure the thread pool by using the values specified in calls to the `SetMaxThreads` and `SetMinThreads` methods. In this case, the host should return an HRESULT value of E_NOTIMPL from these methods. + +## 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 - diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md b/docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md similarity index 57% rename from docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md rename to docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md index 0be760483a1b0..92f6941dae642 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-queueuserworkitem-method.md @@ -2,70 +2,71 @@ description: "Learn more about: IHostThreadPoolManager::QueueUserWorkItem Method" title: "IHostThreadPoolManager::QueueUserWorkItem Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostThreadPoolManager.QueueUserWorkItem" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostThreadPoolManager::QueueUserWorkItem" -helpviewer_keywords: +helpviewer_keywords: - "IHostThreadPoolManager::QueueUserWorkItem method [.NET Framework hosting]" - "QueueUserWorkItem method [.NET Framework hosting]" -topic_type: +ms.assetid: 41602053-8670-4827-9d61-cbfcba509b9c +topic_type: - "apiref" --- # IHostThreadPoolManager::QueueUserWorkItem Method -Queues a function for execution, and specifies an object containing data to be used by that function. The function executes when a thread becomes available. - -## Syntax - -```cpp -HRESULT QueueUserWorkItem ( - [in] LPTHREAD_START_ROUTINE Function, - [in] PVOID Context, - [in] ULONG Flags -); -``` - -## Parameters - - `Function` - [in] A function pointer that represents the function to execute. - - `Context` - [in] An object that contains data to be used by `Function`. - - `Flags` - [in] One of the flags values, as defined for the Win32 `QueueUserWorkItem` method, that control execution. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`QueueUserWorkItem` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| - -## Remarks - - `QueueUserWorkItem` queues a work item to a worker thread in the thread pool. Its signature and parameter types are identical to those of the corresponding Win32 function, which has the same name. For more information, see the Windows Platform documentation. - -## 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 2.0 - +Queues a function for execution, and specifies an object containing data to be used by that function. The function executes when a thread becomes available. + +## Syntax + +```cpp +HRESULT QueueUserWorkItem ( + [in] LPTHREAD_START_ROUTINE Function, + [in] PVOID Context, + [in] ULONG Flags +); +``` + +## Parameters + + `Function` + [in] A function pointer that represents the function to execute. + + `Context` + [in] An object that contains data to be used by `Function`. + + `Flags` + [in] One of the flags values, as defined for the Win32 `QueueUserWorkItem` method, that control execution. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`QueueUserWorkItem` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| + +## Remarks + + `QueueUserWorkItem` queues a work item to a worker thread in the thread pool. Its signature and parameter types are identical to those of the corresponding Win32 function, which has the same name. For more information, see the Windows Platform documentation. + +## 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 - diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md b/docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md similarity index 60% rename from docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md rename to docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md index cf1fd0545e979..44619b07ee7dc 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-setmaxthreads-method.md @@ -2,63 +2,64 @@ description: "Learn more about: IHostThreadPoolManager::SetMaxThreads Method" title: "IHostThreadPoolManager::SetMaxThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostThreadPoolManager.SetMaxThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostThreadPoolManager::SetMaxThreads" -helpviewer_keywords: +helpviewer_keywords: - "IHostThreadPoolManager::SetMaxThreads method [.NET Framework hosting]" - "SetMaxThreads method, IHostThreadPoolManager interface [.NET Framework hosting]" -topic_type: +ms.assetid: 77cfd347-95c2-4425-b807-4ecc2a8d4578 +topic_type: - "apiref" --- # IHostThreadPoolManager::SetMaxThreads Method -Sets the maximum number of threads that the host can maintain in the thread pool. - -## Syntax - -```cpp -HRESULT SetMaxThreads ( - [in] DWORD MaxThreads -); -``` - -## Parameters - - `MaxThreads` - The maximum number of worker threads in the thread pool. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetMaxThreads` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not provide an implementation of `SetMaxThreads`.| - -## Remarks - - A host is not required to allow the CLR to configure the size of the thread pool. Some hosts might want exclusive control over the thread pool, for reasons such as implementation, performance, or scalability. In this case, a host should return an HRESULT value of E_NOTIMPL. - -## 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 2.0 - +Sets the maximum number of threads that the host can maintain in the thread pool. + +## Syntax + +```cpp +HRESULT SetMaxThreads ( + [in] DWORD MaxThreads +); +``` + +## Parameters + + `MaxThreads` + The maximum number of worker threads in the thread pool. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetMaxThreads` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not provide an implementation of `SetMaxThreads`.| + +## Remarks + + A host is not required to allow the CLR to configure the size of the thread pool. Some hosts might want exclusive control over the thread pool, for reasons such as implementation, performance, or scalability. In this case, a host should return an HRESULT value of E_NOTIMPL. + +## 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 - diff --git a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md b/docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md similarity index 60% rename from docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md rename to docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md index c0054c718404c..f6fcd2859f9e6 100644 --- a/docs/core/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md +++ b/docs/framework/unmanaged-api/hosting/ihostthreadpoolmanager-setminthreads-method.md @@ -2,63 +2,64 @@ description: "Learn more about: IHostThreadPoolManager::SetMinThreads Method" title: "IHostThreadPoolManager::SetMinThreads Method" ms.date: "03/30/2017" -api_name: +api_name: - "IHostThreadPoolManager.SetMinThreads" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "IHostThreadPoolManager::SetMinThreads" -helpviewer_keywords: +helpviewer_keywords: - "SetMinThreads method, IHostThreadPoolManager interface [.NET Framework hosting]" - "IHostThreadPoolManager::SetMinThreads method [.NET Framework hosting]" -topic_type: +ms.assetid: 10409db9-9fd2-4e4d-b8cd-cf6fec0afaa2 +topic_type: - "apiref" --- # IHostThreadPoolManager::SetMinThreads Method -Sets the minimum number of idle threads that the host must maintain in anticipation of requests. - -## Syntax - -```cpp -HRESULT SetMinThreads ( - [in] DWORD MinThreads -); -``` - -## Parameters - - `MinThreads` - [in] The new minimum number of threads that the host must maintain. - -## Return Value - -|HRESULT|Description| -|-------------|-----------------| -|S_OK|`SetMinThreads` returned successfully.| -|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| -|E_NOTIMPL|The host does not provide an implementation of `SetMinThreads`.| - -## Remarks - - A host is not required to provide an implementation of `SetMinThreads`. In this case, it should return an HRESULT value of E_NOTIMPL. - -## 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 2.0 - +Sets the minimum number of idle threads that the host must maintain in anticipation of requests. + +## Syntax + +```cpp +HRESULT SetMinThreads ( + [in] DWORD MinThreads +); +``` + +## Parameters + + `MinThreads` + [in] The new minimum number of threads that the host must maintain. + +## Return Value + +|HRESULT|Description| +|-------------|-----------------| +|S_OK|`SetMinThreads` returned successfully.| +|HOST_E_CLRNOTAVAILABLE|The common language runtime (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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.| +|E_NOTIMPL|The host does not provide an implementation of `SetMinThreads`.| + +## Remarks + + A host is not required to provide an implementation of `SetMinThreads`. In this case, it should return an HRESULT value of E_NOTIMPL. + +## 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 - diff --git a/docs/framework/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md b/docs/framework/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md new file mode 100644 index 0000000000000..13b77328d549f --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/imanagedobject-getobjectidentity-method.md @@ -0,0 +1,61 @@ +--- +description: "Learn more about: IManagedObject::GetObjectIdentity Method" +title: "IManagedObject::GetObjectIdentity Method" +ms.date: "03/30/2017" +api_name: + - "IManagedObject.GetObjectIdentity" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "GetObjectIdentity" +helpviewer_keywords: + - "GetObjectIdentity method [.NET Framework hosting]" + - "IManagedObject::GetObjectIdentity method [.NET Framework hosting]" +ms.assetid: b862ff3e-e480-4cdf-84e2-e1013334a467 +topic_type: + - "apiref" +--- +# IManagedObject::GetObjectIdentity Method + +Gets the identity of this managed object. + +## Syntax + +```cpp +HRESULT GetObjectIdentity ( + [out] BSTR* pBSTRGUID, + [out] int* AppDomainID, + [out] CCW_PTR pCCW +); +``` + +## Parameters + + `pBSTRGUID` + [out] A pointer to the GUID of the process in which the object resides. + + `AppDomainID` + [out] A pointer to the ID of the object's application domain. + + `pCCW` + [out] A pointer to object's index in the COM classic v-table. + +## Remarks + + The identity of a managed object includes process GUID, application domain ID, and the object's index in the COM classic v-table. + +## 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 + +- [IManagedObject Interface](imanagedobject-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md b/docs/framework/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md new file mode 100644 index 0000000000000..c0aaecd511870 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/imanagedobject-getserializedbuffer-method.md @@ -0,0 +1,53 @@ +--- +description: "Learn more about: IManagedObject::GetSerializedBuffer Method" +title: "IManagedObject::GetSerializedBuffer Method" +ms.date: "03/30/2017" +api_name: + - "IManagedObject.GetSerializedBuffer" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "GetSerializedBuffer" +helpviewer_keywords: + - "IManagedObject::GetSerializedBuffer method [.NET Framework hosting]" + - "GetSerializedBuffer method [.NET Framework hosting]" +ms.assetid: c17105bb-b49f-434e-8f9b-77f8c85b9220 +topic_type: + - "apiref" +--- +# IManagedObject::GetSerializedBuffer Method + +Gets the string representation of this managed object. + +## Syntax + +```cpp +HRESULT GetSerializedBuffer ( + [out] BSTR *pBSTR +); +``` + +## Parameters + + `pBSTR` + [out] A pointer to a string that is the serialized object. + +## Remarks + + The `GetSerializedBuffer` method serializes the object so it can be marshalled to the client. + +## 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 + +- [IManagedObject Interface](imanagedobject-interface.md) diff --git a/docs/framework/unmanaged-api/hosting/imanagedobject-interface.md b/docs/framework/unmanaged-api/hosting/imanagedobject-interface.md new file mode 100644 index 0000000000000..e73871cfa055b --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/imanagedobject-interface.md @@ -0,0 +1,42 @@ +--- +description: "Learn more about: IManagedObject Interface" +title: "IManagedObject Interface" +ms.date: "03/30/2017" +api_name: + - "IManagedObject" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IManagedObject" +helpviewer_keywords: + - "IManagedObject interface [.NET Framework hosting]" +ms.assetid: 1fbbf572-6d28-41a5-82fb-579ac90bfcf5 +topic_type: + - "apiref" +--- +# IManagedObject Interface + +Provides methods for controlling a managed object. + +## Methods + +|Method|Description| +|------------|-----------------| +|[GetObjectIdentity Method](imanagedobject-getobjectidentity-method.md)|Gets the identity of this managed object.| +|[GetSerializedBuffer Method](imanagedobject-getserializedbuffer-method.md)|Gets the string representation of this managed object.| + +## 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 + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/index.md b/docs/framework/unmanaged-api/hosting/index.md new file mode 100644 index 0000000000000..c08be3ff940f6 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/index.md @@ -0,0 +1,35 @@ +--- +description: "Learn more about: Hosting (Unmanaged API Reference)" +title: "Hosting (Unmanaged API Reference)" +ms.date: "03/30/2017" +helpviewer_keywords: + - "unmanaged API reference [.NET Framework], hosting" + - "native API reference [.NET Framework], hosting" + - "hosting [.NET Framework], using the unmanaged API" +ms.assetid: 14295c28-1da8-408b-a656-9584abcd9896 +--- +# Hosting (Unmanaged API Reference) + +The hosting API enables unmanaged hosts to integrate the common language runtime (CLR) into their applications. + +## In This Section + + [Hosting Coclasses](hosting-coclasses.md) + Describes the unmanaged coclasses that the hosting API uses. + + [Hosting Enumerations](hosting-enumerations.md) + Describes the unmanaged enumerations that the hosting API uses. + + [Hosting Global Static Functions](hosting-global-static-functions.md) + Describes the unmanaged global static functions that the hosting API uses. + + [Hosting Interfaces](hosting-interfaces.md) + Describes the unmanaged interfaces that enable a runtime host to integrate the CLR into an unmanaged application. + + [Hosting Structures](hosting-structures.md) + Describes the unmanaged structures that the hosting API uses. + +## Related Sections + + [Runtime Hosts](/previous-versions/dotnet/netframework-4.0/a51xd4ze(v=vs.100)) + Describes the runtime hosts included with the .NET Framework. diff --git a/docs/framework/unmanaged-api/hosting/iobjecthandle-interface.md b/docs/framework/unmanaged-api/hosting/iobjecthandle-interface.md new file mode 100644 index 0000000000000..45ed96483f626 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iobjecthandle-interface.md @@ -0,0 +1,41 @@ +--- +description: "Learn more about: IObjectHandle Interface" +title: "IObjectHandle Interface" +ms.date: "03/30/2017" +api_name: + - "IObjectHandle" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "IObjectHandle" +helpviewer_keywords: + - "IObjectHandle interface [.NET Framework hosting]" +ms.assetid: 436683ef-9849-4b24-89a9-28c06d148dce +topic_type: + - "apiref" +--- +# IObjectHandle Interface + +Provides a method for unwrapping marshal-by-value objects from indirection. + +## Methods + +|Method|Description| +|------------|-----------------| +|[Unwrap Method](iobjecthandle-unwrap-method.md)|Unwraps a marshal-by-value object from indirection.| + +## 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 + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/iobjecthandle-unwrap-method.md b/docs/framework/unmanaged-api/hosting/iobjecthandle-unwrap-method.md new file mode 100644 index 0000000000000..d10fd7e6e0501 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/iobjecthandle-unwrap-method.md @@ -0,0 +1,45 @@ +--- +description: "Learn more about: IObjectHandle::Unwrap Method" +title: "IObjectHandle::Unwrap Method" +ms.date: "03/30/2017" +api_name: + - "IObjectHandle.Unwrap" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "Unwrap" +helpviewer_keywords: + - "Unwrap method [.NET Framework hosting]" + - "IObjectHandle::Unwrap method [.NET Framework hosting]" +ms.assetid: 794c6f8e-ed58-416b-b756-e864f2c958f7 +topic_type: + - "apiref" +--- +# IObjectHandle::Unwrap Method + +Unwraps a marshal-by-value object from indirection. + +## Syntax + +```cpp +HRESULT Unwrap ( + [out, retval] VARIANT *ppv +); +``` + +## Parameters + + `ppv` + [out] A pointer to the object to be unwrapped. + +## 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)] diff --git a/docs/framework/unmanaged-api/hosting/itypename-getassemblyname-method.md b/docs/framework/unmanaged-api/hosting/itypename-getassemblyname-method.md new file mode 100644 index 0000000000000..e653dbeb51638 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/itypename-getassemblyname-method.md @@ -0,0 +1,44 @@ +--- +description: "Learn more about: ITypeName::GetAssemblyName Method" +title: "ITypeName::GetAssemblyName Method" +ms.date: "03/30/2017" +api_name: + - "ITypeName.GetAssemblyName" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "GetAssemblyName" +helpviewer_keywords: + - "ITypeName::GetAssemblyName method [.NET Framework hosting]" + - "GetAssemblyName method [.NET Framework hosting]" +ms.assetid: 97801d99-f5f1-4a30-882f-959827093fac +topic_type: + - "apiref" +--- +# ITypeName::GetAssemblyName Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT GetAssemblyName ( + [out, retval] BSTR* rgbszAssemblyNames +); +``` + +## 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 + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/itypename-getmodifierlength-method.md b/docs/framework/unmanaged-api/hosting/itypename-getmodifierlength-method.md new file mode 100644 index 0000000000000..d9208ba2d4eb8 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/itypename-getmodifierlength-method.md @@ -0,0 +1,44 @@ +--- +description: "Learn more about: ITypeName::GetModifierLength Method" +title: "ITypeName::GetModifierLength Method" +ms.date: "03/30/2017" +api_name: + - "ITypeName.GetModifierLength" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "GetModifierLength" +helpviewer_keywords: + - "ITypeName::GetModifierLength method [.NET Framework hosting]" + - "GetModifierLength method [.NET Framework hosting]" +ms.assetid: ac45f261-03f9-4728-b5d7-dd7cbb05f9e6 +topic_type: + - "apiref" +--- +# ITypeName::GetModifierLength Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT GetModifierLength ( + [out, retval] DWORD* pCount +); +``` + +## 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 + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/itypename-getmodifiers-method.md b/docs/framework/unmanaged-api/hosting/itypename-getmodifiers-method.md new file mode 100644 index 0000000000000..dc6b34ab2c425 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/itypename-getmodifiers-method.md @@ -0,0 +1,46 @@ +--- +description: "Learn more about: ITypeName::GetModifiers Method" +title: "ITypeName::GetModifiers Method" +ms.date: "03/30/2017" +api_name: + - "ITypeName.GetModifiers" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "GetModifiers" +helpviewer_keywords: + - "ITypeName::GetModifiers method [.NET Framework hosting]" + - "GetModifiers method [.NET Framework hosting]" +ms.assetid: 75508c55-3e09-4135-80da-cc811003fa82 +topic_type: + - "apiref" +--- +# ITypeName::GetModifiers Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT GetModifiers ( + [in] DWORD count, + [out] DWORD* rgModifiers, + [out, retval] DWORD* pCount +); +``` + +## 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 + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/itypename-getnamecount-method.md b/docs/framework/unmanaged-api/hosting/itypename-getnamecount-method.md new file mode 100644 index 0000000000000..efdb4a2fb1c3c --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/itypename-getnamecount-method.md @@ -0,0 +1,44 @@ +--- +description: "Learn more about: ITypeName::GetNameCount Method" +title: "ITypeName::GetNameCount Method" +ms.date: "03/30/2017" +api_name: + - "ITypeName.GetNameCount" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "GetNameCount" +helpviewer_keywords: + - "GetNameCount method [.NET Framework hosting]" + - "ITypeName::GetNameCount method [.NET Framework hosting]" +ms.assetid: 0beb909a-5095-40e5-909d-9ecc280300b8 +topic_type: + - "apiref" +--- +# ITypeName::GetNameCount Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT GetNameCount ( + [out, retval] DWORD* pCount +); +``` + +## 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 + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/itypename-getnames-method.md b/docs/framework/unmanaged-api/hosting/itypename-getnames-method.md new file mode 100644 index 0000000000000..3deaeb962ecda --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/itypename-getnames-method.md @@ -0,0 +1,46 @@ +--- +description: "Learn more about: ITypeName::GetNames Method" +title: "ITypeName::GetNames Method" +ms.date: "03/30/2017" +api_name: + - "ITypeName.GetNames" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "GetNames" +helpviewer_keywords: + - "ITypeName::GetNames method [.NET Framework hosting]" + - "GetNames method [.NET Framework hosting]" +ms.assetid: e2a3637b-d1e9-4d93-9e9b-0555fbff793d +topic_type: + - "apiref" +--- +# ITypeName::GetNames Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT GetNames ( + [in] DWORD count, + [out] BSTR* rgbszNames, + [out, retval] DWORD* pCount +); +``` + +## 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 + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md b/docs/framework/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md new file mode 100644 index 0000000000000..df7a497f0febf --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/itypename-gettypeargumentcount-method.md @@ -0,0 +1,44 @@ +--- +description: "Learn more about: ITypeName::GetTypeArgumentCount Method" +title: "ITypeName::GetTypeArgumentCount Method" +ms.date: "03/30/2017" +api_name: + - "ITypeName.GetTypeArgumentCount" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "GetTypeArgumentCount" +helpviewer_keywords: + - "GetTypeArgumentCount method [.NET Framework hosting]" + - "ITypeName::GetTypeArgumentCount method [.NET Framework hosting]" +ms.assetid: ecb5480c-761a-4b02-83e0-b79abc67fd08 +topic_type: + - "apiref" +--- +# ITypeName::GetTypeArgumentCount Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT GetTypeArgumentCount ( + [out, retval] DWORD* pCount +); +``` + +## 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 + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/itypename-gettypearguments-method.md b/docs/framework/unmanaged-api/hosting/itypename-gettypearguments-method.md new file mode 100644 index 0000000000000..038ff4efc727f --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/itypename-gettypearguments-method.md @@ -0,0 +1,46 @@ +--- +description: "Learn more about: ITypeName::GetTypeArguments Method" +title: "ITypeName::GetTypeArguments Method" +ms.date: "03/30/2017" +api_name: + - "ITypeName.GetTypeArguments" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "GetTypeArguments" +helpviewer_keywords: + - "ITypeName::GetTypeArguments method [.NET Framework hosting]" + - "GetTypeArguments method [.NET Framework hosting]" +ms.assetid: 638d77df-ff9c-40d9-88ee-930f5f87ada1 +topic_type: + - "apiref" +--- +# ITypeName::GetTypeArguments Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT GetTypeArguments ( + [in] DWORD count, + [out] ITypeName** rgpArguments, + [out, retval] DWORD* pCount +); +``` + +## 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 + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/itypename-interface.md b/docs/framework/unmanaged-api/hosting/itypename-interface.md new file mode 100644 index 0000000000000..b0b055e987610 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/itypename-interface.md @@ -0,0 +1,37 @@ +--- +description: "Learn more about: ITypeName Interface" +title: "ITypeName Interface" +ms.date: "03/30/2017" +api_name: + - "ITypeName" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ITypeName" +helpviewer_keywords: + - "ITypeName interface [.NET Framework hosting]" +ms.assetid: 3be458bb-a519-4e22-b373-0b28f2c9cc3c +topic_type: + - "apiref" +--- +# ITypeName Interface + +Provides methods for obtaining type name information. + + This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## 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 + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/itypenamebuilder-addarray-method.md b/docs/framework/unmanaged-api/hosting/itypenamebuilder-addarray-method.md new file mode 100644 index 0000000000000..94da6a5bfdd46 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/itypenamebuilder-addarray-method.md @@ -0,0 +1,44 @@ +--- +description: "Learn more about: ITypeNameBuilder::AddArray Method" +title: "ITypeNameBuilder::AddArray Method" +ms.date: "03/30/2017" +api_name: + - "ITypeNameBuilder.AddArray" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "AddArray" +helpviewer_keywords: + - "ITypeNameBuilder::AddArray method [.NET Framework hosting]" + - "AddArray method [.NET Framework hosting]" +ms.assetid: 0a21ae28-54bc-4f6e-aaa6-960a22c5f530 +topic_type: + - "apiref" +--- +# ITypeNameBuilder::AddArray Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT AddArray ( + [in] DWORD rank +); +``` + +## 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)] + +## See also + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md b/docs/framework/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md new file mode 100644 index 0000000000000..f5dad0aad8787 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/itypenamebuilder-addassemblyspec-method.md @@ -0,0 +1,44 @@ +--- +description: "Learn more about: ITypeNameBuilder::AddAssemblySpec Method" +title: "ITypeNameBuilder::AddAssemblySpec Method" +ms.date: "03/30/2017" +api_name: + - "ITypeNameBuilder.AddAssemblySpec" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "AddAssemblySpec" +helpviewer_keywords: + - "ITypeNameBuilder::AddAssemblySpec method [.NET Framework hosting]" + - "AddAssemblySpec method [.NET Framework hosting]" +ms.assetid: 4723e553-10c6-4828-aff8-bc62385163b8 +topic_type: + - "apiref" +--- +# ITypeNameBuilder::AddAssemblySpec Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT AddAssemblySpec ( + [in] LPCWSTR szAssemblySpec +); +``` + +## 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 + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md b/docs/framework/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md similarity index 76% rename from docs/core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md rename to docs/framework/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md index a49fc10234e01..a492396e0f1aa 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md +++ b/docs/framework/unmanaged-api/hosting/itypenamebuilder-addbyref-method.md @@ -13,6 +13,7 @@ f1_keywords: helpviewer_keywords: - "ITypeNameBuilder::AddByRef method [.NET Framework hosting]" - "AddByRef method [.NET Framework hosting]" +ms.assetid: 3f1b6bc4-6efb-4b90-8be0-b1ba8d856ca0 topic_type: - "apiref" --- @@ -29,13 +30,13 @@ HRESULT AddByRef ( ); ## Requirements -**Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). +**Platforms:** See [System Requirements](../../get-started/system-requirements.md). **Header:** MSCorEE.h **Library:** Included as a resource in MSCorEE.dll -**.NET versions:** Available since .NET Framework 2.0 +**.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] ## See also diff --git a/docs/framework/unmanaged-api/hosting/itypenamebuilder-addname-method.md b/docs/framework/unmanaged-api/hosting/itypenamebuilder-addname-method.md new file mode 100644 index 0000000000000..c06e902fdfc38 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/itypenamebuilder-addname-method.md @@ -0,0 +1,44 @@ +--- +description: "Learn more about: ITypeNameBuilder::AddName Method" +title: "ITypeNameBuilder::AddName Method" +ms.date: "03/30/2017" +api_name: + - "ITypeNameBuilder.AddName" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "AddName" +helpviewer_keywords: + - "ITypeNameBuilder::AddName method [.NET Framework hosting]" + - "AddName method [.NET Framework hosting]" +ms.assetid: be2f6e55-f46d-49aa-b477-80fd7e4515f7 +topic_type: + - "apiref" +--- +# ITypeNameBuilder::AddName Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT AddName ( + [in] LPCWSTR szName +); +``` + +## 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 + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md b/docs/framework/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md new file mode 100644 index 0000000000000..4e865dc4f844b --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/itypenamebuilder-addpointer-method.md @@ -0,0 +1,42 @@ +--- +description: "Learn more about: ITypeNameBuilder::AddPointer Method" +title: "ITypeNameBuilder::AddPointer Method" +ms.date: "03/30/2017" +api_name: + - "ITypeNameBuilder.AddPointer" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "AddPointer" +helpviewer_keywords: + - "ITypeNameBuilder::AddPointer method [.NET Framework hosting]" + - "AddPointer method [.NET Framework hosting]" +ms.assetid: b6f1dbd4-1a9f-44dd-b54b-c530ab44eb48 +topic_type: + - "apiref" +--- +# ITypeNameBuilder::AddPointer Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT AddPointer ( ); +``` + +## 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 + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md b/docs/framework/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md new file mode 100644 index 0000000000000..63ede89292fe3 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/itypenamebuilder-addszarray-method.md @@ -0,0 +1,42 @@ +--- +description: "Learn more about: ITypeNameBuilder::AddSzArray Method" +title: "ITypeNameBuilder::AddSzArray Method" +ms.date: "03/30/2017" +api_name: + - "ITypeNameBuilder.AddSzArray" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "AddSzArray" +helpviewer_keywords: + - "AddSzArray method [.NET Framework hosting]" + - "ITypeNameBuilder::AddSzArray method [.NET Framework hosting]" +ms.assetid: a6a46296-af14-4c53-9744-f7a1e3f3028a +topic_type: + - "apiref" +--- +# ITypeNameBuilder::AddSzArray Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT AddSzArray ( ); +``` + +## 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 + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/itypenamebuilder-clear-method.md b/docs/framework/unmanaged-api/hosting/itypenamebuilder-clear-method.md new file mode 100644 index 0000000000000..50728006d19ad --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/itypenamebuilder-clear-method.md @@ -0,0 +1,42 @@ +--- +description: "Learn more about: ITypeNameBuilder::Clear Method" +title: "ITypeNameBuilder::Clear Method" +ms.date: "03/30/2017" +api_name: + - "ITypeNameBuilder.Clear" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "Clear" +helpviewer_keywords: + - "Clear method [.NET Framework hosting]" + - "ITypeNameBuilder::Clear method [.NET Framework hosting]" +ms.assetid: 18d54280-46af-479f-8d84-5ab64f8b23b9 +topic_type: + - "apiref" +--- +# ITypeNameBuilder::Clear Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT Clear ( ); +``` + +## 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)] + +## See also + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md b/docs/framework/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md similarity index 50% rename from docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md rename to docs/framework/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md index 084e259b756bc..91f5b04d9ccfa 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md +++ b/docs/framework/unmanaged-api/hosting/itypenamebuilder-closegenericargument-method.md @@ -2,40 +2,41 @@ description: "Learn more about: ITypeNameBuilder::CloseGenericArgument Method" title: "ITypeNameBuilder::CloseGenericArgument Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeNameBuilder.CloseGenericArgument" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CloseGenericArgument" -helpviewer_keywords: +helpviewer_keywords: - "ITypeNameBuilder::CloseGenericArgument method [.NET Framework hosting]" - "CloseGenericArgument method [.NET Framework hosting]" -topic_type: +ms.assetid: c9a8178d-be1f-4ad4-abdb-d38470659b82 +topic_type: - "apiref" --- # ITypeNameBuilder::CloseGenericArgument Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CloseGenericArgument ( ); -``` - -## 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 2.0 - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CloseGenericArgument ( ); +``` + +## 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 - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md b/docs/framework/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md similarity index 51% rename from docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md rename to docs/framework/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md index e77e25179a2ec..66cf552bfa1de 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md +++ b/docs/framework/unmanaged-api/hosting/itypenamebuilder-closegenericarguments-method.md @@ -2,40 +2,41 @@ description: "Learn more about: ITypeNameBuilder::CloseGenericArguments Method" title: "ITypeNameBuilder::CloseGenericArguments Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeNameBuilder.CloseGenericArguments" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "CloseGenericArguments" -helpviewer_keywords: +helpviewer_keywords: - "CloseGenericArguments method [.NET Framework hosting]" - "ITypeNameBuilder::CloseGenericArguments method [.NET Framework hosting]" -topic_type: +ms.assetid: 583d13f9-786b-49e3-bc42-a4ba3aa8d9c6 +topic_type: - "apiref" --- # ITypeNameBuilder::CloseGenericArguments Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT CloseGenericArguments ( ); -``` - -## 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 2.0 - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT CloseGenericArguments ( ); +``` + +## 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 - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/itypenamebuilder-interface.md b/docs/framework/unmanaged-api/hosting/itypenamebuilder-interface.md new file mode 100644 index 0000000000000..8dd3a6621ca95 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/itypenamebuilder-interface.md @@ -0,0 +1,37 @@ +--- +description: "Learn more about: ITypeNameBuilder Interface" +title: "ITypeNameBuilder Interface" +ms.date: "03/30/2017" +api_name: + - "ITypeNameBuilder" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ITypeNameBuilder" +helpviewer_keywords: + - "ITypeNameBuilder interface [.NET Framework hosting]" +ms.assetid: 1f88e62e-2762-44d1-83b1-095f8734c0bc +topic_type: + - "apiref" +--- +# ITypeNameBuilder Interface + +Provides methods for building a type name. + + This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## 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 + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md b/docs/framework/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md similarity index 50% rename from docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md rename to docs/framework/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md index 5d41cf8236f01..341445f00170c 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md +++ b/docs/framework/unmanaged-api/hosting/itypenamebuilder-opengenericargument-method.md @@ -2,40 +2,41 @@ description: "Learn more about: ITypeNameBuilder::OpenGenericArgument Method" title: "ITypeNameBuilder::OpenGenericArgument Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeNameBuilder.OpenGenericArgument" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "OpenGenericArgument" -helpviewer_keywords: +helpviewer_keywords: - "ITypeNameBuilder::OpenGenericArgument method [.NET Framework hosting]" - "OpenGenericArgument method [.NET Framework hosting]" -topic_type: +ms.assetid: 476feeac-e8e9-46cf-9f8d-be103181d0ab +topic_type: - "apiref" --- # ITypeNameBuilder::OpenGenericArgument Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT OpenGenericArgument ( ); -``` - -## 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 2.0 - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT OpenGenericArgument ( ); +``` + +## 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 - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md b/docs/framework/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md similarity index 50% rename from docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md rename to docs/framework/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md index 60c9d866482bd..a1b5ab0682ebd 100644 --- a/docs/core/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md +++ b/docs/framework/unmanaged-api/hosting/itypenamebuilder-opengenericarguments-method.md @@ -2,40 +2,41 @@ description: "Learn more about: ITypeNameBuilder::OpenGenericArguments Method" title: "ITypeNameBuilder::OpenGenericArguments Method" ms.date: "03/30/2017" -api_name: +api_name: - "ITypeNameBuilder.OpenGenericArguments" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "OpenGenericArguments" -helpviewer_keywords: +helpviewer_keywords: - "OpenGenericArguments method [.NET Framework hosting]" - "ITypeNameBuilder::OpenGenericArguments method [.NET Framework hosting]" -topic_type: +ms.assetid: 4da94508-30da-41f4-8bf9-ce88bdf96fd2 +topic_type: - "apiref" --- # ITypeNameBuilder::OpenGenericArguments Method -This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. - -## Syntax - -```cpp -HRESULT OpenGenericArguments ( ); -``` - -## 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 2.0 - +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT OpenGenericArguments ( ); +``` + +## 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 - [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/itypenamebuilder-tostring-method.md b/docs/framework/unmanaged-api/hosting/itypenamebuilder-tostring-method.md new file mode 100644 index 0000000000000..eb3648beddcc1 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/itypenamebuilder-tostring-method.md @@ -0,0 +1,44 @@ +--- +description: "Learn more about: ITypeNameBuilder::ToString Method" +title: "ITypeNameBuilder::ToString Method" +ms.date: "03/30/2017" +api_name: + - "ITypeNameBuilder.ToString" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ToString" +helpviewer_keywords: + - "ToString method [.NET Framework hosting]" + - "ITypeNameBuilder::ToString method [.NET Framework hosting]" +ms.assetid: 6372aca7-869a-4af6-ba2b-0eb1047ef5c0 +topic_type: + - "apiref" +--- +# ITypeNameBuilder::ToString Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT ToString ( + [out, retval] BSTR* pszStringRepresentation +); +``` + +## 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 + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md b/docs/framework/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md new file mode 100644 index 0000000000000..ec950109c3a59 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/itypenamefactory-gettypenamebuilder-method.md @@ -0,0 +1,44 @@ +--- +description: "Learn more about: ITypeNameFactory::GetTypeNameBuilder Method" +title: "ITypeNameFactory::GetTypeNameBuilder Method" +ms.date: "03/30/2017" +api_name: + - "ITypeNameFactory.GetTypeNameBuilder" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "GetTypeNameBuilder" +helpviewer_keywords: + - "ITypeNameFactory::GetTypeNameBuilder method [.NET Framework hosting]" + - "GetTypeNameBuilder method [.NET Framework hosting]" +ms.assetid: c682f744-996e-43c7-a9ea-c57cbc755398 +topic_type: + - "apiref" +--- +# ITypeNameFactory::GetTypeNameBuilder Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT GetTypeNameBuilder ( + [out, retval] ITypeNameBuilder** ppTypeBuilder +); +``` + +## 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 + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/itypenamefactory-interface.md b/docs/framework/unmanaged-api/hosting/itypenamefactory-interface.md new file mode 100644 index 0000000000000..c216aeab8883c --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/itypenamefactory-interface.md @@ -0,0 +1,38 @@ +--- +description: "Learn more about: ITypeNameFactory Interface" +title: "ITypeNameFactory Interface" +ms.date: "03/30/2017" +api_name: + - "ITypeNameFactory" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ITypeNameFactory" +helpviewer_keywords: + - "ITypeNameFactory interface [.NET Framework hosting]" +ms.assetid: fa4247c4-f4f1-4855-9241-e04d737f5f73 +topic_type: + - "apiref" +--- +# ITypeNameFactory Interface + +Provides methods for deconstructing a type name. + + This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## 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 + +- [Hosting Interfaces](hosting-interfaces.md) +- [TypeNameFactory Coclass](typenamefactory-coclass.md) diff --git a/docs/framework/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md b/docs/framework/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md new file mode 100644 index 0000000000000..471fee66526ff --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/itypenamefactory-parsetypename-method.md @@ -0,0 +1,46 @@ +--- +description: "Learn more about: ITypeNameFactory::ParseTypeName Method" +title: "ITypeNameFactory::ParseTypeName Method" +ms.date: "03/30/2017" +api_name: + - "ITypeNameFactory.ParseTypeName" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "ParseTypeName" +helpviewer_keywords: + - "ITypeNameFactory::ParseTypeName method [.NET Framework hosting]" + - "ParseTypeName method [.NET Framework hosting]" +ms.assetid: 13c9f063-371c-4911-a5e7-e1e0b88ae382 +topic_type: + - "apiref" +--- +# ITypeNameFactory::ParseTypeName Method + +This method supports the .NET Framework infrastructure and is not intended to be used directly from your code. + +## Syntax + +```cpp +HRESULT ParseTypeName ( + [in] LPCWSTR szName, + [out] DWORD* pError, + [out, retval] ITypeName** ppTypeName +); +``` + +## 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 + +- [Hosting Interfaces](hosting-interfaces.md) diff --git a/docs/framework/unmanaged-api/hosting/ivalidator-formateventinfo-method.md b/docs/framework/unmanaged-api/hosting/ivalidator-formateventinfo-method.md new file mode 100644 index 0000000000000..b6f36658bb921 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/ivalidator-formateventinfo-method.md @@ -0,0 +1,61 @@ +--- +description: "Learn more about: IValidator::FormatEventInfo Method" +title: "IValidator::FormatEventInfo Method" +ms.date: "03/30/2017" +api_name: + - "IValidator.FormatEventInfo" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "FormatEventInfo" +helpviewer_keywords: + - "IValidator::FormatEventInfo method [.NET Framework hosting]" + - "FormatEventInfo method, IValidator interface [.NET Framework hosting]" +ms.assetid: 4c0c7477-05ba-461b-b21b-cbfba95f1db1 +topic_type: + - "apiref" +--- +# IValidator::FormatEventInfo Method + +Gets the error message corresponding to the specified validation error. + +## Syntax + +```cpp +HRESULT FormatEventInfo( + [in] HRESULT hVECode, + [in] VEContext Context, + [in, out] LPWSTR msg, + [in] unsigned long ulMaxLength, + [in] SAFEARRAY(VARIANT) psa +); +``` + +## Parameters + + `hVECode` + [in] The HRESULT value that was passed to the validation error handler. + + `Context` + [in] A `VEContext` instance that contains context information about the validation error. + + `msg` + [in, out] A string that contains the returned error message. + + `ulMaxLength` + [in] The maximum length of the error message. + + `psa` + [in] A safe array that contains additional parameters describing the error. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** IValidator.idl, IValidator.h + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] diff --git a/docs/core/unmanaged-api/hosting/ivalidator-interface.md b/docs/framework/unmanaged-api/hosting/ivalidator-interface.md similarity index 78% rename from docs/core/unmanaged-api/hosting/ivalidator-interface.md rename to docs/framework/unmanaged-api/hosting/ivalidator-interface.md index fdbd6aafa1905..07404ee94ddd6 100644 --- a/docs/core/unmanaged-api/hosting/ivalidator-interface.md +++ b/docs/framework/unmanaged-api/hosting/ivalidator-interface.md @@ -12,6 +12,7 @@ f1_keywords: - "IValidator" helpviewer_keywords: - "IValidator interface [.NET Framework hosting]" +ms.assetid: b297e3b0-20f9-478f-b707-5e2eecb2b5b2 topic_type: - "apiref" --- @@ -28,13 +29,13 @@ Provides methods for validating portable executable (PE) images and reporting va ## Requirements - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h **Library:** Included as a resource in MSCorEE.dll - **.NET versions:** Available since .NET Framework 2.0 + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] ## See also diff --git a/docs/core/unmanaged-api/hosting/ivalidator-validate-method.md b/docs/framework/unmanaged-api/hosting/ivalidator-validate-method.md similarity index 87% rename from docs/core/unmanaged-api/hosting/ivalidator-validate-method.md rename to docs/framework/unmanaged-api/hosting/ivalidator-validate-method.md index 0cf17d4f7b32f..f98a917cdb9c9 100644 --- a/docs/core/unmanaged-api/hosting/ivalidator-validate-method.md +++ b/docs/framework/unmanaged-api/hosting/ivalidator-validate-method.md @@ -13,6 +13,7 @@ f1_keywords: helpviewer_keywords: - "IValidator::Validate method [.NET Framework hosting]" - "Validate method, IValidator interface [.NET Framework hosting]" +ms.assetid: 7d68666a-fb73-4455-bebd-908d49a16abc topic_type: - "apiref" --- @@ -63,10 +64,10 @@ HRESULT Validate ( ## Requirements - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h **Library:** Included as a resource in MSCorEE.dll - **.NET versions:** Available since .NET Framework 2.0 + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] diff --git a/docs/core/unmanaged-api/hosting/loadlibraryshim-function.md b/docs/framework/unmanaged-api/hosting/loadlibraryshim-function.md similarity index 63% rename from docs/core/unmanaged-api/hosting/loadlibraryshim-function.md rename to docs/framework/unmanaged-api/hosting/loadlibraryshim-function.md index fbc39e9984a54..726c07cb0547e 100644 --- a/docs/core/unmanaged-api/hosting/loadlibraryshim-function.md +++ b/docs/framework/unmanaged-api/hosting/loadlibraryshim-function.md @@ -2,75 +2,76 @@ description: "Learn more about: LoadLibraryShim Function" title: "LoadLibraryShim Function" ms.date: "03/30/2017" -api_name: +api_name: - "LoadLibraryShim" -api_location: +api_location: - "mscoree.dll" - "mscoreei.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "LoadLibraryShim" -helpviewer_keywords: +helpviewer_keywords: - "LoadLibraryShim function [.NET Framework hosting]" -topic_type: +ms.assetid: 30931874-4d0e-4df1-b3d1-e425b50655d1 +topic_type: - "apiref" --- # LoadLibraryShim Function -Loads a specified version of a DLL that is included in the .NET Framework redistributable package. - - This function has been deprecated in the .NET Framework 4. Use the [ICLRRuntimeInfo::LoadLibrary](iclrruntimeinfo-loadlibrary-method.md) method instead. - -## Syntax - -```cpp -HRESULT LoadLibraryShim ( - [in] LPCWSTR szDllName, - [in] LPCWSTR szVersion, - LPVOID pvReserved, - [out] HMODULE *phModDll -); -``` - -## Parameters - - `szDllName` - [in] A zero-terminated string that represents the name of the DLL to be loaded from the .NET Framework library. - - `szVersion` - [in] A zero-terminated string that represents the version of the DLL to be loaded. If `szVersion` is null, the version selected for loading is the latest version of the specified DLL that is less than version 4. That is, all versions equal to or greater than version 4 are ignored if `szVersion` is null, and if no version less than version 4 is installed, the DLL fails to load. This is to ensure that installation of the .NET Framework 4 does not affect pre-existing applications or components. See the entry [In-Proc SxS and Migration Quick Start](https://devblogs.microsoft.com/dotnet/in-proc-sxs-and-migration-quick-start/) in the CLR team blog. - - `pvReserved` - Reserved for future use. - - `phModDll` - [out] A pointer to the handle of the module. - -## Return Value - - This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values. - -|Return code|Description| -|-----------------|-----------------| -|S_OK|The method completed successfully.| -|CLR_E_SHIM_RUNTIMELOAD|Loading `szDllName` requires loading the common language runtime (CLR), and the necessary version of the CLR cannot be loaded.| - -## Remarks - - This function is used to load DLLs that are included in the .NET Framework redistributable package. It does not load user-generated DLLs. - +Loads a specified version of a DLL that is included in the .NET Framework redistributable package. + + This function has been deprecated in the .NET Framework 4. Use the [ICLRRuntimeInfo::LoadLibrary](iclrruntimeinfo-loadlibrary-method.md) method instead. + +## Syntax + +```cpp +HRESULT LoadLibraryShim ( + [in] LPCWSTR szDllName, + [in] LPCWSTR szVersion, + LPVOID pvReserved, + [out] HMODULE *phModDll +); +``` + +## Parameters + + `szDllName` + [in] A zero-terminated string that represents the name of the DLL to be loaded from the .NET Framework library. + + `szVersion` + [in] A zero-terminated string that represents the version of the DLL to be loaded. If `szVersion` is null, the version selected for loading is the latest version of the specified DLL that is less than version 4. That is, all versions equal to or greater than version 4 are ignored if `szVersion` is null, and if no version less than version 4 is installed, the DLL fails to load. This is to ensure that installation of the .NET Framework 4 does not affect pre-existing applications or components. See the entry [In-Proc SxS and Migration Quick Start](https://devblogs.microsoft.com/dotnet/in-proc-sxs-and-migration-quick-start/) in the CLR team blog. + + `pvReserved` + Reserved for future use. + + `phModDll` + [out] A pointer to the handle of the module. + +## Return Value + + This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values. + +|Return code|Description| +|-----------------|-----------------| +|S_OK|The method completed successfully.| +|CLR_E_SHIM_RUNTIMELOAD|Loading `szDllName` requires loading the common language runtime (CLR), and the necessary version of the CLR cannot be loaded.| + +## Remarks + + This function is used to load DLLs that are included in the .NET Framework redistributable package. It does not load user-generated DLLs. + > [!NOTE] -> Beginning with .NET Framework version 2.0, loading Fusion.dll causes the CLR to be loaded. This is because the functions in Fusion.dll are now wrappers whose implementations are provided by the runtime. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **.NET versions:** Available since .NET Framework 1.0 - +> Beginning with .NET Framework version 2.0, loading Fusion.dll causes the CLR to be loaded. This is because the functions in Fusion.dll are now wrappers whose implementations are provided by the runtime. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/loadstringrc-function.md b/docs/framework/unmanaged-api/hosting/loadstringrc-function.md new file mode 100644 index 0000000000000..8a2f7c38c0f70 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/loadstringrc-function.md @@ -0,0 +1,76 @@ +--- +description: "Learn more about: LoadStringRC Function" +title: "LoadStringRC Function" +ms.date: "03/30/2017" +api_name: + - "LoadStringRC" +api_location: + - "mscoree.dll" +api_type: + - "DLLExport" +f1_keywords: + - "LoadStringRC" +helpviewer_keywords: + - "LoadStringRC function [.NET Framework hosting]" +ms.assetid: 752e49b4-987c-4c28-a118-1a0c1ed510c5 +topic_type: + - "apiref" +--- +# LoadStringRC Function + +Translates an HRESULT value into an error message by using the default culture of the current thread. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT LoadStringRC ( + [in] UINT iResourceID, + [out] LPWSTR szBuffer, + [in] int iMax, + [in] int bQuiet +); +``` + +## Parameters + + `iResourceID` + [in] An HRESULT. + + `szBuffer` + [out] A buffer that contains the error message upon successful completion. + + `iMax` + [in] The size of the error message buffer. + + `bQuiet` + [in] Ignored. + +## Return Value + + This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values. + +|Return code|Description| +|-----------------|-----------------| +|S_OK|The method completed successfully.| +|E_INVALIDARG|`szBuffer` is null or `iMax` is zero (0).| + +## Remarks + + If the method does not complete successfully, `szBuffer` contains an empty string. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll and Mscorwks.dll. Use MSCorEE.dll instead of Mscorwks.dll to ensure that you target the correct version of the .NET Framework. + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + +## See also + +- [LoadStringRCEx Function](loadstringrcex-function.md) +- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/loadstringrcex-function.md b/docs/framework/unmanaged-api/hosting/loadstringrcex-function.md new file mode 100644 index 0000000000000..78669913b9b17 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/loadstringrcex-function.md @@ -0,0 +1,85 @@ +--- +description: "Learn more about: LoadStringRCEx Function" +title: "LoadStringRCEx Function" +ms.date: "03/30/2017" +api_name: + - "LoadStringRCEx" +api_location: + - "mscoree.dll" +api_type: + - "DLLExport" +f1_keywords: + - "LoadStringRCEx" +helpviewer_keywords: + - "LoadStringRCEx function [.NET Framework hosting]" +ms.assetid: bc789636-ca14-4f07-8f77-9305874d7495 +topic_type: + - "apiref" +--- +# LoadStringRCEx Function + +Translates an HRESULT value to an appropriate error message for the specified culture. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT LoadStringRCEx ( + [in] LCID lcid, + [in] UINT iResouceID, + [out] LPWSTR szBuffer, + [in] int iMax, + [in] int bQuiet, + [out] int *pcwchUsed +); +``` + +## Parameters + + `lcid` + [in] A culture identifier. Pass -1 for `lcid` to use the default culture. + + `iResourceID` + [in] An HRESULT. + + `szBuffer` + [out] A buffer that contains the error message upon successful completion. + + `iMax` + [in] The size of the error message buffer. + + `bQuiet` + [in] Ignored. + + `pcwchUsed` + [out] A pointer to the length of the error message. + +## Return Value + + This method returns standard COM error codes, as defined in WinError.h, in addition to the following values. + +|Return code|Description| +|-----------------|-----------------| +|S_OK|The method completed successfully.| +|E_INVALIDARG|`szBuffer` is null, or `iMax` is zero (0).| + +## Remarks + + If the method does not complete successfully, `szBuffer` contains an empty string. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + +## See also + +- +- [LoadStringRC Function](loadstringrc-function.md) +- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/lockclrversion-function.md b/docs/framework/unmanaged-api/hosting/lockclrversion-function.md similarity index 51% rename from docs/core/unmanaged-api/hosting/lockclrversion-function.md rename to docs/framework/unmanaged-api/hosting/lockclrversion-function.md index 72a74f11766e4..0fd9540d2c012 100644 --- a/docs/core/unmanaged-api/hosting/lockclrversion-function.md +++ b/docs/framework/unmanaged-api/hosting/lockclrversion-function.md @@ -2,94 +2,95 @@ description: "Learn more about: LockClrVersion Function" title: "LockClrVersion Function" ms.date: "03/30/2017" -api_name: +api_name: - "LockClrVersion" -api_location: +api_location: - "mscoree.dll" - "mscoreei.dll" -api_type: +api_type: - "DLLExport" -f1_keywords: +f1_keywords: - "LockClrVersion" -helpviewer_keywords: +helpviewer_keywords: - "LockClrVersion function [.NET Framework hosting]" -topic_type: +ms.assetid: 1318ee37-c43b-40eb-bbe8-88fc46453d74 +topic_type: - "apiref" --- # LockClrVersion Function -Allows the host to determine which version of the common language runtime (CLR) will be used within the process before explicitly initializing the CLR. - - This function has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -HRESULT LockClrVersion ( - [in] FLockClrVersionCallback hostCallback, - [in] FLockClrVersionCallback *pBeginHostSetup, - [in] FLockClrVersionCallback *pEndHostSetup -); -``` - -## Parameters - - `hostCallback` - [in] The function to be called by the CLR upon initialization. - - `pBeginHostSetup` - [in] The function to be called by the host to inform the CLR that initialization is starting. - - `pEndHostSetup` - [in] The function to be called by the host to inform the CLR that initialization is complete. - -## Return Value - - This method returns standard COM error codes, as defined in WinError.h, in addition to the following values. - -|Return code|Description| -|-----------------|-----------------| -|S_OK|The method completed successfully.| -|E_INVALIDARG|One or more of the arguments is null.| - -## Remarks - - The host calls `LockClrVersion` before initializing the CLR. `LockClrVersion` takes three parameters, all of which are callbacks of type [FLockClrVersionCallback](flockclrversioncallback-function-pointer.md). This type is defined as follows. - -```cpp -typedef HRESULT ( __stdcall *FLockClrVersionCallback ) (); -``` - - The following steps occur upon initialization of the runtime: - -1. The host calls [CorBindToRuntimeEx](corbindtoruntimeex-function.md) or one of the other runtime initialization functions. Alternatively, the host could initialize the runtime using COM object activation. - -2. The runtime calls the function specified by the `hostCallback` parameter. - -3. The function specified by `hostCallback` then makes the following sequence of calls: - - - The function specified by the `pBeginHostSetup` parameter. - - - `CorBindToRuntimeEx` (or another runtime initialization function). - - - [ICLRRuntimeHost::SetHostControl](iclrruntimehost-sethostcontrol-method.md). - - - [ICLRRuntimeHost::Start](iclrruntimehost-start-method.md). - - - The function specified by the `pEndHostSetup` parameter. - - All the calls from `pBeginHostSetup` to `pEndHostSetup` must occur on a single thread or fiber, with the same logical stack. This thread can be different from the thread upon which `hostCallback` is called. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - +Allows the host to determine which version of the common language runtime (CLR) will be used within the process before explicitly initializing the CLR. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT LockClrVersion ( + [in] FLockClrVersionCallback hostCallback, + [in] FLockClrVersionCallback *pBeginHostSetup, + [in] FLockClrVersionCallback *pEndHostSetup +); +``` + +## Parameters + + `hostCallback` + [in] The function to be called by the CLR upon initialization. + + `pBeginHostSetup` + [in] The function to be called by the host to inform the CLR that initialization is starting. + + `pEndHostSetup` + [in] The function to be called by the host to inform the CLR that initialization is complete. + +## Return Value + + This method returns standard COM error codes, as defined in WinError.h, in addition to the following values. + +|Return code|Description| +|-----------------|-----------------| +|S_OK|The method completed successfully.| +|E_INVALIDARG|One or more of the arguments is null.| + +## Remarks + + The host calls `LockClrVersion` before initializing the CLR. `LockClrVersion` takes three parameters, all of which are callbacks of type [FLockClrVersionCallback](flockclrversioncallback-function-pointer.md). This type is defined as follows. + +```cpp +typedef HRESULT ( __stdcall *FLockClrVersionCallback ) (); +``` + + The following steps occur upon initialization of the runtime: + +1. The host calls [CorBindToRuntimeEx](corbindtoruntimeex-function.md) or one of the other runtime initialization functions. Alternatively, the host could initialize the runtime using COM object activation. + +2. The runtime calls the function specified by the `hostCallback` parameter. + +3. The function specified by `hostCallback` then makes the following sequence of calls: + + - The function specified by the `pBeginHostSetup` parameter. + + - `CorBindToRuntimeEx` (or another runtime initialization function). + + - [ICLRRuntimeHost::SetHostControl](iclrruntimehost-sethostcontrol-method.md). + + - [ICLRRuntimeHost::Start](iclrruntimehost-start-method.md). + + - The function specified by the `pEndHostSetup` parameter. + + All the calls from `pBeginHostSetup` to `pEndHostSetup` must occur on a single thread or fiber, with the same logical stack. This thread can be different from the thread upon which `hostCallback` is called. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md b/docs/framework/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md similarity index 50% rename from docs/core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md rename to docs/framework/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md index 5e9b4ef28c3d1..be55c1f77615d 100644 --- a/docs/core/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md +++ b/docs/framework/unmanaged-api/hosting/lpoverlapped-completion-routine-function-pointer.md @@ -2,62 +2,63 @@ description: "Learn more about: LPOVERLAPPED_COMPLETION_ROUTINE Function Pointer" title: "LPOVERLAPPED_COMPLETION_ROUTINE Function Pointer" ms.date: "03/30/2017" -api_name: +api_name: - "LPOVERLAPPED_COMPLETION_ROUTINE" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "LPOVERLAPPED_COMPLETION_ROUTINE" -helpviewer_keywords: +helpviewer_keywords: - "LPOVERLAPPED_COMPLETION_ROUTINE function pointer [.NET Framework hosting]" -topic_type: +ms.assetid: 5fb645d9-b818-401c-8c2c-c30d86de58ba +topic_type: - "apiref" --- # LPOVERLAPPED_COMPLETION_ROUTINE Function Pointer -Points to a function that notifies the host when an overlapped (that is, asynchronous) I/O to a device has completed. - - This function pointer has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -typedef VOID (*LPOVERLAPPED_COMPLETION_ROUTINE) ( - [in] DWORD dwErrorCode, - [in] DWORD dwNumberOfBytesTransfered, - [in] LPVOID lpOverlapped -); -``` - -## Parameters - - `dwErrorCode` - [in] A value that is an error code if the device has been closed; otherwise, this value is zero. - - Closing a device causes all pending I/O to the device to be completed immediately. - - `dwNumberOfBytesTransfered` - [in] The number of bytes transferred by the I/O operation. - - `lpOverlapped` - [in] A pointer to a structure that contains information to be used to complete the I/O request. - -## Remarks - - The function to which `LPOVERLAPPED_COMPLETION_ROUTINE` points is a callback function and must be implemented by the writer of the hosting application. The callback function allows the host to process the completed I/O request. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorWks.dll - - **.NET versions:** Available since .NET Framework 1.0 - +Points to a function that notifies the host when an overlapped (that is, asynchronous) I/O to a device has completed. + + This function pointer has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +typedef VOID (*LPOVERLAPPED_COMPLETION_ROUTINE) ( + [in] DWORD dwErrorCode, + [in] DWORD dwNumberOfBytesTransfered, + [in] LPVOID lpOverlapped +); +``` + +## Parameters + + `dwErrorCode` + [in] A value that is an error code if the device has been closed; otherwise, this value is zero. + + Closing a device causes all pending I/O to the device to be completed immediately. + + `dwNumberOfBytesTransfered` + [in] The number of bytes transferred by the I/O operation. + + `lpOverlapped` + [in] A pointer to a structure that contains information to be used to complete the I/O request. + +## Remarks + + The function to which `LPOVERLAPPED_COMPLETION_ROUTINE` points is a callback function and must be implemented by the writer of the hosting application. The callback function allows the host to process the completed I/O request. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorWks.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md b/docs/framework/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md new file mode 100644 index 0000000000000..24bda7a04f1be --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/lpthread-start-routine-function-pointer.md @@ -0,0 +1,54 @@ +--- +description: "Learn more about: LPTHREAD_START_ROUTINE Function Pointer" +title: "LPTHREAD_START_ROUTINE Function Pointer" +ms.date: "03/30/2017" +api_name: + - "LPTHREAD_START_ROUTINE" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "LPTHREAD_START_ROUTINE" +helpviewer_keywords: + - "LPTHREAD_START_ROUTINE function pointer [.NET Framework hosting]" +ms.assetid: 7b9b93b0-fe92-42ba-8693-701168a29dde +topic_type: + - "apiref" +--- +# LPTHREAD_START_ROUTINE Function Pointer + +Points to a function that notifies the host that a thread has started to execute. + + This function pointer has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +typedef DWORD (__stdcall *LPTHREAD_START_ROUTINE) ( + [in] LPVOID lpThreadParameter +); +``` + +## Parameters + + `lpThreadParameter` + [in] A pointer to the code that has started executing. + +## Remarks + + The function to which `LPTHREAD_START_ROUTINE` points is a callback function and must be implemented by the writer of the hosting application. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorWks.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + +## See also + +- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/malloc-type-enumeration.md b/docs/framework/unmanaged-api/hosting/malloc-type-enumeration.md new file mode 100644 index 0000000000000..c73d9a728ba12 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/malloc-type-enumeration.md @@ -0,0 +1,51 @@ +--- +description: "Learn more about: MALLOC_TYPE Enumeration" +title: "MALLOC_TYPE Enumeration" +ms.date: "03/30/2017" +api_name: + - "MALLOC_TYPE" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "MALLOC_TYPE" +helpviewer_keywords: + - "MALLOC_TYPE Enumeration" +ms.assetid: c02476f9-23a2-4af7-9282-aa9c42c7429b +topic_type: + - "apiref" +--- +# MALLOC_TYPE Enumeration + +Contains values that specify the characteristics of the memory that is being allocated. + +## Syntax + +```cpp +typedef enum { + MALLOC_THREADSAFE = 0x1, + MALLOC_EXECUTABLE = 0x2, +} MALLOC_TYPE; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`MALLOC_EXECUTABLE`|The allocated memory can contain an executable file.| +|`MALLOC_THREADSAFE`|The allocated memory is thread-safe. That is, the memory can be accessed by multiple threads without any synchronization.

If this flag is not set, calls on the object must be serialized.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + +## See also + +- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/mdainfo-structure.md b/docs/framework/unmanaged-api/hosting/mdainfo-structure.md similarity index 61% rename from docs/core/unmanaged-api/hosting/mdainfo-structure.md rename to docs/framework/unmanaged-api/hosting/mdainfo-structure.md index fa03531fc707f..95a838e764892 100644 --- a/docs/core/unmanaged-api/hosting/mdainfo-structure.md +++ b/docs/framework/unmanaged-api/hosting/mdainfo-structure.md @@ -2,62 +2,63 @@ description: "Learn more about: MDAInfo Structure" title: "MDAInfo Structure" ms.date: "03/30/2017" -api_name: +api_name: - "MDAInfo" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "MDAInfo" -helpviewer_keywords: +helpviewer_keywords: - "MDAInfo structure [.NET Framework hosting]" -topic_type: +ms.assetid: fb8c14f7-d461-43d1-8b47-adb6723b9b93 +topic_type: - "apiref" --- # MDAInfo Structure -Provides details about the `Event_MDAFired` event, which triggers the creation of a managed debugging assistant (MDA). - -## Syntax - -```cpp -typedef struct _MDAInfo { - LPCWSTR lpMDACaption; - LPCWSTR lpMDAMessage -} MDAInfo; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`lpMDACaption`|The title of the current MDA. The title describes the kind of failure that triggered the `Event_MDAFired` event.| -|`lpMDAMessage`|The output message provided by the current MDA.| - -## Remarks - - Managed debugging assistants (MDAs) are debugging aids that work in conjunction with the common language runtime (CLR) to perform tasks such as identifying invalid conditions in the runtime execution engine or dumping additional information about the state of the engine. MDAs generate XML messages about events that are otherwise difficult to trap. They are especially useful for debugging transitions between managed and unmanaged code. - - The runtime takes the following steps when an event that triggers the creation of an MDA is fired: - -- If the host has not registered an [IActionOnCLREvent](iactiononclrevent-interface.md) instance by calling [ICLROnEventManager::RegisterActionOnEvent](iclroneventmanager-registeractiononevent-method.md) to be notified of an `Event_MDAFired` event, the runtime proceeds with its default, non-hosted behavior. - -- If the host has registered a handler for this event, the runtime checks to see whether a debugger is attached to the process. If it is, the runtime breaks into the debugger. When the debugger continues, it calls into the host. If no debugger is attached, the runtime calls `IActionOnCLREvent::OnEvent` and passes a pointer to an `MDAInfo` instance as the `data` parameter. - - The host can choose to activate MDAs and to be notified when an MDA is activated. This gives the host an opportunity to override default behavior and to abort the managed thread that raised the event, to prevent it from corrupting the process state. For more information about using MDAs, see [Diagnosing Errors with Managed Debugging Assistants](../../../framework/debug-trace-profile/diagnosing-errors-with-managed-debugging-assistants.md). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.idl - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - +Provides details about the `Event_MDAFired` event, which triggers the creation of a managed debugging assistant (MDA). + +## Syntax + +```cpp +typedef struct _MDAInfo { + LPCWSTR lpMDACaption; + LPCWSTR lpMDAMessage +} MDAInfo; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`lpMDACaption`|The title of the current MDA. The title describes the kind of failure that triggered the `Event_MDAFired` event.| +|`lpMDAMessage`|The output message provided by the current MDA.| + +## Remarks + + Managed debugging assistants (MDAs) are debugging aids that work in conjunction with the common language runtime (CLR) to perform tasks such as identifying invalid conditions in the runtime execution engine or dumping additional information about the state of the engine. MDAs generate XML messages about events that are otherwise difficult to trap. They are especially useful for debugging transitions between managed and unmanaged code. + + The runtime takes the following steps when an event that triggers the creation of an MDA is fired: + +- If the host has not registered an [IActionOnCLREvent](iactiononclrevent-interface.md) instance by calling [ICLROnEventManager::RegisterActionOnEvent](iclroneventmanager-registeractiononevent-method.md) to be notified of an `Event_MDAFired` event, the runtime proceeds with its default, non-hosted behavior. + +- If the host has registered a handler for this event, the runtime checks to see whether a debugger is attached to the process. If it is, the runtime breaks into the debugger. When the debugger continues, it calls into the host. If no debugger is attached, the runtime calls `IActionOnCLREvent::OnEvent` and passes a pointer to an `MDAInfo` instance as the `data` parameter. + + The host can choose to activate MDAs and to be notified when an MDA is activated. This gives the host an opportunity to override default behavior and to abort the managed thread that raised the event, to prevent it from corrupting the process state. For more information about using MDAs, see [Diagnosing Errors with Managed Debugging Assistants](../../debug-trace-profile/diagnosing-errors-with-managed-debugging-assistants.md). + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.idl + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [Hosting Structures](hosting-structures.md) -- [Diagnosing Errors with Managed Debugging Assistants](../../../framework/debug-trace-profile/diagnosing-errors-with-managed-debugging-assistants.md) +- [Diagnosing Errors with Managed Debugging Assistants](../../debug-trace-profile/diagnosing-errors-with-managed-debugging-assistants.md) diff --git a/docs/core/unmanaged-api/hosting/metahost-config-flags-enumeration.md b/docs/framework/unmanaged-api/hosting/metahost-config-flags-enumeration.md similarity index 59% rename from docs/core/unmanaged-api/hosting/metahost-config-flags-enumeration.md rename to docs/framework/unmanaged-api/hosting/metahost-config-flags-enumeration.md index 1bc0dcc4a7fbe..b61054e6a4089 100644 --- a/docs/core/unmanaged-api/hosting/metahost-config-flags-enumeration.md +++ b/docs/framework/unmanaged-api/hosting/metahost-config-flags-enumeration.md @@ -2,57 +2,58 @@ description: "Learn more about: METAHOST_CONFIG_FLAGS Enumeration" title: "METAHOST_CONFIG_FLAGS Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "METAHOST_CONFIG_FLAGS" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "METAHOST_CONFIG_FLAGS" -helpviewer_keywords: +helpviewer_keywords: - "METAHOST_CONFIG_FLAGS enumeration [.NET Framework hosting]" -topic_type: +ms.assetid: 6f1e389f-ed99-4d6a-a0ba-72d7d869a01d +topic_type: - "apiref" --- # METAHOST_CONFIG_FLAGS Enumeration -Describes the possible flags returned in the `pdwConfigFlags` parameter of the [ICLRMetaHostPolicy::GetRequestedRuntime](iclrmetahostpolicy-getrequestedruntime-method.md) method, indicating the presence and setting of the `useLegacyV2RuntimeActivationPolicy` attribute in the [\ element](../../../framework/configure-apps/file-schema/startup/startup-element.md) of the configuration file. - -## Syntax - -```cpp -typedef enum { - METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_UNSET = 0x00, - METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_TRUE = 0x01, - METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_FALSE = 0x02, - METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_MASK = 0x03 -} METAHOST_CONFIG_FLAGS; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_UNSET`|The `useLegacyV2RuntimeActivationPolicy` attribute was not present in the [\ Element](../../../framework/configure-apps/file-schema/startup/startup-element.md).| -|`METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_TRUE`|The `useLegacyV2RuntimeActivationPolicy` attribute was present and set to `true`.| -|`METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_FALSE`|The `useLegacyV2RuntimeActivationPolicy` attribute was present and set to `false`.| -|`METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_MASK`|Apply this mask to the value returned in `pdwConfigFlags` to get the values relevant to `useLegacyV2RuntimeActivationPolicy`.| - -## Remarks - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** Metahost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] - +Describes the possible flags returned in the `pdwConfigFlags` parameter of the [ICLRMetaHostPolicy::GetRequestedRuntime](iclrmetahostpolicy-getrequestedruntime-method.md) method, indicating the presence and setting of the `useLegacyV2RuntimeActivationPolicy` attribute in the [\ element](../../configure-apps/file-schema/startup/startup-element.md) of the configuration file. + +## Syntax + +```cpp +typedef enum { + METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_UNSET = 0x00, + METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_TRUE = 0x01, + METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_FALSE = 0x02, + METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_MASK = 0x03 +} METAHOST_CONFIG_FLAGS; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_UNSET`|The `useLegacyV2RuntimeActivationPolicy` attribute was not present in the [\ Element](../../configure-apps/file-schema/startup/startup-element.md).| +|`METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_TRUE`|The `useLegacyV2RuntimeActivationPolicy` attribute was present and set to `true`.| +|`METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_FALSE`|The `useLegacyV2RuntimeActivationPolicy` attribute was present and set to `false`.| +|`METAHOST_CONFIG_FLAGS_LEGACY_V2_ACTIVATION_POLICY_MASK`|Apply this mask to the value returned in `pdwConfigFlags` to get the values relevant to `useLegacyV2RuntimeActivationPolicy`.| + +## Remarks + +## 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 Enumerations](hosting-enumerations.md) - [GetRequestedRuntime Method](iclrmetahostpolicy-getrequestedruntime-method.md) -- [\ Element](../../../framework/configure-apps/file-schema/startup/startup-element.md) +- [\ Element](../../configure-apps/file-schema/startup/startup-element.md) diff --git a/docs/core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md b/docs/framework/unmanaged-api/hosting/metahost-policy-flags-enumeration.md similarity index 69% rename from docs/core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md rename to docs/framework/unmanaged-api/hosting/metahost-policy-flags-enumeration.md index d02bdc97eeecd..e9aa7b658ec1b 100644 --- a/docs/core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md +++ b/docs/framework/unmanaged-api/hosting/metahost-policy-flags-enumeration.md @@ -2,62 +2,63 @@ description: "Learn more about: METAHOST_POLICY_FLAGS Enumeration" title: "METAHOST_POLICY_FLAGS Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "METAHOST_POLICY_FLAGS" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "METAHOST_POLICY_FLAGS" -helpviewer_keywords: +helpviewer_keywords: - "METAHOST_POLICY_FLAGS enumeration [.NET Framework hosting]" -topic_type: +ms.assetid: 3bb4b526-0118-42e2-ba59-c95648528ce9 +topic_type: - "apiref" --- # METAHOST_POLICY_FLAGS Enumeration -Provides binding policies that are common to most runtime hosts. This enumeration is used by the [ICLRMetaHostPolicy::GetRequestedRuntime](iclrmetahostpolicy-getrequestedruntime-method.md) method. - -## Syntax - -```cpp -typedef enum { - METAHOST_POLICY_HIGHCOMPAT = 0x00, - METAHOST_POLICY_APPLY_UPGRADE_POLICY = 0x08, - METAHOST_POLICY_EMULATE_EXE_LAUNCH = 0x10, - METAHOST_POLICY_SHOW_ERROR_DIALOG = 0x20, - METAHOST_POLICY_USE_PROCESS_IMAGE_PATH = 0x40, - METAHOST_POLICY_ENSURE_SKU_SUPPORTED = 0x80, - METAHOST_POLICY_IGNORE_ERROR_MODE = 0x1000 - -} METAHOST_POLICY_FLAGS; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`METAHOST_POLICY_HIGHCOMPAT`|Defines the high-compatibility policy, which does not consider any common language runtime (CLR) that is loaded into the current process. Instead, it considers only the installed CLRs and the preferences of the component, as derived from the assembly file itself, the declared built-against version, or the configuration file.| -|`METAHOST_POLICY_APPLY_UPGRADE_POLICY`|Applies upgrade policy to the version bind result when an exact match is not found, based on the contents of HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\\.NETFramework\Policy\Upgrades. This has the same effect as [RUNTIME_INFO_UPGRADE_VERSION](runtime-info-flags-enumeration.md).| -|`METAHOST_POLICY_EMULATE_EXE_LAUNCH`|Binding results are returned as if the image provided to the call were launched in a new process. Currently, `GetRequestedRuntime` ignores the set of loadable runtimes and binds against the set of installed runtimes. This flag allows a host to determine which runtime an EXE will bind to when it is launched.| -|`METAHOST_POLICY_SHOW_ERROR_DIALOG`|An error dialog box is displayed if `GetRequestedRuntime` is unable to find a runtime that is compatible with the input parameters. Beginning with .NET Framework 4.5, this error dialog box can take the form of a Windows feature dialog box that asks whether the user would like to enable the appropriate feature.| -|`METAHOST_POLICY_USE_PROCESS_IMAGE_PATH`|`GetRequestedRuntime` uses the process image (and any corresponding configuration file) as additional input to the binding process. By default, `GetRequestedRuntime` does not fall back to the process image path (typically, the EXE that was used to launch the process) when determining the runtime to bind to.| -|`METAHOST_POLICY_ENSURE_SKU_SUPPORTED`|`GetRequestedRuntime` must check whether the appropriate SKU is installed when no information is available in the configuration file. This allows applications that do not have configuration files to fail gracefully on smaller SKUs than the default installation of the .NET Framework. By default, `GetRequestedRuntime` does not check whether the appropriate SKU is installed unless the SKU attribute is specified in the configuration file `` element.| -|`METAHOST_POLICY_IGNORE_ERROR_MODE`|`GetRequestedRuntime` should ignore SEM_FAILCRITICALERRORS (which is set by calling the [SetErrorMode](/windows/win32/api/errhandlingapi/nf-errhandlingapi-seterrormode) function), and show the error dialog box. By default, SEM_FAILCRITICALERRORS suppresses the error dialog box. It may have been inherited from another process, and the silent error may be undesirable in your scenario.| - -## Remarks - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** Metahost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v40plus](../../../../includes/net-current-v40plus-md.md)] +Provides binding policies that are common to most runtime hosts. This enumeration is used by the [ICLRMetaHostPolicy::GetRequestedRuntime](iclrmetahostpolicy-getrequestedruntime-method.md) method. + +## Syntax + +```cpp +typedef enum { + METAHOST_POLICY_HIGHCOMPAT = 0x00, + METAHOST_POLICY_APPLY_UPGRADE_POLICY = 0x08, + METAHOST_POLICY_EMULATE_EXE_LAUNCH = 0x10, + METAHOST_POLICY_SHOW_ERROR_DIALOG = 0x20, + METAHOST_POLICY_USE_PROCESS_IMAGE_PATH = 0x40, + METAHOST_POLICY_ENSURE_SKU_SUPPORTED = 0x80, + METAHOST_POLICY_IGNORE_ERROR_MODE = 0x1000 + +} METAHOST_POLICY_FLAGS; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`METAHOST_POLICY_HIGHCOMPAT`|Defines the high-compatibility policy, which does not consider any common language runtime (CLR) that is loaded into the current process. Instead, it considers only the installed CLRs and the preferences of the component, as derived from the assembly file itself, the declared built-against version, or the configuration file.| +|`METAHOST_POLICY_APPLY_UPGRADE_POLICY`|Applies upgrade policy to the version bind result when an exact match is not found, based on the contents of HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\\.NETFramework\Policy\Upgrades. This has the same effect as [RUNTIME_INFO_UPGRADE_VERSION](runtime-info-flags-enumeration.md).| +|`METAHOST_POLICY_EMULATE_EXE_LAUNCH`|Binding results are returned as if the image provided to the call were launched in a new process. Currently, `GetRequestedRuntime` ignores the set of loadable runtimes and binds against the set of installed runtimes. This flag allows a host to determine which runtime an EXE will bind to when it is launched.| +|`METAHOST_POLICY_SHOW_ERROR_DIALOG`|An error dialog box is displayed if `GetRequestedRuntime` is unable to find a runtime that is compatible with the input parameters. Beginning with .NET Framework 4.5, this error dialog box can take the form of a Windows feature dialog box that asks whether the user would like to enable the appropriate feature.| +|`METAHOST_POLICY_USE_PROCESS_IMAGE_PATH`|`GetRequestedRuntime` uses the process image (and any corresponding configuration file) as additional input to the binding process. By default, `GetRequestedRuntime` does not fall back to the process image path (typically, the EXE that was used to launch the process) when determining the runtime to bind to.| +|`METAHOST_POLICY_ENSURE_SKU_SUPPORTED`|`GetRequestedRuntime` must check whether the appropriate SKU is installed when no information is available in the configuration file. This allows applications that do not have configuration files to fail gracefully on smaller SKUs than the default installation of the .NET Framework. By default, `GetRequestedRuntime` does not check whether the appropriate SKU is installed unless the SKU attribute is specified in the configuration file `` element.| +|`METAHOST_POLICY_IGNORE_ERROR_MODE`|`GetRequestedRuntime` should ignore SEM_FAILCRITICALERRORS (which is set by calling the [SetErrorMode](/windows/win32/api/errhandlingapi/nf-errhandlingapi-seterrormode) function), and show the error dialog box. By default, SEM_FAILCRITICALERRORS suppresses the error dialog box. It may have been inherited from another process, and the silent error may be undesirable in your scenario.| + +## Remarks + +## 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 Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/modulebindinfo-structure.md b/docs/framework/unmanaged-api/hosting/modulebindinfo-structure.md similarity index 65% rename from docs/core/unmanaged-api/hosting/modulebindinfo-structure.md rename to docs/framework/unmanaged-api/hosting/modulebindinfo-structure.md index f0262aff3f19f..2c6cc88ada98b 100644 --- a/docs/core/unmanaged-api/hosting/modulebindinfo-structure.md +++ b/docs/framework/unmanaged-api/hosting/modulebindinfo-structure.md @@ -2,55 +2,56 @@ description: "Learn more about: ModuleBindInfo Structure" title: "ModuleBindInfo Structure" ms.date: "03/30/2017" -api_name: +api_name: - "ModuleBindInfo" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "ModuleBindInfo" -helpviewer_keywords: +helpviewer_keywords: - "ModuleBindInfo structure [.NET Framework hosting]" -topic_type: +ms.assetid: 632d4adc-dbc9-4ce8-9397-abc3285c1c69 +topic_type: - "apiref" --- # ModuleBindInfo Structure -Provides detailed information about the referenced module and the assembly that contains it. - -## Syntax - -```cpp -typedef struct _ModuleBindInfo { - DWORD dwAppDomainId; - LPCWSTR lpAssemblyIdentity; - LPCWSTR lpModuleName -} ModuleBindInfo; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`dwAppDomainId`|A unique identifier for the `IStream` that is returned by a call to the [IHostAssemblyStore::ProvideModule](ihostassemblystore-providemodule-method.md) method from which the referenced module is to be loaded.| -|`lpAssemblyIdentity`|A unique identifier for the assembly that contains the referenced module.| -|`lpModuleName`|The name of the referenced module.| - -## Remarks - - `ModuleBindInfo` is passed as a parameter to `IHostAssemblyStore::ProvideModule`. The host supplies the unique identifier `dwAppDomainId` to the common language runtime (CLR). After a call to the [IHostAssemblyStore::ProvideAssembly](ihostassemblystore-provideassembly-method.md) method returns, the runtime uses the identifier to determine whether the contents of the `IStream` have been mapped. If so, the runtime loads the existing copy rather than remapping the stream. The runtime also uses this identifier as a lookup key for streams that are returned from calls to the `IHostAssemblyStore::ProvideAssembly` method. Therefore, the identifier must be unique for module requests as well as for assembly requests. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.idl - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - +Provides detailed information about the referenced module and the assembly that contains it. + +## Syntax + +```cpp +typedef struct _ModuleBindInfo { + DWORD dwAppDomainId; + LPCWSTR lpAssemblyIdentity; + LPCWSTR lpModuleName +} ModuleBindInfo; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`dwAppDomainId`|A unique identifier for the `IStream` that is returned by a call to the [IHostAssemblyStore::ProvideModule](ihostassemblystore-providemodule-method.md) method from which the referenced module is to be loaded.| +|`lpAssemblyIdentity`|A unique identifier for the assembly that contains the referenced module.| +|`lpModuleName`|The name of the referenced module.| + +## Remarks + + `ModuleBindInfo` is passed as a parameter to `IHostAssemblyStore::ProvideModule`. The host supplies the unique identifier `dwAppDomainId` to the common language runtime (CLR). After a call to the [IHostAssemblyStore::ProvideAssembly](ihostassemblystore-provideassembly-method.md) method returns, the runtime uses the identifier to determine whether the contents of the `IStream` have been mapped. If so, the runtime loads the existing copy rather than remapping the stream. The runtime also uses this identifier as a lookup key for streams that are returned from calls to the `IHostAssemblyStore::ProvideAssembly` method. Therefore, the identifier must be unique for module requests as well as for assembly requests. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.idl + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [Hosting Structures](hosting-structures.md) diff --git a/docs/core/unmanaged-api/hosting/net-framework-4-hosting-global-static-functions.md b/docs/framework/unmanaged-api/hosting/net-framework-4-hosting-global-static-functions.md similarity index 70% rename from docs/core/unmanaged-api/hosting/net-framework-4-hosting-global-static-functions.md rename to docs/framework/unmanaged-api/hosting/net-framework-4-hosting-global-static-functions.md index 7a4f2b9c4fb66..1608cf357d7cb 100644 --- a/docs/core/unmanaged-api/hosting/net-framework-4-hosting-global-static-functions.md +++ b/docs/framework/unmanaged-api/hosting/net-framework-4-hosting-global-static-functions.md @@ -2,20 +2,21 @@ description: "Learn more about: .NET Framework 4 Hosting Global Static Functions" title: ".NET Framework 4 Hosting Global Static Functions" ms.date: "03/30/2017" -helpviewer_keywords: +helpviewer_keywords: - "hosting global static functions [.NET Framework], version 4" - "global static functions [.NET Framework hosting], version 4" - ".NET Framework 4, hosting global static functions" +ms.assetid: 07a1a6e1-db73-4555-81df-bc4054c51492 --- # .NET Framework 4 Hosting Global Static Functions -The .NET Framework 4 introduces one new exported method in MSCorEE.dll: [CLRCreateInstance](clrcreateinstance-function.md). - -## In This Section - - [CLRCreateInstance Function](clrcreateinstance-function.md) - Provides one of three interfaces: [ICLRMetaHost](iclrmetahost-interface.md), [ICLRMetaHostPolicy](iclrmetahostpolicy-interface.md), or [ICLRDebugging](../../../framework/unmanaged-api/debugging/iclrdebugging-interface.md). +The .NET Framework 4 introduces one new exported method in MSCorEE.dll: [CLRCreateInstance](clrcreateinstance-function.md). + +## In This Section + [CLRCreateInstance Function](clrcreateinstance-function.md) + Provides one of three interfaces: [ICLRMetaHost](iclrmetahost-interface.md), [ICLRMetaHostPolicy](iclrmetahostpolicy-interface.md), or [ICLRDebugging](../debugging/iclrdebugging-interface.md). + ## See also - [Hosting Global Static Functions](hosting-global-static-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/rundll32shimw-function.md b/docs/framework/unmanaged-api/hosting/rundll32shimw-function.md new file mode 100644 index 0000000000000..fa08812e21e11 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/rundll32shimw-function.md @@ -0,0 +1,62 @@ +--- +description: "Learn more about: RunDll32ShimW Function" +title: "RunDll32ShimW Function" +ms.date: "03/30/2017" +api_name: + - "RunDll32ShimW" +api_location: + - "mscoree.dll" +api_type: + - "DLLExport" +f1_keywords: + - "RunDll32ShimW" +helpviewer_keywords: + - "RunDll32ShimW function [.NET Framework hosting]" +ms.assetid: 9ea07b57-96e2-44df-8711-8fe6c119087f +topic_type: + - "apiref" +--- +# RunDll32ShimW Function + +Executes the specified command. + + This function has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +HRESULT RunDll32ShimW ( + [in] HWND hwnd, + [in] HINSTANCE hinst, + [in] LPCWSTR lpszCmdLine, + [in] int nCmdShow +); +``` + +## Parameters + + `hwnd` + [in] A handle to a window in which the command output will be displayed. + + `hinst` + [in] A handle to the library that contains the command. + + `lpszCmdLine` + [in] A string that specifies the command to be executed. + + `nCmdShow` + [in] An integer that specifies the display mode for the output window. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + +## See also + +- [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/runtime-info-flags-enumeration.md b/docs/framework/unmanaged-api/hosting/runtime-info-flags-enumeration.md new file mode 100644 index 0000000000000..94c9d1d4ca99a --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/runtime-info-flags-enumeration.md @@ -0,0 +1,75 @@ +--- +description: "Learn more about: RUNTIME_INFO_FLAGS Enumeration" +title: "RUNTIME_INFO_FLAGS Enumeration" +ms.date: "03/30/2017" +api_name: + - "RUNTIME_INFO_FLAGS" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "RUNTIME_INFO_FLAGS" +helpviewer_keywords: + - "RUNTIME_INFO_FLAGS enumeration [.NET Framework hosting]" +ms.assetid: adba37be-f775-4cdb-8919-5746ce694f33 +topic_type: + - "apiref" +--- +# RUNTIME_INFO_FLAGS Enumeration + +Contains values that indicate what information about the common language runtime (CLR) should be returned. + +## Syntax + +```cpp +typedef enum { + + RUNTIME_INFO_UPGRADE_VERSION = 0x01, + RUNTIME_INFO_REQUEST_IA64 = 0x02, + RUNTIME_INFO_REQUEST_AMD64 = 0x04, + RUNTIME_INFO_REQUEST_X86 = 0x08, + RUNTIME_INFO_DONT_RETURN_DIRECTORY = 0x10, + RUNTIME_INFO_DONT_RETURN_VERSION = 0x20, + RUNTIME_INFO_DONT_SHOW_ERROR_DIALOG = 0x40, + RUNTIME_INFO_IGNORE_ERROR_MODE = 0x1000 + +} RUNTIME_INFO_FLAGS; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`RUNTIME_INFO_DONT_RETURN_DIRECTORY`|Indicates that directory information should not be included.| +|`RUNTIME_INFO_DONT_RETURN_VERSION`|Indicates that version information should not be included.| +|`RUNTIME_INFO_DONT_SHOW_ERROR_DIALOG`|Indicates that an error dialog box should not be shown upon failure.| +|`RUNTIME_INFO_IGNORE_ERROR_MODE`|Indicates that the effects of calling the [SetErrorMode](/windows/win32/api/errhandlingapi/nf-errhandlingapi-seterrormode) function with the SEM_FAILCRITICALERRORS flag should be overridden. That is, an installation dialog box should be shown upon failure, instead of being suppressed.| +|`RUNTIME_INFO_REQUEST_AMD64`|Indicates a request for information about an AMD-64-compatible version of the runtime.| +|`RUNTIME_INFO_REQUEST_IA64`|Indicates a request for information about an IA-64-compatible version of the runtime.| +|`RUNTIME_INFO_REQUEST_X86`|Indicates a request for information about an x86-compatible version of the runtime.| +|`RUNTIME_INFO_UPGRADE_VERSION`|Indicates that version upgrade information should be included.| + +## Remarks + + The following platform architecture flags can be specified only one at a time and cannot be combined: + +- RUNTIME_INFO_REQUEST_IA64 + +- RUNTIME_INFO_REQUEST_AMD64 + +- RUNTIME_INFO_REQUEST_X86 + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + +## See also + +- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md b/docs/framework/unmanaged-api/hosting/stackoverflowinfo-structure.md similarity index 53% rename from docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md rename to docs/framework/unmanaged-api/hosting/stackoverflowinfo-structure.md index 06100f28379b7..8f6354cd49fef 100644 --- a/docs/core/unmanaged-api/hosting/stackoverflowinfo-structure.md +++ b/docs/framework/unmanaged-api/hosting/stackoverflowinfo-structure.md @@ -2,53 +2,54 @@ description: "Learn more about: StackOverflowInfo Structure" title: "StackOverflowInfo Structure" ms.date: "03/30/2017" -api_name: +api_name: - "StackOverflowInfo" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "StackOverflowInfo" -helpviewer_keywords: +helpviewer_keywords: - "StackOverflowInfo structure [.NET Framework hosting]" -topic_type: +ms.assetid: 519389f2-0217-436c-99d4-93a76ebce5b5 +topic_type: - "apiref" --- # StackOverflowInfo Structure -Stores the type of overflow that occurred and information on the exception that was thrown due to the overflow. - -## Syntax - -```cpp -typedef struct _StackOverflowInfo { - StackOverflowType soType; - EXCEPTION_POINTERS *pExceptionInfo; -} StackOverflowInfo; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`soType`|A value of the [StackOverflowType](stackoverflowtype-enumeration.md) enumeration that specifies the type of overflow.| -|`pExceptionInfo`|A pointer to a Win32 `EXCEPTION_POINTERS` object, which contains an exception record with a machine-independent description of an exception and a context record with a machine-dependent description of the processor context at the time of the exception.| - -## Remarks - - A `StackOverflowInfo` object is passed to the [IActionOnCLREvent::OnEvent](iactiononclrevent-onevent-method.md) method for `Event_StackOverflow` events. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.idl - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - +Stores the type of overflow that occurred and information on the exception that was thrown due to the overflow. + +## Syntax + +```cpp +typedef struct _StackOverflowInfo { + StackOverflowType soType; + EXCEPTION_POINTERS *pExceptionInfo; +} StackOverflowInfo; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`soType`|A value of the [StackOverflowType](stackoverflowtype-enumeration.md) enumeration that specifies the type of overflow.| +|`pExceptionInfo`|A pointer to a Win32 `EXCEPTION_POINTERS` object, which contains an exception record with a machine-independent description of an exception and a context record with a machine-dependent description of the processor context at the time of the exception.| + +## Remarks + + A `StackOverflowInfo` object is passed to the [IActionOnCLREvent::OnEvent](iactiononclrevent-onevent-method.md) method for `Event_StackOverflow` events. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.idl + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [Hosting Structures](hosting-structures.md) diff --git a/docs/framework/unmanaged-api/hosting/stackoverflowtype-enumeration.md b/docs/framework/unmanaged-api/hosting/stackoverflowtype-enumeration.md new file mode 100644 index 0000000000000..8fe74531b6fe1 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/stackoverflowtype-enumeration.md @@ -0,0 +1,57 @@ +--- +description: "Learn more about: StackOverflowType Enumeration" +title: "StackOverflowType Enumeration" +ms.date: "03/30/2017" +api_name: + - "StackOverflowType" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "StackOverflowType" +helpviewer_keywords: + - "StackOverflowType enumeration [.NET Framework hosting]" +ms.assetid: dab648ad-972b-479c-b129-b4c1dcbd932e +topic_type: + - "apiref" +--- +# StackOverflowType Enumeration + +Contains values that indicate the underlying cause of a stack overflow event. + +## Syntax + +```cpp +typedef enum { + SO_Managed, + SO_ClrEngine, + SO_Other +} StackOverflowType; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`SO_ClrEngine`|The stack overflow was caused by the execution engine.| +|`SO_Managed`|The stack overflow was caused by managed code.| +|`SO_Other`|The stack overflow was caused by unmanaged code.| + +## Remarks + + This information is passed to the host through a call to the [IActionOnCLREvent::OnEvent](iactiononclrevent-onevent-method.md) method. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + +## See also + +- [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/startup-flags-enumeration.md b/docs/framework/unmanaged-api/hosting/startup-flags-enumeration.md similarity index 54% rename from docs/core/unmanaged-api/hosting/startup-flags-enumeration.md rename to docs/framework/unmanaged-api/hosting/startup-flags-enumeration.md index aeb9e9feea13f..5356440fe38f3 100644 --- a/docs/core/unmanaged-api/hosting/startup-flags-enumeration.md +++ b/docs/framework/unmanaged-api/hosting/startup-flags-enumeration.md @@ -2,81 +2,82 @@ description: "Learn more about: STARTUP_FLAGS Enumeration" title: "STARTUP_FLAGS Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "STARTUP_FLAGS" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "STARTUP_FLAGS" -helpviewer_keywords: +helpviewer_keywords: - "STARTUP_FLAGS enumeration [.NET Framework hosting]" -topic_type: +ms.assetid: 4f043594-0c45-4bc6-988e-a6793f0d8d06 +topic_type: - "apiref" --- # STARTUP_FLAGS Enumeration -Contains values that indicate the startup behavior of the common language runtime (CLR). By default, garbage collection is non-concurrent, and only the base class library is loaded into the domain-neutral area. - -## Syntax - -```cpp -typedef enum { - STARTUP_CONCURRENT_GC = 0x1, - STARTUP_LOADER_OPTIMIZATION_MASK = 0x3<<1, - STARTUP_LOADER_OPTIMIZATION_SINGLE_DOMAIN = 0x1<<1, - STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN = 0x2<<1, - STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN_HOST = 0x3<<1, - - STARTUP_LOADER_SAFEMODE = 0x10, - STARTUP_LOADER_SETPREFERENCE = 0x100, - - STARTUP_SERVER_GC = 0x1000, - STARTUP_HOARD_GC_VM = 0x2000, - - STARTUP_SINGLE_VERSION_HOSTING_INTERFACE = 0x4000, - STARTUP_LEGACY_IMPERSONATION = 0x10000, - STARTUP_DISABLE_COMMITTHREADSTACK = 0x20000, - STARTUP_ALWAYSFLOW_IMPERSONATION = 0x40000, - STARTUP_TRIM_GC_COMMIT = 0x80000, - - STARTUP_ETW = 0x100000, - STARTUP_ARM = 0x400000 -} STARTUP_FLAGS; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`STARTUP_CONCURRENT_GC`|Specifies that concurrent garbage collection should be used. If the caller asks for the server build and concurrent garbage collection on a single-processor machine, the workstation build and non-concurrent garbage collection are run instead. **Note:** Concurrent garbage collection is not supported in applications that are running the WOW64 x86 emulator on 64-bit systems that implement the Intel Itanium architecture (formerly called IA-64). For more information about using WOW64 on 64-bit Windows systems, see [Running 32-bit Applications](/windows/desktop/WinProg64/running-32-bit-applications).| -|`STARTUP_LOADER_OPTIMIZATION_MASK`|Specifies that loader optimization shall occur.| -|`STARTUP_LOADER_OPTIMIZATION_SINGLE_DOMAIN`|Specifies that no assemblies are loaded as domain-neutral.| -|`STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN`|Specifies that all assemblies are loaded as domain-neutral.| -|`STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN_HOST`|Specifies that all strong-named assemblies are loaded as domain-neutral.| -|`STARTUP_LOADER_SAFEMODE`|Specifies that CLR version policy will not be applied to the version passed in. The exact version specified of the CLR will be loaded. The shim does not evaluate policy to determine the latest compatible version.| -|`STARTUP_LOADER_SETPREFERENCE`|Specifies that the preferred runtime will be set, but not actually started.| -|`STARTUP_SERVER_GC`|Specifies that the server garbage collection will be used.| -|`STARTUP_HOARD_GC_VM`|Specifies that garbage collection will keep the virtual address used.| -|`STARTUP_SINGLE_VERSION_HOSTING_INTERFACE`|Specifies that mixing a hosting interface will not be allowed.| -|`STARTUP_LEGACY_IMPERSONATION`|Specifies that impersonation should not flow across asynchronous points by default.| -|`STARTUP_DISABLE_COMMITTHREADSTACK`|Specifies that the full thread stack should not be committed when the thread starts running.| -|`STARTUP_ALWAYSFLOW_IMPERSONATION`|Specifies that managed impersonations and impersonations achieved through platform invoke will flow across asynchronous points. By default, only managed impersonations will flow across asynchronous points.| -|`STARTUP_TRIM_GC_COMMIT`|Specifies that garbage collection will use less committed space when system memory is low. See `gcTrimCommitOnLowMemory` in [Optimization for Shared Web Hosting](../../../standard/garbage-collection/optimization-for-shared-web-hosting.md).| -|`STARTUP_ETW`|Specifies that event tracing for Windows (ETW) is enabled for common language runtime events. Beginning with Windows Vista, event tracing is always enabled, so this flag has no effect. See [Controlling .NET Framework Logging](../../../framework/performance/controlling-logging.md).| -|`STARTUP_ARM`|Specifies that application domain resource monitoring is enabled. See the property and [\ Element](../../../framework/configure-apps/file-schema/runtime/appdomainresourcemonitoring-element.md).| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - +Contains values that indicate the startup behavior of the common language runtime (CLR). By default, garbage collection is non-concurrent, and only the base class library is loaded into the domain-neutral area. + +## Syntax + +```cpp +typedef enum { + STARTUP_CONCURRENT_GC = 0x1, + STARTUP_LOADER_OPTIMIZATION_MASK = 0x3<<1, + STARTUP_LOADER_OPTIMIZATION_SINGLE_DOMAIN = 0x1<<1, + STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN = 0x2<<1, + STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN_HOST = 0x3<<1, + + STARTUP_LOADER_SAFEMODE = 0x10, + STARTUP_LOADER_SETPREFERENCE = 0x100, + + STARTUP_SERVER_GC = 0x1000, + STARTUP_HOARD_GC_VM = 0x2000, + + STARTUP_SINGLE_VERSION_HOSTING_INTERFACE = 0x4000, + STARTUP_LEGACY_IMPERSONATION = 0x10000, + STARTUP_DISABLE_COMMITTHREADSTACK = 0x20000, + STARTUP_ALWAYSFLOW_IMPERSONATION = 0x40000, + STARTUP_TRIM_GC_COMMIT = 0x80000, + + STARTUP_ETW = 0x100000, + STARTUP_ARM = 0x400000 +} STARTUP_FLAGS; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`STARTUP_CONCURRENT_GC`|Specifies that concurrent garbage collection should be used. If the caller asks for the server build and concurrent garbage collection on a single-processor machine, the workstation build and non-concurrent garbage collection are run instead. **Note:** Concurrent garbage collection is not supported in applications that are running the WOW64 x86 emulator on 64-bit systems that implement the Intel Itanium architecture (formerly called IA-64). For more information about using WOW64 on 64-bit Windows systems, see [Running 32-bit Applications](/windows/desktop/WinProg64/running-32-bit-applications).| +|`STARTUP_LOADER_OPTIMIZATION_MASK`|Specifies that loader optimization shall occur.| +|`STARTUP_LOADER_OPTIMIZATION_SINGLE_DOMAIN`|Specifies that no assemblies are loaded as domain-neutral.| +|`STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN`|Specifies that all assemblies are loaded as domain-neutral.| +|`STARTUP_LOADER_OPTIMIZATION_MULTI_DOMAIN_HOST`|Specifies that all strong-named assemblies are loaded as domain-neutral.| +|`STARTUP_LOADER_SAFEMODE`|Specifies that CLR version policy will not be applied to the version passed in. The exact version specified of the CLR will be loaded. The shim does not evaluate policy to determine the latest compatible version.| +|`STARTUP_LOADER_SETPREFERENCE`|Specifies that the preferred runtime will be set, but not actually started.| +|`STARTUP_SERVER_GC`|Specifies that the server garbage collection will be used.| +|`STARTUP_HOARD_GC_VM`|Specifies that garbage collection will keep the virtual address used.| +|`STARTUP_SINGLE_VERSION_HOSTING_INTERFACE`|Specifies that mixing a hosting interface will not be allowed.| +|`STARTUP_LEGACY_IMPERSONATION`|Specifies that impersonation should not flow across asynchronous points by default.| +|`STARTUP_DISABLE_COMMITTHREADSTACK`|Specifies that the full thread stack should not be committed when the thread starts running.| +|`STARTUP_ALWAYSFLOW_IMPERSONATION`|Specifies that managed impersonations and impersonations achieved through platform invoke will flow across asynchronous points. By default, only managed impersonations will flow across asynchronous points.| +|`STARTUP_TRIM_GC_COMMIT`|Specifies that garbage collection will use less committed space when system memory is low. See `gcTrimCommitOnLowMemory` in [Optimization for Shared Web Hosting](../../../standard/garbage-collection/optimization-for-shared-web-hosting.md).| +|`STARTUP_ETW`|Specifies that event tracing for Windows (ETW) is enabled for common language runtime events. Beginning with Windows Vista, event tracing is always enabled, so this flag has no effect. See [Controlling .NET Framework Logging](../../performance/controlling-logging.md).| +|`STARTUP_ARM`|Specifies that application domain resource monitoring is enabled. See the property and [\ Element](../../configure-apps/file-schema/runtime/appdomainresourcemonitoring-element.md).| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md b/docs/framework/unmanaged-api/hosting/strongnamegetpublickeyex-method.md similarity index 51% rename from docs/core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md rename to docs/framework/unmanaged-api/hosting/strongnamegetpublickeyex-method.md index d5d4bdd2b94e1..190ef0cd5c6f7 100644 --- a/docs/core/unmanaged-api/hosting/strongnamegetpublickeyex-method.md +++ b/docs/framework/unmanaged-api/hosting/strongnamegetpublickeyex-method.md @@ -2,96 +2,97 @@ description: "Learn more about: StrongNameGetPublicKeyEx Method" title: "StrongNameGetPublicKeyEx Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName2.StrongNameGetPublicKeyEx" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "StrongNameGetPublicKeyEx" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameGetPublicKeyEx method, ICLRStrongName2 interface [.NET Framework hosting]" - "ICLRStrongName2::StrongNameGetPublicKeyEx method [.NET Framework hosting]" -topic_type: +ms.assetid: 63d8260c-fb32-4f8f-a357-768afd570f68 +topic_type: - "apiref" --- # StrongNameGetPublicKeyEx Method -Gets the public key from a public/private key pair, and specifies a hash algorithm and a signature algorithm. - -## Syntax - -```cpp +Gets the public key from a public/private key pair, and specifies a hash algorithm and a signature algorithm. + +## Syntax + +```cpp HRESULT StrongNameGetPublicKey ( - [in] LPCWSTR pwzKeyContainer, - [in] BYTE *pbKeyBlob, - [in] ULONG cbKeyBlob, - [out] BYTE **ppbPublicKeyBlob, - [out] ULONG *pcbPublicKeyBlob - [in] ULONG uHashAlgId, - [in] ULONG uReserved, -); -``` - -## Parameters - - `pwzKeyContainer` - [in] The name of the key container that contains the public/private key pair. If `pbKeyBlob` is null, `szKeyContainer` must specify a valid container within the cryptographic service provider (CSP). In this case, the `StrongNameGetPublicKeyEx` method extracts the public key from the key pair stored in the container. - - If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). - - The keys must be 1024-bit Rivest-Shamir-Adleman (RSA) signing keys. No other types of keys are supported at this time. - - `pbKeyBlob` - [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `szKeyContainer` is assumed to contain the key pair. - - `cbKeyBlob` - [in] The size, in bytes, of `pbKeyBlob`. - - `ppbPublicKeyBlob` - [out] The returned public key BLOB. The `ppbPublicKeyBlob` parameter is allocated by the common language runtime and returned to the caller. The caller must free the memory by using the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method. - - `pcbPublicKeyBlob` - [out] The size of the returned public key BLOB. - - `uHashAlgId` - [in] The assembly hash algorithm. See the Remarks section for a list of accepted values. - - `uReserved` - [in] Reserved for future use; defaults to null. - -## Return Value - - `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Remarks - - The public key is contained in a [PublicKeyBlob]((../../../framework/unmanaged-api/strong-naming/publickeyblob-structure.md) structure. - - The following table shows the set of accepted values for the `uHashAlgId` parameter. - -|Name|Value| -|----------|-----------| -|None|0| -|SHA-1|0x8004| -|SHA-256|0x800c| -|SHA-384|0x800d| -|SHA-512|0x800e| - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] - + [in] LPCWSTR pwzKeyContainer, + [in] BYTE *pbKeyBlob, + [in] ULONG cbKeyBlob, + [out] BYTE **ppbPublicKeyBlob, + [out] ULONG *pcbPublicKeyBlob + [in] ULONG uHashAlgId, + [in] ULONG uReserved, +); +``` + +## Parameters + + `pwzKeyContainer` + [in] The name of the key container that contains the public/private key pair. If `pbKeyBlob` is null, `szKeyContainer` must specify a valid container within the cryptographic service provider (CSP). In this case, the `StrongNameGetPublicKeyEx` method extracts the public key from the key pair stored in the container. + + If `pbKeyBlob` is not null, the key pair is assumed to be contained in the key binary large object (BLOB). + + The keys must be 1024-bit Rivest-Shamir-Adleman (RSA) signing keys. No other types of keys are supported at this time. + + `pbKeyBlob` + [in] A pointer to the public/private key pair. This pair is in the format created by the Win32 `CryptExportKey` function. If `pbKeyBlob` is null, the key container specified by `szKeyContainer` is assumed to contain the key pair. + + `cbKeyBlob` + [in] The size, in bytes, of `pbKeyBlob`. + + `ppbPublicKeyBlob` + [out] The returned public key BLOB. The `ppbPublicKeyBlob` parameter is allocated by the common language runtime and returned to the caller. The caller must free the memory by using the [ICLRStrongName::StrongNameFreeBuffer](iclrstrongname-strongnamefreebuffer-method.md) method. + + `pcbPublicKeyBlob` + [out] The size of the returned public key BLOB. + + `uHashAlgId` + [in] The assembly hash algorithm. See the Remarks section for a list of accepted values. + + `uReserved` + [in] Reserved for future use; defaults to null. + +## Return Value + + `S_OK` if the method completed successfully; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## Remarks + + The public key is contained in a [PublicKeyBlob](../strong-naming/publickeyblob-structure.md) structure. + + The following table shows the set of accepted values for the `uHashAlgId` parameter. + +|Name|Value| +|----------|-----------| +|None|0| +|SHA-1|0x8004| +|SHA-256|0x800c| +|SHA-384|0x800d| +|SHA-512|0x800e| + +## 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_v45plus](../../../../includes/net-current-v45plus-md.md)] + ## See also - [StrongNameTokenFromPublicKey Method](iclrstrongname-strongnametokenfrompublickey-method.md) -- [PublicKeyBlob Structure]((../../../framework/unmanaged-api/strong-naming/publickeyblob-structure.md) +- [PublicKeyBlob Structure](../strong-naming/publickeyblob-structure.md) - [ICLRStrongName Interface](iclrstrongname-interface.md) - [StrongNameGetPublicKey Method](iclrstrongname-strongnamegetpublickey-method.md) diff --git a/docs/core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md b/docs/framework/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md similarity index 55% rename from docs/core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md rename to docs/framework/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md index 18388ed0ec933..7fdb82eccd975 100644 --- a/docs/core/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md +++ b/docs/framework/unmanaged-api/hosting/strongnamesignatureverificationex2-method.md @@ -2,66 +2,67 @@ description: "Learn more about: StrongNameSignatureVerificationEx2 Method" title: "StrongNameSignatureVerificationEx2 Method" ms.date: "03/30/2017" -api_name: +api_name: - "ICLRStrongName2.StrongNameSignatureVerificationEx2" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "StrongNameSignatureVerificationEx2" -helpviewer_keywords: +helpviewer_keywords: - "StrongNameSignatureVerificationEx2 method, ICLRStrongName2 interface [.NET Framework hosting]" - "ICLRStrongName2::StrongNameSignatureVerificationEx2 method [.NET Framework hosting]" -topic_type: +ms.assetid: dfd4133f-a074-4db3-a7ee-4f250fe9ad3a +topic_type: - "apiref" --- # StrongNameSignatureVerificationEx2 Method -Verifies the signature of a strongly named assembly, and provides a mapping from the ECMA key to a real key. - -## Syntax - -```cpp -HRESULT StrongNameSignatureVerificationEx ( - [in] LPCWSTR wszFilePath, - [in] BOOLEAN fForceVerification, [in] BYTE *pbEcmaPublicKey, - [in] DWORD cbEcmaPublicKey, - [out] BOOLEAN *pfWasVerified -); -``` - -## Parameters - - `wszFilePath` - [in] The path to the portable executable (.exe or .dll) file for the assembly to be verified. - - `fForceVerification` - [in] `true` to perform verification, even if it is necessary to override registry settings; otherwise, `false`. - - `pbEcmaPublicKey` - [in] A pointer to the mapping from the ECMA public key to the real key used for verification. - - `cbEcmaPublicKey` - [in] The length of the real ECMA public key. - - `pfWasVerified` - [out] `true` if the strong name signature was verified; otherwise, `false`. This parameter is also set to `false` if the verification was successful due to registry settings. - -## Return Value - - `S_OK` if the verification was successful; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MetaHost.h - - **Library:** Included as a resource in MSCorEE.dll - - **.NET versions:** [!INCLUDE[net_current_v45plus](../../../../includes/net-current-v45plus-md.md)] - +Verifies the signature of a strongly named assembly, and provides a mapping from the ECMA key to a real key. + +## Syntax + +```cpp +HRESULT StrongNameSignatureVerificationEx ( + [in] LPCWSTR wszFilePath, + [in] BOOLEAN fForceVerification, [in] BYTE *pbEcmaPublicKey, + [in] DWORD cbEcmaPublicKey, + [out] BOOLEAN *pfWasVerified +); +``` + +## Parameters + + `wszFilePath` + [in] The path to the portable executable (.exe or .dll) file for the assembly to be verified. + + `fForceVerification` + [in] `true` to perform verification, even if it is necessary to override registry settings; otherwise, `false`. + + `pbEcmaPublicKey` + [in] A pointer to the mapping from the ECMA public key to the real key used for verification. + + `cbEcmaPublicKey` + [in] The length of the real ECMA public key. + + `pfWasVerified` + [out] `true` if the strong name signature was verified; otherwise, `false`. This parameter is also set to `false` if the verification was successful due to registry settings. + +## Return Value + + `S_OK` if the verification was successful; otherwise, an HRESULT value that indicates failure (see [Common HRESULT Values](/windows/win32/seccrypto/common-hresult-values) for a list). + +## 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_v45plus](../../../../includes/net-current-v45plus-md.md)] + ## See also - [StrongNameSignatureVerification Method](iclrstrongname-strongnamesignatureverification-method.md) diff --git a/docs/framework/unmanaged-api/hosting/toc.yml b/docs/framework/unmanaged-api/hosting/toc.yml new file mode 100644 index 0000000000000..e9f6cb68585b2 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/toc.yml @@ -0,0 +1,1000 @@ +items: +- name: Hosting + href: index.md +- name: Hosting Coclasses + href: hosting-coclasses.md + items: + - name: CLRRuntimeHost Coclass + href: clrruntimehost-coclass.md + - name: ComCallUnmarshal Coclass + href: comcallunmarshal-coclass.md + - name: CorRuntimeHost Coclass + href: corruntimehost-coclass.md + - name: TypeNameFactory Coclass + href: typenamefactory-coclass.md +- name: Hosting Enumerations + href: hosting-enumerations.md + items: + - name: CLSID_RESOLUTION_FLAGS Enumeration + href: clsid-resolution-flags-enumeration.md + - name: COR_GC_STAT_TYPES Enumeration + href: cor-gc-stat-types-enumeration.md + - name: COR_GC_THREAD_STATS_TYPES Enumeration + href: cor-gc-thread-stats-types-enumeration.md + - name: EApiCategories Enumeration + href: eapicategories-enumeration.md + - name: EBindPolicyLevels Enumeration + href: ebindpolicylevels-enumeration.md + - name: ECLRAssemblyIdentityFlags Enumeration + href: eclrassemblyidentityflags-enumeration.md + - name: EClrEvent Enumeration + href: eclrevent-enumeration.md + - name: EClrFailure Enumeration + href: eclrfailure-enumeration.md + - name: EClrOperation Enumeration + href: eclroperation-enumeration.md + - name: EClrUnhandledException Enumeration + href: eclrunhandledexception-enumeration.md + - name: EContextType Enumeration + href: econtexttype-enumeration.md + - name: ECustomDumpFlavor Enumeration + href: ecustomdumpflavor-enumeration.md + - name: ECustomDumpItemKind Enumeration + href: ecustomdumpitemkind-enumeration.md + - name: EHostApplicationPolicy Enumeration + href: ehostapplicationpolicy-enumeration.md + - name: EHostBindingPolicyModifyFlags Enumeration + href: ehostbindingpolicymodifyflags-enumeration.md + - name: EInitializeNewDomainFlags Enumeration + href: einitializenewdomainflags-enumeration.md + - name: EMemoryAvailable Enumeration + href: ememoryavailable-enumeration.md + - name: EMemoryCriticalLevel Enumeration + href: ememorycriticallevel-enumeration.md + - name: EPolicyAction Enumeration + href: epolicyaction-enumeration.md + - name: ESymbolReadingPolicy Enumeration + href: esymbolreadingpolicy-enumeration.md + - name: ETaskType Enumeration + href: etasktype-enumeration.md + - name: HOST_TYPE Enumeration + href: host-type-enumeration.md + - name: MALLOC_TYPE Enumeration + href: malloc-type-enumeration.md + - name: METAHOST_CONFIG_FLAGS Enumeration + href: metahost-config-flags-enumeration.md + - name: METAHOST_POLICY_FLAGS Enumeration + href: metahost-policy-flags-enumeration.md + - name: RUNTIME_INFO_FLAGS Enumeration + href: runtime-info-flags-enumeration.md + - name: StackOverflowType Enumeration + href: stackoverflowtype-enumeration.md + - name: STARTUP_FLAGS Enumeration + href: startup-flags-enumeration.md + - name: ValidatorFlags Enumeration + href: validatorflags-enumeration.md + - name: WAIT_OPTION Enumeration + href: wait-option-enumeration.md +- name: Hosting Global Static Functions + href: hosting-global-static-functions.md + items: + - name: .NET Framework 4 Hosting Global Static Functions + href: net-framework-4-hosting-global-static-functions.md + items: + - name: CLRCreateInstance Function + href: clrcreateinstance-function.md + - name: Deprecated CLR Hosting Functions + href: deprecated-clr-hosting-functions.md + items: + - name: _CorDllMain Function + href: cordllmain-function.md + - name: _CorExeMain Function + href: corexemain-function.md + - name: _CorExeMain2 Function + href: corexemain2-function.md + - name: _CorImageUnloading Function + href: corimageunloading-function.md + - name: _CorValidateImage Function + href: corvalidateimage-function.md + - name: CallFunctionShim Function + href: callfunctionshim-function.md + - name: ClrCreateManagedInstance Function + href: clrcreatemanagedinstance-function.md + - name: CoEEShutDownCOM Function + href: coeeshutdowncom-function.md + - name: CoInitializeCor Function + href: coinitializecor-function.md + - name: CoInitializeEE Function + href: coinitializeee-function.md + - name: CorBindToCurrentRuntime Function + href: corbindtocurrentruntime-function.md + - name: CorBindToRuntime Function + href: corbindtoruntime-function.md + - name: CorBindToRuntimeByCfg Function + href: corbindtoruntimebycfg-function.md + - name: CorBindToRuntimeEx Function + href: corbindtoruntimeex-function.md + - name: CorBindToRuntimeHost Function + href: corbindtoruntimehost-function.md + - name: CorExitProcess Function + href: corexitprocess-function.md + - name: CorLaunchApplication Function + href: corlaunchapplication-function.md + - name: CorMarkThreadInThreadPool Function + href: cormarkthreadinthreadpool-function.md + - name: CoUninitializeCor Function + href: couninitializecor-function.md + - name: CoUninitializeEE Function + href: couninitializeee-function.md + - name: CreateDebuggingInterfaceFromVersion Function + href: createdebugginginterfacefromversion-function.md + - name: CreateICeeFileGen Function + href: createiceefilegen-function.md + - name: DestroyICeeFileGen Function + href: destroyiceefilegen-function.md + - name: FExecuteInAppDomainCallback Function Pointer + href: fexecuteinappdomaincallback-function-pointer.md + - name: FLockClrVersionCallback Function Pointer + href: flockclrversioncallback-function-pointer.md + - name: GetCLRIdentityManager Function + href: getclridentitymanager-function.md + - name: GetCORRequiredVersion Function + href: getcorrequiredversion-function.md + - name: GetCORSystemDirectory Function + href: getcorsystemdirectory-function.md + - name: GetCORVersion Function + href: getcorversion-function.md + - name: GetFileVersion Function + href: getfileversion-function.md + - name: GetRealProcAddress Function + href: getrealprocaddress-function.md + - name: GetRequestedRuntimeInfo Function + href: getrequestedruntimeinfo-function.md + - name: GetRequestedRuntimeVersion Function + href: getrequestedruntimeversion-function.md + - name: GetRequestedRuntimeVersionForCLSID Function + href: getrequestedruntimeversionforclsid-function.md + - name: GetVersionFromProcess Function + href: getversionfromprocess-function.md + - name: LoadLibraryShim Function + href: loadlibraryshim-function.md + - name: LoadStringRC Function + href: loadstringrc-function.md + - name: LoadStringRCEx Function + href: loadstringrcex-function.md + - name: LockClrVersion Function + href: lockclrversion-function.md + - name: LPOVERLAPPED_COMPLETION_ROUTINE Function Pointer + href: lpoverlapped-completion-routine-function-pointer.md + - name: LPTHREAD_START_ROUTINE Function Pointer + href: lpthread-start-routine-function-pointer.md + - name: RunDll32ShimW Function + href: rundll32shimw-function.md + - name: WAITORTIMERCALLBACK Function Pointer + href: waitortimercallback-function-pointer.md +- name: Hosting Interfaces + href: hosting-interfaces.md + items: + - name: Deprecated CLR Hosting Interfaces and Coclasses + href: deprecated-clr-hosting-interfaces-and-coclasses.md + items: + - name: IAppDomainSetup Interface + href: iappdomainsetup-interface.md + - name: ICeeFileGen Class + href: iceefilegen-class.md + - name: ICorRuntimeHost Interface + href: icorruntimehost-interface.md + items: + - name: CloseEnum Method + href: icorruntimehost-closeenum-method.md + - name: CreateDomain Method + href: icorruntimehost-createdomain-method.md + - name: CreateDomainSetup Method + href: icorruntimehost-createdomainsetup-method.md + - name: CreateDomainEx Method + href: icorruntimehost-createdomainex-method.md + - name: CreateEvidence Method + href: icorruntimehost-createevidence-method.md + - name: CreateLogicalThreadState Method + href: icorruntimehost-createlogicalthreadstate-method.md + - name: CurrentDomain Method + href: icorruntimehost-currentdomain-method.md + - name: DeleteLogicalThreadState Method + href: icorruntimehost-deletelogicalthreadstate-method.md + - name: EnumDomains Method + href: icorruntimehost-enumdomains-method.md + - name: GetConfiguration Method + href: icorruntimehost-getconfiguration-method.md + - name: GetDefaultDomain Method + href: icorruntimehost-getdefaultdomain-method.md + - name: LocksHeldByLogicalThread Method + href: icorruntimehost-locksheldbylogicalthread-method.md + - name: MapFile Method + href: icorruntimehost-mapfile-method.md + - name: NextDomain Method + href: icorruntimehost-nextdomain-method.md + - name: Start Method + href: icorruntimehost-start-method.md + - name: Stop Method + href: icorruntimehost-stop-method.md + - name: SwitchInLogicalThreadState Method + href: icorruntimehost-switchinlogicalthreadstate-method.md + - name: SwitchOutLogicalThreadState Method + href: icorruntimehost-switchoutlogicalthreadstate-method.md + - name: UnloadDomain Method + href: icorruntimehost-unloaddomain-method.md + - name: CLR Hosting Interfaces + href: clr-hosting-interfaces.md + items: + - name: IActionOnCLREvent Interface + href: iactiononclrevent-interface.md + items: + - name: OnEvent Method + href: iactiononclrevent-onevent-method.md + - name: IApartmentCallback Interface + href: iapartmentcallback-interface.md + items: + - name: DoCallback Method + href: iapartmentcallback-docallback-method.md + - name: IAppDomainBinding Interface + href: iappdomainbinding-interface.md + items: + - name: OnAppDomain Method + href: iappdomainbinding-onappdomain-method.md + - name: ICatalogServices Interface + href: icatalogservices-interface.md + items: + - name: Autodone Method + href: icatalogservices-autodone-method.md + - name: NotAutodone Method + href: icatalogservices-notautodone-method.md + - name: ICLRAssemblyIdentityManager Interface + href: iclrassemblyidentitymanager-interface.md + items: + - name: GetBindingIdentityFromFile Method + href: iclrassemblyidentitymanager-getbindingidentityfromfile-method.md + - name: GetBindingIdentityFromStream Method + href: iclrassemblyidentitymanager-getbindingidentityfromstream-method.md + - name: GetCLRAssemblyReferenceList Method + href: iclrassemblyidentitymanager-getclrassemblyreferencelist-method.md + - name: GetProbingAssembliesFromReference Method + href: iclrassemblyidentitymanager-getprobingassembliesfromreference-method.md + - name: GetReferencedAssembliesFromFile Method + href: iclrassemblyidentitymanager-getreferencedassembliesfromfile-method.md + - name: GetReferencedAssembliesFromStream Method + href: iclrassemblyidentitymanager-getreferencedassembliesfromstream-method.md + - name: IsStronglyNamed Method + href: iclrassemblyidentitymanager-isstronglynamed-method.md + - name: ICLRAssemblyReferenceList Interface + href: iclrassemblyreferencelist-interface.md + items: + - name: IsAssemblyReferenceInList Method + href: iclrassemblyreferencelist-isassemblyreferenceinlist-method.md + - name: IsStringAssemblyReferenceInList Method + href: iclrassemblyreferencelist-isstringassemblyreferenceinlist-method.md + - name: ICLRControl Interface + href: iclrcontrol-interface.md + items: + - name: GetCLRManager Method + href: iclrcontrol-getclrmanager-method.md + - name: SetAppDomainManagerType Method + href: iclrcontrol-setappdomainmanagertype-method.md + - name: ICLRDebugManager Interface + href: iclrdebugmanager-interface.md + items: + - name: BeginConnection Method + href: iclrdebugmanager-beginconnection-method.md + - name: EndConnection Method + href: iclrdebugmanager-endconnection-method.md + - name: GetDacl Method + href: iclrdebugmanager-getdacl-method.md + - name: IsDebuggerAttached Method + href: iclrdebugmanager-isdebuggerattached-method.md + - name: SetConnectionTasks Method + href: iclrdebugmanager-setconnectiontasks-method.md + - name: SetDacl Method + href: iclrdebugmanager-setdacl-method.md + - name: SetSymbolReadingPolicy Method + href: iclrdebugmanager-setsymbolreadingpolicy-method.md + - name: ICLRErrorReportingManager Interface + href: iclrerrorreportingmanager-interface.md + items: + - name: BeginCustomDump Method + href: iclrerrorreportingmanager-begincustomdump-method.md + - name: EndCustomDump Method + href: iclrerrorreportingmanager-endcustomdump-method.md + - name: GetBucketParametersForCurrentException Method + href: iclrerrorreportingmanager-getbucketparametersforcurrentexception-method.md + - name: ICLRGCManager Interface + href: iclrgcmanager-interface.md + items: + - name: Collect Method + href: iclrgcmanager-collect-method.md + - name: GetStats Method + href: iclrgcmanager-getstats-method.md + - name: SetGCStartupLimits Method + href: iclrgcmanager-setgcstartuplimits-method.md + - name: ICLRHostBindingPolicyManager Interface + href: iclrhostbindingpolicymanager-interface.md + items: + - name: EvaluatePolicy Method + href: iclrhostbindingpolicymanager-evaluatepolicy-method.md + - name: ModifyApplicationPolicy Method + href: iclrhostbindingpolicymanager-modifyapplicationpolicy-method.md + - name: ICLRHostProtectionManager Interface + href: iclrhostprotectionmanager-interface.md + items: + - name: SetEagerSerializeGrantSets + href: iclrhostprotectionmanager-seteagerserializegrantsets-method.md + - name: SetProtectedCategories Method + href: iclrhostprotectionmanager-setprotectedcategories-method.md + - name: ICLRIoCompletionManager Interface + href: iclriocompletionmanager-interface.md + items: + - name: OnComplete Method + href: iclriocompletionmanager-oncomplete-method.md + - name: ICLRMemoryNotificationCallback Interface + href: iclrmemorynotificationcallback-interface.md + items: + - name: OnMemoryNotification Method + href: iclrmemorynotificationcallback-onmemorynotification-method.md + - name: ICLROnEventManager Interface + href: iclroneventmanager-interface.md + items: + - name: RegisterActionOnEvent Method + href: iclroneventmanager-registeractiononevent-method.md + - name: UnregisterActionOnEvent Method + href: iclroneventmanager-unregisteractiononevent-method.md + - name: ICLRPolicyManager Interface + href: iclrpolicymanager-interface.md + items: + - name: SetActionOnFailure Method + href: iclrpolicymanager-setactiononfailure-method.md + - name: SetActionOnTimeout Method + href: iclrpolicymanager-setactionontimeout-method.md + - name: SetDefaultAction Method + href: iclrpolicymanager-setdefaultaction-method.md + - name: SetTimeout Method + href: iclrpolicymanager-settimeout-method.md + - name: SetTimeoutAndAction Method + href: iclrpolicymanager-settimeoutandaction-method.md + - name: SetUnhandledExceptionPolicy Method + href: iclrpolicymanager-setunhandledexceptionpolicy-method.md + - name: ICLRProbingAssemblyEnum Interface + href: iclrprobingassemblyenum-interface.md + items: + - name: Get Method + href: iclrprobingassemblyenum-get-method.md + - name: ICLRReferenceAssemblyEnum Interface + href: iclrreferenceassemblyenum-interface.md + items: + - name: Get Method + href: iclrreferenceassemblyenum-get-method.md + - name: ICLRRuntimeHost Interface + href: iclrruntimehost-interface.md + items: + - name: ExecuteApplication Method + href: iclrruntimehost-executeapplication-method.md + - name: ExecuteInAppDomain Method + href: iclrruntimehost-executeinappdomain-method.md + - name: ExecuteInDefaultAppDomain Method + href: iclrruntimehost-executeindefaultappdomain-method.md + - name: GetCLRControl Method + href: iclrruntimehost-getclrcontrol-method.md + - name: GetCurrentAppDomainId Method + href: iclrruntimehost-getcurrentappdomainid-method.md + - name: SetHostControl Method + href: iclrruntimehost-sethostcontrol-method.md + - name: Start Method + href: iclrruntimehost-start-method.md + - name: Stop Method + href: iclrruntimehost-stop-method.md + - name: UnloadAppDomain Method + href: iclrruntimehost-unloadappdomain-method.md + - name: ICLRSyncManager Interface + href: iclrsyncmanager-interface.md + items: + - name: CreateRWLockOwnerIterator Method + href: iclrsyncmanager-createrwlockowneriterator-method.md + - name: DeleteRWLockOwnerIterator Method + href: iclrsyncmanager-deleterwlockowneriterator-method.md + - name: GetMonitorOwner Method + href: iclrsyncmanager-getmonitorowner-method.md + - name: GetRWLockOwnerNext Method + href: iclrsyncmanager-getrwlockownernext-method.md + - name: ICLRTask Interface + href: iclrtask-interface.md + items: + - name: Abort Method + href: iclrtask-abort-method.md + - name: ExitTask Method + href: iclrtask-exittask-method.md + - name: GetMemStats Method + href: iclrtask-getmemstats-method.md + - name: LocksHeld Method + href: iclrtask-locksheld-method.md + - name: NeedsPriorityScheduling Method + href: iclrtask-needspriorityscheduling-method.md + - name: Reset Method + href: iclrtask-reset-method.md + - name: RudeAbort Method + href: iclrtask-rudeabort-method.md + - name: SetTaskIdentifier Method + href: iclrtask-settaskidentifier-method.md + - name: SwitchIn Method + href: iclrtask-switchin-method.md + - name: SwitchOut Method + href: iclrtask-switchout-method.md + - name: YieldTask Method + href: iclrtask-yieldtask-method.md + - name: ICLRTaskManager Interface + href: iclrtaskmanager-interface.md + items: + - name: CreateTask Method + href: iclrtaskmanager-createtask-method.md + - name: GetCurrentTask Method + href: iclrtaskmanager-getcurrenttask-method.md + - name: GetCurrentTaskType Method + href: iclrtaskmanager-getcurrenttasktype-method.md + - name: SetLocale Method + href: iclrtaskmanager-setlocale-method.md + - name: SetUILocale Method + href: iclrtaskmanager-setuilocale-method.md + - name: ICLRValidator Interface + href: iclrvalidator-interface.md + items: + - name: FormatEventInfo Method + href: iclrvalidator-formateventinfo-method.md + - name: Validate Method + href: iclrvalidator-validate-method.md + - name: ICorConfiguration Interface + href: icorconfiguration-interface.md + items: + - name: AddDebuggerSpecialThread Method + href: icorconfiguration-adddebuggerspecialthread-method.md + - name: SetDebuggerThreadControl Method + href: icorconfiguration-setdebuggerthreadcontrol-method.md + - name: SetGCHostControl Method + href: icorconfiguration-setgchostcontrol-method.md + - name: SetGCThreadControl Method + href: icorconfiguration-setgcthreadcontrol-method.md + - name: ICorThreadpool Interface + href: icorthreadpool-interface.md + items: + - name: CorBindIoCompletionCallback Method + href: icorthreadpool-corbindiocompletioncallback-method.md + - name: CorCallOrQueueUserWorkItem Method + href: icorthreadpool-corcallorqueueuserworkitem-method.md + - name: CorChangeTimer Method + href: icorthreadpool-corchangetimer-method.md + - name: CorCreateTimer Method + href: icorthreadpool-corcreatetimer-method.md + - name: CorDeleteTimer Method + href: icorthreadpool-cordeletetimer-method.md + - name: CorGetAvailableThreads Method + href: icorthreadpool-corgetavailablethreads-method.md + - name: CorGetMaxThreads Method + href: icorthreadpool-corgetmaxthreads-method.md + - name: CorQueueUserWorkItem Method + href: icorthreadpool-corqueueuserworkitem-method.md + - name: CorRegisterWaitForSingleObject Method + href: icorthreadpool-corregisterwaitforsingleobject-method.md + - name: CorSetMaxThreads Method + href: icorthreadpool-corsetmaxthreads-method.md + - name: CorUnregisterWait Method + href: icorthreadpool-corunregisterwait-method.md + - name: IDebuggerInfo Interface + href: idebuggerinfo-interface.md + items: + - name: IsDebuggerAttached Method + href: idebuggerinfo-isdebuggerattached-method.md + - name: IDebuggerThreadControl Interface + href: idebuggerthreadcontrol-interface.md + items: + - name: ReleaseAllRuntimeThreads Method + href: idebuggerthreadcontrol-releaseallruntimethreads-method.md + - name: StartBlockingForDebugger Method + href: idebuggerthreadcontrol-startblockingfordebugger-method.md + - name: ThreadIsBlockingForDebugger Method + href: idebuggerthreadcontrol-threadisblockingfordebugger-method.md + - name: IGCHost Interface + href: igchost-interface.md + items: + - name: Collect Method + href: igchost-collect-method.md + - name: GetStats Method + href: igchost-getstats-method.md + - name: GetThreadStats Method + href: igchost-getthreadstats-method.md + - name: SetGCStartupLimits Method + href: igchost-setgcstartuplimits-method.md + - name: SetVirtualMemLimit Method + href: igchost-setvirtualmemlimit-method.md + - name: IGCHost2 Interface + href: igchost2-interface.md + items: + - name: SetGCStartupLimitsEx Method + href: igchost2-setgcstartuplimitsex-method.md + - name: IGCHostControl Interface + href: igchostcontrol-interface.md + items: + - name: RequestVirtualMemLimit Method + href: igchostcontrol-requestvirtualmemlimit-method.md + - name: IGCThreadControl Interface + href: igcthreadcontrol-interface.md + items: + - name: SuspensionEnding Method + href: igcthreadcontrol-suspensionending-method.md + - name: SuspensionStarting Method + href: igcthreadcontrol-suspensionstarting-method.md + - name: ThreadIsBlockingForSuspension Method + href: igcthreadcontrol-threadisblockingforsuspension-method.md + - name: IHostAssemblyManager Interface + href: ihostassemblymanager-interface.md + items: + - name: GetAssemblyStore Method + href: ihostassemblymanager-getassemblystore-method.md + - name: GetNonHostStoreAssemblies Method + href: ihostassemblymanager-getnonhoststoreassemblies-method.md + - name: IHostAssemblyStore Interface + href: ihostassemblystore-interface.md + items: + - name: ProvideAssembly Method + href: ihostassemblystore-provideassembly-method.md + - name: ProvideModule Method + href: ihostassemblystore-providemodule-method.md + - name: IHostAutoEvent Interface + href: ihostautoevent-interface.md + items: + - name: Set Method + href: ihostautoevent-set-method.md + - name: Wait Method + href: ihostautoevent-wait-method.md + - name: IHostControl Interface + href: ihostcontrol-interface.md + items: + - name: GetHostManager Method + href: ihostcontrol-gethostmanager-method.md + - name: SetAppDomainManager Method + href: ihostcontrol-setappdomainmanager-method.md + - name: IHostCrst Interface + href: ihostcrst-interface.md + items: + - name: Enter Method + href: ihostcrst-enter-method.md + - name: Leave Method + href: ihostcrst-leave-method.md + - name: SetSpinCount Method + href: ihostcrst-setspincount-method.md + - name: TryEnter Method + href: ihostcrst-tryenter-method.md + - name: IHostGCManager Interface + href: ihostgcmanager-interface.md + items: + - name: SuspensionEnding Method + href: ihostgcmanager-suspensionending-method.md + - name: SuspensionStarting Method + href: ihostgcmanager-suspensionstarting-method.md + - name: ThreadIsBlockingForSuspension Method + href: ihostgcmanager-threadisblockingforsuspension-method.md + - name: IHostIoCompletionManager Interface + href: ihostiocompletionmanager-interface.md + items: + - name: Bind Method + href: ihostiocompletionmanager-bind-method.md + - name: CloseIoCompletionPort Method + href: ihostiocompletionmanager-closeiocompletionport-method.md + - name: CreateIoCompletionPort Method + href: ihostiocompletionmanager-createiocompletionport-method.md + - name: GetAvailableThreads Method + href: ihostiocompletionmanager-getavailablethreads-method.md + - name: GetHostOverlappedSize Method + href: ihostiocompletionmanager-gethostoverlappedsize-method.md + - name: GetMaxThreads Method + href: ihostiocompletionmanager-getmaxthreads-method.md + - name: GetMinThreads Method + href: ihostiocompletionmanager-getminthreads-method.md + - name: InitializeHostOverlapped Method + href: ihostiocompletionmanager-initializehostoverlapped-method.md + - name: SetCLRIoCompletionManager Method + href: ihostiocompletionmanager-setclriocompletionmanager-method.md + - name: SetMaxThreads Method + href: ihostiocompletionmanager-setmaxthreads-method.md + - name: SetMinThreads Method + href: ihostiocompletionmanager-setminthreads-method.md + - name: IHostMalloc Interface + href: ihostmalloc-interface.md + items: + - name: Alloc Method + href: ihostmalloc-alloc-method.md + - name: DebugAlloc Method + href: ihostmalloc-debugalloc-method.md + - name: Free Method + href: ihostmalloc-free-method.md + - name: IHostManualEvent Interface + href: ihostmanualevent-interface.md + items: + - name: Reset Method + href: ihostmanualevent-reset-method.md + - name: Set Method + href: ihostmanualevent-set-method.md + - name: Wait Method + href: ihostmanualevent-wait-method.md + - name: IHostMemoryManager Interface + href: ihostmemorymanager-interface.md + items: + - name: AcquiredVirtualAddressSpace Method + href: ihostmemorymanager-acquiredvirtualaddressspace-method.md + - name: CreateMAlloc Method + href: ihostmemorymanager-createmalloc-method.md + - name: GetMemoryLoad Method + href: ihostmemorymanager-getmemoryload-method.md + - name: NeedsVirtualAddressSpace Method + href: ihostmemorymanager-needsvirtualaddressspace-method.md + - name: RegisterMemoryNotificationCallback Method + href: ihostmemorymanager-registermemorynotificationcallback-method.md + - name: ReleasedVirtualAddressSpace Method + href: ihostmemorymanager-releasedvirtualaddressspace-method.md + - name: VirtualAlloc Method + href: ihostmemorymanager-virtualalloc-method.md + - name: VirtualFree Method + href: ihostmemorymanager-virtualfree-method.md + - name: VirtualProtect Method + href: ihostmemorymanager-virtualprotect-method.md + - name: VirtualQuery Method + href: ihostmemorymanager-virtualquery-method.md + - name: IHostPolicyManager Interface + href: ihostpolicymanager-interface.md + items: + - name: OnDefaultAction Method + href: ihostpolicymanager-ondefaultaction-method.md + - name: OnFailure Method + href: ihostpolicymanager-onfailure-method.md + - name: OnTimeout Method + href: ihostpolicymanager-ontimeout-method.md + - name: IHostSecurityContext Interface + href: ihostsecuritycontext-interface.md + items: + - name: Capture Method + href: ihostsecuritycontext-capture-method.md + - name: IHostSecurityManager Interface + href: ihostsecuritymanager-interface.md + items: + - name: GetSecurityContext Method + href: ihostsecuritymanager-getsecuritycontext-method.md + - name: ImpersonateLoggedOnUser Method + href: ihostsecuritymanager-impersonateloggedonuser-method.md + - name: OpenThreadToken Method + href: ihostsecuritymanager-openthreadtoken-method.md + - name: RevertToSelf Method + href: ihostsecuritymanager-reverttoself-method.md + - name: SetSecurityContext Method + href: ihostsecuritymanager-setsecuritycontext-method.md + - name: SetThreadToken Method + href: ihostsecuritymanager-setthreadtoken-method.md + - name: IHostSemaphore Interface + href: ihostsemaphore-interface.md + items: + - name: ReleaseSemaphore Method + href: ihostsemaphore-releasesemaphore-method.md + - name: Wait Method + href: ihostsemaphore-wait-method.md + - name: IHostSyncManager Interface + href: ihostsyncmanager-interface.md + items: + - name: CreateAutoEvent Method + href: ihostsyncmanager-createautoevent-method.md + - name: CreateCrst Method + href: ihostsyncmanager-createcrst-method.md + - name: CreateCrstWithSpinCount Method + href: ihostsyncmanager-createcrstwithspincount-method.md + - name: CreateManualEvent Method + href: ihostsyncmanager-createmanualevent-method.md + - name: CreateMonitorEvent Method + href: ihostsyncmanager-createmonitorevent-method.md + - name: CreateRWLockReaderEvent Method + href: ihostsyncmanager-createrwlockreaderevent-method.md + - name: CreateRWLockWriterEvent Method + href: ihostsyncmanager-createrwlockwriterevent-method.md + - name: CreateSemaphore Method + href: ihostsyncmanager-createsemaphore-method.md + - name: SetCLRSyncManager Method + href: ihostsyncmanager-setclrsyncmanager-method.md + - name: IHostTask Interface + href: ihosttask-interface.md + items: + - name: Alert Method + href: ihosttask-alert-method.md + - name: GetPriority Method + href: ihosttask-getpriority-method.md + - name: Join Method + href: ihosttask-join-method.md + - name: SetCLRTask Method + href: ihosttask-setclrtask-method.md + - name: SetPriority Method + href: ihosttask-setpriority-method.md + - name: Start Method + href: ihosttask-start-method.md + - name: IHostTaskManager Interface + href: ihosttaskmanager-interface.md + items: + - name: BeginDelayAbort Method + href: ihosttaskmanager-begindelayabort-method.md + - name: BeginThreadAffinity Method + href: ihosttaskmanager-beginthreadaffinity-method.md + - name: CallNeedsHostHook Method + href: ihosttaskmanager-callneedshosthook-method.md + - name: CreateTask Method + href: ihosttaskmanager-createtask-method.md + - name: EndDelayAbort Method + href: ihosttaskmanager-enddelayabort-method.md + - name: EndThreadAffinity Method + href: ihosttaskmanager-endthreadaffinity-method.md + - name: EnterRuntime Method + href: ihosttaskmanager-enterruntime-method.md + - name: GetCurrentTask Method + href: ihosttaskmanager-getcurrenttask-method.md + - name: GetStackGuarantee Method + href: ihosttaskmanager-getstackguarantee-method.md + - name: LeaveRuntime Method + href: ihosttaskmanager-leaveruntime-method.md + - name: ReverseEnterRuntime Method + href: ihosttaskmanager-reverseenterruntime-method.md + - name: ReverseLeaveRuntime Method + href: ihosttaskmanager-reverseleaveruntime-method.md + - name: SetCLRTaskManager Method + href: ihosttaskmanager-setclrtaskmanager-method.md + - name: SetLocale Method + href: ihosttaskmanager-setlocale-method.md + - name: SetStackGuarantee Method + href: ihosttaskmanager-setstackguarantee-method.md + - name: SetUILocale Method + href: ihosttaskmanager-setuilocale-method.md + - name: Sleep Method + href: ihosttaskmanager-sleep-method.md + - name: SwitchToTask Method + href: ihosttaskmanager-switchtotask-method.md + - name: IHostThreadPoolManager Interface + href: ihostthreadpoolmanager-interface.md + items: + - name: GetAvailableThreads Method + href: ihostthreadpoolmanager-getavailablethreads-method.md + - name: GetMaxThreads Method + href: ihostthreadpoolmanager-getmaxthreads-method.md + - name: GetMinThreads Method + href: ihostthreadpoolmanager-getminthreads-method.md + - name: QueueUserWorkItem Method + href: ihostthreadpoolmanager-queueuserworkitem-method.md + - name: SetMaxThreads Method + href: ihostthreadpoolmanager-setmaxthreads-method.md + - name: SetMinThreads Method + href: ihostthreadpoolmanager-setminthreads-method.md + - name: IManagedObject Interface + href: imanagedobject-interface.md + items: + - name: GetObjectIdentity Method + href: imanagedobject-getobjectidentity-method.md + - name: GetSerializedBuffer Method + href: imanagedobject-getserializedbuffer-method.md + - name: IObjectHandle Interface + href: iobjecthandle-interface.md + items: + - name: Unwrap Method + href: iobjecthandle-unwrap-method.md + - name: ITypeName Interface + href: itypename-interface.md + items: + - name: GetAssemblyName Method + href: itypename-getassemblyname-method.md + - name: GetModifierLength Method + href: itypename-getmodifierlength-method.md + - name: GetModifiers Method + href: itypename-getmodifiers-method.md + - name: GetNameCount Method + href: itypename-getnamecount-method.md + - name: GetNames Method + href: itypename-getnames-method.md + - name: GetTypeArgumentCount Method + href: itypename-gettypeargumentcount-method.md + - name: GetTypeArguments Method + href: itypename-gettypearguments-method.md + - name: ITypeNameBuilder Interface + href: itypenamebuilder-interface.md + items: + - name: AddArray Method + href: itypenamebuilder-addarray-method.md + - name: AddAssemblySpec Method + href: itypenamebuilder-addassemblyspec-method.md + - name: AddByRef Method + href: itypenamebuilder-addbyref-method.md + - name: AddName Method + href: itypenamebuilder-addname-method.md + - name: AddPointer Method + href: itypenamebuilder-addpointer-method.md + - name: AddSzArray Method + href: itypenamebuilder-addszarray-method.md + - name: Clear Method + href: itypenamebuilder-clear-method.md + - name: CloseGenericArgument Method + href: itypenamebuilder-closegenericargument-method.md + - name: CloseGenericArguments Method + href: itypenamebuilder-closegenericarguments-method.md + - name: OpenGenericArgument Method + href: itypenamebuilder-opengenericargument-method.md + - name: OpenGenericArguments Method + href: itypenamebuilder-opengenericarguments-method.md + - name: ToString Method + href: itypenamebuilder-tostring-method.md + - name: ITypeNameFactory Interface + href: itypenamefactory-interface.md + items: + - name: GetTypeNameBuilder Method + href: itypenamefactory-gettypenamebuilder-method.md + - name: ParseTypeName Method + href: itypenamefactory-parsetypename-method.md + - name: IValidator Interface + href: ivalidator-interface.md + items: + - name: FormatEventInfo Method + href: ivalidator-formateventinfo-method.md + - name: Validate Method + href: ivalidator-validate-method.md + - name: CLR Hosting Interfaces Added in the .NET Framework 4 and 4.5 + href: clr-hosting-interfaces-added-in-the-net-framework-4-and-4-5.md + items: + - name: ICLRAppDomainResourceMonitor Interface + href: iclrappdomainresourcemonitor-interface.md + items: + - name: GetCurrentAllocated Method + href: iclrappdomainresourcemonitor-getcurrentallocated-method.md + - name: GetCurrentSurvived Method + href: iclrappdomainresourcemonitor-getcurrentsurvived-method.md + - name: GetCurrentCpuTime Method + href: iclrappdomainresourcemonitor-getcurrentcputime-method.md + - name: ICLRDomainManager Interface + href: iclrdomainmanager-interface.md + items: + - name: SetAppDomainManagerType Method + href: iclrdomainmanager-setappdomainmanagertype-method.md + - name: SetPropertiesForDefaultAppDomain Method + href: iclrdomainmanager-setpropertiesfordefaultappdomain-method.md + - name: ICLRGCManager2 Interface + href: iclrgcmanager2-interface.md + items: + - name: SetGCStartupLimitsEx Method + href: iclrgcmanager2-setgcstartuplimitsex-method.md + - name: ICLRMetaHost Interface + href: iclrmetahost-interface.md + items: + - name: EnumerateInstalledRuntimes Method + href: iclrmetahost-enumerateinstalledruntimes-method.md + - name: EnumerateLoadedRuntimes Method + href: iclrmetahost-enumerateloadedruntimes-method.md + - name: ExitProcess Method + href: iclrmetahost-exitprocess-method.md + - name: GetRuntime Method + href: iclrmetahost-getruntime-method.md + - name: GetVersionFromFile Method + href: iclrmetahost-getversionfromfile-method.md + - name: QueryLegacyV2RuntimeBinding Method + href: iclrmetahost-querylegacyv2runtimebinding-method.md + - name: RequestRuntimeLoadedNotification Method + href: iclrmetahost-requestruntimeloadednotification-method.md + - name: ICLRMetaHostPolicy Interface + href: iclrmetahostpolicy-interface.md + items: + - name: GetRequestedRuntime Method + href: iclrmetahostpolicy-getrequestedruntime-method.md + - name: ICLRRuntimeInfo Interface + href: iclrruntimeinfo-interface.md + items: + - name: BindAsLegacyV2Runtime Method + href: iclrruntimeinfo-bindaslegacyv2runtime-method.md + - name: GetDefaultStartupFlags Method + href: iclrruntimeinfo-getdefaultstartupflags-method.md + - name: GetInterface Method + href: iclrruntimeinfo-getinterface-method.md + - name: GetProcAddress Method + href: iclrruntimeinfo-getprocaddress-method.md + - name: GetRuntimeDirectory Method + href: iclrruntimeinfo-getruntimedirectory-method.md + - name: GetVersionString Method + href: iclrruntimeinfo-getversionstring-method.md + - name: IsLoadable Method + href: iclrruntimeinfo-isloadable-method.md + - name: IsLoaded Method + href: iclrruntimeinfo-isloaded-method.md + - name: IsStarted Method + href: iclrruntimeinfo-isstarted-method.md + - name: LoadErrorString Method + href: iclrruntimeinfo-loaderrorstring-method.md + - name: LoadLibrary Method + href: iclrruntimeinfo-loadlibrary-method.md + - name: SetDefaultStartupFlags Method + href: iclrruntimeinfo-setdefaultstartupflags-method.md + - name: ICLRStrongName Interface + href: iclrstrongname-interface.md + items: + - name: GetHashFromAssemblyFile Method + href: iclrstrongname-gethashfromassemblyfile-method.md + - name: GetHashFromAssemblyFileW Method + href: iclrstrongname-gethashfromassemblyfilew-method.md + - name: GetHashFromBlob Method + href: iclrstrongname-gethashfromblob-method.md + - name: GetHashFromFile Method + href: iclrstrongname-gethashfromfile-method.md + - name: GetHashFromFileW Method + href: iclrstrongname-gethashfromfilew-method.md + - name: GetHashFromHandle Method + href: iclrstrongname-gethashfromhandle-method.md + - name: StrongNameCompareAssemblies Method + href: iclrstrongname-strongnamecompareassemblies-method.md + - name: StrongNameFreeBuffer Method + href: iclrstrongname-strongnamefreebuffer-method.md + - name: StrongNameGetBlob Method + href: iclrstrongname-strongnamegetblob-method.md + - name: StrongNameGetBlobFromImage Method + href: iclrstrongname-strongnamegetblobfromimage-method.md + - name: StrongNameGetPublicKey Method + href: iclrstrongname-strongnamegetpublickey-method.md + - name: StrongNameHashSize Method + href: iclrstrongname-strongnamehashsize-method.md + - name: StrongNameKeyDelete Method + href: iclrstrongname-strongnamekeydelete-method.md + - name: StrongNameKeyGen Method + href: iclrstrongname-strongnamekeygen-method.md + - name: StrongNameKeyGenEx Method + href: iclrstrongname-strongnamekeygenex-method.md + - name: StrongNameKeyInstall Method + href: iclrstrongname-strongnamekeyinstall-method.md + - name: StrongNameSignatureGeneration Method + href: iclrstrongname-strongnamesignaturegeneration-method.md + - name: StrongNameSignatureGenerationEx Method + href: iclrstrongname-strongnamesignaturegenerationex-method.md + - name: StrongNameSignatureSize Method + href: iclrstrongname-strongnamesignaturesize-method.md + - name: StrongNameSignatureVerification Method + href: iclrstrongname-strongnamesignatureverification-method.md + - name: StrongNameSignatureVerificationEx Method + href: iclrstrongname-strongnamesignatureverificationex-method.md + - name: StrongNameSignatureVerificationFromImage Method + href: iclrstrongname-strongnamesignatureverificationfromimage-method.md + - name: StrongNameTokenFromAssembly Method + href: iclrstrongname-strongnametokenfromassembly-method.md + - name: StrongNameTokenFromAssemblyEx Method + href: iclrstrongname-strongnametokenfromassemblyex-method.md + - name: StrongNameTokenFromPublicKey Method + href: iclrstrongname-strongnametokenfrompublickey-method.md + - name: ICLRStrongName2 Interface + href: iclrstrongname2-interface.md + items: + - name: StrongNameGetPublicKeyEx Method + href: strongnamegetpublickeyex-method.md + - name: StrongNameSignatureVerificationEx2 Method + href: strongnamesignatureverificationex2-method.md + - name: ICLRTask2 Interface + href: iclrtask2-interface.md + items: + - name: BeginPreventAsyncAbort Method + href: iclrtask2-beginpreventasyncabort-method.md + - name: EndPreventAsyncAbort Method + href: iclrtask2-endpreventasyncabort-method.md +- name: Hosting Structures + href: hosting-structures.md + items: + - name: AssemblyBindInfo Structure + href: assemblybindinfo-structure.md + - name: BucketParameters Structure + href: bucketparameters-structure.md + - name: COR_GC_STATS Structure + href: cor-gc-stats-structure.md + - name: COR_GC_THREAD_STATS Structure + href: cor-gc-thread-stats-structure.md + - name: CustomDumpItem Structure + href: customdumpitem-structure.md + - name: MDAInfo Structure + href: mdainfo-structure.md + - name: ModuleBindInfo Structure + href: modulebindinfo-structure.md + - name: StackOverflowInfo Structure + href: stackoverflowinfo-structure.md diff --git a/docs/framework/unmanaged-api/hosting/typenamefactory-coclass.md b/docs/framework/unmanaged-api/hosting/typenamefactory-coclass.md new file mode 100644 index 0000000000000..1b976283ece91 --- /dev/null +++ b/docs/framework/unmanaged-api/hosting/typenamefactory-coclass.md @@ -0,0 +1,49 @@ +--- +description: "Learn more about: TypeNameFactory Coclass" +title: "TypeNameFactory Coclass" +ms.date: "03/30/2017" +api_name: + - "TypeNameFactory Coclass" +api_location: + - "mscoree.dll" +api_type: + - "COM" +f1_keywords: + - "TypeNameFactory" +helpviewer_keywords: + - "TypeNameFactory coclass [.NET Framework hosting]" +ms.assetid: c853bb58-c9c5-476b-8e80-608aa53ea18d +topic_type: + - "apiref" +--- +# TypeNameFactory Coclass + +Provides an interface for managing the deconstruction of a type name. + +## Syntax + +```cpp +coclass TypeNameFactory { + [default] interface ITypeNameFactory; +}; +``` + +## Interfaces + +|Interface|Description| +|---------------|-----------------| +|[ITypeNameFactory Interface](itypenamefactory-interface.md)|This interface supports the .NET Framework infrastructure and is not intended to be used directly from your code.| + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.idl + + **Library:** Included as a resource in MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + +## See also + +- [Hosting Coclasses](hosting-coclasses.md) diff --git a/docs/core/unmanaged-api/hosting/validatorflags-enumeration.md b/docs/framework/unmanaged-api/hosting/validatorflags-enumeration.md similarity index 87% rename from docs/core/unmanaged-api/hosting/validatorflags-enumeration.md rename to docs/framework/unmanaged-api/hosting/validatorflags-enumeration.md index d70dbbb4b5c81..581dc0f4e5841 100644 --- a/docs/core/unmanaged-api/hosting/validatorflags-enumeration.md +++ b/docs/framework/unmanaged-api/hosting/validatorflags-enumeration.md @@ -12,6 +12,7 @@ f1_keywords: - "ValidatorFlags" helpviewer_keywords: - "ValidatorFlags enumeration [.NET Framework hosting]" +ms.assetid: a3f5c266-3fcc-4ad1-aaf5-4cdbe26304ad topic_type: - "apiref" --- @@ -43,13 +44,13 @@ enum ValidatorFlags { ## Requirements - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). **Header:** IValidator.idl, IValidator.h **Library:** MSCorEE.dll - **.NET versions:** Available since .NET Framework 2.0 + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] ## See also diff --git a/docs/core/unmanaged-api/hosting/wait-option-enumeration.md b/docs/framework/unmanaged-api/hosting/wait-option-enumeration.md similarity index 56% rename from docs/core/unmanaged-api/hosting/wait-option-enumeration.md rename to docs/framework/unmanaged-api/hosting/wait-option-enumeration.md index f154977dd388b..ede3134dc0e3e 100644 --- a/docs/core/unmanaged-api/hosting/wait-option-enumeration.md +++ b/docs/framework/unmanaged-api/hosting/wait-option-enumeration.md @@ -2,55 +2,56 @@ description: "Learn more about: WAIT_OPTION Enumeration" title: "WAIT_OPTION Enumeration" ms.date: "03/30/2017" -api_name: +api_name: - "WAIT_OPTION" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "WAIT_OPTION" -helpviewer_keywords: +helpviewer_keywords: - "WAIT_OPTION enumeration [.NET Framework hosting]" -topic_type: +ms.assetid: 962fc293-8ded-4b3b-90ce-2c21a4f1b244 +topic_type: - "apiref" --- # WAIT_OPTION Enumeration -Contains values that indicate the action a host should take if an operation requested by the common language runtime (CLR) blocks. - -## Syntax - -```cpp -typedef enum { - WAIT_MSGPUMP = 0x1, - WAIT_ALERTABLE = 0x2, - WAIT_NOTINDEADLOCK = 0x4, -} WAIT_OPTION; -``` - -## Members - -|Member|Description| -|------------|-----------------| -|`WAIT_ALERTABLE`|Notifies the host that the task should be awakened if the CLR calls the [IHostTask::Alert](ihosttask-alert-method.md) method.| -|`WAIT_MSGPUMP`|Notifies the host that it must pump messages on the current OS thread if the thread becomes blocked. The runtime specifies this value only on an thread.| -|`WAIT_NOTINDEADLOCK`|Notifies the host that the specified synchronization request cannot be broken by a host. That is, the host cannot return `HOST_E_DEADLOCK`.| - -## Remarks - - The [IHostTaskManager::Sleep](ihosttaskmanager-sleep-method.md) and [IHostTaskManager::SwitchToTask](ihosttaskmanager-switchtotask-method.md) methods both take a parameter of this type. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorEE.dll - - **.NET versions:** Available since .NET Framework 2.0 - +Contains values that indicate the action a host should take if an operation requested by the common language runtime (CLR) blocks. + +## Syntax + +```cpp +typedef enum { + WAIT_MSGPUMP = 0x1, + WAIT_ALERTABLE = 0x2, + WAIT_NOTINDEADLOCK = 0x4, +} WAIT_OPTION; +``` + +## Members + +|Member|Description| +|------------|-----------------| +|`WAIT_ALERTABLE`|Notifies the host that the task should be awakened if the CLR calls the [IHostTask::Alert](ihosttask-alert-method.md) method.| +|`WAIT_MSGPUMP`|Notifies the host that it must pump messages on the current OS thread if the thread becomes blocked. The runtime specifies this value only on an thread.| +|`WAIT_NOTINDEADLOCK`|Notifies the host that the specified synchronization request cannot be broken by a host. That is, the host cannot return `HOST_E_DEADLOCK`.| + +## Remarks + + The [IHostTaskManager::Sleep](ihosttaskmanager-sleep-method.md) and [IHostTaskManager::SwitchToTask](ihosttaskmanager-switchtotask-method.md) methods both take a parameter of this type. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorEE.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v20plus](../../../../includes/net-current-v20plus-md.md)] + ## See also - [Hosting Enumerations](hosting-enumerations.md) diff --git a/docs/core/unmanaged-api/hosting/waitortimercallback-function-pointer.md b/docs/framework/unmanaged-api/hosting/waitortimercallback-function-pointer.md similarity index 55% rename from docs/core/unmanaged-api/hosting/waitortimercallback-function-pointer.md rename to docs/framework/unmanaged-api/hosting/waitortimercallback-function-pointer.md index 16c0dddf803c1..ecaa39c0b67e3 100644 --- a/docs/core/unmanaged-api/hosting/waitortimercallback-function-pointer.md +++ b/docs/framework/unmanaged-api/hosting/waitortimercallback-function-pointer.md @@ -2,56 +2,57 @@ description: "Learn more about: WAITORTIMERCALLBACK Function Pointer" title: "WAITORTIMERCALLBACK Function Pointer" ms.date: "03/30/2017" -api_name: +api_name: - "WAITORTIMERCALLBACK" -api_location: +api_location: - "mscoree.dll" -api_type: +api_type: - "COM" -f1_keywords: +f1_keywords: - "WAITORTIMERCALLBACK" -helpviewer_keywords: +helpviewer_keywords: - "WAITORTIMERCALLBACK function pointer [.NET Framework hosting]" -topic_type: +ms.assetid: 1fec4aef-0a06-4df0-bae7-d31a9ef9603d +topic_type: - "apiref" --- # WAITORTIMERCALLBACK Function Pointer -Points to a function that notifies the host that a wait handle () has either been signaled or timed out. - - This function pointer has been deprecated in the .NET Framework 4. - -## Syntax - -```cpp -typedef VOID (__stdcall *WAITORTIMERCALLBACK) ( - [in] PVOID lpParameter, - [in] BOOL TimerOrWaitFired -); -``` - -## Parameters - - `lpParameter` - [in] A pointer to an object that contains information defined by the host. - - `TimerOrWaitFired` - [in] `true` if the wait handle timed out, or `false` if it was signaled. - -## Remarks - - The function to which `WAITORTIMERCALLBACK` points is a callback function and must be implemented by the writer of the hosting application. - -## Requirements - - **Platforms:** See [System Requirements](../../../framework/get-started/system-requirements.md). - - **Header:** MSCorEE.h - - **Library:** MSCorWks.dll - - **.NET versions:** Available since .NET Framework 1.0 - +Points to a function that notifies the host that a wait handle () has either been signaled or timed out. + + This function pointer has been deprecated in the .NET Framework 4. + +## Syntax + +```cpp +typedef VOID (__stdcall *WAITORTIMERCALLBACK) ( + [in] PVOID lpParameter, + [in] BOOL TimerOrWaitFired +); +``` + +## Parameters + + `lpParameter` + [in] A pointer to an object that contains information defined by the host. + + `TimerOrWaitFired` + [in] `true` if the wait handle timed out, or `false` if it was signaled. + +## Remarks + + The function to which `WAITORTIMERCALLBACK` points is a callback function and must be implemented by the writer of the hosting application. + +## Requirements + + **Platforms:** See [System Requirements](../../get-started/system-requirements.md). + + **Header:** MSCorEE.h + + **Library:** MSCorWks.dll + + **.NET Framework Versions:** [!INCLUDE[net_current_v10plus](../../../../includes/net-current-v10plus-md.md)] + ## See also - [Deprecated CLR Hosting Functions](deprecated-clr-hosting-functions.md) From 7ee39f04940403acfc22a287c41ecb867a42b9d7 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Thu, 26 Jun 2025 21:04:23 +0200 Subject: [PATCH 17/20] fix invalid links --- .../metadata/coiniticor-enumeration.md | 2 +- .../metadata/coinitiee-enumeration.md | 2 +- .../metadata/couninitiee-enumeration.md | 2 +- ...emblyimport-findassembliesbyname-method.md | 2 +- .../metadata/metadata-enumerations.md | 6 +- .../metadata-global-static-functions.md | 2 +- .../app-domains/application-domains.md | 2 +- .../alwaysflowimpersonationpolicy-element.md | 2 +- .../appdomainmanagerassembly-element.md | 2 +- .../runtime/appdomainmanagertype-element.md | 2 +- .../appdomainresourcemonitoring-element.md | 2 +- .../disablecommitthreadstack-element.md | 2 +- .../legacyimpersonationpolicy-element.md | 2 +- ...efercominsteadofmanagedremoting-element.md | 4 +- .../startup/requiredruntime-element.md | 2 +- .../file-schema/startup/startup-element.md | 4 +- .../startup/supportedruntime-element.md | 4 +- .../how-to-debug-clr-activation-issues.md | 2 +- ...ion-errors-managing-the-user-experience.md | 6 +- .../certverifyauthenticodelicense-function.md | 4 +- ...mmon-data-types-unmanaged-api-reference.md | 2 +- .../cordebuginterfaceversion-enumeration.md | 2 +- .../cordebugthreadstate-enumeration.md | 2 +- .../debugging/iclrdebugging-interface.md | 2 +- .../debugging/icordebug-interface.md | 2 +- ...anagedcallback2-changeconnection-method.md | 2 +- ...anagedcallback2-createconnection-method.md | 2 +- ...nagedcallback2-destroyconnection-method.md | 2 +- ...debugprocess2-getthreadfortaskid-method.md | 2 +- .../hosting/coeeshutdowncom-function.md | 66 ++++----- .../hosting/coinitializecor-function.md | 50 +++---- .../hosting/coinitializeee-function.md | 92 ++++++------ .../hosting/cordllmain-function.md | 106 +++++++------- .../hosting/corexemain-function.md | 64 ++++----- .../hosting/corexemain2-function.md | 96 ++++++------- .../hosting/corimageunloading-function.md | 66 ++++----- .../hosting/corvalidateimage-function.md | 136 +++++++++--------- .../hosting/couninitializecor-function.md | 36 ++--- .../hosting/couninitializeee-function.md | 40 +++--- .../iclrruntimehost-sethostcontrol-method.md | 94 ++++++------ .../iclrruntimeinfo-getinterface-method.md | 132 ++++++++--------- .../hosting/iclrruntimeinfo-interface.md | 70 ++++----- 42 files changed, 561 insertions(+), 561 deletions(-) diff --git a/docs/core/unmanaged-api/metadata/coiniticor-enumeration.md b/docs/core/unmanaged-api/metadata/coiniticor-enumeration.md index db47cb0f36659..21c9136bf63cd 100644 --- a/docs/core/unmanaged-api/metadata/coiniticor-enumeration.md +++ b/docs/core/unmanaged-api/metadata/coiniticor-enumeration.md @@ -17,7 +17,7 @@ topic_type: --- # COINITICOR Enumeration -Specifies constants used by [CoInitializeCor](../hosting/coinitializecor-function.md) when it initializes the common language runtime. +Specifies constants used by [CoInitializeCor](../../../framework/unmanaged-api/hosting/coinitializecor-function.md) when it initializes the common language runtime. ## Syntax diff --git a/docs/core/unmanaged-api/metadata/coinitiee-enumeration.md b/docs/core/unmanaged-api/metadata/coinitiee-enumeration.md index 69ecde0ea1a64..e5fd3156a3a73 100644 --- a/docs/core/unmanaged-api/metadata/coinitiee-enumeration.md +++ b/docs/core/unmanaged-api/metadata/coinitiee-enumeration.md @@ -17,7 +17,7 @@ topic_type: --- # COINITIEE Enumeration -Specifies constants used by [CoInitializeEE](../hosting/coinitializeee-function.md) when initializing the common language runtime. +Specifies constants used by [CoInitializeEE](../../../framework/unmanaged-api/hosting/coinitializeee-function.md) when initializing the common language runtime. ## Syntax diff --git a/docs/core/unmanaged-api/metadata/couninitiee-enumeration.md b/docs/core/unmanaged-api/metadata/couninitiee-enumeration.md index 2ae1f9b541fd7..34f0c8203276f 100644 --- a/docs/core/unmanaged-api/metadata/couninitiee-enumeration.md +++ b/docs/core/unmanaged-api/metadata/couninitiee-enumeration.md @@ -17,7 +17,7 @@ topic_type: --- # COUNINITIEE Enumeration -Specifies constants used by [CoUninitializeEE](../hosting/couninitializeee-function.md) when initializing the common language runtime. +Specifies constants used by [CoUninitializeEE](../../../framework/unmanaged-api/hosting/couninitializeee-function.md) when initializing the common language runtime. ## Syntax diff --git a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md index 6ad929430a545..9cd5dedccc3e1 100644 --- a/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md +++ b/docs/core/unmanaged-api/metadata/imetadataassemblyimport-findassembliesbyname-method.md @@ -64,7 +64,7 @@ HRESULT FindAssembliesByName ( 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](../hosting/coinitializeee-function.md) (passing COINITEE_DEFAULT) before calling `FindAssembliesByName`, and then follow with a call to [CoUninitializeCor](../hosting/couninitializecor-function.md). + 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. diff --git a/docs/core/unmanaged-api/metadata/metadata-enumerations.md b/docs/core/unmanaged-api/metadata/metadata-enumerations.md index fe4784bb9a075..b2a2f0772ac5f 100644 --- a/docs/core/unmanaged-api/metadata/metadata-enumerations.md +++ b/docs/core/unmanaged-api/metadata/metadata-enumerations.md @@ -26,10 +26,10 @@ This section describes the unmanaged enumerations that the metadata API uses. 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. + 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](../hosting/coinitializeee-function.md) when initializing the common language runtime. + 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. @@ -149,7 +149,7 @@ This section describes the unmanaged enumerations that the metadata API uses. 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. + Specifies constants used by [CoUninitializeEE](../../../framework/unmanaged-api/hosting/couninitializeee-function.md) when initializing the common language runtime. ## Related Sections diff --git a/docs/core/unmanaged-api/metadata/metadata-global-static-functions.md b/docs/core/unmanaged-api/metadata/metadata-global-static-functions.md index 6f1e7aca4bd66..d736e6d88627b 100644 --- a/docs/core/unmanaged-api/metadata/metadata-global-static-functions.md +++ b/docs/core/unmanaged-api/metadata/metadata-global-static-functions.md @@ -9,7 +9,7 @@ helpviewer_keywords: --- # 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. +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](../../../framework/unmanaged-api/hosting/deprecated-clr-hosting-functions.md). There are no global static functions that pertain to metadata. ## Related Sections diff --git a/docs/framework/app-domains/application-domains.md b/docs/framework/app-domains/application-domains.md index a2c4c2d8a92ca..9bd146b9669b0 100644 --- a/docs/framework/app-domains/application-domains.md +++ b/docs/framework/app-domains/application-domains.md @@ -59,7 +59,7 @@ Operating systems and runtime environments typically provide some form of isolat - If an assembly is not loaded domain-neutral, it must be JIT-compiled in every application domain in which it is loaded. However, the assembly can be unloaded from the process by unloading all the application domains in which it is loaded. - The runtime host determines whether to load assemblies as domain-neutral when it loads the runtime into a process. For managed applications, apply the attribute to the entry-point method for the process, and specify a value from the associated enumeration. For unmanaged applications that host the common language runtime, specify the appropriate flag when you call the [CorBindToRuntimeEx Function](../../core/unmanaged-api/hosting/corbindtoruntimeex-function.md) method. + The runtime host determines whether to load assemblies as domain-neutral when it loads the runtime into a process. For managed applications, apply the attribute to the entry-point method for the process, and specify a value from the associated enumeration. For unmanaged applications that host the common language runtime, specify the appropriate flag when you call the [CorBindToRuntimeEx Function](../unmanaged-api/hosting/corbindtoruntimeex-function.md) method. There are three options for loading domain-neutral assemblies: 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 ea3c4f19f77ad..057e3169aec62 100644 --- a/docs/framework/configure-apps/file-schema/runtime/alwaysflowimpersonationpolicy-element.md +++ b/docs/framework/configure-apps/file-schema/runtime/alwaysflowimpersonationpolicy-element.md @@ -65,7 +65,7 @@ Specifies that the Windows identity always flows across asynchronous points, reg 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](../../../../core/unmanaged-api/hosting/corbindtoruntimeex-function.md) function. To enable the compatibility mode for the entire process, set the `flags` parameter for [CorBindToRuntimeEx Function](../../../../core/unmanaged-api/hosting/corbindtoruntimeex-function.md) to `STARTUP_ALWAYSFLOW_IMPERSONATION`. + 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 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 3805af8f3824b..efc56780ae140 100644 --- a/docs/framework/configure-apps/file-schema/runtime/appdomainmanagerassembly-element.md +++ b/docs/framework/configure-apps/file-schema/runtime/appdomainmanagerassembly-element.md @@ -79,4 +79,4 @@ Specifies the assembly that provides the application domain manager for the defa - [\ Element](appdomainmanagertype-element.md) - [Runtime Settings Schema](index.md) - [Configuration File Schema](../index.md) -- [SetAppDomainManagerType Method](../../../../core/unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.md) +- [SetAppDomainManagerType Method](../../../unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.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 4b62ff4b59683..83cd0f284a55e 100644 --- a/docs/framework/configure-apps/file-schema/runtime/appdomainmanagertype-element.md +++ b/docs/framework/configure-apps/file-schema/runtime/appdomainmanagertype-element.md @@ -79,4 +79,4 @@ Specifies the type that serves as the application domain manager for the default - [\ Element](appdomainmanagerassembly-element.md) - [Runtime Settings Schema](index.md) - [Configuration File Schema](../index.md) -- [SetAppDomainManagerType Method](../../../../core/unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.md) +- [SetAppDomainManagerType Method](../../../unmanaged-api/hosting/iclrcontrol-setappdomainmanagertype-method.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 60168e5f35dec..a05e5fb167529 100644 --- a/docs/framework/configure-apps/file-schema/runtime/appdomainresourcemonitoring-element.md +++ b/docs/framework/configure-apps/file-schema/runtime/appdomainresourcemonitoring-element.md @@ -52,7 +52,7 @@ Instructs the runtime to collect statistics on all application domains in the pr ## Remarks - Application domain resource monitoring is available through the managed application domain class, the hosting [ICLRAppDomainResourceMonitor](../../../../core/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. + 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. 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 a79a845f40452..50b7680e5e8c5 100644 --- a/docs/framework/configure-apps/file-schema/runtime/disablecommitthreadstack-element.md +++ b/docs/framework/configure-apps/file-schema/runtime/disablecommitthreadstack-element.md @@ -57,7 +57,7 @@ Specifies whether the full thread stack is committed when a thread is started. 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](../../../../core/unmanaged-api/hosting/startup-flags-enumeration.md) enumeration to accomplish the same result. +> 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 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 78a75cffee4fe..88f1d479a8e35 100644 --- a/docs/framework/configure-apps/file-schema/runtime/legacyimpersonationpolicy-element.md +++ b/docs/framework/configure-apps/file-schema/runtime/legacyimpersonationpolicy-element.md @@ -70,7 +70,7 @@ Specifies that the Windows identity does not flow across asynchronous points, re 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](../../../../core/unmanaged-api/hosting/corbindtoruntimeex-function.md) function. To enable the compatibility mode for the entire process, set the `flags` parameter for [CorBindToRuntimeEx Function](../../../../core/unmanaged-api/hosting/corbindtoruntimeex-function.md) to STARTUP_LEGACY_IMPERSONATION. + 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). 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 cad7d389030a6..0e57062653e88 100644 --- a/docs/framework/configure-apps/file-schema/runtime/prefercominsteadofmanagedremoting-element.md +++ b/docs/framework/configure-apps/file-schema/runtime/prefercominsteadofmanagedremoting-element.md @@ -53,9 +53,9 @@ Specifies whether the runtime will use COM interop instead of remoting for all c 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](../../../../core/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 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](../../../../core/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. +- 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. 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 c7e580d513982..f047e116b9cee 100644 --- a/docs/framework/configure-apps/file-schema/startup/requiredruntime-element.md +++ b/docs/framework/configure-apps/file-schema/startup/requiredruntime-element.md @@ -61,7 +61,7 @@ None. Applications built to support only version 1.0 of the runtime must use the `` element. Applications built using version 1.1 or later of the runtime must use the `` element. > [!NOTE] -> If you use the [CorBindToRuntimeByCfg](../../../../core/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](../../../../core/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). The `version` attribute string must match the installation folder name for the specified version of the .NET Framework. This string is not interpreted. If the runtime startup code does not find a matching folder, the runtime is not loaded; the startup code shows an error message and quits. 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 5bc6b25e0feaf..845d17e8a196c 100644 --- a/docs/framework/configure-apps/file-schema/startup/startup-element.md +++ b/docs/framework/configure-apps/file-schema/startup/startup-element.md @@ -39,7 +39,7 @@ Specifies common language runtime startup information. |Value|Description| |-----------|-----------------| -|`true`|Enable .NET Framework 2.0 runtime activation policy for the chosen runtime, which is to bind legacy runtime activation techniques (such as the [CorBindToRuntimeEx function](../../../../core/unmanaged-api/hosting/corbindtoruntimeex-function.md)) to the runtime chosen from the configuration file instead of capping them at CLR version 2.0. Thus, if CLR version 4 or later is chosen from the configuration file, mixed-mode assemblies created with earlier versions of the .NET Framework are loaded with the chosen CLR version. Setting this value prevents CLR version 1.1 or CLR version 2.0 from loading into the same process, effectively disabling the in-process side-by-side feature.| +|`true`|Enable .NET Framework 2.0 runtime activation policy for the chosen runtime, which is to bind legacy runtime activation techniques (such as the [CorBindToRuntimeEx function](../../../unmanaged-api/hosting/corbindtoruntimeex-function.md)) to the runtime chosen from the configuration file instead of capping them at CLR version 2.0. Thus, if CLR version 4 or later is chosen from the configuration file, mixed-mode assemblies created with earlier versions of the .NET Framework are loaded with the chosen CLR version. Setting this value prevents CLR version 1.1 or CLR version 2.0 from loading into the same process, effectively disabling the in-process side-by-side feature.| |`false`|Use the default activation policy for the .NET Framework 4 and later, which is to allow legacy runtime activation techniques to load CLR version 1.1 or 2.0 into the process. Setting this value prevents mixed-mode assemblies from loading into the .NET Framework 4 or later unless they were built with the .NET Framework 4 or later. This value is the default.| ### Child elements @@ -61,7 +61,7 @@ Specifies common language runtime startup information. ## The useLegacyV2RuntimeActivationPolicy attribute - This attribute is useful if your application uses legacy activation paths, such as the [CorBindToRuntimeEx function](../../../../core/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. In those scenarios, set the attribute to `true`. + This attribute is useful 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. In those scenarios, set the attribute to `true`. > [!NOTE] > Setting the attribute to `true` prevents CLR version 1.1 or CLR version 2.0 from loading into the same process, effectively disabling the in-process side-by-side feature (see [Side-by-Side Execution for COM Interop](/previous-versions/dotnet/netframework-4.0/8t8td04t(v=vs.100))). 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 e1294d7e8bf7c..28111e727a909 100644 --- a/docs/framework/configure-apps/file-schema/startup/supportedruntime-element.md +++ b/docs/framework/configure-apps/file-schema/startup/supportedruntime-element.md @@ -38,14 +38,14 @@ 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](../../../../core/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](../../../../core/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](../../../../core/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. +> 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. We recommend that you test applications with all the .NET Framework versions that they can run on. diff --git a/docs/framework/deployment/how-to-debug-clr-activation-issues.md b/docs/framework/deployment/how-to-debug-clr-activation-issues.md index 66f1fa7ee7d19..0f3319ef34836 100644 --- a/docs/framework/deployment/how-to-debug-clr-activation-issues.md +++ b/docs/framework/deployment/how-to-debug-clr-activation-issues.md @@ -101,7 +101,7 @@ In the following example of an activation log, the most useful information is hi 532,205950.382,Installed Runtime: v4.0.30319. VERSION_ARCHITECTURE: 0 ``` -- **built with version** is the version of the CLR that was used to build the binary that was provided to a method such as [ICLRMetaHostPolicy::GetRequestedRuntime](../../core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md). +- **built with version** is the version of the CLR that was used to build the binary that was provided to a method such as [ICLRMetaHostPolicy::GetRequestedRuntime](../unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md). ```output 532,205950.382,C:\Tests\myapp.exe was built with version: v2.0.50727 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 e0c988d2444ef..c4cdaf6493e7a 100644 --- a/docs/framework/deployment/initialization-errors-managing-the-user-experience.md +++ b/docs/framework/deployment/initialization-errors-managing-the-user-experience.md @@ -47,15 +47,15 @@ To resolve the underlying issues and provide the best user experience (fewer err Displaying an error message to communicate that a requested .NET Framework version was not found can be viewed as either a helpful service or a minor annoyance to users. In either case, you can control this UI by passing flags to the activation APIs. -The [ICLRMetaHostPolicy::GetRequestedRuntime](../../core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md) method accepts a [METAHOST_POLICY_FLAGS](../../core/unmanaged-api/hosting/metahost-policy-flags-enumeration.md) enumeration member as input. You can include the METAHOST_POLICY_SHOW_ERROR_DIALOG flag to request an error message if the requested version of the CLR is not found. By default, the error message is not displayed. (The [ICLRMetaHost::GetRuntime](../../core/unmanaged-api/hosting/iclrmetahost-getruntime-method.md) method does not accept this flag, and does not provide any other way to display the error message.) +The [ICLRMetaHostPolicy::GetRequestedRuntime](../unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md) method accepts a [METAHOST_POLICY_FLAGS](../unmanaged-api/hosting/metahost-policy-flags-enumeration.md) enumeration member as input. You can include the METAHOST_POLICY_SHOW_ERROR_DIALOG flag to request an error message if the requested version of the CLR is not found. By default, the error message is not displayed. (The [ICLRMetaHost::GetRuntime](../unmanaged-api/hosting/iclrmetahost-getruntime-method.md) method does not accept this flag, and does not provide any other way to display the error message.) Windows provides a [SetErrorMode](/windows/win32/api/errhandlingapi/nf-errhandlingapi-seterrormode) function that you can use to declare whether you want error messages to be shown as a result of code that runs within your process. You can specify the SEM_FAILCRITICALERRORS flag to prevent the error message from being displayed. However, in some scenarios, it is important to override the SEM_FAILCRITICALERRORS setting set by an application process. For example, if you have a native COM component that hosts the CLR and that is hosted in a process where SEM_FAILCRITICALERRORS is set, you may want to override the flag, depending on the impact of displaying error messages within that particular application process. In this case, you can use one of the following flags to override SEM_FAILCRITICALERRORS: -- Use METAHOST_POLICY_IGNORE_ERROR_MODE with the [ICLRMetaHostPolicy::GetRequestedRuntime](../../core/unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md) method. +- Use METAHOST_POLICY_IGNORE_ERROR_MODE with the [ICLRMetaHostPolicy::GetRequestedRuntime](../unmanaged-api/hosting/iclrmetahostpolicy-getrequestedruntime-method.md) method. -- Use RUNTIME_INFO_IGNORE_ERROR_MODE with the [GetRequestedRuntimeInfo](../../core/unmanaged-api/hosting/getrequestedruntimeinfo-function.md) function. +- Use RUNTIME_INFO_IGNORE_ERROR_MODE with the [GetRequestedRuntimeInfo](../unmanaged-api/hosting/getrequestedruntimeinfo-function.md) function. ## UI policy for CLR-provided hosts diff --git a/docs/framework/unmanaged-api/authenticode/certverifyauthenticodelicense-function.md b/docs/framework/unmanaged-api/authenticode/certverifyauthenticodelicense-function.md index cb6d13b245dac..18aa995ddc0f3 100644 --- a/docs/framework/unmanaged-api/authenticode/certverifyauthenticodelicense-function.md +++ b/docs/framework/unmanaged-api/authenticode/certverifyauthenticodelicense-function.md @@ -70,5 +70,5 @@ HRESULT CertVerifyAuthenticodeLicense ( ## See also - [Authenticode](index.md) -- [GetHashFromHandle Method](../../../core/unmanaged-api/hosting/iclrstrongname-gethashfromhandle-method.md) -- [ICLRStrongName Interface](../../../core/unmanaged-api/hosting/iclrstrongname-interface.md) +- [GetHashFromHandle Method](../hosting/iclrstrongname-gethashfromhandle-method.md) +- [ICLRStrongName Interface](../hosting/iclrstrongname-interface.md) 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 8930db9ed7d73..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 @@ -32,7 +32,7 @@ This topic lists simple data types used by the unmanaged APIs for the .NET Frame |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](../../core/unmanaged-api/hosting/iclrtask-interface.md) instance.| +|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 diff --git a/docs/framework/unmanaged-api/debugging/cordebuginterfaceversion-enumeration.md b/docs/framework/unmanaged-api/debugging/cordebuginterfaceversion-enumeration.md index 42999ba3dbb1f..c3ea31c940ac0 100644 --- a/docs/framework/unmanaged-api/debugging/cordebuginterfaceversion-enumeration.md +++ b/docs/framework/unmanaged-api/debugging/cordebuginterfaceversion-enumeration.md @@ -218,7 +218,7 @@ typedef enum CorDebugInterfaceVersion { ## Remarks - A debugger can use the `CorDebugInterfaceVersion` enumeration in the [CreateDebuggingInterfaceFromVersion](../../../core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md) function to specify the highest version of the .NET Framework that the debugger supports. + A debugger can use the `CorDebugInterfaceVersion` enumeration in the [CreateDebuggingInterfaceFromVersion](../hosting/createdebugginginterfacefromversion-function.md) function to specify the highest version of the .NET Framework that the debugger supports. ## Interface Names diff --git a/docs/framework/unmanaged-api/debugging/cordebugthreadstate-enumeration.md b/docs/framework/unmanaged-api/debugging/cordebugthreadstate-enumeration.md index 21eaf83557aa0..4744569bd97e3 100644 --- a/docs/framework/unmanaged-api/debugging/cordebugthreadstate-enumeration.md +++ b/docs/framework/unmanaged-api/debugging/cordebugthreadstate-enumeration.md @@ -40,7 +40,7 @@ typedef enum CorDebugThreadState { The debugger uses the `CorDebugThreadState` enumeration to control a thread's execution. The state of a thread can be set by using the [ICorDebugThread::SetDebugState](icordebugthread-setdebugstate-method.md) or [ICorDebugController::SetAllThreadsDebugState](icordebugcontroller-setallthreadsdebugstate-method.md) method. - A callback provided to the [hosting API](../../../core/unmanaged-api/hosting/index.md) enables message pumping, so an interrupted state is not needed. + A callback provided to the [hosting API](../hosting/index.md) enables message pumping, so an interrupted state is not needed. ## Requirements diff --git a/docs/framework/unmanaged-api/debugging/iclrdebugging-interface.md b/docs/framework/unmanaged-api/debugging/iclrdebugging-interface.md index 6bedc473882f8..cc9936752d676 100644 --- a/docs/framework/unmanaged-api/debugging/iclrdebugging-interface.md +++ b/docs/framework/unmanaged-api/debugging/iclrdebugging-interface.md @@ -29,7 +29,7 @@ Provides methods that handle loading and unloading modules for debugging. ## Remarks - You can obtain an instance of the `ICLRDebugging` interface by using the [CLRCreateInstance](../../../core/unmanaged-api/hosting/clrcreateinstance-function.md) function. + You can obtain an instance of the `ICLRDebugging` interface by using the [CLRCreateInstance](../hosting/clrcreateinstance-function.md) function. ## Requirements diff --git a/docs/framework/unmanaged-api/debugging/icordebug-interface.md b/docs/framework/unmanaged-api/debugging/icordebug-interface.md index f86e59a8eb537..61dec178ae5e2 100644 --- a/docs/framework/unmanaged-api/debugging/icordebug-interface.md +++ b/docs/framework/unmanaged-api/debugging/icordebug-interface.md @@ -41,7 +41,7 @@ Provides methods that allow developers to debug applications in the common langu `ICorDebug` represents an event processing loop for a debugger process. The debugger must wait for the [ICorDebugManagedCallback::ExitProcess](icordebugmanagedcallback-exitprocess-method.md) callback from all processes being debugged before releasing this interface. - The `ICorDebug` object is the initial object to control all further managed debugging. In the .NET Framework versions 1.0 and 1.1, this object was a `CoClass` object created from COM. In .NET Framework version 2.0, this object is no longer a `CoClass` object. It must be created by the [CreateDebuggingInterfaceFromVersion](../../../core/unmanaged-api/hosting/createdebugginginterfacefromversion-function.md) function, which is more version-aware. This new creation function enables clients to get a specific implementation of `ICorDebug`, which also emulates a specific version of the debugging API. + The `ICorDebug` object is the initial object to control all further managed debugging. In the .NET Framework versions 1.0 and 1.1, this object was a `CoClass` object created from COM. In .NET Framework version 2.0, this object is no longer a `CoClass` object. It must be created by the [CreateDebuggingInterfaceFromVersion](../hosting/createdebugginginterfacefromversion-function.md) function, which is more version-aware. This new creation function enables clients to get a specific implementation of `ICorDebug`, which also emulates a specific version of the debugging API. > [!NOTE] > This interface does not support being called remotely, either cross-machine or cross-process. diff --git a/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-changeconnection-method.md b/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-changeconnection-method.md index bbd373a6d5fa6..238b50ea449e3 100644 --- a/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-changeconnection-method.md +++ b/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-changeconnection-method.md @@ -44,7 +44,7 @@ HRESULT ChangeConnection ( - When a debugger attaches to a process that contains connections. In this case, the runtime will generate and dispatch a [ICorDebugManagedCallback2::CreateConnection](icordebugmanagedcallback2-createconnection-method.md) event and a `ChangeConnection` event for each connection in the process. A `ChangeConnection` event is generated for every existing connection, regardless of whether that connection’s set of tasks has been changed since its creation. -- When a host calls [ICLRDebugManager::SetConnectionTasks](../../../core/unmanaged-api/hosting/iclrdebugmanager-setconnectiontasks-method.md) in the [Hosting API](../../../core/unmanaged-api/hosting/index.md). +- When a host calls [ICLRDebugManager::SetConnectionTasks](../hosting/iclrdebugmanager-setconnectiontasks-method.md) in the [Hosting API](../hosting/index.md). The debugger should scan all threads in the process to pick up the new changes. diff --git a/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-createconnection-method.md b/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-createconnection-method.md index 1d606ac5372be..a410986005df2 100644 --- a/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-createconnection-method.md +++ b/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-createconnection-method.md @@ -48,7 +48,7 @@ HRESULT CreateConnection ( - When a debugger attaches to a process that contains connections. In this case, the runtime will generate and dispatch a `CreateConnection` event and a [ICorDebugManagedCallback2::ChangeConnection](icordebugmanagedcallback2-changeconnection-method.md) event for each connection in the process. -- When a host calls [ICLRDebugManager::BeginConnection](../../../core/unmanaged-api/hosting/iclrdebugmanager-beginconnection-method.md) in the [Hosting API](../../../core/unmanaged-api/hosting/index.md). +- When a host calls [ICLRDebugManager::BeginConnection](../hosting/iclrdebugmanager-beginconnection-method.md) in the [Hosting API](../hosting/index.md). ## Requirements diff --git a/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-destroyconnection-method.md b/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-destroyconnection-method.md index d1bb2a0e4e1bd..9f5d5d6a7f0f3 100644 --- a/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-destroyconnection-method.md +++ b/docs/framework/unmanaged-api/debugging/icordebugmanagedcallback2-destroyconnection-method.md @@ -40,7 +40,7 @@ HRESULT DestroyConnection ( ## Remarks - A `DestroyConnection` callback will be fired when a host calls [ICLRDebugManager::EndConnection](../../../core/unmanaged-api/hosting/iclrdebugmanager-endconnection-method.md) in the [Hosting API](../../../core/unmanaged-api/hosting/index.md). + A `DestroyConnection` callback will be fired when a host calls [ICLRDebugManager::EndConnection](../hosting/iclrdebugmanager-endconnection-method.md) in the [Hosting API](../hosting/index.md). ## Requirements diff --git a/docs/framework/unmanaged-api/debugging/icordebugprocess2-getthreadfortaskid-method.md b/docs/framework/unmanaged-api/debugging/icordebugprocess2-getthreadfortaskid-method.md index 0706ff8ca12c2..93f69797d28a4 100644 --- a/docs/framework/unmanaged-api/debugging/icordebugprocess2-getthreadfortaskid-method.md +++ b/docs/framework/unmanaged-api/debugging/icordebugprocess2-getthreadfortaskid-method.md @@ -40,7 +40,7 @@ HRESULT GetThreadForTaskID ( ## Remarks - The host can set the task identifier by using the [ICLRTask::SetTaskIdentifier](../../../core/unmanaged-api/hosting/iclrtask-settaskidentifier-method.md) method. + The host can set the task identifier by using the [ICLRTask::SetTaskIdentifier](../hosting/iclrtask-settaskidentifier-method.md) method. ## Requirements diff --git a/docs/framework/unmanaged-api/hosting/coeeshutdowncom-function.md b/docs/framework/unmanaged-api/hosting/coeeshutdowncom-function.md index c44b17e3cdf88..0254f52db3897 100644 --- a/docs/framework/unmanaged-api/hosting/coeeshutdowncom-function.md +++ b/docs/framework/unmanaged-api/hosting/coeeshutdowncom-function.md @@ -2,53 +2,53 @@ 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)] - +> 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) +- [Metadata Global Static Functions](../../../core/unmanaged-api/metadata/metadata-global-static-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/coinitializecor-function.md b/docs/framework/unmanaged-api/hosting/coinitializecor-function.md index f48cf805b3d79..18aa825d97cce 100644 --- a/docs/framework/unmanaged-api/hosting/coinitializecor-function.md +++ b/docs/framework/unmanaged-api/hosting/coinitializecor-function.md @@ -2,41 +2,41 @@ 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 - - To initialize the common language runtime, use either [CorBindToRuntimeEx](corbindtoruntimeex-function.md) or [CorBindToCurrentRuntime](corbindtocurrentruntime-function.md). - -## Requirements - - **Header:** Cor.h - +`CoInitializeCor` is obsolete. + +## Syntax + +```cpp +STDAPI CoInitializeCor ( + DWORD fFlags +); +``` + +## Remarks + + To initialize the common language runtime, use either [CorBindToRuntimeEx](corbindtoruntimeex-function.md) or [CorBindToCurrentRuntime](corbindtocurrentruntime-function.md). + +## Requirements + + **Header:** Cor.h + ## See also -- [Metadata Global Static Functions](../metadata/metadata-global-static-functions.md) +- [Metadata Global Static Functions](../../../core/unmanaged-api/metadata/metadata-global-static-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/coinitializeee-function.md b/docs/framework/unmanaged-api/hosting/coinitializeee-function.md index a862de2ae0256..c5872abff03d6 100644 --- a/docs/framework/unmanaged-api/hosting/coinitializeee-function.md +++ b/docs/framework/unmanaged-api/hosting/coinitializeee-function.md @@ -2,62 +2,62 @@ 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)] - +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)] + ## See also -- [Metadata Global Static Functions](../metadata/metadata-global-static-functions.md) +- [Metadata Global Static Functions](../../../core/unmanaged-api/metadata/metadata-global-static-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/cordllmain-function.md b/docs/framework/unmanaged-api/hosting/cordllmain-function.md index 9a329189ad375..43c361ed27521 100644 --- a/docs/framework/unmanaged-api/hosting/cordllmain-function.md +++ b/docs/framework/unmanaged-api/hosting/cordllmain-function.md @@ -2,69 +2,69 @@ 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)] - + + 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) +- [Metadata Global Static Functions](../../../core/unmanaged-api/metadata/metadata-global-static-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/corexemain-function.md b/docs/framework/unmanaged-api/hosting/corexemain-function.md index 708c87a9e02a7..177b14d9ca616 100644 --- a/docs/framework/unmanaged-api/hosting/corexemain-function.md +++ b/docs/framework/unmanaged-api/hosting/corexemain-function.md @@ -2,51 +2,51 @@ 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)] - + + 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) +- [Metadata Global Static Functions](../../../core/unmanaged-api/metadata/metadata-global-static-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/corexemain2-function.md b/docs/framework/unmanaged-api/hosting/corexemain2-function.md index fc3bd53e240bd..ae6bea2f865e6 100644 --- a/docs/framework/unmanaged-api/hosting/corexemain2-function.md +++ b/docs/framework/unmanaged-api/hosting/corexemain2-function.md @@ -2,63 +2,63 @@ 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 - - `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)] - +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 + + `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)] + ## See also -- [Metadata Global Static Functions](../metadata/metadata-global-static-functions.md) +- [Metadata Global Static Functions](../../../core/unmanaged-api/metadata/metadata-global-static-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/corimageunloading-function.md b/docs/framework/unmanaged-api/hosting/corimageunloading-function.md index 23492f385aa43..cd272c570573d 100644 --- a/docs/framework/unmanaged-api/hosting/corimageunloading-function.md +++ b/docs/framework/unmanaged-api/hosting/corimageunloading-function.md @@ -2,49 +2,49 @@ 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)] - + [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) +- [Metadata Global Static Functions](../../../core/unmanaged-api/metadata/metadata-global-static-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/corvalidateimage-function.md b/docs/framework/unmanaged-api/hosting/corvalidateimage-function.md index c2b91d387f4bc..827d9bf1b0694 100644 --- a/docs/framework/unmanaged-api/hosting/corvalidateimage-function.md +++ b/docs/framework/unmanaged-api/hosting/corvalidateimage-function.md @@ -2,84 +2,84 @@ 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)] - + [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) +- [Metadata Global Static Functions](../../../core/unmanaged-api/metadata/metadata-global-static-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/couninitializecor-function.md b/docs/framework/unmanaged-api/hosting/couninitializecor-function.md index b491716f17953..6e1a5d7cbdd94 100644 --- a/docs/framework/unmanaged-api/hosting/couninitializecor-function.md +++ b/docs/framework/unmanaged-api/hosting/couninitializecor-function.md @@ -2,35 +2,35 @@ 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. + +## Syntax + +```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. - 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 -- [Metadata Global Static Functions](../metadata/metadata-global-static-functions.md) +- [Metadata Global Static Functions](../../../core/unmanaged-api/metadata/metadata-global-static-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/couninitializeee-function.md b/docs/framework/unmanaged-api/hosting/couninitializeee-function.md index ff8f0ed97ccf6..5fddd3f75b494 100644 --- a/docs/framework/unmanaged-api/hosting/couninitializeee-function.md +++ b/docs/framework/unmanaged-api/hosting/couninitializeee-function.md @@ -2,38 +2,38 @@ 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) +- [Metadata Global Static Functions](../../../core/unmanaged-api/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) From e596d05607272819b0c80b339fbc5f5f3197d08b Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Fri, 27 Jun 2025 19:18:26 +0200 Subject: [PATCH 18/20] add redirects --- .openpublishing.redirection.framework.json | 1420 ++++++++++++++++++++ 1 file changed, 1420 insertions(+) diff --git a/.openpublishing.redirection.framework.json b/.openpublishing.redirection.framework.json index 86c062d8841ec..ab091664f7102 100644 --- a/.openpublishing.redirection.framework.json +++ b/.openpublishing.redirection.framework.json @@ -2357,6 +2357,1426 @@ "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/metadata-global-static-functions", + "redirect_document_id": true + }, + { + "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", From d3201b54a5cbb56d5513a28b822e5756f422e57c Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Fri, 27 Jun 2025 20:31:06 +0200 Subject: [PATCH 19/20] final touchups --- .openpublishing.redirection.framework.json | 2 +- docs/core/unmanaged-api/index.md | 4 +- .../metadata-global-static-functions.md | 22 --- docs/framework/unmanaged-api/index.md | 3 - docs/framework/unmanaged-api/toc.yml | 2 +- docs/navigate/tools-diagnostics/toc.yml | 150 +++++++++--------- 6 files changed, 79 insertions(+), 104 deletions(-) delete mode 100644 docs/core/unmanaged-api/metadata/metadata-global-static-functions.md diff --git a/.openpublishing.redirection.framework.json b/.openpublishing.redirection.framework.json index ab091664f7102..a30acc3e4797a 100644 --- a/.openpublishing.redirection.framework.json +++ b/.openpublishing.redirection.framework.json @@ -3754,7 +3754,7 @@ }, { "source_path_from_root": "/docs/framework/unmanaged-api/metadata/metadata-global-static-functions.md", - "redirect_url": "/dotnet/core/unmanaged-api/metadata/metadata-global-static-functions", + "redirect_url": "/dotnet/core/unmanaged-api/metadata/", "redirect_document_id": true }, { diff --git a/docs/core/unmanaged-api/index.md b/docs/core/unmanaged-api/index.md index ed4d0435d5f0d..bdafadace4228 100644 --- a/docs/core/unmanaged-api/index.md +++ b/docs/core/unmanaged-api/index.md @@ -7,7 +7,9 @@ ms.date: 09/19/2023 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). +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 diff --git a/docs/core/unmanaged-api/metadata/metadata-global-static-functions.md b/docs/core/unmanaged-api/metadata/metadata-global-static-functions.md deleted file mode 100644 index d736e6d88627b..0000000000000 --- a/docs/core/unmanaged-api/metadata/metadata-global-static-functions.md +++ /dev/null @@ -1,22 +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]" ---- -# 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](../../../framework/unmanaged-api/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/index.md b/docs/framework/unmanaged-api/index.md index 67a91602fc7f9..0b59fccdca7cd 100644 --- a/docs/framework/unmanaged-api/index.md +++ b/docs/framework/unmanaged-api/index.md @@ -29,9 +29,6 @@ For unmanaged APIs that can be used with both .NET Framework and .NET, see [.NET [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)\ Describes the debugging API, which enables a debugger to debug code that runs in the common language runtime (CLR) environment. diff --git a/docs/framework/unmanaged-api/toc.yml b/docs/framework/unmanaged-api/toc.yml index e0922db3284b9..c45e583d04a8e 100644 --- a/docs/framework/unmanaged-api/toc.yml +++ b/docs/framework/unmanaged-api/toc.yml @@ -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 diff --git a/docs/navigate/tools-diagnostics/toc.yml b/docs/navigate/tools-diagnostics/toc.yml index 88a9691eba559..0668174c533db 100644 --- a/docs/navigate/tools-diagnostics/toc.yml +++ b/docs/navigate/tools-diagnostics/toc.yml @@ -641,10 +641,10 @@ items: items: - name: Overview href: ../../core/unmanaged-api/metadata/index.md - - name: Metadata Interfaces + - name: Interfaces href: ../../core/unmanaged-api/metadata/metadata-interfaces.md items: - - name: ICeeGen Interface + - name: ICeeGen interface href: ../../core/unmanaged-api/metadata/iceegen-interface.md items: - name: AddSectionReloc Method @@ -677,17 +677,17 @@ items: href: ../../core/unmanaged-api/metadata/iceegen-getstringsection-method.md - name: TruncateSection Method href: ../../core/unmanaged-api/metadata/iceegen-truncatesection-method.md - - name: IHostFilter Interface + - 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 + - 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 + - name: IMetaDataAssemblyEmit interface href: ../../core/unmanaged-api/metadata/imetadataassemblyemit-interface.md items: - name: DefineAssembly Method @@ -710,7 +710,7 @@ items: href: ../../core/unmanaged-api/metadata/imetadataassemblyemit-setfileprops-method.md - name: SetManifestResourceProps Method href: ../../core/unmanaged-api/metadata/imetadataassemblyemit-setmanifestresourceprops-method.md - - name: IMetaDataAssemblyImport Interface + - name: IMetaDataAssemblyImport interface href: ../../core/unmanaged-api/metadata/imetadataassemblyimport-interface.md items: - name: CloseEnum Method @@ -741,7 +741,7 @@ items: href: ../../core/unmanaged-api/metadata/imetadataassemblyimport-getfileprops-method.md - name: GetManifestResourceProps Method href: ../../core/unmanaged-api/metadata/imetadataassemblyimport-getmanifestresourceprops-method.md - - name: IMetaDataConverter Interface + - name: IMetaDataConverter interface href: ../../core/unmanaged-api/metadata/imetadataconverter-interface.md items: - name: GetMetaDataFromTypeInfo Method @@ -750,7 +750,7 @@ items: href: ../../core/unmanaged-api/metadata/imetadataconverter-getmetadatafromtypelib-method.md - name: GetTypeLibFromMetaData Method href: ../../core/unmanaged-api/metadata/imetadataconverter-gettypelibfrommetadata-method.md - - name: IMetaDataDispenser Interface + - name: IMetaDataDispenser interface href: ../../core/unmanaged-api/metadata/imetadatadispenser-interface.md items: - name: DefineScope Method @@ -759,7 +759,7 @@ items: href: ../../core/unmanaged-api/metadata/imetadatadispenser-openscope-method.md - name: OpenScopeOnMemory Method href: ../../core/unmanaged-api/metadata/imetadatadispenser-openscopeonmemory-method.md - - name: IMetaDataDispenserEx Interface + - name: IMetaDataDispenserEx interface href: ../../core/unmanaged-api/metadata/imetadatadispenserex-interface.md items: - name: FindAssembly Method @@ -774,7 +774,7 @@ items: href: ../../core/unmanaged-api/metadata/imetadatadispenserex-openscopeonitypeinfo-method.md - name: SetOption Method href: ../../core/unmanaged-api/metadata/imetadatadispenserex-setoption-method.md - - name: IMetaDataEmit Interface + - name: IMetaDataEmit interface href: ../../core/unmanaged-api/metadata/imetadataemit-interface.md items: - name: ApplyEditAndContinue Method @@ -875,7 +875,7 @@ items: href: ../../core/unmanaged-api/metadata/imetadataemit-settypedefprops-method.md - name: TranslateSigWithScope Method href: ../../core/unmanaged-api/metadata/imetadataemit-translatesigwithscope-method.md - - name: IMetaDataEmit2 Interface + - name: IMetaDataEmit2 interface href: ../../core/unmanaged-api/metadata/imetadataemit2-interface.md items: - name: DefineGenericParam Method @@ -894,12 +894,12 @@ items: href: ../../core/unmanaged-api/metadata/imetadataemit2-savedeltatostream-method.md - name: SetGenericParamProps Method href: ../../core/unmanaged-api/metadata/imetadataemit2-setgenericparamprops-method.md - - name: IMetaDataError Interface + - 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 + - name: IMetaDataFilter interface href: ../../core/unmanaged-api/metadata/imetadatafilter-interface.md items: - name: IsTokenMarked Method @@ -908,7 +908,7 @@ items: href: ../../core/unmanaged-api/metadata/imetadatafilter-marktoken-method.md - name: UnmarkAll Method href: ../../core/unmanaged-api/metadata/imetadatafilter-unmarkall-method.md - - name: IMetaDataImport Interface + - name: IMetaDataImport interface href: ../../core/unmanaged-api/metadata/imetadataimport-interface.md items: - name: CloseEnum Method @@ -1035,7 +1035,7 @@ items: href: ../../core/unmanaged-api/metadata/imetadataimport-resetenum-method.md - name: ResolveTypeRef Method href: ../../core/unmanaged-api/metadata/imetadataimport-resolvetyperef-method.md - - name: IMetaDataImport2 Interface + - name: IMetaDataImport2 interface href: ../../core/unmanaged-api/metadata/imetadataimport2-interface.md items: - name: EnumGenericParamConstraints Method @@ -1054,12 +1054,12 @@ items: href: ../../core/unmanaged-api/metadata/imetadataimport2-getpekind-method.md - name: GetVersionString Method href: ../../core/unmanaged-api/metadata/imetadataimport2-getversionstring-method.md - - name: IMetaDataInfo Interface + - 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 + - name: IMetaDataTables interface href: ../../core/unmanaged-api/metadata/imetadatatables-interface.md items: - name: GetBlob Method @@ -1100,134 +1100,132 @@ items: href: ../../core/unmanaged-api/metadata/imetadatatables-getuserstring-method.md - name: GetUserStringHeapSize Method href: ../../core/unmanaged-api/metadata/imetadatatables-getuserstringheapsize-method.md - - name: IMetaDataTables2 Interface + - 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 + - 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: Metadata Global Static Functions - href: ../../core/unmanaged-api/metadata/metadata-global-static-functions.md - - name: Metadata Enumerations + - name: Enumerations href: ../../core/unmanaged-api/metadata/metadata-enumerations.md items: - - name: AssemblyFlags Enumeration + - name: AssemblyFlags enumeration href: ../../core/unmanaged-api/metadata/assemblyflags-enumeration.md - - name: AssemblyRefFlags Enumeration + - name: AssemblyRefFlags enumeration href: ../../core/unmanaged-api/metadata/assemblyrefflags-enumeration.md - - name: CeeSectionAttr Enumeration + - name: CeeSectionAttr enumeration href: ../../core/unmanaged-api/metadata/ceesectionattr-enumeration.md - - name: CeeSectionRelocType Enumeration + - name: CeeSectionRelocType enumeration href: ../../core/unmanaged-api/metadata/ceesectionreloctype-enumeration.md - - name: COINITICOR Enumeration + - name: COINITICOR enumeration href: ../../core/unmanaged-api/metadata/coiniticor-enumeration.md - - name: COINITIEE Enumeration + - name: COINITIEE enumeration href: ../../core/unmanaged-api/metadata/coinitiee-enumeration.md - - name: CorArgType Enumeration + - name: CorArgType enumeration href: ../../core/unmanaged-api/metadata/corargtype-enumeration.md - - name: CorAssemblyFlags Enumeration + - name: CorAssemblyFlags enumeration href: ../../core/unmanaged-api/metadata/corassemblyflags-enumeration.md - - name: CorAttributeTargets Enumeration + - name: CorAttributeTargets enumeration href: ../../core/unmanaged-api/metadata/corattributetargets-enumeration.md - - name: CorCallingConvention Enumeration + - name: CorCallingConvention enumeration href: ../../core/unmanaged-api/metadata/corcallingconvention-enumeration.md - - name: CorCheckDuplicatesFor Enumeration + - name: CorCheckDuplicatesFor enumeration href: ../../core/unmanaged-api/metadata/corcheckduplicatesfor-enumeration.md - - name: CorDeclSecurity Enumeration + - name: CorDeclSecurity enumeration href: ../../core/unmanaged-api/metadata/cordeclsecurity-enumeration.md - - name: CorElementType Enumeration1 + - name: CorElementType enumeration1 href: ../../core/unmanaged-api/metadata/corelementtype-enumeration.md - - name: CorErrorIfEmitOutOfOrder Enumeration + - name: CorErrorIfEmitOutOfOrder enumeration href: ../../core/unmanaged-api/metadata/corerrorifemitoutoforder-enumeration.md - - name: CorEventAttr Enumeration + - name: CorEventAttr enumeration href: ../../core/unmanaged-api/metadata/coreventattr-enumeration.md - - name: CorFieldAttr Enumeration + - name: CorFieldAttr enumeration href: ../../core/unmanaged-api/metadata/corfieldattr-enumeration.md - - name: CorFileFlags Enumeration + - name: CorFileFlags enumeration href: ../../core/unmanaged-api/metadata/corfileflags-enumeration.md - - name: CorFileMapping Enumeration + - name: CorFileMapping enumeration href: ../../core/unmanaged-api/metadata/corfilemapping-enumeration.md - - name: CorGenericParamAttr Enumeration + - name: CorGenericParamAttr enumeration href: ../../core/unmanaged-api/metadata/corgenericparamattr-enumeration.md - - name: CorImportOptions Enumeration + - name: CorImportOptions enumeration href: ../../core/unmanaged-api/metadata/corimportoptions-enumeration.md - - name: CorLinkerOptions Enumeration + - name: CorLinkerOptions enumeration href: ../../core/unmanaged-api/metadata/corlinkeroptions-enumeration.md - - name: CorLocalRefPreservation Enumeration + - name: CorLocalRefPreservation enumeration href: ../../core/unmanaged-api/metadata/corlocalrefpreservation-enumeration.md - - name: CorManifestResourceFlags Enumeration + - name: CorManifestResourceFlags enumeration href: ../../core/unmanaged-api/metadata/cormanifestresourceflags-enumeration.md - - name: CorMethodAttr Enumeration + - name: CorMethodAttr enumeration href: ../../core/unmanaged-api/metadata/cormethodattr-enumeration.md - - name: CorMethodImpl Enumeration + - name: CorMethodImpl enumeration href: ../../core/unmanaged-api/metadata/cormethodimpl-enumeration.md - - name: CorMethodSemanticsAttr Enumeration + - name: CorMethodSemanticsAttr enumeration href: ../../core/unmanaged-api/metadata/cormethodsemanticsattr-enumeration.md - - name: CorNativeLinkFlags Enumeration + - name: CorNativeLinkFlags enumeration href: ../../core/unmanaged-api/metadata/cornativelinkflags-enumeration.md - - name: CorNativeLinkType Enumeration + - name: CorNativeLinkType enumeration href: ../../core/unmanaged-api/metadata/cornativelinktype-enumeration.md - - name: CorNativeType Enumeration + - name: CorNativeType enumeration href: ../../core/unmanaged-api/metadata/cornativetype-enumeration.md - - name: CorNotificationForTokenMovement Enumeration + - name: CorNotificationForTokenMovement enumeration href: ../../core/unmanaged-api/metadata/cornotificationfortokenmovement-enumeration.md - - name: CorOpenFlags Enumeration + - name: CorOpenFlags enumeration href: ../../core/unmanaged-api/metadata/coropenflags-enumeration.md - - name: CorParamAttr Enumeration + - name: CorParamAttr enumeration href: ../../core/unmanaged-api/metadata/corparamattr-enumeration.md - - name: CorPEKind Enumeration + - name: CorPEKind enumeration href: ../../core/unmanaged-api/metadata/corpekind-enumeration.md - - name: CorPinvokeMap Enumeration + - name: CorPinvokeMap enumeration href: ../../core/unmanaged-api/metadata/corpinvokemap-enumeration.md - - name: CorPropertyAttr Enumeration + - name: CorPropertyAttr enumeration href: ../../core/unmanaged-api/metadata/corpropertyattr-enumeration.md - - name: CorRefToDefCheck Enumeration + - name: CorRefToDefCheck enumeration href: ../../core/unmanaged-api/metadata/correftodefcheck-enumeration.md - - name: CorRegFlags Enumeration + - name: CorRegFlags enumeration href: ../../core/unmanaged-api/metadata/corregflags-enumeration.md - - name: CorSaveSize Enumeration + - name: CorSaveSize enumeration href: ../../core/unmanaged-api/metadata/corsavesize-enumeration.md - - name: CorSerializationType Enumeration + - name: CorSerializationType enumeration href: ../../core/unmanaged-api/metadata/corserializationtype-enumeration.md - - name: CorSetENC Enumeration + - name: CorSetENC enumeration href: ../../core/unmanaged-api/metadata/corsetenc-enumeration.md - - name: CorThreadSafetyOptions Enumeration + - name: CorThreadSafetyOptions enumeration href: ../../core/unmanaged-api/metadata/corthreadsafetyoptions-enumeration.md - - name: CorTokenType Enumeration + - name: CorTokenType enumeration href: ../../core/unmanaged-api/metadata/cortokentype-enumeration.md - - name: CorTypeAttr Enumeration + - name: CorTypeAttr enumeration href: ../../core/unmanaged-api/metadata/cortypeattr-enumeration.md - - name: CorUnmanagedCallingConvention Enumeration + - name: CorUnmanagedCallingConvention enumeration href: ../../core/unmanaged-api/metadata/corunmanagedcallingconvention-enumeration.md - - name: CorValidatorModuleType Enumeration + - name: CorValidatorModuleType enumeration href: ../../core/unmanaged-api/metadata/corvalidatormoduletype-enumeration.md - - name: COUNINITIEE Enumeration + - name: COUNINITIEE enumeration href: ../../core/unmanaged-api/metadata/couninitiee-enumeration.md - - name: Metadata Structures + - name: Structures href: ../../core/unmanaged-api/metadata/metadata-structures.md items: - - name: ASSEMBLYMETADATA Structure + - name: ASSEMBLYMETADATA structure href: ../../core/unmanaged-api/metadata/assemblymetadata-structure.md - - name: COR_FIELD_OFFSET Structure + - name: COR_FIELD_OFFSET structure href: ../../core/unmanaged-api/metadata/cor-field-offset-structure.md - - name: COR_NATIVE_LINK Structure + - name: COR_NATIVE_LINK structure href: ../../core/unmanaged-api/metadata/cor-native-link-structure.md - - name: CVStruct Structure + - name: CVStruct structure href: ../../core/unmanaged-api/metadata/cvstruct-structure.md - - name: OSINFO Structure + - name: OSINFO structure href: ../../core/unmanaged-api/metadata/osinfo-structure.md - - name: Metadata Unions + - name: Unions href: ../../core/unmanaged-api/metadata/metadata-unions.md items: - - name: CeeSectionRelocExtra Union + - name: CeeSectionRelocExtra union href: ../../core/unmanaged-api/metadata/ceesectionrelocextra-union.md - name: Profiling items: From 98f9ceeaf8c0289525f33618107227bca77a96ca Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Fri, 27 Jun 2025 21:22:53 +0200 Subject: [PATCH 20/20] fix build warnings --- .openpublishing.redirection.framework.json | 3 +-- docs/core/unmanaged-api/metadata/index.md | 3 --- .../metadata/metadata-enumerations.md | 16 ++++++---------- .../metadata/metadata-interfaces.md | 16 ++++++---------- .../metadata/metadata-structures.md | 16 ++++++---------- .../unmanaged-api/metadata/metadata-unions.md | 16 ++++++---------- .../hosting/coeeshutdowncom-function.md | 4 ---- .../hosting/coinitializecor-function.md | 4 ---- .../hosting/coinitializeee-function.md | 4 ---- .../unmanaged-api/hosting/cordllmain-function.md | 4 ---- .../unmanaged-api/hosting/corexemain-function.md | 4 ---- .../hosting/corexemain2-function.md | 4 ---- .../hosting/corimageunloading-function.md | 4 ---- .../hosting/corvalidateimage-function.md | 4 ---- .../hosting/couninitializecor-function.md | 4 ---- .../hosting/couninitializeee-function.md | 1 - 16 files changed, 25 insertions(+), 82 deletions(-) diff --git a/.openpublishing.redirection.framework.json b/.openpublishing.redirection.framework.json index a30acc3e4797a..20f7232d050d0 100644 --- a/.openpublishing.redirection.framework.json +++ b/.openpublishing.redirection.framework.json @@ -3754,8 +3754,7 @@ }, { "source_path_from_root": "/docs/framework/unmanaged-api/metadata/metadata-global-static-functions.md", - "redirect_url": "/dotnet/core/unmanaged-api/metadata/", - "redirect_document_id": true + "redirect_url": "/dotnet/core/unmanaged-api/metadata/" }, { "source_path_from_root": "/docs/framework/unmanaged-api/metadata/metadata-interfaces.md", diff --git a/docs/core/unmanaged-api/metadata/index.md b/docs/core/unmanaged-api/metadata/index.md index c447c48fdcad5..496371fa39e9b 100644 --- a/docs/core/unmanaged-api/metadata/index.md +++ b/docs/core/unmanaged-api/metadata/index.md @@ -18,9 +18,6 @@ These APIs that can be used with both .NET Framework and .NET. [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 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. diff --git a/docs/core/unmanaged-api/metadata/metadata-enumerations.md b/docs/core/unmanaged-api/metadata/metadata-enumerations.md index b2a2f0772ac5f..2890909237acf 100644 --- a/docs/core/unmanaged-api/metadata/metadata-enumerations.md +++ b/docs/core/unmanaged-api/metadata/metadata-enumerations.md @@ -7,11 +7,11 @@ helpviewer_keywords: - "metadata enumerations [.NET Framework]" - "unmanaged enumerations [.NET Framework], metadata" --- -# Metadata Enumerations +# Metadata enumerations This section describes the unmanaged enumerations that the metadata API uses. -## In This Section +## In this section [AssemblyFlags Enumeration](assemblyflags-enumeration.md) Contains values that describe the run-time features of an assembly. @@ -151,12 +151,8 @@ This section describes the unmanaged enumerations that the metadata API uses. [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 +## 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) +- [Metadata Interfaces](metadata-interfaces.md) +- [Metadata Structures](metadata-structures.md) +- [Metadata Unions](metadata-unions.md) diff --git a/docs/core/unmanaged-api/metadata/metadata-interfaces.md b/docs/core/unmanaged-api/metadata/metadata-interfaces.md index 994d97762b04d..ca64f7eb4dd1b 100644 --- a/docs/core/unmanaged-api/metadata/metadata-interfaces.md +++ b/docs/core/unmanaged-api/metadata/metadata-interfaces.md @@ -7,11 +7,11 @@ helpviewer_keywords: - "metadata interfaces [.NET Framework]" - "interfaces (.NET Framework metadata]" --- -# Metadata Interfaces +# 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 +## In this section [ICeeGen Interface](iceegen-interface.md) Provides methods for dynamic code compilation. @@ -67,12 +67,8 @@ This section describes the unmanaged interfaces that provide access to the metad [IMetaDataValidate Interface](imetadatavalidate-interface.md) Provides methods to use for validation of metadata signatures. -## Related Sections +## 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 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 index 657ce90aab8b7..269ab930bce92 100644 --- a/docs/core/unmanaged-api/metadata/metadata-structures.md +++ b/docs/core/unmanaged-api/metadata/metadata-structures.md @@ -7,11 +7,11 @@ helpviewer_keywords: - "unmanaged structures [.NET Framework], metadata" - "metadata structures [.NET Framework]" --- -# Metadata Structures +# Metadata structures This section describes the unmanaged structures that the metadata API uses. -## In This Section +## In this section ASSEMBLYMETADATA Stores assembly metadata for later use. @@ -28,12 +28,8 @@ This section describes the unmanaged structures that the metadata API uses. [OSINFO Structure](osinfo-structure.md) Contains information about the operating system. -## Related Sections +## 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) +- [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 index 14695a1e17a8a..b15f7a6ddf03e 100644 --- a/docs/core/unmanaged-api/metadata/metadata-unions.md +++ b/docs/core/unmanaged-api/metadata/metadata-unions.md @@ -7,21 +7,17 @@ helpviewer_keywords: - "unions [.NET Framework metadata]" - "metadata unions [.NET Framework]" --- -# Metadata Unions +# Metadata unions This section describes the unmanaged unions that the metadata API uses. -## In This Section +## 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 +## 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) +- [Metadata Interfaces](metadata-interfaces.md) +- [Metadata Enumerations](metadata-enumerations.md) +- [Metadata Structures](metadata-structures.md) diff --git a/docs/framework/unmanaged-api/hosting/coeeshutdowncom-function.md b/docs/framework/unmanaged-api/hosting/coeeshutdowncom-function.md index 0254f52db3897..525a5c939dada 100644 --- a/docs/framework/unmanaged-api/hosting/coeeshutdowncom-function.md +++ b/docs/framework/unmanaged-api/hosting/coeeshutdowncom-function.md @@ -48,7 +48,3 @@ void CoEEShutDownCOM (); **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](../../../core/unmanaged-api/metadata/metadata-global-static-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/coinitializecor-function.md b/docs/framework/unmanaged-api/hosting/coinitializecor-function.md index 18aa825d97cce..fc9cbba7853a7 100644 --- a/docs/framework/unmanaged-api/hosting/coinitializecor-function.md +++ b/docs/framework/unmanaged-api/hosting/coinitializecor-function.md @@ -36,7 +36,3 @@ STDAPI CoInitializeCor ( ## Requirements **Header:** Cor.h - -## See also - -- [Metadata Global Static Functions](../../../core/unmanaged-api/metadata/metadata-global-static-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/coinitializeee-function.md b/docs/framework/unmanaged-api/hosting/coinitializeee-function.md index c5872abff03d6..23accef892f40 100644 --- a/docs/framework/unmanaged-api/hosting/coinitializeee-function.md +++ b/docs/framework/unmanaged-api/hosting/coinitializeee-function.md @@ -57,7 +57,3 @@ HRESULT CoInitializeEE ( **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](../../../core/unmanaged-api/metadata/metadata-global-static-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/cordllmain-function.md b/docs/framework/unmanaged-api/hosting/cordllmain-function.md index 43c361ed27521..b8a55302638e7 100644 --- a/docs/framework/unmanaged-api/hosting/cordllmain-function.md +++ b/docs/framework/unmanaged-api/hosting/cordllmain-function.md @@ -64,7 +64,3 @@ The `_CorDllMain` function is called directly by the operating system loader. **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](../../../core/unmanaged-api/metadata/metadata-global-static-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/corexemain-function.md b/docs/framework/unmanaged-api/hosting/corexemain-function.md index 177b14d9ca616..42a82de85b994 100644 --- a/docs/framework/unmanaged-api/hosting/corexemain-function.md +++ b/docs/framework/unmanaged-api/hosting/corexemain-function.md @@ -46,7 +46,3 @@ __int32 STDMETHODCALLTYPE _CorExeMain (); **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](../../../core/unmanaged-api/metadata/metadata-global-static-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/corexemain2-function.md b/docs/framework/unmanaged-api/hosting/corexemain2-function.md index ae6bea2f865e6..12f4583535cb0 100644 --- a/docs/framework/unmanaged-api/hosting/corexemain2-function.md +++ b/docs/framework/unmanaged-api/hosting/corexemain2-function.md @@ -58,7 +58,3 @@ __int32 STDMETHODCALLTYPE _CorExeMain2 ( **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](../../../core/unmanaged-api/metadata/metadata-global-static-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/corimageunloading-function.md b/docs/framework/unmanaged-api/hosting/corimageunloading-function.md index cd272c570573d..80cdc92f3dced 100644 --- a/docs/framework/unmanaged-api/hosting/corimageunloading-function.md +++ b/docs/framework/unmanaged-api/hosting/corimageunloading-function.md @@ -44,7 +44,3 @@ STDAPI (VOID) _CorImageUnloading( **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](../../../core/unmanaged-api/metadata/metadata-global-static-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/corvalidateimage-function.md b/docs/framework/unmanaged-api/hosting/corvalidateimage-function.md index 827d9bf1b0694..8504a343a78a9 100644 --- a/docs/framework/unmanaged-api/hosting/corvalidateimage-function.md +++ b/docs/framework/unmanaged-api/hosting/corvalidateimage-function.md @@ -79,7 +79,3 @@ STDAPI _CorValidateImage ( **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](../../../core/unmanaged-api/metadata/metadata-global-static-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/couninitializecor-function.md b/docs/framework/unmanaged-api/hosting/couninitializecor-function.md index 6e1a5d7cbdd94..b9636f83320ea 100644 --- a/docs/framework/unmanaged-api/hosting/couninitializecor-function.md +++ b/docs/framework/unmanaged-api/hosting/couninitializecor-function.md @@ -30,7 +30,3 @@ 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. - -## See also - -- [Metadata Global Static Functions](../../../core/unmanaged-api/metadata/metadata-global-static-functions.md) diff --git a/docs/framework/unmanaged-api/hosting/couninitializeee-function.md b/docs/framework/unmanaged-api/hosting/couninitializeee-function.md index 5fddd3f75b494..301980921d013 100644 --- a/docs/framework/unmanaged-api/hosting/couninitializeee-function.md +++ b/docs/framework/unmanaged-api/hosting/couninitializeee-function.md @@ -36,4 +36,3 @@ void CoUninitializeEE ( ## See also - [CoInitializeEE Function](coinitializeee-function.md) -- [Metadata Global Static Functions](../../../core/unmanaged-api/metadata/metadata-global-static-functions.md)