diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index 3a37dd275a1..8bf90bb8b99 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -2335,6 +2335,11 @@ "redirect_url": "/visualstudio/ide/refactoring-in-visual-studio", "redirect_document_id": false }, + { + "source_path": "docs/vs-2015/misc/warning-the-dependency-file-in-project-project-cannot-be-copied-to-the-run-directory-because-it-would-overwrite-the-reference-file.md", + "redirect_url": "/visualstudio/vs-2015/misc/warning-the-dependency-file-in-project-project-cannot-be-copied", + "redirect_document_id": false + }, { "source_path": "docs/vsto/index.md", "redirect_url": "/visualstudio/vsto/office-and-sharepoint-development-in-visual-studio", @@ -2721,6 +2726,751 @@ "redirect_url": "/microsoft-edge/hosting/javascript-runtime-hosting", "redirect_document_id": false }, + { + "source_path": "scripting-docs/chakra-hosting/reference-javascript-runtime.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/reference-javascript-runtime", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/hosting-the-javascript-runtime.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/hosting-the-javascript-runtime", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/targeting-edge-vs-legacy-engines-in-jsrt-apis.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/targeting-edge-vs-legacy-engines-in-jsrt-apis", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/javascript-runtime-typedefs-constants-and-enumerations.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/javascript-runtime-typedefs-constants-and-enumerations", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsbackgroundworkitemcallback-typedef.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsbackgroundworkitemcallback-typedef", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsbeforecollectcallback-typedef.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsbeforecollectcallback-typedef", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jscontextref-typedef.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jscontextref-typedef", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsfinalizecallback-typedef.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsfinalizecallback-typedef", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsmemoryallocationcallback-typedef.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsmemoryallocationcallback-typedef", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsnativefunction-typedef.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsnativefunction-typedef", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsobjectbeforecollectcallback-typedef.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsobjectbeforecollectcallback-typedef", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsprojectioncallback-typedef.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsprojectioncallback-typedef", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsprojectioncallbackcontext-typedef.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsprojectioncallbackcontext-typedef", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsprojectionenqueuecallback-typedef.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsprojectionenqueuecallback-typedef", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jspromisecontinuationcallback-typedef.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jspromisecontinuationcallback-typedef", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jspropertyidref-typedef.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jspropertyidref-typedef", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsref-typedef.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsref-typedef", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsruntimehandle-typedef.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsruntimehandle-typedef", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsserializedscriptloadsourcecallback-typedef.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsserializedscriptloadsourcecallback-typedef", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsserializedscriptunloadcallback-typedef.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsserializedscriptunloadcallback-typedef", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jssourcecontext-typedef.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jssourcecontext-typedef", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsthreadservicecallback-typedef.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsthreadservicecallback-typedef", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsvalueref-typedef.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsvalueref-typedef", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/js-invalid-propertyid-constant.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/js-invalid-propertyid-constant", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/js-invalid-reference-constant.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/js-invalid-reference-constant", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/js-invalid-runtime-handle-constant.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/js-invalid-runtime-handle-constant", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/js-source-context-none-constant.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/js-source-context-none-constant", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jserrorcode-enumeration.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jserrorcode-enumeration", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsmemoryeventtype-enumeration.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsmemoryeventtype-enumeration", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jspropertyidtype-enumeration.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jspropertyidtype-enumeration", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsruntimeattributes-enumeration.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsruntimeattributes-enumeration", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsruntimeversion-enumeration.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsruntimeversion-enumeration", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jstypedarraytype-enumeration.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jstypedarraytype-enumeration", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsvaluetype-enumeration.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsvaluetype-enumeration", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsaddref-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsaddref-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsbooleantobool-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsbooleantobool-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsbooltoboolean-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsbooltoboolean-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jscallfunction-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jscallfunction-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jscollectgarbage-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jscollectgarbage-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsconstructobject-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsconstructobject-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsconvertvaluetoboolean-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsconvertvaluetoboolean-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsconvertvaluetonumber-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsconvertvaluetonumber-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsconvertvaluetoobject-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsconvertvaluetoobject-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsconvertvaluetostring-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsconvertvaluetostring-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jscreatearray-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jscreatearray-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jscreatearraybuffer-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jscreatearraybuffer-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jscreatecontext-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jscreatecontext-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jscreatedataview-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jscreatedataview-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jscreateerror-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jscreateerror-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jscreateexternalarraybuffer-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jscreateexternalarraybuffer-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jscreateexternalobject-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jscreateexternalobject-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jscreatefunction-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jscreatefunction-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jscreatenamedfunction-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jscreatenamedfunction-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jscreateobject-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jscreateobject-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jscreaterangeerror-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jscreaterangeerror-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jscreatereferenceerror-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jscreatereferenceerror-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jscreateruntime-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jscreateruntime-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jscreatesymbol-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jscreatesymbol-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jscreatesyntaxerror-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jscreatesyntaxerror-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jscreatetypeerror-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jscreatetypeerror-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jscreatetypedarray-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jscreatetypedarray-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jscreateurierror-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jscreateurierror-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsdefineproperty-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsdefineproperty-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsdeleteindexedproperty-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsdeleteindexedproperty-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsdeleteproperty-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsdeleteproperty-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsdisableruntimeexecution-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsdisableruntimeexecution-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsdisposeruntime-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsdisposeruntime-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsdoubletonumber-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsdoubletonumber-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsenableruntimeexecution-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsenableruntimeexecution-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsenumerateheap-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsenumerateheap-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsequals-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsequals-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetandclearexception-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetandclearexception-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetarraybufferstorage-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetarraybufferstorage-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetcontextdata-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetcontextdata-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetcontextofobject-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetcontextofobject-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetcurrentcontext-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetcurrentcontext-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetdataviewstorage-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetdataviewstorage-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetextensionallowed-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetextensionallowed-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetexternaldata-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetexternaldata-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetfalsevalue-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetfalsevalue-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetglobalobject-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetglobalobject-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetindexedpropertiesexternaldata-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetindexedpropertiesexternaldata-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetindexedproperty-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetindexedproperty-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetnullvalue-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetnullvalue-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetownpropertydescriptor-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetownpropertydescriptor-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetownpropertynames-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetownpropertynames-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetownpropertysymbols-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetownpropertysymbols-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetproperty-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetproperty-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetpropertyidfromname-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetpropertyidfromname-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetpropertyidfromsymbol-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetpropertyidfromsymbol-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetpropertyidtype-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetpropertyidtype-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetpropertynamefromid-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetpropertynamefromid-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetprototype-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetprototype-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetruntime-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetruntime-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetruntimememorylimit-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetruntimememorylimit-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetruntimememoryusage-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetruntimememoryusage-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetstringlength-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetstringlength-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetsymbolfrompropertyid-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetsymbolfrompropertyid-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgettruevalue-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgettruevalue-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgettypedarrayinfo-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgettypedarrayinfo-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgettypedarraystorage-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgettypedarraystorage-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetundefinedvalue-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetundefinedvalue-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsgetvaluetype-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsgetvaluetype-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jshasexception-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jshasexception-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jshasexternaldata-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jshasexternaldata-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jshasindexedpropertiesexternaldata-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jshasindexedpropertiesexternaldata-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jshasindexedproperty-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jshasindexedproperty-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jshasproperty-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jshasproperty-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsidle-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsidle-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsinspectabletoobject-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsinspectabletoobject-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsinstanceof-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsinstanceof-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsinttonumber-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsinttonumber-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsisenumeratingheap-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsisenumeratingheap-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsisruntimeexecutiondisabled-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsisruntimeexecutiondisabled-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsnumbertodouble-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsnumbertodouble-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsnumbertoint-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsnumbertoint-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsobjecttoinspectable-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsobjecttoinspectable-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsparsescript-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsparsescript-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsparseserializedscript-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsparseserializedscript-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsparseserializedscriptwithcallback-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsparseserializedscriptwithcallback-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jspointertostring-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jspointertostring-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jspreventextension-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jspreventextension-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsprojectwinrtnamespace-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsprojectwinrtnamespace-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsrelease-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsrelease-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsrunscript-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsrunscript-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsrunserializedscript-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsrunserializedscript-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsrunserializedscriptwithcallback-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsrunserializedscriptwithcallback-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsserializescript-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsserializescript-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jssetcontextdata-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jssetcontextdata-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jssetcurrentcontext-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jssetcurrentcontext-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jssetexception-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jssetexception-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jssetexternaldata-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jssetexternaldata-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jssetindexedpropertiestoexternaldata-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jssetindexedpropertiestoexternaldata-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jssetindexedproperty-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jssetindexedproperty-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jssetobjectbeforecollectcallback-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jssetobjectbeforecollectcallback-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jssetprojectionenqueuecallback-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jssetprojectionenqueuecallback-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jssetpromisecontinuationcallback-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jssetpromisecontinuationcallback-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jssetproperty-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jssetproperty-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jssetprototype-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jssetprototype-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jssetruntimebeforecollectcallback-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jssetruntimebeforecollectcallback-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jssetruntimememoryallocationcallback-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jssetruntimememoryallocationcallback-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jssetruntimememorylimit-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jssetruntimememorylimit-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsstartdebugging-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsstartdebugging-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsstartprofiling-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsstartprofiling-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsstopprofiling-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsstopprofiling-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsstrictequals-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsstrictequals-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsstringtopointer-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsstringtopointer-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsvaluetovariant-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsvaluetovariant-function", + "redirect_document_id": false + }, + { + "source_path": "scripting-docs/chakra-hosting/jsvarianttovalue-function.md", + "redirect_url": "/microsoft-edge/hosting/chakra-hosting/jsvarianttovalue-function", + "redirect_document_id": false + }, { "source_path": "scripting-docs/javascript/advanced/index.md", "redirect_url": "/script/javascript/advanced/advanced-javascript", diff --git a/docs/deployment/tutorial-kubernetes-tools.md b/docs/deployment/tutorial-kubernetes-tools.md index 1899f87a042..eb3c9f80df4 100644 --- a/docs/deployment/tutorial-kubernetes-tools.md +++ b/docs/deployment/tutorial-kubernetes-tools.md @@ -12,7 +12,7 @@ ms.workload: --- # Get started with Visual Studio Kubernetes Tools -The Visual Studio Kubernetes Tools help streamline the development of containerized applications targeting Kubernetes. Visual Studio can automatically create the configuration-as-code files needed to support Kubernetes deployment, such as Dockerfiles and Helm charts. In addition, you can publish directly to an Azure Kubernetes Service (AKS) cluster from Visual Studio. +The Visual Studio Kubernetes Tools help streamline the development of containerized applications targeting Kubernetes. Visual Studio can automatically create the configuration-as-code files needed to support Kubernetes deployment, such as Dockerfiles and Helm charts. You can debug your code in a live Azure Kubernetes Service (AKS) cluster using Azure Dev Spaces, or publish directly to an AKS cluster from inside Visual Studio. ## Prerequisites @@ -22,7 +22,7 @@ To leverage this new functionality, you'll need: - The [Kubernetes tools for Visual Studio](https://aka.ms/get-vsk8stools), available as a separate download. -- [Docker for Windows](https://store.docker.com/editions/community/docker-ce-desktop-windows) installed on your development workstation (that is, where you run Visual Studio) +- [Docker for Windows](https://store.docker.com/editions/community/docker-ce-desktop-windows) installed on your development workstation (that is, where you run Visual Studio), if you wish to build Docker images, debug Docker containers running locally, or publish to AKS. - If you wish to publish to AKS from Visual Studio: @@ -71,7 +71,7 @@ The added files are: - a Helm chart, and a *charts* folder. These yaml files make up the Helm chart for the application, which you can use to deploy it to Kubernetes. For more information on Helm, see [https://www.helm.sh](https://www.helm.sh). -- *azds.yaml*. This contains settings for Azure Dev Spaces, a new service that provides a rapid, iterative debugging experience in Azure Kubernetes Service. This file is currently unused, but is reserved for future use by Azure Dev Spaces. +- *azds.yaml*. This contains settings for Azure Dev Spaces, which provides a rapid, iterative debugging experience in Azure Kubernetes Service. For more information, please reference [the Azure Dev Spaces documentation](https://docs.microsoft.com/azure/dev-spaces/azure-dev-spaces). ## Publish to Azure Kubernetes Service (AKS) diff --git a/docs/install/advanced-build-tools-container.md b/docs/install/advanced-build-tools-container.md index e7425d61641..42721981350 100644 --- a/docs/install/advanced-build-tools-container.md +++ b/docs/install/advanced-build-tools-container.md @@ -111,16 +111,7 @@ The command 'cmd /S /C C:\TEMP\Install.cmd C:\TEMP\vs_buildtools.exe ...' return After the last line finishes executing, open "%TEMP%\vslogs.zip" on your machine, or submit an issue on the [Developer Community](https://developercommunity.visualstudio.com) web site. -## Get support - -Sometimes, things can go wrong. If your Visual Studio install fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/automated-installation-with-response-file.md b/docs/install/automated-installation-with-response-file.md index 16c6258da12..b35d5a9bd9e 100644 --- a/docs/install/automated-installation-with-response-file.md +++ b/docs/install/automated-installation-with-response-file.md @@ -90,16 +90,7 @@ The following example installs Visual Studio Enterprise with six common workload } ``` -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/automatically-apply-product-keys-when-deploying-visual-studio.md b/docs/install/automatically-apply-product-keys-when-deploying-visual-studio.md index c1098b0b516..bc592f82ea9 100644 --- a/docs/install/automatically-apply-product-keys-when-deploying-visual-studio.md +++ b/docs/install/automatically-apply-product-keys-when-deploying-visual-studio.md @@ -55,16 +55,7 @@ If `StorePID.exe` successfully applies the product key, it returns an `%ERRORLEV | `PID_ACTION_FAILURE` | 5 | | `PID_ACTION_NOUPGRADE` | 6 | -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/build-tools-container-issues.md b/docs/install/build-tools-container-issues.md index a33e4cf66a3..7f361514be3 100644 --- a/docs/install/build-tools-container-issues.md +++ b/docs/install/build-tools-container-issues.md @@ -36,16 +36,7 @@ The following known issues might occur when you use a Build Tools container. To * IntelliTrace may not work in [some scenarios](https://github.com/Microsoft/vstest/issues/940) within a container. -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/build-tools-container.md b/docs/install/build-tools-container.md index 6f55f27f62d..83fbdf3282b 100644 --- a/docs/install/build-tools-container.md +++ b/docs/install/build-tools-container.md @@ -184,16 +184,7 @@ Now that you have created an image, you can run it in a container to do both int To use this image for your CI/CD workflow, you can publish it to your own [Azure Container Registry](https://azure.microsoft.com/services/container-registry) or other internal [Docker registry](https://docs.docker.com/registry/deploying) so servers only need to pull it. -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/change-installation-locations.md b/docs/install/change-installation-locations.md index 3f396b0899f..94cd232f877 100644 --- a/docs/install/change-installation-locations.md +++ b/docs/install/change-installation-locations.md @@ -46,16 +46,7 @@ Here's how. > [!NOTE] > There are some tools and SDKs that have different rules on where they can be are installed. These tools and SDKs will still be installed on your system drive even if you choose another location.) -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page for help. You can also contact us for installation help by [live chat](https://visualstudio.microsoft.com/vs/support/#talktous) (English only); for more information, see the [Visual Studio "Contact Us" page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/command-line-parameter-examples.md b/docs/install/command-line-parameter-examples.md index 85967c205e1..59f9ee2294f 100644 --- a/docs/install/command-line-parameter-examples.md +++ b/docs/install/command-line-parameter-examples.md @@ -123,16 +123,7 @@ These command-line parameters are **new in 15.7**. For more information about th `vs_enterprise.exe --add Microsoft.VisualStudio.Workload.CoreEditor --path install="C:\VS"` -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/controlling-updates-to-visual-studio-deployments.md b/docs/install/controlling-updates-to-visual-studio-deployments.md index 5d97835d226..121a957babc 100644 --- a/docs/install/controlling-updates-to-visual-studio-deployments.md +++ b/docs/install/controlling-updates-to-visual-studio-deployments.md @@ -79,16 +79,7 @@ vsregedit.exe set "C:\Program Files (x86)\Microsoft Visual Studio\2017\Enterpris > [!TIP] > Use [vswhere.exe](tools-for-managing-visual-studio-instances.md#detecting-existing-visual-studio-instances) to find a specific instance of Visual Studio on a client workstation. -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/create-a-network-installation-of-visual-studio.md b/docs/install/create-a-network-installation-of-visual-studio.md index eb867dda85c..dcf01fd1d14 100644 --- a/docs/install/create-a-network-installation-of-visual-studio.md +++ b/docs/install/create-a-network-installation-of-visual-studio.md @@ -142,18 +142,9 @@ If you need to create a layout for an older version of Visual Studio 2017, you c If you experience a problem with your offline installation, we want to know about it. The best way to tell us is by using the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool. When you use this tool, you can send us the telemetry and logs we need to help us diagnose and fix the problem. -We have other support options available, too. For a list, see our [Talk to us](../ide/how-to-report-a-problem-with-visual-studio-2017.md) page. - -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). +We also offer a [**live chat**](https://visualstudio.microsoft.com/vs/support/#talktous) (English only) support option for installation-related issues. -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +We have other support options available, too. For a list, see our [Talk to us](../ide/how-to-report-a-problem-with-visual-studio-2017.md) page. ## See also diff --git a/docs/install/create-an-offline-installation-of-visual-studio.md b/docs/install/create-an-offline-installation-of-visual-studio.md index be70b05ea7c..8341342f613 100644 --- a/docs/install/create-an-offline-installation-of-visual-studio.md +++ b/docs/install/create-an-offline-installation-of-visual-studio.md @@ -36,13 +36,4 @@ If you want to install offline because your internet connection is unavailable o > [!NOTE] > If you are an enterprise administrator who wants to perform a deployment of Visual Studio 2017 to a network of client workstations that are firewalled from the internet, see our [Create a network installation of Visual Studio 2017](../install/create-a-network-installation-of-visual-studio.md) and [Install certificates required for Visual Studio offline installation](../install/install-certificates-for-visual-studio-offline.md) pages. -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] diff --git a/docs/install/disable-or-move-the-package-cache.md b/docs/install/disable-or-move-the-package-cache.md index 945b41e761a..83dcd4823d6 100644 --- a/docs/install/disable-or-move-the-package-cache.md +++ b/docs/install/disable-or-move-the-package-cache.md @@ -55,16 +55,7 @@ code, program binaries, and more. If you want to work offline you can instead mo Currently, you can only do this if you set the `CachePath` [registry policy](set-defaults-for-enterprise-deployments.md) before you install, modify, or repair Visual Studio. -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/install-and-use-visual-studio-behind-a-firewall-or-proxy-server.md b/docs/install/install-and-use-visual-studio-behind-a-firewall-or-proxy-server.md index 2b75906e707..61132a41f3e 100644 --- a/docs/install/install-and-use-visual-studio-behind-a-firewall-or-proxy-server.md +++ b/docs/install/install-and-use-visual-studio-behind-a-firewall-or-proxy-server.md @@ -122,12 +122,14 @@ Sometimes, you might run in to network- or proxy-related errors when you install ## Get support -Here are a few more support options for you: +We offer a [**live chat**](https://visualstudio.microsoft.com/vs/support/#talktous) (English only) support option for installation-related issues. -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +Here are a few more support options: + +* Report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. +* Share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). +* Track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). +* Use your [GitHub](https://github.com/) account to talk to us and other Visual Studio developers in the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). ## See also diff --git a/docs/install/install-certificates-for-visual-studio-offline.md b/docs/install/install-certificates-for-visual-studio-offline.md index e45b2ad8516..f70905e15d2 100644 --- a/docs/install/install-certificates-for-visual-studio-offline.md +++ b/docs/install/install-certificates-for-visual-studio-offline.md @@ -121,16 +121,7 @@ If the certificates names were not in the **Issued To** columns, they must be in After you install the certificates, deployment of Visual Studio can proceed by using the instructions from the [Deploying from a network installation](create-a-network-installation-of-visual-studio.md#deploying-from-a-network-installation) section of the "Create a network installation of Visual Studio" page. -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/install-vs-inconsistent-quality-network.md b/docs/install/install-vs-inconsistent-quality-network.md index 820b82fe45e..688ba369b5c 100644 --- a/docs/install/install-vs-inconsistent-quality-network.md +++ b/docs/install/install-vs-inconsistent-quality-network.md @@ -100,16 +100,7 @@ Use this command to run the installation: | zh-CN | Chinese - Simplified | | zh-TW | Chinese - Traditional | -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/modify-visual-studio.md b/docs/install/modify-visual-studio.md index d7addb6aa29..ecef3d5134e 100644 --- a/docs/install/modify-visual-studio.md +++ b/docs/install/modify-visual-studio.md @@ -60,16 +60,7 @@ Here's how. If you don't want to use the handy Workloads feature to customize your Visual Studio installation, choose the **Individual Components** option from the Visual Studio Installer, select what you want and then follow the prompts. -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page for help. You can also contact us for installation help by [live chat](https://visualstudio.microsoft.com/vs/support/#talktous) (English only); for more information, see the [Visual Studio "Contact Us" page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/remove-visual-studio.md b/docs/install/remove-visual-studio.md index b9835ed1be8..658dff2deb4 100644 --- a/docs/install/remove-visual-studio.md +++ b/docs/install/remove-visual-studio.md @@ -45,16 +45,7 @@ In the instructions below, you can run the tool with different command-line swit If you do not find `InstallCleanup.exe` under the Visual Studio Installer directory - always located at `%ProgramFiles(x86)%\Microsoft Visual Studio` - follow the instructions to [install Visual Studio](install-visual-studio.md) and when the workload selection screen is displayed, close the window and follow the preceding steps again. -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/repair-visual-studio.md b/docs/install/repair-visual-studio.md index 86965ea1c8e..9bca2da1684 100644 --- a/docs/install/repair-visual-studio.md +++ b/docs/install/repair-visual-studio.md @@ -26,16 +26,7 @@ Sometimes your Visual Studio installation becomes damaged or corrupted. A repair 2. Click or tap to start the installer, then select **More**, and then select **Repair**. -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/set-defaults-for-enterprise-deployments.md b/docs/install/set-defaults-for-enterprise-deployments.md index 8afbca283cd..9dd28911492 100644 --- a/docs/install/set-defaults-for-enterprise-deployments.md +++ b/docs/install/set-defaults-for-enterprise-deployments.md @@ -53,16 +53,7 @@ You can set the following registry values: > If you change the `CachePath` registry policy after any installs you must move the existing package cache to the new location and make sure it's secured so that `SYSTEM` and `Administrators` have Full Control and `Everyone` has Read access. > Failure to move the existing cache or securing it may cause problems with future installs. -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/tools-for-managing-visual-studio-instances.md b/docs/install/tools-for-managing-visual-studio-instances.md index 44159678231..e467ab8ef1a 100644 --- a/docs/install/tools-for-managing-visual-studio-instances.md +++ b/docs/install/tools-for-managing-visual-studio-instances.md @@ -63,16 +63,7 @@ You will be prompted to provide a hive name, which becomes the name of your isol > [!IMPORTANT] > Before you start Visual Studio again, you must unload the isolated hive that you created. To do this, select File -> Unload Hive from the Regedit main menu. (If you do not do this, then the file remains locked and Visual Studio will not be able to start.) -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/troubleshooting-network-related-errors-in-visual-studio.md b/docs/install/troubleshooting-network-related-errors-in-visual-studio.md index 8fac81137b3..6ecc712fd78 100644 --- a/docs/install/troubleshooting-network-related-errors-in-visual-studio.md +++ b/docs/install/troubleshooting-network-related-errors-in-visual-studio.md @@ -106,16 +106,7 @@ Enable connections for the following URLs: > [!NOTE] > Privately owned NuGet server URLs may not be included in this list. You can check for the NuGet servers that you are using in %APPData%\Nuget\NuGet.Config. -## Get support - -If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the installation troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/uninstall-visual-studio.md b/docs/install/uninstall-visual-studio.md index 223092228b0..cffad4659c0 100644 --- a/docs/install/uninstall-visual-studio.md +++ b/docs/install/uninstall-visual-studio.md @@ -47,16 +47,7 @@ To completely remove all installations of Visual Studio 2017 as well as the Visu 2. Find **Microsoft Visual Studio 2017**. 3. Click **Uninstall**. -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/update-a-network-installation-of-visual-studio.md b/docs/install/update-a-network-installation-of-visual-studio.md index 959e1216f9f..1e59e4c32fc 100644 --- a/docs/install/update-a-network-installation-of-visual-studio.md +++ b/docs/install/update-a-network-installation-of-visual-studio.md @@ -128,16 +128,7 @@ c:\VS2017Layout\vs_enterprise.exe --layout c:\VS2017Layout --clean c:\VS2017Layo When you execute this command, Setup analyzes your offline cache folder to find the list of files that it will remove. You will then have a chance to review the files that are going to be deleted and confirm the deletions. -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/update-visual-studio.md b/docs/install/update-visual-studio.md index acdb76f7f10..848b0a953e3 100644 --- a/docs/install/update-visual-studio.md +++ b/docs/install/update-visual-studio.md @@ -140,16 +140,7 @@ If you choose to ignore a notification, Visual Studio stops showing it. If you w ![Update Visual Studio 2017 by using the Visual Studio Installer](media/update-visual-studio.png "Update Visual Studio 2017 by using the Visual Studio Installer") -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/use-command-line-parameters-to-install-visual-studio.md b/docs/install/use-command-line-parameters-to-install-visual-studio.md index 5ddf26a3742..ae324dae830 100644 --- a/docs/install/use-command-line-parameters-to-install-visual-studio.md +++ b/docs/install/use-command-line-parameters-to-install-visual-studio.md @@ -139,16 +139,7 @@ Depending on the result of the operation, the `%ERRORLEVEL%` environment variabl Each operation generates several log files in the `%TEMP%` directory that indicate the progress of the installation. Sort the folder by date and look for files that begin with `dd_bootstrapper`, `dd_client`, and `dd_setup` for the bootstrapper, the installer app, and the setup engine, respectively. -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/visual-studio-administrator-guide.md b/docs/install/visual-studio-administrator-guide.md index 35a127a325f..84432b1047e 100644 --- a/docs/install/visual-studio-administrator-guide.md +++ b/docs/install/visual-studio-administrator-guide.md @@ -65,16 +65,7 @@ Value = (DWORD) For more information about customer feedback settings, see the [Visual Studio Customer Experience Improvement Program](../ide/visual-studio-experience-improvement-program.md) page. -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/visual-studio-build-numbers-and-release-dates.md b/docs/install/visual-studio-build-numbers-and-release-dates.md index 5a137721eda..51910e609fc 100644 --- a/docs/install/visual-studio-build-numbers-and-release-dates.md +++ b/docs/install/visual-studio-build-numbers-and-release-dates.md @@ -138,16 +138,7 @@ The following table lists the build numbers and release dates for Visual Studio | 15.1 Preview 1 | Preview | March 7, 2017 | 15.0.26304.0 | | 15.0.0 | Release | March 7, 2017 | 15.0.26228.4 | -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/workload-and-component-ids.md b/docs/install/workload-and-component-ids.md index 932a288eb95..16715076a73 100644 --- a/docs/install/workload-and-component-ids.md +++ b/docs/install/workload-and-component-ids.md @@ -37,16 +37,7 @@ Click the edition names in the following table to see the available workload and For more information about how to use these lists, see the [Use command-line parameters to install Visual Studio 2017](use-command-line-parameters-to-install-visual-studio.md) page and the [How to: Migrate extensibility projects to Visual Studio 2017](../extensibility/how-to-migrate-extensibility-projects-to-visual-studio-2017.md) page. -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/workload-component-id-vs-build-tools.md b/docs/install/workload-component-id-vs-build-tools.md index 261e97118bd..96aac8bf3a1 100644 --- a/docs/install/workload-component-id-vs-build-tools.md +++ b/docs/install/workload-component-id-vs-build-tools.md @@ -423,16 +423,7 @@ Microsoft.VisualStudio.Component.VC.Tools.14.12 | VC++ 2017 version 15.5 v14.12 Microsoft.VisualStudio.Component.VC.Tools.14.13 | VC++ 2017 version 15.6 v14.13 toolset | 15.0.27924.0 Microsoft.VisualStudio.Component.VC.Tools.14.14 | VC++ 2017 version 15.7 v14.14 toolset | 15.0.27924.0 -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/workload-component-id-vs-community.md b/docs/install/workload-component-id-vs-community.md index 951e2e72acd..b0d19c70aaf 100644 --- a/docs/install/workload-component-id-vs-community.md +++ b/docs/install/workload-component-id-vs-community.md @@ -1057,16 +1057,7 @@ Microsoft.VisualStudio.Component.VC.Tools.14.13 | VC++ 2017 version 15.6 v14.13 Microsoft.VisualStudio.Component.VC.Tools.14.14 | VC++ 2017 version 15.7 v14.14 toolset | 15.0.27924.0 Microsoft.VisualStudio.Component.VC.Tools.ARM64 | Visual C++ compilers and libraries for ARM64 | 15.6.27309.0 -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/workload-component-id-vs-enterprise.md b/docs/install/workload-component-id-vs-enterprise.md index c4a846967ee..9cb1391cfa4 100644 --- a/docs/install/workload-component-id-vs-enterprise.md +++ b/docs/install/workload-component-id-vs-enterprise.md @@ -1117,16 +1117,7 @@ Microsoft.VisualStudio.Component.VC.Tools.14.13 | VC++ 2017 version 15.6 v14.13 Microsoft.VisualStudio.Component.VC.Tools.14.14 | VC++ 2017 version 15.7 v14.14 toolset | 15.0.27924.0 Microsoft.VisualStudio.Component.VC.Tools.ARM64 | Visual C++ compilers and libraries for ARM64 | 15.6.27309.0 -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/workload-component-id-vs-express.md b/docs/install/workload-component-id-vs-express.md index 73dc4d5fe2b..c1afef58ab4 100644 --- a/docs/install/workload-component-id-vs-express.md +++ b/docs/install/workload-component-id-vs-express.md @@ -86,16 +86,7 @@ Component ID | Name | Version --- | --- | --- n/a | n/a | n/a -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/workload-component-id-vs-feedback-client.md b/docs/install/workload-component-id-vs-feedback-client.md index 3aaff870ee1..6dc7087e227 100644 --- a/docs/install/workload-component-id-vs-feedback-client.md +++ b/docs/install/workload-component-id-vs-feedback-client.md @@ -53,16 +53,7 @@ Component ID | Name | Version --- | --- | --- n/a | n/a | n/a -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/workload-component-id-vs-professional.md b/docs/install/workload-component-id-vs-professional.md index d8b3842d211..8393647ff91 100644 --- a/docs/install/workload-component-id-vs-professional.md +++ b/docs/install/workload-component-id-vs-professional.md @@ -1057,16 +1057,7 @@ Microsoft.VisualStudio.Component.VC.Tools.14.13 | VC++ 2017 version 15.6 v14.13 Microsoft.VisualStudio.Component.VC.Tools.14.14 | VC++ 2017 version 15.7 v14.14 toolset | 15.0.27924.0 Microsoft.VisualStudio.Component.VC.Tools.ARM64 | Visual C++ compilers and libraries for ARM64 | 15.6.27309.0 -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/workload-component-id-vs-team-explorer.md b/docs/install/workload-component-id-vs-team-explorer.md index 61d4eaf9066..6b16f44d0e0 100644 --- a/docs/install/workload-component-id-vs-team-explorer.md +++ b/docs/install/workload-component-id-vs-team-explorer.md @@ -54,16 +54,7 @@ Component ID | Name | Version --- | --- | --- n/a | n/a | n/a -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/workload-component-id-vs-test-agent.md b/docs/install/workload-component-id-vs-test-agent.md index e7114678983..c28d5934130 100644 --- a/docs/install/workload-component-id-vs-test-agent.md +++ b/docs/install/workload-component-id-vs-test-agent.md @@ -53,16 +53,7 @@ Component ID | Name | Version --- | --- | --- n/a | n/a | n/a -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/workload-component-id-vs-test-controller.md b/docs/install/workload-component-id-vs-test-controller.md index ce1ae7c44a3..446347c161e 100644 --- a/docs/install/workload-component-id-vs-test-controller.md +++ b/docs/install/workload-component-id-vs-test-controller.md @@ -53,16 +53,7 @@ Component ID | Name | Version --- | --- | --- n/a | n/a | n/a -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/install/workload-component-id-vs-test-professional.md b/docs/install/workload-component-id-vs-test-professional.md index b388fcbe237..8ae272e7ab2 100644 --- a/docs/install/workload-component-id-vs-test-professional.md +++ b/docs/install/workload-component-id-vs-test-professional.md @@ -54,16 +54,7 @@ Component ID | Name | Version --- | --- | --- n/a | n/a | n/a -## Get support - -Sometimes, things can go wrong. If your Visual Studio installation fails, see the [Troubleshooting Visual Studio 2017 installation and upgrade issues](troubleshooting-installation-issues.md) page. If none of the troubleshooting steps help, you can contact us by live chat for installation assistance (English only). For details, see the [Visual Studio support page](https://visualstudio.microsoft.com/vs/support/#talktous). - -Here are a few more support options: - -* You can report product issues to us via the [Report a Problem](../ide/how-to-report-a-problem-with-visual-studio-2017.md) tool that appears both in the Visual Studio Installer and in the Visual Studio IDE. -* You can share a product suggestion with us on [UserVoice](https://visualstudio.uservoice.com/forums/121579). -* You can track product issues and find answers in the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/). -* You can also engage with us and other Visual Studio developers through the [Visual Studio conversation in the Gitter community](https://gitter.im/Microsoft/VisualStudio). (This option requires a [GitHub](https://github.com/) account.) +[!INCLUDE[install_get_support_md](includes/install_get_support_md.md)] ## See also diff --git a/docs/test/how-to-use-google-test-for-cpp.md b/docs/test/how-to-use-google-test-for-cpp.md index 259aea87cdd..59cd5d62607 100644 --- a/docs/test/how-to-use-google-test-for-cpp.md +++ b/docs/test/how-to-use-google-test-for-cpp.md @@ -12,7 +12,7 @@ author: mikeblome --- # How to use Google Test for C++ in Visual Studio -In **Visual Studio 2017 version 15.5** and later, Google Test is integrated into the Visual Studio IDE as a default component of the **Desktop Develoment with C++** workload. To verify that it is installed on your machine, open the Visual Studio Installer and find Google Test under the list of workload components: +In **Visual Studio 2017 version 15.5** and later, Google Test is integrated into the Visual Studio IDE as a default component of the **Desktop Development with C++** workload. To verify that it is installed on your machine, open the Visual Studio Installer and find Google Test under the list of workload components: ![Install Google Test](media/cpp-google-component.png) diff --git a/docs/vs-2015/misc/warning-the-dependency-file-in-project-project-cannot-be-copied-to-the-run-directory-because-it-would-overwrite-the-reference-file.md b/docs/vs-2015/misc/warning-the-dependency-file-in-project-project-cannot-be-copied.md similarity index 100% rename from docs/vs-2015/misc/warning-the-dependency-file-in-project-project-cannot-be-copied-to-the-run-directory-because-it-would-overwrite-the-reference-file.md rename to docs/vs-2015/misc/warning-the-dependency-file-in-project-project-cannot-be-copied.md diff --git a/scripting-docs/chakra-hosting/TOC.md b/scripting-docs/chakra-hosting/TOC.md deleted file mode 100644 index 316aa080bc2..00000000000 --- a/scripting-docs/chakra-hosting/TOC.md +++ /dev/null @@ -1,150 +0,0 @@ -# [JavaScript Runtime Hosting](javascript-runtime-hosting.md) -## [Hosting the JavaScript Runtime](hosting-the-javascript-runtime.md) -## [Targeting Edge vs. Legacy Engines](targeting-edge-vs-legacy-engines-in-jsrt-apis.md) -## [Reference (JavaScript Runtime)](reference-javascript-runtime.md) -### [JavaScript Runtime Typedefs, Constants, and Enumerations](javascript-runtime-typedefs-constants-and-enumerations.md) -#### [JsBackgroundWorkItemCallback Typedef](jsbackgroundworkitemcallback-typedef.md) -#### [JsBeforeCollectCallback Typedef](jsbeforecollectcallback-typedef.md) -#### [JsContextRef Typedef](jscontextref-typedef.md) -#### [JsFinalizeCallback Typedef](jsfinalizecallback-typedef.md) -#### [JsMemoryAllocationCallback Typedef](jsmemoryallocationcallback-typedef.md) -#### [JsNativeFunction Typedef](jsnativefunction-typedef.md) -#### [JsObjectBeforeCollectCallback Typedef](jsobjectbeforecollectcallback-typedef.md) -#### [JsProjectionCallback Typedef](jsprojectioncallback-typedef.md) -#### [JsProjectionCallbackContext Typedef](jsprojectioncallbackcontext-typedef.md) -#### [JsProjectionEnqueueCallback Typedef](jsprojectionenqueuecallback-typedef.md) -#### [JsPromiseContinuationCallback Typedef](jspromisecontinuationcallback-typedef.md) -#### [JsPropertyIdRef Typedef](jspropertyidref-typedef.md) -#### [JsRef Typedef](jsref-typedef.md) -#### [JsRuntimeHandle Typedef](jsruntimehandle-typedef.md) -#### [JsSerializedScriptLoadSourceCallback Typedef](jsserializedscriptloadsourcecallback-typedef.md) -#### [JsSerializedScriptUnloadCallback typedef](jsserializedscriptunloadcallback-typedef.md) -#### [JsSourceContext Typedef](jssourcecontext-typedef.md) -#### [JsThreadServiceCallback Typedef](jsthreadservicecallback-typedef.md) -#### [JsValueRef Typedef](jsvalueref-typedef.md) -#### [JS_INVALID_PROPERTYID Constant](js-invalid-propertyid-constant.md) -#### [JS_INVALID_REFERENCE Constant](js-invalid-reference-constant.md) -#### [JS_INVALID_RUNTIME_HANDLE Constant](js-invalid-runtime-handle-constant.md) -#### [JS_SOURCE_CONTEXT_NONE Constant](js-source-context-none-constant.md) -#### [JsErrorCode Enumeration](jserrorcode-enumeration.md) -#### [JsMemoryEventType Enumeration](jsmemoryeventtype-enumeration.md) -#### [JsPropertyIdType Enumeration](jspropertyidtype-enumeration.md) -#### [JsRuntimeAttributes Enumeration](jsruntimeattributes-enumeration.md) -#### [JsRuntimeVersion Enumeration](jsruntimeversion-enumeration.md) -#### [JsTypedArrayType Enumeration](jstypedarraytype-enumeration.md) -#### [JsValueType Enumeration](jsvaluetype-enumeration.md) -### [JsAddRef Function](jsaddref-function.md) -### [JsBooleanToBool Function](jsbooleantobool-function.md) -### [JsBoolToBoolean Function](jsbooltoboolean-function.md) -### [JsCallFunction Function](jscallfunction-function.md) -### [JsCollectGarbage Function](jscollectgarbage-function.md) -### [JsConstructObject Function](jsconstructobject-function.md) -### [JsConvertValueToBoolean Function](jsconvertvaluetoboolean-function.md) -### [JsConvertValueToNumber Function](jsconvertvaluetonumber-function.md) -### [JsConvertValueToObject Function](jsconvertvaluetoobject-function.md) -### [JsConvertValueToString Function](jsconvertvaluetostring-function.md) -### [JsCreateArray Function](jscreatearray-function.md) -### [JsCreateArrayBuffer Function](jscreatearraybuffer-function.md) -### [JsCreateContext Function](jscreatecontext-function.md) -### [JsCreateDataView Function](jscreatedataview-function.md) -### [JsCreateError Function](jscreateerror-function.md) -### [JsCreateExternalArrayBuffer Function](jscreateexternalarraybuffer-function.md) -### [JsCreateExternalObject Function](jscreateexternalobject-function.md) -### [JsCreateFunction Function](jscreatefunction-function.md) -### [JsCreateNamedFunction Function](jscreatenamedfunction-function.md) -### [JsCreateObject Function](jscreateobject-function.md) -### [JsCreateRangeError Function](jscreaterangeerror-function.md) -### [JsCreateReferenceError Function](jscreatereferenceerror-function.md) -### [JsCreateRuntime Function](jscreateruntime-function.md) -### [JsCreateSymbol Function](jscreatesymbol-function.md) -### [JsCreateSyntaxError Function](jscreatesyntaxerror-function.md) -### [JsCreateTypeError Function](jscreatetypeerror-function.md) -### [JsCreateTypedArray Function](jscreatetypedarray-function.md) -### [JsCreateURIError Function](jscreateurierror-function.md) -### [JsDefineProperty Function](jsdefineproperty-function.md) -### [JsDeleteIndexedProperty Function](jsdeleteindexedproperty-function.md) -### [JsDeleteProperty Function](jsdeleteproperty-function.md) -### [JsDisableRuntimeExecution Function](jsdisableruntimeexecution-function.md) -### [JsDisposeRuntime Function](jsdisposeruntime-function.md) -### [JsDoubleToNumber Function](jsdoubletonumber-function.md) -### [JsEnableRuntimeExecution Function](jsenableruntimeexecution-function.md) -### [JsEnumerateHeap Function](jsenumerateheap-function.md) -### [JsEquals Function](jsequals-function.md) -### [JsGetAndClearException Function](jsgetandclearexception-function.md) -### [JsGetArrayBufferStorage Function](jsgetarraybufferstorage-function.md) -### [JsGetContextData Function](jsgetcontextdata-function.md) -### [JsGetContextOfObject Function](jsgetcontextofobject-function.md) -### [JsGetCurrentContext Function](jsgetcurrentcontext-function.md) -### [JsGetDataViewStorage Function](jsgetdataviewstorage-function.md) -### [JsGetExtensionAllowed Function](jsgetextensionallowed-function.md) -### [JsGetExternalData Function](jsgetexternaldata-function.md) -### [JsGetFalseValue Function](jsgetfalsevalue-function.md) -### [JsGetGlobalObject Function](jsgetglobalobject-function.md) -### [JsGetIndexedPropertiesExternalData Function](jsgetindexedpropertiesexternaldata-function.md) -### [JsGetIndexedProperty Function](jsgetindexedproperty-function.md) -### [JsGetNullValue Function](jsgetnullvalue-function.md) -### [JsGetOwnPropertyDescriptor Function](jsgetownpropertydescriptor-function.md) -### [JsGetOwnPropertyNames Function](jsgetownpropertynames-function.md) -### [JsGetOwnPropertySymbols Function](jsgetownpropertysymbols-function.md) -### [JsGetProperty Function](jsgetproperty-function.md) -### [JsGetPropertyIdFromName Function](jsgetpropertyidfromname-function.md) -### [JsGetPropertyIdFromSymbol Function](jsgetpropertyidfromsymbol-function.md) -### [JsGetPropertyIdType Function](jsgetpropertyidtype-function.md) -### [JsGetPropertyNameFromId Function](jsgetpropertynamefromid-function.md) -### [JsGetPrototype Function](jsgetprototype-function.md) -### [JsGetRuntime Function](jsgetruntime-function.md) -### [JsGetRuntimeMemoryLimit Function](jsgetruntimememorylimit-function.md) -### [JsGetRuntimeMemoryUsage Function](jsgetruntimememoryusage-function.md) -### [JsGetStringLength Function](jsgetstringlength-function.md) -### [JsGetSymbolFromPropertyId Function](jsgetsymbolfrompropertyid-function.md) -### [JsGetTrueValue Function](jsgettruevalue-function.md) -### [JsGetTypedArrayInfo Function](jsgettypedarrayinfo-function.md) -### [JsGetTypedArrayStorage Function](jsgettypedarraystorage-function.md) -### [JsGetUndefinedValue Function](jsgetundefinedvalue-function.md) -### [JsGetValueType Function](jsgetvaluetype-function.md) -### [JsHasException Function](jshasexception-function.md) -### [JsHasExternalData Function](jshasexternaldata-function.md) -### [JsHasIndexedPropertiesExternalData Function](jshasindexedpropertiesexternaldata-function.md) -### [JsHasIndexedProperty Function](jshasindexedproperty-function.md) -### [JsHasProperty Function](jshasproperty-function.md) -### [JsIdle Function](jsidle-function.md) -### [JsInspectableToObject Function](jsinspectabletoobject-function.md) -### [JsInstanceOf Function](jsinstanceof-function.md) -### [JsIntToNumber Function](jsinttonumber-function.md) -### [JsIsEnumeratingHeap Function](jsisenumeratingheap-function.md) -### [JsIsRuntimeExecutionDisabled Function](jsisruntimeexecutiondisabled-function.md) -### [JsNumberToDouble Function](jsnumbertodouble-function.md) -### [JsNumberToInt Function](jsnumbertoint-function.md) -### [JsObjectToInspectable Function](jsobjecttoinspectable-function.md) -### [JsParseScript Function](jsparsescript-function.md) -### [JsParseSerializedScript Function](jsparseserializedscript-function.md) -### [JsParseSerializedScriptWithCallback Function](jsparseserializedscriptwithcallback-function.md) -### [JsPointerToString Function](jspointertostring-function.md) -### [JsPreventExtension Function](jspreventextension-function.md) -### [JsProjectWinRTNamespace Function](jsprojectwinrtnamespace-function.md) -### [JsRelease Function](jsrelease-function.md) -### [JsRunScript Function](jsrunscript-function.md) -### [JsRunSerializedScript Function](jsrunserializedscript-function.md) -### [JsRunSerializedScriptWithCallback Function](jsrunserializedscriptwithcallback-function.md) -### [JsSerializeScript Function](jsserializescript-function.md) -### [JsSetContextData Function](jssetcontextdata-function.md) -### [JsSetCurrentContext Function](jssetcurrentcontext-function.md) -### [JsSetException Function](jssetexception-function.md) -### [JsSetExternalData Function](jssetexternaldata-function.md) -### [JsSetIndexedPropertiesToExternalData Function](jssetindexedpropertiestoexternaldata-function.md) -### [JsSetIndexedProperty Function](jssetindexedproperty-function.md) -### [JsSetObjectBeforeCollectCallback Function](jssetobjectbeforecollectcallback-function.md) -### [JsSetProjectionEnqueueCallback Function](jssetprojectionenqueuecallback-function.md) -### [JsSetPromiseContinuationCallback Function](jssetpromisecontinuationcallback-function.md) -### [JsSetProperty Function](jssetproperty-function.md) -### [JsSetPrototype Function](jssetprototype-function.md) -### [JsSetRuntimeBeforeCollectCallback Function](jssetruntimebeforecollectcallback-function.md) -### [JsSetRuntimeMemoryAllocationCallback Function](jssetruntimememoryallocationcallback-function.md) -### [JsSetRuntimeMemoryLimit Function](jssetruntimememorylimit-function.md) -### [JsStartDebugging Function](jsstartdebugging-function.md) -### [JsStartProfiling Function](jsstartprofiling-function.md) -### [JsStopProfiling Function](jsstopprofiling-function.md) -### [JsStrictEquals Function](jsstrictequals-function.md) -### [JsStringToPointer Function](jsstringtopointer-function.md) -### [JsValueToVariant Function](jsvaluetovariant-function.md) -### [JsVariantToValue Function](jsvarianttovalue-function.md) diff --git a/scripting-docs/chakra-hosting/hosting-the-javascript-runtime.md b/scripting-docs/chakra-hosting/hosting-the-javascript-runtime.md deleted file mode 100644 index 1f3541a506a..00000000000 --- a/scripting-docs/chakra-hosting/hosting-the-javascript-runtime.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -title: "Hosting the JavaScript Runtime | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "article" -ms.assetid: 30ec744e-57cc-4ef5-8fe1-d2c27b946548 -caps.latest.revision: 14 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# Hosting the JavaScript Runtime -The JavaScript Runtime (JsRT) APIs provide a way for desktop, Windows Store, and server-side applications running on the Windows operating system to add scripting capabilities to the application by using the standards-based Chakra JavaScript engine that is also utilized by Microsoft Edge and Internet Explorer. These APIs are available on Windows 10 and any version of the Windows operating system that has Internet Explorer version 11.0 installed on the machine. For more info, see [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md). For info on using the JsRT in Windows Store apps, see [JsRT and the Universal Windows Platform](#Windows). - -> [!NOTE] -> This documentation assumes a general working familiarity with the JavaScript language. - -## Concepts - Understanding how to host the JavaScript engine using the JsRT APIs depends on two key concepts: runtimes and execution contexts. - - A *runtime* represents a complete JavaScript execution environment. Each runtime that is created has its own isolated garbage collected heap and, by default, its own just-in-time (JIT) compiler thread and garbage collector (GC) thread. An *execution context* represents a JavaScript environment that has its own JavaScript global object distinct from all other execution contexts. One runtime may contain multiple execution contexts, and in such cases, all the execution contexts share the JIT compiler and GC thread associated with the runtime. - - Runtimes represent a single thread of execution. Only one runtime can be active on a particular thread at a time, and a runtime can only be active on one thread at a time. Runtimes are rental threaded, so a runtime that is not currently active on a thread (i.e. isn't running any JavaScript code or responding to any calls from the host) can be used on any thread that doesn't already have an active runtime on it. - - Execution contexts are tied to a particular runtime and execute code within that runtime. Unlike runtimes, multiple execution contexts can be active on a thread at the same time. So a host can make a call into an execution context, that execution context can call back to the host, and the host can make a call into a different execution context. - - ![Multiple Execution Contexts](../chakra-hosting/media/js-chakra-hosting.png "JS_Chakra_Hosting") - - In practice, unless a host needs to run code in separated environments, a single execution context can be used. Similarly, unless a host needs to run multiple pieces of code concurrently, a single runtime is sufficient. - -## Memory management - JavaScript is a garbage collected language, and thus there are several considerations that must be kept in mind when working with the JsRT APIs from another language. - - The main consideration is that the JavaScript garbage collector can only see references to values in two places: its runtime's heap, and the stack. Thus, a reference to a JavaScript value that is stored inside of another JavaScript value or in a local variable on the stack will always be seen by the garbage collector. But references stored in other locations, such as heaps managed by the host or the system, will not be seen by the garbage collector and may result in premature collection of values that are still in use by the host. - -> [!IMPORTANT] -> Some language compilers (such as the Visual Studio C++ compiler) will optimize away local variables where possible. Care must be taken to ensure that local variables that reference JavaScript values are on the stack if they are expected to keep those values alive. - - If a reference to a JavaScript value will be stored in a location not visible to the garbage collector, the host must manually add and remove references using the JsRT APIs. - -## Exception handling - When a JavaScript exception occurs during script execution, the containing runtime is put into an exception state. While in an exception state, no code can run and all API calls will fail with the error code `JsErrorInExceptionState` until the host retrieves and clears the exception using the `JsGetAndClearException` API. If the host returns from a JavaScript callback without clearing the runtime from an exception state, then the JavaScript exception will be re-thrown as soon as control passes back to the JavaScript engine. This also enables host callbacks to "throw" a JavaScript exception by setting the runtime into an exception state and then returning from a host callback. - - A host is not allowed to let its own internal exceptions to propagate across a host callback—any callback methods must catch all host exceptions before returning control to the runtime. - -## Runtime resource usage - The JsRT APIs expose a number of way to monitor and modify the way runtimes use resources. They generally break down into the following categories: - -- **Thread Usage**. By default, each runtime will create a dedicated JIT compiler thread and a dedicated GC thread that service that runtime. If a runtime is created with the `JsRuntimeAttributeDisableBackgroundWork` flag, then the JIT and GC work will be performed on the runtime thread itself instead of separate background threads for each one of them. A host can also supply a thread service callback to the `JsCreateRuntime` call, which will allow the host to schedule JIT and GC work in any way it sees fit. - -- **Memory Usage**. There are several ways to monitor and modify the memory usage of a runtime. If the runtime will be running for a long time, the host can specify the `JsRuntimeAttributeEnableIdleProcessing` flag when creating the runtime and then call `JsIdle` when the host is in an idle state. This allows the engine to defer some memory cleanup and bookkeeping work until idle time. - - The host can monitor garbage collections by calling `JsSetRuntimeBeforeCollectCallback`. It can also monitor allocations made by the heap by calling `JsSetRuntimeMemoryAllocationCallback`. Note that this API does not call back on every JavaScript allocation, just when the runtime's heap needs more space from which to allocate. The memory allocation callback is allowed to deny the request, which will trigger a garbage collection and, if no memory is available, an out of memory error in the runtime. - - The host can also call `JsSetRuntimeMemoryLimit` to set a limit for how much memory a runtime can use. When a runtime hits a limit, it will trigger a garbage collection and, if no memory is available, an out of memory error will be thrown by the runtime. - -- **Script Interruption and Evaluation**. The host can call `JsDisableRuntimeExecution` to terminate execution within a runtime. This call can be made at any time and from any thread. Because script termination depends on reaching guard points inserted into the code, a script may not terminate at the exact moment, but will do so very shortly afterwards. By default, termination guard points are placed in the generated code conservatively and may not cover every situation, such as an infinite loop. Creating the runtime with the `JsRuntimeAttributeAllowScriptInterrupt` flag causes the runtime to insert additional checks for infinite loops, often at the cost of a small performance overhead. - - If a host wishes to disallow generation of native code by the JIT compiler, it can specify the `JsRuntimeAttributeDisableNativeCodeGeneration` flag. A host can also disallow scripts from dynamically running scripts itself by specifying the `JsRuntimeAttributeDisableEval` flag. - -## Debugging and Profiling - JsRT APIs supports debugging and profiling via the Active Scripting technology. - - Starting in Windows 10, the Chakra JavaScript Engine supports a legacy engine and Edge engine, and you can target either in JsRT (see [Targeting Edge vs. Legacy Engines](../chakra-hosting/targeting-edge-vs-legacy-engines-in-jsrt-apis.md) for details). Debugging a script in Visual Studio works differently between the legacy and the Edge engine. With the legacy engine, the host needs to provide an [IDebugApplication Interface](../winscript/reference/idebugapplication-interface.md) pointer, which can be obtained from an [IProcessDebugManager Interface](../winscript/reference/iprocessdebugmanager-interface.md) instance. With the Edge engine, `IDebugApplication` is deprecated, and the Chakra engine enables native and script debugging capabilities through the Visual Studio debugger without requiring an implementation of `IDebugApplication` from the user. - - To make scripts in an execution context debuggable, the Chakra engine has to switch to using less efficient code execution methods. As such, debuggable code typically runs slower than non-debuggable code. As a result, with the legacy engine, a host can choose to either start debugging in an execution context from the beginning by providing the `IDebugApplication` pointer up front through `JsCreateContext`, or it can wait until debugging is needed and then call `JsStartDebugging`. With the Edge engine, `JsCreateContext` no longer takes an `IDebugApplication` parameter, and as a result the script is debuggable only after `JsStartDebugging` is called. When debugging using Visual Studio, the "Script" debugger option must be enabled. - - The JavaScript code in an execution context can be profiled in one of two ways. The command line Visual Studio Profiler (vsperf.exe) can be used in Windows 8.1 and later versions with the /js switch to produce a report that targets the JavaScript code run in the application. Or the host can directly call `JsStartProfiling` and `JsStopProfiling` and provide a callback to do profiling itself. The host can also examine the state of the garbage collected heap by calling `JsEnumerateHeap`. Profiling in JsRT works in the same manner between the legacy and the Edge engine. However, JsRT profiling APIs (`JsStartProfiling`, `JsStopProfiling`, `JsEnumerateHeap`, and `JsIsEnumeratingHeap`) are not available for Universal Windows Apps. - - -## JsRT and the Universal Windows Platform - You can use JsRT APIs to add scripting capabilities to a Universal Windows app. A Universal Windows app that uses the JsRT APIs will need to target the Edge JSRT APIs, which in turn target the Edge Chakra engine. For more information, see [Targeting Edge vs. Legacy Engines](../chakra-hosting/targeting-edge-vs-legacy-engines-in-jsrt-apis.md). The complete JsRT API is available for Universal Windows apps, except for profiling and heap enumeration support (`JsStartProfiling`, `JsStopProfiling`, `JsEnumerateHeap`, and `JsIsEnumeratingHeap` are not supported). - - JsRT also allows scripts to natively access any [Universal Windows Platform (UWP) APIs](https://msdn.microsoft.com/en-us/library/windows/apps/br211377.aspx) after exposing the API namespace through Edge JsRT API `JsProjectWinRTNamespace`. While Universal Windows Applications require no setup in addition to projecting necessary namespaces, in a Classic (Win32) Windows Application, a COM-initialized delegated pumping mechanism needs to be enabled through `JsSetProjectionEnqueueCallback` to enable events and asynchronous APIs. The following Win32 sample utilizes asynchronous UWP APIs to create an http client to get content from a Uri: - -```cpp -typedef struct _jsCall { - JsProjectionCallback jsCallback; - JsProjectionCallbackContext jsContext; - HANDLE event; -} jsCall; - -// Set up delegated pumping mechanism; not necessary in UWP applications. -jsCall outstandingCall = {}; -CoInitializeEx(nullptr, COINIT_MULTITHREADED); -JsSetProjectionEnqueueCallback([](JsProjectionCallback jsCallback, -JsProjectionCallbackContext jsContext, void *callbackState) { - jsCall* call = (jsCall*)callbackState; - call->jsCallback = jsCallback; - call->jsContext = jsContext; - SetEvent(call->event); - }, -&outstandingCall); -HANDLE event = CreateEventEx(NULL, NULL, CREATE_EVENT_MANUAL_RESET, EVENT_ALL_ACCESS); -outstandingCall.event = event; - -// Project necessary namespaces. -JsProjectWinRTNamespace(L"Windows.Foundation"); -JsProjectWinRTNamespace(L"Windows.Web"); - -// Get content from an Uri. -JsRunScript(L"var uri = new Windows.Foundation.Uri(\"http://somedatasource.com\"); " \ - L"var httpClient = new Windows.Web.Http.HttpClient();" \ - L"httpClient.getStringAsync(uri).done(function (content) { " \ - L" // do something with the string content " \ - L"}, onError); " \ - L"function onError(reason) { " \ - L" // error handling " \ - L"}", - currentSourceContext, L"", &result); - -// Wait for async call to come in and then execute; not necessary in UWP applications. -WaitForSingleObjectEx(outstandingCall.event, 10000, FALSE) == WAIT_OBJECT_0; -outstandingCall.jsCallback(outstandingCall.jsContext); - -``` - -## See Also - [JavaScript Runtime Sample App](http://go.microsoft.com/fwlink/p/?LinkID=306674&clcid=0x409) - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) - [JavaScript Runtime Hosting](../chakra-hosting/javascript-runtime-hosting.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/javascript-runtime-typedefs-constants-and-enumerations.md b/scripting-docs/chakra-hosting/javascript-runtime-typedefs-constants-and-enumerations.md deleted file mode 100644 index aaf22620a9b..00000000000 --- a/scripting-docs/chakra-hosting/javascript-runtime-typedefs-constants-and-enumerations.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: "JavaScript Runtime Typedefs, Constants, and Enumerations | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 1aa107ed-e144-4947-b5bb-90284a537174 -caps.latest.revision: 5 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JavaScript Runtime Typedefs, Constants, and Enumerations -JavaScript Runtime (JsRT) typedefs, constants, and enumerations support adding scripting capabilities to desktop and server-side applications running on Windows. - -## In This Section - The following global typedefs support JsRT hosting: - -- [JsBackgroundWorkItemCallback Typedef](../chakra-hosting/jsbackgroundworkitemcallback-typedef.md) - -- [JsBeforeCollectCallback Typedef](../chakra-hosting/jsbeforecollectcallback-typedef.md) - -- [JsContextRef Typedef](../chakra-hosting/jscontextref-typedef.md) - -- [JsFinalizeCallback Typedef](../chakra-hosting/jsfinalizecallback-typedef.md) - -- [JsMemoryAllocationCallback Typedef](../chakra-hosting/jsmemoryallocationcallback-typedef.md) - -- [JsNativeFunction Typedef](../chakra-hosting/jsnativefunction-typedef.md) - -- [JsObjectBeforeCollectCallback Typedef](../chakra-hosting/jsobjectbeforecollectcallback-typedef.md) - -- [JsProjectionCallback Typedef](../chakra-hosting/jsprojectioncallback-typedef.md) - -- [JsProjectionCallbackContext Typedef](../chakra-hosting/jsprojectioncallbackcontext-typedef.md) - -- [JsProjectionEnqueueCallback Typedef](../chakra-hosting/jsprojectionenqueuecallback-typedef.md) - -- [JsPromiseContinuationCallback Typedef](../chakra-hosting/jspromisecontinuationcallback-typedef.md) - -- [JsPropertyIdRef Typedef](../chakra-hosting/jspropertyidref-typedef.md) - -- [JsRef Typedef](../chakra-hosting/jsref-typedef.md) - -- [JsRuntimeHandle Typedef](../chakra-hosting/jsruntimehandle-typedef.md) - -- [JsSerializedScriptLoadSourceCallback Typedef](../chakra-hosting/jsserializedscriptloadsourcecallback-typedef.md) - -- [JsSerializedScriptUnloadCallback typedef](../chakra-hosting/jsserializedscriptunloadcallback-typedef.md) - -- [JsSourceContext Typedef](../chakra-hosting/jssourcecontext-typedef.md) - -- [JsThreadServiceCallback Typedef](../chakra-hosting/jsthreadservicecallback-typedef.md) - -- [JsValueRef Typedef](../chakra-hosting/jsvalueref-typedef.md) - - The following constants support JsRT hosting: - -- [JS_INVALID_PROPERTYID Constant](../chakra-hosting/js-invalid-propertyid-constant.md) - -- [JS_INVALID_REFERENCE Constant](../chakra-hosting/js-invalid-reference-constant.md) - -- [JS_INVALID_RUNTIME_HANDLE Constant](../chakra-hosting/js-invalid-runtime-handle-constant.md) - -- [JS_SOURCE_CONTEXT_NONE Constant](../chakra-hosting/js-source-context-none-constant.md) - - The following enumerations support JsRT hosting: - -- [JsErrorCode Enumeration](../chakra-hosting/jserrorcode-enumeration.md) - -- [JsMemoryEventType Enumeration](../chakra-hosting/jsmemoryeventtype-enumeration.md) - -- [JsPropertyIdType Enumeration](../chakra-hosting/jspropertyidtype-enumeration.md) - -- [JsRuntimeAttributes Enumeration](../chakra-hosting/jsruntimeattributes-enumeration.md) - -- [JsRuntimeVersion Enumeration](../chakra-hosting/jsruntimeversion-enumeration.md) - -- [JsTypedArrayType Enumeration](../chakra-hosting/jstypedarraytype-enumeration.md) - -- [JsValueType Enumeration](../chakra-hosting/jsvaluetype-enumeration.md) - -## See Also - [Hosting the JavaScript Runtime](../chakra-hosting/hosting-the-javascript-runtime.md) - [JavaScript Runtime Hosting](../chakra-hosting/javascript-runtime-hosting.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/js-invalid-propertyid-constant.md b/scripting-docs/chakra-hosting/js-invalid-propertyid-constant.md deleted file mode 100644 index 56174ab9f53..00000000000 --- a/scripting-docs/chakra-hosting/js-invalid-propertyid-constant.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "JS_INVALID_PROPERTYID Constant | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 1d2e8768-b2c9-4447-b3f2-3b2ac0abad4f -caps.latest.revision: 11 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JS_INVALID_PROPERTYID Constant -An invalid property identifier. - -## Syntax - -``` -const JsPropertyId JS_INVALID_PROPERTYID = 0; -``` - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/js-invalid-reference-constant.md b/scripting-docs/chakra-hosting/js-invalid-reference-constant.md deleted file mode 100644 index 21cc1ebb9e7..00000000000 --- a/scripting-docs/chakra-hosting/js-invalid-reference-constant.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "JS_INVALID_REFERENCE Constant | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JS_INVALID_REFERENCE" -helpviewer_keywords: - - "JS_INVALID_REFERENCE constant" -ms.assetid: 4fade195-bd4f-4f97-a56e-6b987a7bf729 -caps.latest.revision: 13 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JS_INVALID_REFERENCE Constant -An invalid reference. - -## Syntax - -``` -const JsRef JS_INVALID_REFERENCE = NULL; -``` - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/js-invalid-runtime-handle-constant.md b/scripting-docs/chakra-hosting/js-invalid-runtime-handle-constant.md deleted file mode 100644 index 4203aebdb0a..00000000000 --- a/scripting-docs/chakra-hosting/js-invalid-runtime-handle-constant.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "JS_INVALID_RUNTIME_HANDLE Constant | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JS_INVALID_RUNTIME_HANDLE" -helpviewer_keywords: - - "JS_INVALID_RUNTIME_HANDLE constant" -ms.assetid: ee8c9439-7422-457a-b924-98cf5f126c8c -caps.latest.revision: 13 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JS_INVALID_RUNTIME_HANDLE Constant -An invalid runtime handle. - -## Syntax - -``` -const JsRuntimeHandle JS_INVALID_RUNTIME_HANDLE = NULL; -``` - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/js-source-context-none-constant.md b/scripting-docs/chakra-hosting/js-source-context-none-constant.md deleted file mode 100644 index 6c65e6ed353..00000000000 --- a/scripting-docs/chakra-hosting/js-source-context-none-constant.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "JS_SOURCE_CONTEXT_NONE Constant | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JS_SOURCE_CONTEXT_NONE" -helpviewer_keywords: - - "JS_SOURCE_CONTEXT_NONE constant" -ms.assetid: 3c599580-c814-4d75-8471-260fd864cb6f -caps.latest.revision: 13 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JS_SOURCE_CONTEXT_NONE Constant -An empty source context. - -## Syntax - -``` -const JsSourceContext JS_SOURCE_CONTEXT_NONE = (JsSourceContext)-1; -``` - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsaddref-function.md b/scripting-docs/chakra-hosting/jsaddref-function.md deleted file mode 100644 index 19bf8509d13..00000000000 --- a/scripting-docs/chakra-hosting/jsaddref-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsAddRef Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsAddRef" -helpviewer_keywords: - - "JsAddRef function" -ms.assetid: a7f3ed49-6a86-489a-abdf-c99428e79cae -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsAddRef Function -Adds a reference to a garbage collected object. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsAddRef( - _In_ JsRef ref, - _Out_opt_ unsigned int *count -); -``` - -#### Parameters - `ref` - The object to add a reference to. - - `count` - The object's new reference count (can pass in null). - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - This only needs to be called on `JsRef` handles that are not going to be stored somewhere on the stack. Calling `JsAddRef` ensures that the object the `JsRef` refers to will not be freed until `JsRelease` is called. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsbackgroundworkitemcallback-typedef.md b/scripting-docs/chakra-hosting/jsbackgroundworkitemcallback-typedef.md deleted file mode 100644 index 8629ff994e6..00000000000 --- a/scripting-docs/chakra-hosting/jsbackgroundworkitemcallback-typedef.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "JsBackgroundWorkItemCallback Typedef | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: e6db52e1-830c-46a2-b9f9-cc2d450a1da8 -caps.latest.revision: 6 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsBackgroundWorkItemCallback Typedef -A background work item callback. - -## Syntax - -``` -typedef void (CALLBACK *JsBackgroundWorkItemCallback)( - _In_opt_ void *callbackData -); -``` - -#### Parameters - callbackData - Data argument passed to the thread service. - -## Remarks - This is passed to the host's thread service (if provided) to allow the host to invoke the work item callback on the background thread of its choice. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsbeforecollectcallback-typedef.md b/scripting-docs/chakra-hosting/jsbeforecollectcallback-typedef.md deleted file mode 100644 index 2051eec6ff4..00000000000 --- a/scripting-docs/chakra-hosting/jsbeforecollectcallback-typedef.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "JsBeforeCollectCallback Typedef | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 58bece47-4e6d-49e7-a93d-b6a8f9928b41 -caps.latest.revision: 6 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsBeforeCollectCallback Typedef -A callback called before collection. - -## Syntax - -``` -typedef void (CALLBACK *JsBeforeCollectCallback)( -_In_opt_ void *callbackState -); -``` - -#### Parameters - callbackState - The state passed to JsSetBeforeCollectCallback. - -## Remarks - Use JsSetBeforeCollectCallback to register this callback. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsbooleantobool-function.md b/scripting-docs/chakra-hosting/jsbooleantobool-function.md deleted file mode 100644 index e066b7324e6..00000000000 --- a/scripting-docs/chakra-hosting/jsbooleantobool-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsBooleanToBool Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsBooleanToBool" -helpviewer_keywords: - - "JsBooleanToBool function" -ms.assetid: ab16ac71-fe47-475d-a7ee-46e4643dee60 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsBooleanToBool Function -Retrieves the `bool` value of a Boolean value. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsBooleanToBool( - _In_ JsValueRef value, - _Out_ bool *boolValue -); -``` - -#### Parameters - `value` - The value to be converted. - - `boolValue` - The converted value. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsbooltoboolean-function.md b/scripting-docs/chakra-hosting/jsbooltoboolean-function.md deleted file mode 100644 index 6cc8f99f462..00000000000 --- a/scripting-docs/chakra-hosting/jsbooltoboolean-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsBoolToBoolean Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsBoolToBoolean" -helpviewer_keywords: - - "JsBoolToBoolean function" -ms.assetid: 24322ea3-0638-40a3-9b4c-fc912ebed3ff -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsBoolToBoolean Function -Creates a Boolean value from a `bool` value. - -## Syntax - -``` -STDAPI_(JsErrorCode JsBoolToBoolean( - _In_ bool value, - _Out_ JsValueRef *booleanValue -); -``` - -#### Parameters - `value` - The value to be converted. - - `booleanValue` - The converted value. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jscallfunction-function.md b/scripting-docs/chakra-hosting/jscallfunction-function.md deleted file mode 100644 index a3340ffb9ed..00000000000 --- a/scripting-docs/chakra-hosting/jscallfunction-function.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "JsCallFunction Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsCallFunction" -helpviewer_keywords: - - "JsCallFunction function" -ms.assetid: 8a1dca72-d720-4a28-a86e-6809465006fe -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsCallFunction Function -Invokes a function. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsCallFunction( - _In_ JsValueRef function, - _In_reads_(argumentCount) JsValueRef *arguments, - _In_ unsigned short argumentCount, - _Out_opt_ JsValueRef *result -); -``` - -#### Parameters - `function` - The function to invoke. - - `arguments` - The arguments to the call. - - `argumentCount` - The number of arguments being passed in to the function. - - `result` - The value returned from the function invocation, if any. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jscollectgarbage-function.md b/scripting-docs/chakra-hosting/jscollectgarbage-function.md deleted file mode 100644 index ea8995a1bb3..00000000000 --- a/scripting-docs/chakra-hosting/jscollectgarbage-function.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "JsCollectGarbage Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsCollectGarbage" -helpviewer_keywords: - - "JsCollectGarbage function" -ms.assetid: 995c79a5-6e18-45be-81ff-2a5d3348edb8 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsCollectGarbage Function -Performs a full garbage collection. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsCollectGarbage( - _In_ JsRuntimeHandle runtime -); -``` - -#### Parameters - `runtime` - The runtime in which the garbage collection will be performed. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsconstructobject-function.md b/scripting-docs/chakra-hosting/jsconstructobject-function.md deleted file mode 100644 index ae7706867cb..00000000000 --- a/scripting-docs/chakra-hosting/jsconstructobject-function.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "JsConstructObject Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsConstructObject" -helpviewer_keywords: - - "JsConstructObject function" -ms.assetid: b07d2440-db55-4a6a-8376-56b40a8039a1 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsConstructObject Function -Invokes a function as a constructor. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsConstructObject( - _In_ JsValueRef function, - _In_reads_(argumentCount) JsValueRef *arguments, - _In_ unsigned short argumentCount, - _Out_opt_ JsValueRef *result -); -``` - -#### Parameters - `function` - The function to invoke as a constructor. - - `arguments` - The arguments to the call. - - `argumentCount` - The number of arguments being passed in to the function. - - `result` - The value returned from the function invocation. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jscontextref-typedef.md b/scripting-docs/chakra-hosting/jscontextref-typedef.md deleted file mode 100644 index 625f1faeb86..00000000000 --- a/scripting-docs/chakra-hosting/jscontextref-typedef.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "JsContextRef Typedef | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 8586bfcc-bb24-430d-a6f2-1a3b3e34ec2e -caps.latest.revision: 6 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsContextRef Typedef -A reference to a script context. - -## Syntax - -``` -typedef JsRef JsContextRef; -``` - -## Remarks - Each script context contains its own global object, distinct from the global object in other script contexts. - - Many Chakra hosting APIs require an "active" script context, which can be set using `JsSetCurrentContext`. Chakra hosting APIs that require a current context to be set will note that explicitly in their documentation. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsconvertvaluetoboolean-function.md b/scripting-docs/chakra-hosting/jsconvertvaluetoboolean-function.md deleted file mode 100644 index e645a03ab69..00000000000 --- a/scripting-docs/chakra-hosting/jsconvertvaluetoboolean-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsConvertValueToBoolean Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsConvertValueToBoolean" -helpviewer_keywords: - - "JsConvertValueToBoolean function" -ms.assetid: 7298ec72-a388-4334-b81b-1691ab4cecf0 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsConvertValueToBoolean Function -Converts the value to Boolean using standard JavaScript semantics. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsConvertValueToBoolean( - _In_ JsValueRef value, - _Out_ JsValueRef *booleanValue -); -``` - -#### Parameters - `value` - The value to be converted. - - `booleanValue` - The converted value. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsconvertvaluetonumber-function.md b/scripting-docs/chakra-hosting/jsconvertvaluetonumber-function.md deleted file mode 100644 index 65b9878488b..00000000000 --- a/scripting-docs/chakra-hosting/jsconvertvaluetonumber-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsConvertValueToNumber Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsConvertValueToNumber" -helpviewer_keywords: - - "JsConvertValueToNumber function" -ms.assetid: c47b8653-0591-4863-b8b5-33187b315816 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsConvertValueToNumber Function -Converts the value to number using standard JavaScript semantics. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsConvertValueToNumber( - _In_ JsValueRef value, - _Out_ JsValueRef *numberValue -); -``` - -#### Parameters - `value` - The value to be converted. - - `numberValue` - The converted value. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsconvertvaluetoobject-function.md b/scripting-docs/chakra-hosting/jsconvertvaluetoobject-function.md deleted file mode 100644 index 8c9cb9339df..00000000000 --- a/scripting-docs/chakra-hosting/jsconvertvaluetoobject-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsConvertValueToObject Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsConvertValueToObject" -helpviewer_keywords: - - "JsConvertValueToObject function" -ms.assetid: 6528b28a-1d2b-417f-bf78-bf05547c52e1 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsConvertValueToObject Function -Converts the value to object using standard JavaScript semantics. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsConvertValueToObject( - _In_ JsValueRef value, - _Out_ JsValueRef *object -); -``` - -#### Parameters - `value` - The value to be converted. - - `object` - The converted value. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsconvertvaluetostring-function.md b/scripting-docs/chakra-hosting/jsconvertvaluetostring-function.md deleted file mode 100644 index 814a69ee587..00000000000 --- a/scripting-docs/chakra-hosting/jsconvertvaluetostring-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsConvertValueToString Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsConvertValueToString" -helpviewer_keywords: - - "JsConvertValueToString function" -ms.assetid: a97aca04-b2ce-446a-acf4-49cd6777a85c -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsConvertValueToString Function -Converts the value to string using standard JavaScript semantics. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsConvertValueToString( - _In_ JsValueRef value, - _Out_ JsValueRef *stringValue -); -``` - -#### Parameters - `value` - The value to be converted. - - `stringValue` - The converted value. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jscreatearray-function.md b/scripting-docs/chakra-hosting/jscreatearray-function.md deleted file mode 100644 index 1c1e0d2a825..00000000000 --- a/scripting-docs/chakra-hosting/jscreatearray-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsCreateArray Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsCreateArray" -helpviewer_keywords: - - "JsCreateArray function" -ms.assetid: a119949a-e427-4349-9d00-5ec20fb9319c -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsCreateArray Function -Creates a Javascript array object. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsCreateArray( - _In_ unsigned int length, - _Out_ JsValueRef *result -); -``` - -#### Parameters - `length` - The initial length of the array. - - `result` - The new array object. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jscreatearraybuffer-function.md b/scripting-docs/chakra-hosting/jscreatearraybuffer-function.md deleted file mode 100644 index 1dead29e0d8..00000000000 --- a/scripting-docs/chakra-hosting/jscreatearraybuffer-function.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "JsCreateArrayBuffer Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: c9e74184-7dd9-41a7-a1fe-9575e1701392 -caps.latest.revision: 2 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsCreateArrayBuffer Function -Creates a JavaScript `ArrayBuffer` object. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsCreateArrayBuffer( - _In_ unsigned int byteLength, - _Out_ JsValueRef *result -); -``` - -#### Parameters - `byteLength` - The number of bytes in the ArrayBuffer. - - `result` - The new ArrayBuffer object. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - - This API is supported only in Edge mode. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jscreatecontext-function.md b/scripting-docs/chakra-hosting/jscreatecontext-function.md deleted file mode 100644 index aa98a647420..00000000000 --- a/scripting-docs/chakra-hosting/jscreatecontext-function.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: "JsCreateContext Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsCreateContext" -helpviewer_keywords: - - "JsCreateContext function" -ms.assetid: aceca043-2c73-4029-a06c-8ad6695109cf -caps.latest.revision: 15 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsCreateContext Function -Creates a script context for running scripts. - -## Syntax - -``` -// Edge mode signature -STDAPI_(JsErrorCode) JsCreateContext( - _In_ JsRuntimeHandle runtime, - _Out_ JsContextRef *newContext); - -// Legacy mode signature -STDAPI_(JsErrorCode) JsCreateContext( - _In_ JsRuntimeHandle runtime, - _In_ IDebugApplication *debugApplication, - _Out_ JsContextRef *newContext -); -``` - -#### Parameters - `runtime` - The runtime the script context is being created in. - - `debugApplication` - The debug application to use for debugging. This parameter can be null, in which case debugging is not enabled for the context. - - `newContext` - The created script context. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Each script context has its own global object that is isolated from all other script contexts. - - The `debugApplication` parameter is not supported in Edge mode. For more information on using this API in Edge mode, see [Targeting Edge vs. Legacy Engines](../chakra-hosting/targeting-edge-vs-legacy-engines-in-jsrt-apis.md). - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jscreatedataview-function.md b/scripting-docs/chakra-hosting/jscreatedataview-function.md deleted file mode 100644 index e40bf1ead0a..00000000000 --- a/scripting-docs/chakra-hosting/jscreatedataview-function.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "JsCreateDataView Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 161e59eb-d429-46f7-9a38-bbf2149ccf44 -caps.latest.revision: 2 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsCreateDataView Function -Creates a Javascript `DataView` object. - -## Syntax - -``` -JsErrorCode JsCreateDataView( - _In_ JsValueRef arrayBuffer, - _In_ unsigned int byteOffset, - _In_ unsigned int byteLength, - _Out_ JsValueRef *result -); -``` - -#### Parameters - `arrayBuffer` - An existing `ArrayBuffer` object to use as the storage for the result `DataView` object. - - `byteOffset` - The offset in bytes from the start of `arrayBuffer` for result `DataView` to reference. - - `byteLength` - The number of bytes in the ArrayBuffer for result DataView to reference. - - `result` - The new DataView object. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - - This API is supported only in Edge mode. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jscreateerror-function.md b/scripting-docs/chakra-hosting/jscreateerror-function.md deleted file mode 100644 index 0bac0a0faa4..00000000000 --- a/scripting-docs/chakra-hosting/jscreateerror-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsCreateError Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsCreateError" -helpviewer_keywords: - - "JsCreateError function" -ms.assetid: dadbcac8-c56f-4f30-ba00-2d284daee191 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsCreateError Function -Creates a new JavaScript error object - -## Syntax - -``` -STDAPI_(JsErrorCode) JsCreateError( - _In_ JsValueRef message, - _Out_ JsValueRef *error -); -``` - -#### Parameters - `message` - Message for the error object. - - `error` - The new error object. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jscreateexternalarraybuffer-function.md b/scripting-docs/chakra-hosting/jscreateexternalarraybuffer-function.md deleted file mode 100644 index 7fd02399a56..00000000000 --- a/scripting-docs/chakra-hosting/jscreateexternalarraybuffer-function.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "JsCreateExternalArrayBuffer Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "article" -ms.assetid: 4a02aaec-0f67-4bf9-b37c-71cdb1410ca4 -caps.latest.revision: 3 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsCreateExternalArrayBuffer Function -Creates a Javascript `ArrayBuffer` object to access external memory. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsCreateExternalArrayBuffer( - _Pre_maybenull_ _Pre_writable_byte_size_(byteLength) void *data, - _In_ unsigned int byteLength, - _In_opt_ JsFinalizeCallback finalizeCallback, - _In_opt_ void *callbackState, - _Out_ JsValueRef *result -); - -``` - -#### Parameters - `data` - A pointer to the external memory. - - `byteLength` - The number of bytes in the external memory. - - `finalizeCallback` - A callback for when the object is finalized. May be null. - - `callbackState` - User provided state that will be passed back to finalizeCallback. - - `result` - The new `ArrayBuffer` object. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jscreateexternalobject-function.md b/scripting-docs/chakra-hosting/jscreateexternalobject-function.md deleted file mode 100644 index 6b479f68d6f..00000000000 --- a/scripting-docs/chakra-hosting/jscreateexternalobject-function.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "JsCreateExternalObject Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsCreateExternalObject" -helpviewer_keywords: - - "JsCreateExternalObject function" -ms.assetid: 6bcef506-93fb-429b-b06a-a971ff0b71f3 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsCreateExternalObject Function -Creates a new object that stores some external data. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsCreateExternalObject( - _In_opt_ void *data, - _In_opt_ JsFinalizeCallback finalizeCallback, - _Out_ JsValueRef *object -); -``` - -#### Parameters - `data` - External data that the object will represent. May be null. - - `finalizeCallback` - A callback for when the object is finalized. May be null. - - `object` - The new object. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jscreatefunction-function.md b/scripting-docs/chakra-hosting/jscreatefunction-function.md deleted file mode 100644 index ade5f34654b..00000000000 --- a/scripting-docs/chakra-hosting/jscreatefunction-function.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "JsCreateFunction Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsCreateFunction" -helpviewer_keywords: - - "JsCreateFunction function" -ms.assetid: b298a96a-5ef7-4203-a8c8-55f9bfc6d2bb -caps.latest.revision: 13 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsCreateFunction Function -Creates a new JavaScript function. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsCreateFunction( - _In_ JsNativeFunction nativeFunction, - _In_opt_ void *callbackState, - _Out_ JsValueRef *function -); -``` - -#### Parameters - `nativeFunction` - The method to call when the function is invoked. - - `callbackState` - User-provided state that will be passed back to the callback. - - `function` - The new function object. - -## Return Value - The result of the call, if any. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jscreatenamedfunction-function.md b/scripting-docs/chakra-hosting/jscreatenamedfunction-function.md deleted file mode 100644 index 98bc38def2c..00000000000 --- a/scripting-docs/chakra-hosting/jscreatenamedfunction-function.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: "JsCreateNamedFunction Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 72f40d06-ab82-4fed-a632-68af6b4126c2 -caps.latest.revision: 2 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsCreateNamedFunction Function -Creates a new JavaScript function with name. - -## Syntax - -```cpp -STDAPI_(JsErrorCode) JsCreateNamedFunction( - _In_ JsValueRef name, - _In_ JsNativeFunction nativeFunction, - _In_opt_ void *callbackState, - _Out_ JsValueRef *function -); -``` - -#### Parameters - `name` - The name of this function that will be used for diagnostics and stringification purposes. - - `nativeFunction` - The method to call when the function is invoked. - - `callbackState` - User provided state that will be passed back to the callback. - - `function` - The new function object. - -## Return Value - -## Remarks - Requires an active script context. - - This API is supported only in Edge mode. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jscreateobject-function.md b/scripting-docs/chakra-hosting/jscreateobject-function.md deleted file mode 100644 index 9dff6bc9f4f..00000000000 --- a/scripting-docs/chakra-hosting/jscreateobject-function.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "JsCreateObject Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsCreateObject" -helpviewer_keywords: - - "JsCreateObject function" -ms.assetid: 6c1d01a4-9254-443e-b974-6f0b0c861ca2 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsCreateObject Function -Creates a new object. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsCreateObject( - _Out_ JsValueRef *object -); -``` - -#### Parameters - `object` - The new object. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jscreaterangeerror-function.md b/scripting-docs/chakra-hosting/jscreaterangeerror-function.md deleted file mode 100644 index ba5d0cf8386..00000000000 --- a/scripting-docs/chakra-hosting/jscreaterangeerror-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsCreateRangeError Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsCreateRangeError" -helpviewer_keywords: - - "JsCreateRangeError function" -ms.assetid: 0ab05de7-57af-4cfd-9aa5-0a69a893cc97 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsCreateRangeError Function -Creates a new JavaScript RangeError error object - -## Syntax - -``` -STDAPI_(JsErrorCode) JsCreateRangeError( - _In_ JsValueRef message, - _Out_ JsValueRef *error -); -``` - -#### Parameters - `message` - Message for the error object. - - `error` - The new error object. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jscreatereferenceerror-function.md b/scripting-docs/chakra-hosting/jscreatereferenceerror-function.md deleted file mode 100644 index 0efb009b2f3..00000000000 --- a/scripting-docs/chakra-hosting/jscreatereferenceerror-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsCreateReferenceError Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsCreateReferenceError" -helpviewer_keywords: - - "JsCreateReferenceError function" -ms.assetid: 1d0b2339-4bea-4dd0-a46a-4dcbf0be3bd8 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsCreateReferenceError Function -Creates a new JavaScript ReferenceError error object - -## Syntax - -``` -STDAPI_(JsErrorCode) JsCreateReferenceError( - _In_ JsValueRef message, - _Out_ JsValueRef *error -); -``` - -#### Parameters - `message` - Message for the error object. - - `error` - The new error object. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jscreateruntime-function.md b/scripting-docs/chakra-hosting/jscreateruntime-function.md deleted file mode 100644 index 76f412a859a..00000000000 --- a/scripting-docs/chakra-hosting/jscreateruntime-function.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: "JsCreateRuntime Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsCreateRuntime" -helpviewer_keywords: - - "JsCreateRuntime function" -ms.assetid: 92d09b89-6593-4d73-a562-88f9fec10228 -caps.latest.revision: 15 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsCreateRuntime Function -Creates a new runtime. - -## Syntax - -``` -// Edge mode signature -STDAPI_(JsErrorCode) JsCreateRuntime( - _In_ JsRuntimeAttributes attributes, - _In_opt_ JsThreadServiceCallback threadService, - _Out_ JsRuntimeHandle *runtime); - -// Legacy mode signature -STDAPI_(JsErrorCode) JsCreateRuntime( - _In_ JsRuntimeAttributes attributes, - _In_ JsRuntimeVersion version, - _In_opt_ JsThreadServiceCallback threadService, - _Out_ JsRuntimeHandle *runtime -); -``` - -#### Parameters - `attributes` - The attributes of the runtime to be created. - - `version` - The version of the runtime to be created. - - `threadService` - The thread service for the runtime. Can be null. - - `runtime` - The runtime created. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - The `version` parameter is not supported in Edge mode. For more information on using this API in Edge mode, see [Targeting Edge vs. Legacy Engines](../chakra-hosting/targeting-edge-vs-legacy-engines-in-jsrt-apis.md). - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jscreatesymbol-function.md b/scripting-docs/chakra-hosting/jscreatesymbol-function.md deleted file mode 100644 index 6e015d8f31d..00000000000 --- a/scripting-docs/chakra-hosting/jscreatesymbol-function.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "JsCreateSymbol Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 2fccc5d9-f857-46cd-9aeb-f0a2e7cdee6b -caps.latest.revision: 2 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsCreateSymbol Function -Creates a JavaScript symbol. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsCreateSymbol( - _In_ JsValueRef description, - _Out_ JsValueRef *result -); -``` - -#### Parameters - `description` - The string description of the symbol. Can be null. - - `result` - The new symbol. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - - This API is supported only in Edge mode. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jscreatesyntaxerror-function.md b/scripting-docs/chakra-hosting/jscreatesyntaxerror-function.md deleted file mode 100644 index 68cd64e31e3..00000000000 --- a/scripting-docs/chakra-hosting/jscreatesyntaxerror-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsCreateSyntaxError Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsCreateSyntaxError" -helpviewer_keywords: - - "JsCreateSyntaxError function" -ms.assetid: 839845fc-60c4-4ffc-bfcc-fd7a8f06126f -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsCreateSyntaxError Function -Creates a new JavaScript SyntaxError error object - -## Syntax - -``` -STDAPI_(JsErrorCode) JsCreateSyntaxError( - _In_ JsValueRef message, - _Out_ JsValueRef *error -); -``` - -#### Parameters - `message` - Message for the error object. - - `error` - The new error object. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jscreatetypedarray-function.md b/scripting-docs/chakra-hosting/jscreatetypedarray-function.md deleted file mode 100644 index 2ce8a2791db..00000000000 --- a/scripting-docs/chakra-hosting/jscreatetypedarray-function.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: "JsCreateTypedArray Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 937a2a91-6f5f-4aaa-a018-d3089702bf36 -caps.latest.revision: 2 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsCreateTypedArray Function -Creates a JavaScript typed array object. - -## Syntax - -```cpp -STDAPI_(JsErrorCode) JsCreateTypedArray( - _In_ JsTypedArrayType arrayType, - _In_ JsValueRef baseArray, - _In_ unsigned int byteOffset, - _In_ unsigned int elementLength, - _Out_ JsValueRef *result -); -``` - -#### Parameters - `arrayType` - The type of the array to create. - - `baseArray` - The base array of the new array. Use `JS_INVALID_REFERENCE` if no base array. - - `byteOffset` - The offset in bytes from the start of `baseArray` (`ArrayBuffer`) for result typed array to reference. Only applicable when `baseArray` is an `ArrayBuffer` object. Must be 0 otherwise. - - `elementLength` - The number of elements in the array. Only applicable when creating a new typed array without `baseArray` (`baseArray` is `JS_INVALID_REFERENCE`) or when `baseArray` is an `ArrayBuffer` object. Must be 0 otherwise. - - `result` - The new typed array object. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - The `baseArray` can be an `ArrayBuffer`, another typed array, or a JavaScript `Array`. The returned typed array will use the `baseArray` if it is an `ArrayBuffer`, or otherwise create and use a copy of the underlying source array. - - Requires an active script context. - - This API is supported only in Edge mode. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jscreatetypeerror-function.md b/scripting-docs/chakra-hosting/jscreatetypeerror-function.md deleted file mode 100644 index ff5ad78150d..00000000000 --- a/scripting-docs/chakra-hosting/jscreatetypeerror-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsCreateTypeError Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsCreateTypeError" -helpviewer_keywords: - - "JsCreateTypeError function" -ms.assetid: 8ef7bb77-2c98-482a-bccb-1f0fe2b826f5 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsCreateTypeError Function -Creates a new JavaScript TypeError error object - -## Syntax - -``` -STDAPI_(JsErrorCode) JsCreateTypeError( - _In_ JsValueRef message, - _Out_ JsValueRef *error -); -``` - -#### Parameters - `message` - Message for the error object. - - `error` - The new error object. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jscreateurierror-function.md b/scripting-docs/chakra-hosting/jscreateurierror-function.md deleted file mode 100644 index 068072d0f9b..00000000000 --- a/scripting-docs/chakra-hosting/jscreateurierror-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsCreateURIError Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsCreateURIError" -helpviewer_keywords: - - "JsCreateURIError function" -ms.assetid: 711fd237-12a2-4ff0-b58a-ad74c91e79fb -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsCreateURIError Function -Creates a new JavaScript URIError error object - -## Syntax - -``` -STDAPI_(JsErrorCode) JsCreateURIError( - _In_ JsValueRef message, - _Out_ JsValueRef *error -); -``` - -#### Parameters - `message` - Message for the error object. - - `error` - The new error object. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsdefineproperty-function.md b/scripting-docs/chakra-hosting/jsdefineproperty-function.md deleted file mode 100644 index 4c4ac73c9bb..00000000000 --- a/scripting-docs/chakra-hosting/jsdefineproperty-function.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "JsDefineProperty Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsDefineProperty" -helpviewer_keywords: - - "JsDefineProperty function" -ms.assetid: b2cf48d6-eb40-457c-aa8b-b16a50dc5d6a -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsDefineProperty Function -Defines a new object's own property from a property descriptor. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsDefineProperty( - _In_ JsValueRef object, - _In_ JsPropertyIdRef propertyId, - _In_ JsValueRef propertyDescriptor, - _Out_ bool *result -); -``` - -#### Parameters - `object` - The object that has the property. - - `propertyId` - The ID of the property. - - `propertyDescriptor` - The property descriptor. - - `result` - Whether the property was defined. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsdeleteindexedproperty-function.md b/scripting-docs/chakra-hosting/jsdeleteindexedproperty-function.md deleted file mode 100644 index cf9fed12435..00000000000 --- a/scripting-docs/chakra-hosting/jsdeleteindexedproperty-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsDeleteIndexedProperty Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsDeleteIndexedProperty" -helpviewer_keywords: - - "JsDeleteIndexedProperty function" -ms.assetid: cc876839-2ecd-41a8-82d0-c19b3de944e3 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsDeleteIndexedProperty Function -Delete the value at the specified index of an object. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsDeleteIndexedProperty( - _In_ JsValueRef object, - _In_ JsValueRef index -); -``` - -#### Parameters - `object` - The object to operate on. - - `index` - The index to delete. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsdeleteproperty-function.md b/scripting-docs/chakra-hosting/jsdeleteproperty-function.md deleted file mode 100644 index e64cca36070..00000000000 --- a/scripting-docs/chakra-hosting/jsdeleteproperty-function.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "JsDeleteProperty Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsDeleteProperty" -helpviewer_keywords: - - "JsDeleteProperty function" -ms.assetid: 0f6ac6a7-3576-42f5-98d0-1c06542c8149 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsDeleteProperty Function -Deletes an object's property. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsDeleteProperty( - _In_ JsValueRef object, - _In_ JsPropertyIdRef propertyId, - _In_ bool useStrictRules, - _Out_ JsValueRef *result -); -``` - -#### Parameters - `object` - The object that contains the property. - - `propertyId` - The ID of the property. - - `useStrictRules` - The property set should follow strict mode rules. - - `result` - Whether the property was deleted. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsdisableruntimeexecution-function.md b/scripting-docs/chakra-hosting/jsdisableruntimeexecution-function.md deleted file mode 100644 index 4c9aa7df94b..00000000000 --- a/scripting-docs/chakra-hosting/jsdisableruntimeexecution-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsDisableRuntimeExecution Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsDisableRuntimeExecution" -helpviewer_keywords: - - "JsDisableRuntimeExecution function" -ms.assetid: 4bd4670a-a9da-4f8c-b3fd-1fd366d915c3 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsDisableRuntimeExecution Function -Suspends script execution and terminates any running scripts in a runtime. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsDisableRuntimeExecution( - _In_ JsRuntimeHandle runtime -); -``` - -#### Parameters - `runtime` - The runtime to be suspended. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Calls to a suspended runtime will fail until `JsEnableRuntimeExecution` is called. - - This API does not have to be called on the thread the runtime is active on. Although the runtime will be set into a suspended state, an executing script may not be suspended immediately; a running script will be terminated with an uncatchable exception as soon as possible. - - Suspending execution in a runtime that is already suspended is a no-op. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsdisposeruntime-function.md b/scripting-docs/chakra-hosting/jsdisposeruntime-function.md deleted file mode 100644 index ae90fc0eb1b..00000000000 --- a/scripting-docs/chakra-hosting/jsdisposeruntime-function.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "JsDisposeRuntime Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsDisposeRuntime" -helpviewer_keywords: - - "JsDisposeRuntime function" -ms.assetid: 0aefde3f-7250-48be-afc5-53ea85c12f30 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsDisposeRuntime Function -Disposes a runtime. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsDisposeRuntime( - _In_ JsRuntimeHandle runtime -); -``` - -#### Parameters - `runtime` - The runtime to dispose. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Once a runtime has been disposed, all resources owned by it are invalid and cannot be used. If the runtime is active (i.e. it is set to be current on a particular thread), it cannot be disposed. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsdoubletonumber-function.md b/scripting-docs/chakra-hosting/jsdoubletonumber-function.md deleted file mode 100644 index f4227ef1e4b..00000000000 --- a/scripting-docs/chakra-hosting/jsdoubletonumber-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsDoubleToNumber Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsDoubleToNumber" -helpviewer_keywords: - - "JsDoubleToNumber function" -ms.assetid: 43eb2ee1-2789-4302-954e-c4087e1ee786 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsDoubleToNumber Function -Creates a number value from a `double` value. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsDoubleToNumber( - _In_ double doubleValue, - _Out_ JsValueRef *value -); -``` - -#### Parameters - `doubleValue` - The `double` to convert to a number value. - - `value` - The new number value. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsenableruntimeexecution-function.md b/scripting-docs/chakra-hosting/jsenableruntimeexecution-function.md deleted file mode 100644 index a2f9b2a1d88..00000000000 --- a/scripting-docs/chakra-hosting/jsenableruntimeexecution-function.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "JsEnableRuntimeExecution Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsEnableRuntimeExecution" -helpviewer_keywords: - - "JsEnableRuntimeExecution function" -ms.assetid: daa2036b-aef6-497d-a8ce-5a006b6ed13f -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsEnableRuntimeExecution Function -Enables script execution in a runtime. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsEnableRuntimeExecution( - _In_ JsRuntimeHandle runtime -); -``` - -#### Parameters - `runtime` - The runtime to be enabled. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Enabling script execution in a runtime that already has script execution enabled is a no-op. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsenumerateheap-function.md b/scripting-docs/chakra-hosting/jsenumerateheap-function.md deleted file mode 100644 index bb19cead0bf..00000000000 --- a/scripting-docs/chakra-hosting/jsenumerateheap-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsEnumerateHeap Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsEnumerateHeap" -helpviewer_keywords: - - "JsEnumerateHeap function" -ms.assetid: 3e518e0b-b959-4686-899c-83e6b1946c9d -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsEnumerateHeap Function -Enumerates the heap of the current context. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsEnumerateHeap( - _Out_ IActiveScriptProfilerHeapEnum **enumerator -); -``` - -#### Parameters - `enumerator` - The heap enumerator. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - While the heap is being enumerated, the current context cannot be removed, and all calls to modify the state of the context will fail until the heap enumerator is released. - - Requires an active script context. - - This API is supported in desktop apps, but is not supported in Store apps. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsequals-function.md b/scripting-docs/chakra-hosting/jsequals-function.md deleted file mode 100644 index d4bd3682b3e..00000000000 --- a/scripting-docs/chakra-hosting/jsequals-function.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "JsEquals Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsEquals" -helpviewer_keywords: - - "JsEquals function" -ms.assetid: 8377a7b6-12ff-43e4-8cc8-5a5a198a168b -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsEquals Function -Compare two JavaScript values for equality. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsEquals( - _In_ JsValueRef object1, - _In_ JsValueRef object2, - _Out_ bool *result -); -``` - -#### Parameters - `object1` - The first object to compare. - - `object2` - The second object to compare. - - `result` - Whether the values are equal. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - This function is equivalent to the `==` operator in Javascript. - - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jserrorcode-enumeration.md b/scripting-docs/chakra-hosting/jserrorcode-enumeration.md deleted file mode 100644 index 66f8088e92a..00000000000 --- a/scripting-docs/chakra-hosting/jserrorcode-enumeration.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: "JsErrorCode Enumeration | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsErrorCode" -helpviewer_keywords: - - "JsErrorCode enumeration" -ms.assetid: 4902f3f3-47a5-4e74-9c29-f96eeecbcda9 -caps.latest.revision: 15 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsErrorCode Enumeration -An error code returned from a Chakra hosting API. - -## Syntax - -``` -enum JsErrorCode : unsigned int; -``` - -## Members - -### Values - -|Name|Description| -|----------|-----------------| -|`JsErrorAlreadyDebuggingContext`|The context cannot be put into a debug state because it is already in a debug state.| -|`JsErrorAlreadyProfilingContext`|The context cannot start profiling because it is already profiling.| -|`JsErrorArgumentNotObject`|A hosting API that operates on object values was called with a non-object value.| -|`JsErrorBadSerializedScript`|A bad serialized script was used, or the serialized script was serialized by a different version of the Chakra engine.| -|`JsErrorCannotDisableExecution`|Runtime does not support reliable script interruption.| -|`JsErrorCannotSerializeDebugScript`|Scripts cannot be serialized in debug contexts.| -|`JsErrorCategoryEngine`|Category of errors that relates to errors occurring within the engine itself.| -|`JsErrorCategoryFatal`|Category of errors that are fatal and signify failure of the engine.| -|`JsErrorCategoryScript`|Category of errors that relates to errors in a script.| -|`JsErrorCategoryUsage`|Category of errors that relates to incorrect usage of the API itself.| -|`JsErrorFatal`|A fatal error in the engine has occurred.| -|`JsErrorHeapEnumInProgress`|A heap enumeration is currently underway in the script context.| -|`JsErrorIdleNotEnabled`|Idle notification given when the host did not enable idle processing.| -|`JsErrorInDisabledState`|The runtime is in a disabled state.| -|`JsErrorInExceptionState`|The engine is in an exception state and no APIs can be called until the exception is cleared.| -|`JsErrorInObjectBeforeCollectCallback`|The operation is not supported in an object before collect callback.

This enumeration value is supported only in Edge mode.| -|`JsErrorInProfileCallback`|A script context is in the middle of a profile callback.| -|`JsErrorInThreadServiceCallback`|A thread service callback is currently underway.| -|`JsErrorInvalidArgument`|An argument to a hosting API was invalid.| -|`JsErrorNoCurrentContext`|The hosting API requires that a context be current, but there is no current context.| -|`JsErrorNotImplemented`|A hosting API is not yet implemented.| -|`JsErrorNullArgument`|An argument to a hosting API was null in a context where null is not allowed.| -|`JsErrorObjectNotInspectable`|Object cannot be unwrapped to `IInspectable` pointer.

This enumeration value is supported only in Edge mode.| -|`JsErrorOutOfMemory`|The Chakra engine has run out of memory.| -|`JsErrorPropertyNotSymbol`|A hosting API that operates on symbol property ids but was called with a non-symbol property id. The error code is returned by `JsGetSymbolFromPropertyId` if the function is called with non-symbol property id.

This enumeration value is supported only in Edge mode.| -|`JsErrorPropertyNotString`|A hosting API that operates on string property ids but was called with a non-string property id. The error code is returned by existing `JsGetPropertyNamefromId` if the function is called with non-string property id.

This enumeration value is supported only in Edge mode.| -|`JsErrorRuntimeInUse`|A runtime that is still in use cannot be disposed.| -|`JsErrorScriptCompile`|JavaScript failed to compile.| -|`JsErrorScriptEvalDisabled`|A script was terminated because it tried to use `eval` or `function` and eval was disabled.| -|`JsErrorScriptException`|A JavaScript exception occurred while running a script.| -|`JsErrorScriptTerminated`|A script was terminated due to a request to suspend a runtime.| -|`JsErrorWrongRuntime`|A hosting API was called with object created on different JavaScript runtime.| -|`JsErrorWrongThread`|A hosting API was called on the wrong thread.| -|`JsNoError`|Success error code.| - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsfinalizecallback-typedef.md b/scripting-docs/chakra-hosting/jsfinalizecallback-typedef.md deleted file mode 100644 index f551e72c51a..00000000000 --- a/scripting-docs/chakra-hosting/jsfinalizecallback-typedef.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "JsFinalizeCallback Typedef | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: aa7a0269-b9d4-4717-97ac-8da7eb6ced15 -caps.latest.revision: 6 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsFinalizeCallback Typedef -A finalizer callback. - -## Syntax - -``` -typedef void (CALLBACK *JsFinalizeCallback)( - _In_opt_ void *data -); -``` - -#### Parameters - data - The external data that was passed in when creating the object being finalized. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetandclearexception-function.md b/scripting-docs/chakra-hosting/jsgetandclearexception-function.md deleted file mode 100644 index e5909b939c0..00000000000 --- a/scripting-docs/chakra-hosting/jsgetandclearexception-function.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "JsGetAndClearException Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsGetAndClearException" -helpviewer_keywords: - - "JsGetAndClearException function" -ms.assetid: 6aec8a88-41ee-47f6-b5f4-32f3cae6bb7b -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetAndClearException Function -Returns the exception that caused the runtime of the current context to be in the exception state and resets the exception state for that runtime. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetAndClearException( - _Out_ JsValueRef *exception -); -``` - -#### Parameters - `exception` - The exception for the runtime of the current context. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - If the runtime of the current context is not in an exception state, this API will return `JsErrorInvalidArgument`. If the runtime is disabled, this will return an exception indicating that the script was terminated, but it will not clear the exception (the exception will be cleared if the runtime is re-enabled using `JsEnableRuntimeExecution`). - - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetarraybufferstorage-function.md b/scripting-docs/chakra-hosting/jsgetarraybufferstorage-function.md deleted file mode 100644 index f9f8a5f0e15..00000000000 --- a/scripting-docs/chakra-hosting/jsgetarraybufferstorage-function.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "JsGetArrayBufferStorage Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 712ae298-36a9-47ef-b089-e51835c056bc -caps.latest.revision: 2 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetArrayBufferStorage Function -Obtains the underlying memory storage used by an `ArrayBuffer`. - -## Syntax - -``` -JsErrorCode STDAPI_ JsGetArrayBufferStorage( - _In_ JsValueRef arrayBuffer, - _Outptr_result_bytebuffer_(*bufferLength) BYTE **buffer, - _Out_ unsigned int *bufferLength -); -``` - -#### Parameters - `arrayBuffer` - The ArrayBuffer instance. - - `buffer` - The ArrayBuffer's buffer. The lifetime of the buffer returned is the same as the lifetime of the `ArrayBuffer`. The buffer pointer does not count as a reference to the `ArrayBuffer` for the purpose of garbage collection. - - `bufferLength` - The number of bytes in the buffer. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - - This API is supported only in Edge mode. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetcontextdata-function.md b/scripting-docs/chakra-hosting/jsgetcontextdata-function.md deleted file mode 100644 index 739e959df93..00000000000 --- a/scripting-docs/chakra-hosting/jsgetcontextdata-function.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "JsGetContextData Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "article" -ms.assetid: f5d7e446-267a-4a80-a427-6e1b95a3391b -caps.latest.revision: 4 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetContextData Function -Gets the internal data set on JsrtContext. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetContextData( - _In_ JsContextRef context, - _Out_ void **data -); -``` - -#### Parameters - `context` - The context to get the data from. - - `data` - The pointer to the data where data will be returned. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetcontextofobject-function.md b/scripting-docs/chakra-hosting/jsgetcontextofobject-function.md deleted file mode 100644 index a0e5da35bd0..00000000000 --- a/scripting-docs/chakra-hosting/jsgetcontextofobject-function.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "JsGetContextOfObject Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "article" -ms.assetid: cea6cdcd-790f-455c-af04-026af8ae2eb7 -caps.latest.revision: 3 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetContextOfObject Function -Gets the script context that the object belongs to.. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetContextOfObject( - _In_ JsValueRef object, - _Out_ JsContextRef *context -); -``` - -#### Parameters - `object` - The object to get the context from. - - `context` - The context the object belongs to. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetcurrentcontext-function.md b/scripting-docs/chakra-hosting/jsgetcurrentcontext-function.md deleted file mode 100644 index c022720bcb1..00000000000 --- a/scripting-docs/chakra-hosting/jsgetcurrentcontext-function.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "JsGetCurrentContext Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsGetCurrentContext" -helpviewer_keywords: - - "JsGetCurrentContext function" -ms.assetid: dd5fe0fa-d1e5-4af6-809e-e655a27519b5 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetCurrentContext Function -Gets the current script context on the thread. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetCurrentContext( - _Out_ JsContextRef *currentContext -); -``` - -#### Parameters - `currentContext` - The current script context on the thread, null if there is no current script context. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetdataviewstorage-function.md b/scripting-docs/chakra-hosting/jsgetdataviewstorage-function.md deleted file mode 100644 index 15dc316c387..00000000000 --- a/scripting-docs/chakra-hosting/jsgetdataviewstorage-function.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "JsGetDataViewStorage Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 7c2180e0-51d5-4cc8-ad21-8bf29ff7c583 -caps.latest.revision: 2 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetDataViewStorage Function -Obtains the underlying memory storage used by a `DataView`. - -## Syntax - -```cpp -STDAPI_(JsErrorCode) JsGetDataViewStorage( - _In_ JsValueRef dataView, - _Outptr_result_bytebuffer_(*bufferLength) BYTE **buffer, - _Out_ unsigned int *bufferLength -); -``` - -#### Parameters - `dataView` - The DataView instance. - - `buffer` - The DataView's buffer. The lifetime of the buffer returned is the same as the lifetime of the `DataView`. The buffer pointer does not count as a reference to the `DataView` for the purpose of garbage collection. - - `bufferLength` - The number of bytes in the buffer. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - - This API is supported only in Edge mode. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetextensionallowed-function.md b/scripting-docs/chakra-hosting/jsgetextensionallowed-function.md deleted file mode 100644 index 1715557016c..00000000000 --- a/scripting-docs/chakra-hosting/jsgetextensionallowed-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsGetExtensionAllowed Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsGetExtensionAllowed" -helpviewer_keywords: - - "JsGetExtensionAllowed function" -ms.assetid: 839054a1-d643-47d9-89db-6a015bba0d91 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetExtensionAllowed Function -Returns a value that indicates whether an object is extensible or not. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetExtensionAllowed( - _In_ JsValueRef object, - _Out_ bool *value -); -``` - -#### Parameters - `object` - The object to test. - - `value` - Whether the object is extensible or not. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetexternaldata-function.md b/scripting-docs/chakra-hosting/jsgetexternaldata-function.md deleted file mode 100644 index d583ade9ae6..00000000000 --- a/scripting-docs/chakra-hosting/jsgetexternaldata-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsGetExternalData Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsGetExternalData" -helpviewer_keywords: - - "JsGetExternalData function" -ms.assetid: 1919e1da-3ea7-4269-a5fb-a3be06bd029b -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetExternalData Function -Retrieves the data from an external object. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetExternalData( - _In_ JsValueRef object, - _Out_ void **externalData -); -``` - -#### Parameters - `object` - The external object. - - `externalData` - The external data stored in the object. Can be null if no external data is stored in the object. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetfalsevalue-function.md b/scripting-docs/chakra-hosting/jsgetfalsevalue-function.md deleted file mode 100644 index 1b8c6b86900..00000000000 --- a/scripting-docs/chakra-hosting/jsgetfalsevalue-function.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "JsGetFalseValue Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsGetFalseValue" -helpviewer_keywords: - - "JsGetFalseValue function" -ms.assetid: 621a584c-4ca8-4ba0-b19a-6cb50cf830b6 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetFalseValue Function -Gets the value of `false` in the current script context. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetFalseValue( - _Out_ JsValueRef *falseValue -); -``` - -#### Parameters - `falseValue` - The `false` value. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetglobalobject-function.md b/scripting-docs/chakra-hosting/jsgetglobalobject-function.md deleted file mode 100644 index 55f50cd7660..00000000000 --- a/scripting-docs/chakra-hosting/jsgetglobalobject-function.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "JsGetGlobalObject Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsGetGlobalObject" -helpviewer_keywords: - - "JsGetGlobalObject function" -ms.assetid: d3e91e64-1ca3-4d2b-aada-725ded0fd0b1 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetGlobalObject Function -Gets the global object in the current script context. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetGlobalObject( - _Out_ JsValueRef *globalObject -); -``` - -#### Parameters - `globalObject` - The global object. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetindexedpropertiesexternaldata-function.md b/scripting-docs/chakra-hosting/jsgetindexedpropertiesexternaldata-function.md deleted file mode 100644 index fd9f6a53f42..00000000000 --- a/scripting-docs/chakra-hosting/jsgetindexedpropertiesexternaldata-function.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "JsGetIndexedPropertiesExternalData Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 2c313163-3462-42fd-8dee-3dfb3ac7f43f -caps.latest.revision: 2 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetIndexedPropertiesExternalData Function -Retrieves an object's indexed properties external data information. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetIndexedPropertiesExternalData( - _In_ JsValueRef object, - _Out_ void** data, - _Out_ JsTypedArrayType* arrayType, - _Out_ unsigned int* elementLength -); -``` - -#### Parameters - `object` - The object. - - `data` - The external data back store for the object's indexed properties. - - `arrayType` - The array element type in external data. - - `elementLength` - The number of array elements in external data. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - This API is supported only in Edge mode. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetindexedproperty-function.md b/scripting-docs/chakra-hosting/jsgetindexedproperty-function.md deleted file mode 100644 index f4668bace40..00000000000 --- a/scripting-docs/chakra-hosting/jsgetindexedproperty-function.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "JsGetIndexedProperty Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsGetIndexedProperty" -helpviewer_keywords: - - "JsGetIndexedProperty function" -ms.assetid: f61ea388-0ae6-4a19-b3b5-75ed49a3f32d -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetIndexedProperty Function -Retrieve the value at the specified index of an object. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetIndexedProperty( - _In_ JsValueRef object, - _In_ JsValueRef index, - _Out_ JsValueRef *result -); -``` - -#### Parameters - `object` - The object to operate on. - - `index` - The index to retrieve. - - `result` - The retrieved value. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetnullvalue-function.md b/scripting-docs/chakra-hosting/jsgetnullvalue-function.md deleted file mode 100644 index 6638d794e8f..00000000000 --- a/scripting-docs/chakra-hosting/jsgetnullvalue-function.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "JsGetNullValue Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsGetNullValue" -helpviewer_keywords: - - "JsGetNullValue function" -ms.assetid: 132a1496-8dfe-4d3c-a8f8-389f5b0b50d2 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetNullValue Function -Gets the value of `null` in the current script context. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetNullValue( - _Out_ JsValueRef *nullValue -); -``` - -#### Parameters - `nullValue` - The `null` value. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetownpropertydescriptor-function.md b/scripting-docs/chakra-hosting/jsgetownpropertydescriptor-function.md deleted file mode 100644 index a0574f06670..00000000000 --- a/scripting-docs/chakra-hosting/jsgetownpropertydescriptor-function.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "JsGetOwnPropertyDescriptor Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsGetOwnPropertyDescriptor" -helpviewer_keywords: - - "JsGetOwnPropertyDescriptor function" -ms.assetid: 44c417ce-ab63-44eb-a0ab-19838e3ab34f -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetOwnPropertyDescriptor Function -Gets a property descriptor for an object's own property. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetOwnPropertyDescriptor( - _In_ JsValueRef object, - _In_ JsPropertyIdRef propertyId, - _Out_ JsValueRef *propertyDescriptor -); -``` - -#### Parameters - `object` - The object that has the property. - - `propertyId` - The ID of the property. - - `propertyDescriptor` - The property descriptor. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetownpropertynames-function.md b/scripting-docs/chakra-hosting/jsgetownpropertynames-function.md deleted file mode 100644 index d53114670cd..00000000000 --- a/scripting-docs/chakra-hosting/jsgetownpropertynames-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsGetOwnPropertyNames Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsGetOwnPropertyNames" -helpviewer_keywords: - - "JsGetOwnPropertyNames function" -ms.assetid: 0c17ea06-b17f-4ea3-ad04-1259a4d1b6de -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetOwnPropertyNames Function -Gets the list of all properties on the object. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetOwnPropertyNames( - _In_ JsValueRef object, - _Out_ JsValueRef *propertyNames -); -``` - -#### Parameters - `object` - The object from which to get the property names. - - `propertyNames` - An array of property names. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetownpropertysymbols-function.md b/scripting-docs/chakra-hosting/jsgetownpropertysymbols-function.md deleted file mode 100644 index 138c613094b..00000000000 --- a/scripting-docs/chakra-hosting/jsgetownpropertysymbols-function.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "JsGetOwnPropertySymbols Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 57c431e3-de0b-4ed0-b750-87a86448daff -caps.latest.revision: 2 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetOwnPropertySymbols Function -Gets the list of all symbol properties on the object. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetOwnPropertySymbols( - _In_ JsValueRef object, - _Out_ JsValueRef *propertySymbols -); -``` - -#### Parameters - `object` - The object from which to get the property symbols. - - `propertySymbols` - An array of property symbols. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - - This API is supported only in Edge mode. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetproperty-function.md b/scripting-docs/chakra-hosting/jsgetproperty-function.md deleted file mode 100644 index 3c84d35a412..00000000000 --- a/scripting-docs/chakra-hosting/jsgetproperty-function.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "JsGetProperty Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsGetProperty" -helpviewer_keywords: - - "JsGetProperty function" -ms.assetid: 606bc14f-e849-4f88-a148-6660e923c07b -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetProperty Function -Gets an object's property. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetProperty( - _In_ JsValueRef object, - _In_ JsPropertyIdRef propertyId, - _Out_ JsValueRef *value -); -``` - -#### Parameters - `object` - The object that contains the property. - - `propertyId` - The ID of the property. - - `value` - The value of the property. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetpropertyidfromname-function.md b/scripting-docs/chakra-hosting/jsgetpropertyidfromname-function.md deleted file mode 100644 index 5db5a310460..00000000000 --- a/scripting-docs/chakra-hosting/jsgetpropertyidfromname-function.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "JsGetPropertyIdFromName Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsGetPropertyIdFromName" -helpviewer_keywords: - - "JsGetPropertyIdFromName function" -ms.assetid: 1674906f-746a-4c62-99cd-023276683a86 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetPropertyIdFromName Function -Gets the property ID associated with the name. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetPropertyIdFromName( - _In_z_ const wchar_t *name, - _Out_ JsPropertyIdRef *propertyId -); -``` - -#### Parameters - `name` - The name of the property ID to get or create. The name may consist of only digits. - - `propertyId` - The property ID in this runtime for the given name. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Property IDs are specific to a context and cannot be used across contexts. - - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetpropertyidfromsymbol-function.md b/scripting-docs/chakra-hosting/jsgetpropertyidfromsymbol-function.md deleted file mode 100644 index 7d278d03f38..00000000000 --- a/scripting-docs/chakra-hosting/jsgetpropertyidfromsymbol-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsGetPropertyIdFromSymbol Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 190fe4b9-352e-4b10-9d0e-6c6bbd6363e8 -caps.latest.revision: 2 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetPropertyIdFromSymbol Function -Gets the property ID associated with the symbol. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetPropertyIdFromSymbol( - _In_ JsValueRef symbol, - _Out_ JsPropertyIdRef *propertyId -); -``` - -#### Parameters - `symbol` - The symbol whose property ID is being retrieved. - - `propertyId` - The property ID for the given symbol. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Property IDs are specific to a context and cannot be used across contexts. - - Requires an active script context. - - This API is supported only in Edge mode. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetpropertyidtype-function.md b/scripting-docs/chakra-hosting/jsgetpropertyidtype-function.md deleted file mode 100644 index 900ef3f46de..00000000000 --- a/scripting-docs/chakra-hosting/jsgetpropertyidtype-function.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "JsGetPropertyIdType Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 2b6e85ad-c630-4a07-a759-3b344d06faaa -caps.latest.revision: 3 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetPropertyIdType Function -Gets the type of property. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetPropertyIdType( - _In_ JsPropertyIdRef propertyId, - _Out_ JsPropertyIdType* propertyIdType -); -``` - -#### Parameters - `propertyId` - The property ID to get the type of. - - `propertyIdType` - The `JsPropertyIdType` of the given property ID. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - - This API is supported only in Edge mode. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetpropertynamefromid-function.md b/scripting-docs/chakra-hosting/jsgetpropertynamefromid-function.md deleted file mode 100644 index 55d96099f16..00000000000 --- a/scripting-docs/chakra-hosting/jsgetpropertynamefromid-function.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "JsGetPropertyNameFromId Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsGetPropertyNameFromId" -helpviewer_keywords: - - "JsGetPropertyNameFromId function" -ms.assetid: b4ca442c-573d-4bc3-adf7-1b8d48480b3a -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetPropertyNameFromId Function -Gets the name associated with the property ID. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetPropertyNameFromId( - _In_ JsPropertyIdRef propertyId, - _Outptr_result_z_ const wchar_t **name -); -``` - -#### Parameters - `propertyId` - The property ID to get the name of. - - `name` - The name associated with the property ID. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - - The returned buffer is valid as long as the runtime is alive and cannot be used once the runtime has been disposed. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetprototype-function.md b/scripting-docs/chakra-hosting/jsgetprototype-function.md deleted file mode 100644 index b657fb29674..00000000000 --- a/scripting-docs/chakra-hosting/jsgetprototype-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsGetPrototype Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsGetPrototype" -helpviewer_keywords: - - "JsGetPrototype function" -ms.assetid: 05d743fc-103e-4a92-86f2-a063f39a2a6f -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetPrototype Function -Returns the prototype of an object. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetPrototype( - _In_ JsValueRef object, - _Out_ JsValueRef *prototypeObject -); -``` - -#### Parameters - `object` - The object whose prototype is to be returned. - - `prototypeObject` - The object's prototype. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetruntime-function.md b/scripting-docs/chakra-hosting/jsgetruntime-function.md deleted file mode 100644 index 556374dbd7e..00000000000 --- a/scripting-docs/chakra-hosting/jsgetruntime-function.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "JsGetRuntime Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsGetRuntime" -helpviewer_keywords: - - "JsGetRuntime function" -ms.assetid: 5b62e940-a885-405a-9fdd-0495fb391b95 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetRuntime Function -Gets the runtime that the context belongs to. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetRuntime( - _In_ JsContextRef context, - _Out_ JsRuntimeHandle *runtime -); -``` - -#### Parameters - `context` - The context to get the runtime from. - - `runtime` - The runtime the context belongs to. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetruntimememorylimit-function.md b/scripting-docs/chakra-hosting/jsgetruntimememorylimit-function.md deleted file mode 100644 index 7ecde286f19..00000000000 --- a/scripting-docs/chakra-hosting/jsgetruntimememorylimit-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsGetRuntimeMemoryLimit Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsGetRuntimeMemoryLimit" -helpviewer_keywords: - - "JsGetRuntimeMemoryLimit function" -ms.assetid: ed81ca60-99fd-46b0-89ae-f6ac07926904 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetRuntimeMemoryLimit Function -Gets the current memory limit for a runtime. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetRuntimeMemoryLimit( - _In_ JsRuntimeHandle runtime, - _Out_ size_t *memoryLimit -); -``` - -#### Parameters - `runtime` - The runtime whose memory limit is to be retrieved. - - `memoryLimit` - The runtime's current memory limit, in bytes, or -1 if no limit has been set. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - The memory limit of a runtime can be always be retrieved, regardless of whether or not the runtime is active on another thread. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetruntimememoryusage-function.md b/scripting-docs/chakra-hosting/jsgetruntimememoryusage-function.md deleted file mode 100644 index 78c1c5c692c..00000000000 --- a/scripting-docs/chakra-hosting/jsgetruntimememoryusage-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsGetRuntimeMemoryUsage Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsGetRuntimeMemoryUsage" -helpviewer_keywords: - - "JsGetRuntimeMemoryUsage function" -ms.assetid: b9bd4146-bfbc-4cb1-a0e9-a0ded7fb09bd -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetRuntimeMemoryUsage Function -Gets the current memory usage for a runtime. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetRuntimeMemoryUsage( - _In_ JsRuntimeHandle runtime, - _Out_ size_t *memoryUsage -); -``` - -#### Parameters - `runtime` - The runtime whose memory usage is to be retrieved. - - `memoryUsage` - The runtime's current memory usage, in bytes. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Memory usage can be always be retrieved, regardless of whether or not the runtime is active on another thread. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetstringlength-function.md b/scripting-docs/chakra-hosting/jsgetstringlength-function.md deleted file mode 100644 index 6c50f25e2e6..00000000000 --- a/scripting-docs/chakra-hosting/jsgetstringlength-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsGetStringLength Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsGetStringLength" -helpviewer_keywords: - - "JsGetStringLength function" -ms.assetid: e9f9f28c-e644-439c-aee5-7ce362f71347 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetStringLength Function -Gets the length of a string value. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetStringLength( - _In_ JsValueRef stringValue, - _Out_ int *length -); -``` - -#### Parameters - `stringValue` - The string value to get the length of. - - `length` - The length of the string. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetsymbolfrompropertyid-function.md b/scripting-docs/chakra-hosting/jsgetsymbolfrompropertyid-function.md deleted file mode 100644 index b7c995ade73..00000000000 --- a/scripting-docs/chakra-hosting/jsgetsymbolfrompropertyid-function.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "JsGetSymbolFromPropertyId Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 0e822cb4-ba9e-44df-bf3a-fae97c354daa -caps.latest.revision: 2 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetSymbolFromPropertyId Function -Gets the symbol associated with the property ID. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetSymbolFromPropertyId( - _In_ JsPropertyIdRef propertyId, - _Out_ JsValueRef *symbol -); -``` - -#### Parameters - `propertyId` - The property ID to get the symbol of. - - `symbol` - The symbol associated with the property ID. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - - This API is supported only in Edge mode. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgettruevalue-function.md b/scripting-docs/chakra-hosting/jsgettruevalue-function.md deleted file mode 100644 index 0a52648b418..00000000000 --- a/scripting-docs/chakra-hosting/jsgettruevalue-function.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "JsGetTrueValue Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsGetTrueValue" -helpviewer_keywords: - - "JsGetTrueValue function" -ms.assetid: c2a56d48-344b-492b-90b8-f570710f8310 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetTrueValue Function -Gets the value of `true` in the current script context. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetTrueValue( - _Out_ JsValueRef *trueValue -); -``` - -#### Parameters - `trueValue` - The `true` value. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgettypedarrayinfo-function.md b/scripting-docs/chakra-hosting/jsgettypedarrayinfo-function.md deleted file mode 100644 index 0ae9c27a5bb..00000000000 --- a/scripting-docs/chakra-hosting/jsgettypedarrayinfo-function.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "JsGetTypedArrayInfo Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "article" -ms.assetid: 992bc4e9-3d06-4ad2-8b6b-88a437360f81 -caps.latest.revision: 3 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetTypedArrayInfo Function -Obtains frequently used properties of a typed array. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetTypedArrayInfo( - _In_ JsValueRef typedArray, - _Out_opt_ JsTypedArrayType *arrayType, - _Out_opt_ JsValueRef *arrayBuffer, - _Out_opt_ unsigned int *byteOffset, - _Out_opt_ unsigned int *byteLength -); - -``` - -#### Parameters - `typedArray` - The typed array instance. - - `arrayType` - The type of the array. - - `arrayBuffer` - The `ArrayBuffer` backstore of the array. - - `byteOffset` - The offset in bytes from the start of arrayBuffer referenced by the array. - - `byteLength` - The number of bytes in the array. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgettypedarraystorage-function.md b/scripting-docs/chakra-hosting/jsgettypedarraystorage-function.md deleted file mode 100644 index 791da9a00ac..00000000000 --- a/scripting-docs/chakra-hosting/jsgettypedarraystorage-function.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: "JsGetTypedArrayStorage Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 52e4ac5f-cc71-456d-95de-a48f7327503d -caps.latest.revision: 2 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetTypedArrayStorage Function -Obtains the underlying memory storage used by a typed array. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetTypedArrayStorage( - _In_ JsValueRef typedArray, - _Outptr_result_bytebuffer_(*bufferLength) BYTE **buffer, - _Out_ unsigned int *bufferLength, - _Out_opt_ JsTypedArrayType *arrayType, - _Out_opt_ int *elementSize -); -``` - -#### Parameters - `typedArray` - The typed array instance. - - `buffer` - The array's buffer. The lifetime of the buffer returned is the same as the lifetime of the array. The buffer pointer does not count as a reference to the array for the purpose of garbage collection. - - `bufferLength` - The number of bytes in the buffer. - - `arrayType` - The type of the array. - - `elementSize` - The size of an element of the array. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - - This API is supported only in Edge mode. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetundefinedvalue-function.md b/scripting-docs/chakra-hosting/jsgetundefinedvalue-function.md deleted file mode 100644 index d2f8e85e0f2..00000000000 --- a/scripting-docs/chakra-hosting/jsgetundefinedvalue-function.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "JsGetUndefinedValue Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsGetUndefinedValue" -helpviewer_keywords: - - "JsGetUndefinedValue function" -ms.assetid: e118eaf6-452c-42f2-86b8-e63c7d987cba -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetUndefinedValue Function -Gets the value of `undefined` in the current script context. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetUndefinedValue( - _Out_ JsValueRef *undefinedValue -); -``` - -#### Parameters - `undefinedValue` - The `undefined` value. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsgetvaluetype-function.md b/scripting-docs/chakra-hosting/jsgetvaluetype-function.md deleted file mode 100644 index 010cf7a694a..00000000000 --- a/scripting-docs/chakra-hosting/jsgetvaluetype-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsGetValueType Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsGetValueType" -helpviewer_keywords: - - "JsGetValueType function" -ms.assetid: f403cf7c-c8c0-4a17-bfa9-0302d00e760e -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsGetValueType Function -Gets the JavaScript type of a JsValueRef. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsGetValueType( - _In_ JsValueRef value, - _Out_ JsValueType *type -); -``` - -#### Parameters - `value` - The value whose type is to be returned. - - `type` - The type of the value. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jshasexception-function.md b/scripting-docs/chakra-hosting/jshasexception-function.md deleted file mode 100644 index 99ce838b0e0..00000000000 --- a/scripting-docs/chakra-hosting/jshasexception-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsHasException Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsHasException" -helpviewer_keywords: - - "JsHasException function" -ms.assetid: ac7da3ce-c746-4154-bbb8-bcb0859a8d5b -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsHasException Function -Determines whether the runtime of the current context is in an exception state. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsHasException( - _Out_ bool *hasException -); -``` - -#### Parameters - `hasException` - Whether the runtime of the current context is in the exception state. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - If a call into the runtime results in an exception (either as the result of running a script or due to something like a conversion failure), the runtime is placed into an "exception state." All calls into any context created by the runtime (except for the exception APIs) will fail with `JsErrorInExceptionState` until the exception is cleared. - - If the runtime of the current context is in the exception state when a callback returns into the engine, the engine will automatically rethrow the exception. - - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jshasexternaldata-function.md b/scripting-docs/chakra-hosting/jshasexternaldata-function.md deleted file mode 100644 index 5c6f6e91a3b..00000000000 --- a/scripting-docs/chakra-hosting/jshasexternaldata-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsHasExternalData Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsHasExternalData" -helpviewer_keywords: - - "JsHasExternalData function" -ms.assetid: a077e3ac-4f6f-4d94-8398-f1b5cc4c18e0 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsHasExternalData Function -Determines whether an object is an external object. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsHasExternalData( - _In_ JsValueRef object, - _Out_ bool *value -); -``` - -#### Parameters - `object` - The object. - - `value` - Whether the object is an external object. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jshasindexedpropertiesexternaldata-function.md b/scripting-docs/chakra-hosting/jshasindexedpropertiesexternaldata-function.md deleted file mode 100644 index 9eb1dc2a1d4..00000000000 --- a/scripting-docs/chakra-hosting/jshasindexedpropertiesexternaldata-function.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "JsHasIndexedPropertiesExternalData Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: c676db20-3ef1-4f84-8b26-3e06fe0ab2bf -caps.latest.revision: 2 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsHasIndexedPropertiesExternalData Function -Determines whether an object has its indexed properties in external data. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsHasIndexedPropertiesExternalData( - _In_ JsValueRef object, - _Out_ bool* value -); -``` - -#### Parameters - `object` - The object. - - `value` - Whether the object has its indexed properties in external data. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - This API is supported only in Edge mode. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jshasindexedproperty-function.md b/scripting-docs/chakra-hosting/jshasindexedproperty-function.md deleted file mode 100644 index d38d260c235..00000000000 --- a/scripting-docs/chakra-hosting/jshasindexedproperty-function.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "JsHasIndexedProperty Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsHasIndexedProperty" -helpviewer_keywords: - - "JsHasIndexedProperty function" -ms.assetid: 30436a3d-fda0-407e-aba2-142be2310372 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsHasIndexedProperty Function -Tests whether an object has a value at the specified index. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsHasIndexedProperty( - _In_ JsValueRef object, - _In_ JsValueRef index, - _Out_ bool *result -); -``` - -#### Parameters - `object` - The object to operate on. - - `index` - The index to test. - - `result` - Whether the object has an value at the specified index. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jshasproperty-function.md b/scripting-docs/chakra-hosting/jshasproperty-function.md deleted file mode 100644 index 872330c6e9e..00000000000 --- a/scripting-docs/chakra-hosting/jshasproperty-function.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "JsHasProperty Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsHasProperty" -helpviewer_keywords: - - "JsHasProperty function" -ms.assetid: 26c94c3d-aae6-4257-8644-df63c7e714fb -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsHasProperty Function -Determines whether an object has a property. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsHasProperty( - _In_ JsValueRef object, - _In_ JsPropertyIdRef propertyId, - _Out_ bool *hasProperty -); -``` - -#### Parameters - `object` - The object that may contain the property. - - `propertyId` - The ID of the property. - - `hasProperty` - Whether the object (or a prototype) has the property. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsidle-function.md b/scripting-docs/chakra-hosting/jsidle-function.md deleted file mode 100644 index 1fce38bc5d4..00000000000 --- a/scripting-docs/chakra-hosting/jsidle-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsIdle Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsIdle" -helpviewer_keywords: - - "JsIdle function" -ms.assetid: 372d1c62-8e19-4886-aa33-364cabc09bba -caps.latest.revision: 13 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsIdle Function -Tells the runtime to do any idle processing it need to do. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsIdle( - _Out_opt_ unsigned int *nextIdleTick -); -``` - -#### Parameters - `nextIdleTick` - The next system tick when there will be more idle work to do. Can be null. Returns the maximum number of ticks if there no upcoming idle work to do. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - If idle processing has been enabled for the current runtime, calling `JsIdle` will inform the current runtime that the host is idle and that the runtime can perform memory cleanup tasks. - - `JsIdle` can also return the number of system ticks until there will be more idle work for the runtime to do. Calling `JsIdle` before this number of ticks has passed will do no work. - - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsinspectabletoobject-function.md b/scripting-docs/chakra-hosting/jsinspectabletoobject-function.md deleted file mode 100644 index 3ec09db5d0c..00000000000 --- a/scripting-docs/chakra-hosting/jsinspectabletoobject-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsInspectableToObject Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: dd0ad567-2ba8-4a63-bee4-2c6ff5ce9fa9 -caps.latest.revision: 2 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsInspectableToObject Function -Creates a JavaScript value that is a projection of the passed in `IInspectable` pointer. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsInspectableToObject( - _In_ IInspectable *inspectable, - _Out_ JsValueRef *value -); -``` - -#### Parameters - `inspectable` - A `IInspectable` to be projected. - - `value` - A JavaScript value that is a projection of the `IInspectable`. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - The projected value can be used by script to call a WinRT object. Hosts are responsible for enforcing COM threading rules. - - Requires an active script context. - - This API is supported only in Edge mode. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsinstanceof-function.md b/scripting-docs/chakra-hosting/jsinstanceof-function.md deleted file mode 100644 index b93a348c8fc..00000000000 --- a/scripting-docs/chakra-hosting/jsinstanceof-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsInstanceOf Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "article" -ms.assetid: 94399a62-b996-4fd2-82ce-1c26e7a4da08 -caps.latest.revision: 6 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsInstanceOf Function -Performs JavaScript "instanceof" operator test. - -## Syntax - -``` -JsInstanceOf( - _In_ JsValueRef object, - _In_ JsValueRef constructor, - _Out_ bool *result -); - -``` - -#### Parameters - `object` - The object to test. - - `constructor` - The constructor function to test against. - - `result` - Whether the "object instanceof constructor" is true. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsinttonumber-function.md b/scripting-docs/chakra-hosting/jsinttonumber-function.md deleted file mode 100644 index 37f4c3d618c..00000000000 --- a/scripting-docs/chakra-hosting/jsinttonumber-function.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "JsIntToNumber Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 1393c4ac-7189-4e9c-8e54-b0e041c22112 -caps.latest.revision: 4 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsIntToNumber Function -Creates a number value from an `int` value. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsIntToNumber( - _In_ int intValue, - _Out_ JsValueRef *value -); -``` - -#### Parameters - `intValue` - The `int` to convert to a number value. - - `value` - The new number value. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsisenumeratingheap-function.md b/scripting-docs/chakra-hosting/jsisenumeratingheap-function.md deleted file mode 100644 index 9b313051f08..00000000000 --- a/scripting-docs/chakra-hosting/jsisenumeratingheap-function.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "JsIsEnumeratingHeap Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsIsEnumeratingHeap" -helpviewer_keywords: - - "JsIsEnumeratingHeap function" -ms.assetid: 5d14518e-3153-43f2-9a9c-068580cbd54f -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsIsEnumeratingHeap Function -Returns a value that indicates whether the heap of the current context is being enumerated. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsIsEnumeratingHeap( - _Out_ bool *isEnumeratingHeap -); -``` - -#### Parameters - `isEnumeratingHeap` - Whether the heap is being enumerated. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - - This API is supported in desktop apps, but is not supported in Store apps. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsisruntimeexecutiondisabled-function.md b/scripting-docs/chakra-hosting/jsisruntimeexecutiondisabled-function.md deleted file mode 100644 index 8608c68ae56..00000000000 --- a/scripting-docs/chakra-hosting/jsisruntimeexecutiondisabled-function.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: "JsIsRuntimeExecutionDisabled Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsIsRuntimeExecutionDisabled" -helpviewer_keywords: - - "JsIsRuntimeExecutionDisabled function" -ms.assetid: 77490280-fb84-4614-a1f0-6ac31e3bd607 -caps.latest.revision: 5 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsIsRuntimeExecutionDisabled Function -Returns a value that indicates whether script execution is disabled in the runtime. - -## Syntax - -```vb -STDAPI_(JsErrorCode) JsIsRuntimeExecutionDisabled( _In_ JsRuntimeHandle runtime, _Out_ bool *isDisabled); -``` - -#### Parameters - `runtime` - Specifies the runtime to check if execution is disabled. - - `isDisabled` - `true` if execution is disabled, `false` otherwise. - -## Return Value - `JsNoError` if the operation succeeded, a failure code otherwise. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsmemoryallocationcallback-typedef.md b/scripting-docs/chakra-hosting/jsmemoryallocationcallback-typedef.md deleted file mode 100644 index 36825268471..00000000000 --- a/scripting-docs/chakra-hosting/jsmemoryallocationcallback-typedef.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsMemoryAllocationCallback Typedef | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 511babc7-3caa-4ee5-82a2-943bbd34db8d -caps.latest.revision: 7 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsMemoryAllocationCallback Typedef -User implemented callback routine for memory allocation events. - -## Syntax - -``` -typedef bool (CALLBACK * JsMemoryAllocationCallback)( - _In_opt_ void *callbackState, - _In_ JsMemoryEventType allocationEvent, - _In_ size_t allocationSize -); -``` - -#### Parameters - callbackState - The state passed to JsSetRuntimeMemoryAllocationCallback. - - allocationEvent - The type of type allocation event. - - allocationSize - The size of the allocation. - -## Property Value/Return Value - For the JsMemoryAllocate event, returning true allows the runtime to continue with allocation. Returning false indicates the allocation request is rejected. The return value is ignored for other allocation events. - -## Remarks - Use JsSetRuntimeMemoryAllocationCallback to register this callback. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsmemoryeventtype-enumeration.md b/scripting-docs/chakra-hosting/jsmemoryeventtype-enumeration.md deleted file mode 100644 index 7676bf3a942..00000000000 --- a/scripting-docs/chakra-hosting/jsmemoryeventtype-enumeration.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: "JsMemoryEventType Enumeration | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsMemoryEventType" -helpviewer_keywords: - - "JsMemoryEventType enumeration" -ms.assetid: b4b176b6-b536-472e-8999-95b681a1df55 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsMemoryEventType Enumeration -Allocation callback event type. - -## Syntax - -``` -enum JsMemoryEventType; -``` - -## Members - -### Values - -|Name|Description| -|----------|-----------------| -|`JsMemoryAllocate`|Indicates a request for memory allocation.| -|`JsMemoryFailure`|Indicates a failed allocation event.| -|`JsMemoryFree`|Indicates a memory freeing event.| - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsnativefunction-typedef.md b/scripting-docs/chakra-hosting/jsnativefunction-typedef.md deleted file mode 100644 index f3a5337d084..00000000000 --- a/scripting-docs/chakra-hosting/jsnativefunction-typedef.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "JsNativeFunction Typedef | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 56ef6cdf-4ca9-4f7c-b953-e661addb1a8e -caps.latest.revision: 5 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsNativeFunction Typedef -A function callback. - -## Syntax - -``` -typedef _Ret_maybenull_ JsValueRef (CALLBACK * JsNativeFunction)( - _In_ JsValueRef callee, - _In_ bool isConstructCall, - _In_ JsValueRef *arguments, - _In_ unsigned short argumentCount -); -``` - -#### Parameters - callee - A `Function` object that represents the function being invoked. - - isConstructCall - Indicates whether this is a regular call or a 'new' call. - - arguments - The arguments to the call. - - argumentCount - The number of arguments. - -## Property Value/Return Value - The result of the call, if any. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsnumbertodouble-function.md b/scripting-docs/chakra-hosting/jsnumbertodouble-function.md deleted file mode 100644 index 22235b49dfc..00000000000 --- a/scripting-docs/chakra-hosting/jsnumbertodouble-function.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "JsNumberToDouble Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsNumberToDouble" -helpviewer_keywords: - - "JsNumberToDouble function" -ms.assetid: 5f52e8b6-2b70-49a3-879a-bd83ebf2ac33 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsNumberToDouble Function -Retrieves the `double` value of a number value. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsNumberToDouble( - _In_ JsValueRef value, - _Out_ double *doubleValue -); -``` - -#### Parameters - `value` - The number value to convert to a `double` value. - - `doubleValue` - The `double` value. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - This function retrieves the value of a number value. It will fail with `JsErrorInvalidArgument` if the type of the value is not number. - - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsnumbertoint-function.md b/scripting-docs/chakra-hosting/jsnumbertoint-function.md deleted file mode 100644 index c0e0f66edba..00000000000 --- a/scripting-docs/chakra-hosting/jsnumbertoint-function.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: "JsNumberToInt Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 8b9256d6-76ac-4c74-a97c-fbb16c13f5f5 -caps.latest.revision: 2 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsNumberToInt Function -Retrieves the `int` value of a number value. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsNumberToInt( - _In_ JsValueRef value, - _Out_ int *intValue -); -``` - -#### Parameters - `value` - The number value to convert to an `int` value. - - `intValue` - The `int` value. - -## Return Value - -## Remarks - This function retrieves the value of a number value and converts to an `int` value. It will fail with `JsErrorInvalidArgument` if the type of the value is not number. - - Requires an active script context. - - This API is supported only in Edge mode. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsobjectbeforecollectcallback-typedef.md b/scripting-docs/chakra-hosting/jsobjectbeforecollectcallback-typedef.md deleted file mode 100644 index 1cdc2c5a9fd..00000000000 --- a/scripting-docs/chakra-hosting/jsobjectbeforecollectcallback-typedef.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "JsObjectBeforeCollectCallback Typedef | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: f21a064a-579f-44cb-9d21-76b62e8c18f5 -caps.latest.revision: 3 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsObjectBeforeCollectCallback Typedef -A callback called before collecting an object. - -## Syntax - -``` -typedef void (CALLBACK *JsObjectBeforeCollectCallback)( - _In_ JsRef ref, - _In_opt_ void *callbackState -); -``` - -#### Parameters - `ref` - The object to be collected. - - `callbackState` - The state passed to `JsSetObjectBeforeCollectCallback`. - -## Remarks - This API is supported only in Edge mode. - -## Requirements - jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsobjecttoinspectable-function.md b/scripting-docs/chakra-hosting/jsobjecttoinspectable-function.md deleted file mode 100644 index b4bde6070ac..00000000000 --- a/scripting-docs/chakra-hosting/jsobjecttoinspectable-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsObjectToInspectable Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 1d15b0b8-516f-4fc6-95aa-2ddd65f8ab75 -caps.latest.revision: 2 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsObjectToInspectable Function -Unwraps a JavaScript object to an `IInspectable` pointer - -## Syntax - -``` -STDAPI_(JsErrorCode) JsObjectToInspectable( - _In_ JsValueRef value, - _Out_ IInspectable **inspectable -); -``` - -#### Parameters - `value` - A JavaScript value that should be projected to `IInspectable`. - - `inspectable` - An `IInspectable` value of the object. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Hosts are responsible for enforcing COM threading rules. - - Requires an active script context. - - This API is supported only in Edge mode. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsparsescript-function.md b/scripting-docs/chakra-hosting/jsparsescript-function.md deleted file mode 100644 index 66ec5c5af62..00000000000 --- a/scripting-docs/chakra-hosting/jsparsescript-function.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "JsParseScript Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsParseScript" -helpviewer_keywords: - - "JsParseScript function" -ms.assetid: e9d0e363-7cbe-43eb-9dc0-1f47e586c9ab -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsParseScript Function -Parses a script and returns a function representing the script. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsParseScript( - _In_z_ const wchar_t *script, - _In_ JsSourceContext sourceContext, - _In_z_ const wchar_t *sourceUrl, - _Out_ JsValueRef *result -); -``` - -#### Parameters - `script` - The script to parse. - - `sourceContext` - A cookie identifying the script that can be used by debuggable script contexts. - - `sourceUrl` - The location the script came from. - - `result` - A function representing the script code. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsparseserializedscript-function.md b/scripting-docs/chakra-hosting/jsparseserializedscript-function.md deleted file mode 100644 index 49b81ee880f..00000000000 --- a/scripting-docs/chakra-hosting/jsparseserializedscript-function.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "JsParseSerializedScript Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsParseSerializedScript" -helpviewer_keywords: - - "JsParseSerializedScript function" -ms.assetid: 40d0c7c4-fd5b-46ed-9e65-38c2db2fc859 -caps.latest.revision: 13 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsParseSerializedScript Function -Parses a serialized script and returns a function representing the script. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsParseSerializedScript( - _In_z_ const wchar_t *script, - _In_ BYTE *buffer, - _In_ JsSourceContext sourceContext, - _In_z_ const wchar_t *sourceUrl, - _Out_ JsValueRef *result -); -``` - -#### Parameters - `script` - The script to parse. - - `buffer` - The serialized script. - - `sourceContext` - A cookie identifying the script that can be used by debuggable script contexts. - - `sourceUrl` - The location the script came from. - - `result` - A function representing the script code. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - - The buffer is not persisted in memory by the scripting engine, so your code must keep it alive for as long as it might be used to execute scripts. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsparseserializedscriptwithcallback-function.md b/scripting-docs/chakra-hosting/jsparseserializedscriptwithcallback-function.md deleted file mode 100644 index f3f966ffdf8..00000000000 --- a/scripting-docs/chakra-hosting/jsparseserializedscriptwithcallback-function.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "JsParseSerializedScriptWithCallback Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "article" -ms.assetid: 0a93ecfb-4b82-4a85-b24c-6816db2332ea -caps.latest.revision: 5 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsParseSerializedScriptWithCallback Function -Parses a serialized script and returns a function representing the script. Provides the ability to lazy load the script source only if/when it is needed. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsParseSerializedScriptWithCallback( - _In_ JsSerializedScriptLoadSourceCallback scriptLoadCallback, - _In_ JsSerializedScriptUnloadCallback scriptUnloadCallback, - _In_ BYTE *buffer, - _In_ JsSourceContext sourceContext, - _In_z_ const wchar_t *sourceUrl, - _Out_ JsValueRef * result -); - -``` - -#### Parameters - `scriptLoadCallback` - Callback called when the source code of the script needs to be loaded. - - `scriptUnloadCallback` - Callback called when the serialized script and source code are no longer needed. - - `buffer` - The serialized script. - - `sourceContext` - A cookie identifying the script that can be used by debuggable script contexts. This context will passed into scriptLoadCallback and scriptUnloadCallback. - - `sourceUrl` - The location the script came from. - - `result` - A function representing the script code. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - -> [!NOTE] -> This API is not yet available for Store apps. - - Requires an active script context. - - The runtime will hold on to the buffer until all instances of any functions created from the buffer are garbage collected. It will then call scriptUnloadCallback to inform the caller that it is safe to release. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jspointertostring-function.md b/scripting-docs/chakra-hosting/jspointertostring-function.md deleted file mode 100644 index 57549ed7eb5..00000000000 --- a/scripting-docs/chakra-hosting/jspointertostring-function.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "JsPointerToString Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsPointerToString" -helpviewer_keywords: - - "JsPointerToString function" -ms.assetid: c71ce07e-4359-450c-afbf-a6ab7d48dddf -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsPointerToString Function -Creates a string value from a string pointer. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsPointerToString( - _In_reads_(stringLength) const wchar_t *stringValue, - _In_ size_t stringLength, - _Out_ JsValueRef *value -); -``` - -#### Parameters - `stringValue` - The string pointer to convert to a string value. - - `stringLength` - The length of the string to convert. - - `value` - The new string value. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jspreventextension-function.md b/scripting-docs/chakra-hosting/jspreventextension-function.md deleted file mode 100644 index 447016e2748..00000000000 --- a/scripting-docs/chakra-hosting/jspreventextension-function.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "JsPreventExtension Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsPreventExtension" -helpviewer_keywords: - - "JsPreventExtension function" -ms.assetid: 8da07e20-d076-4ae4-9fb0-3f3c141518c2 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsPreventExtension Function -Makes an object non-extensible. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsPreventExtension( - _In_ JsValueRef object -); -``` - -#### Parameters - `object` - The object to make non-extensible. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsprojectioncallback-typedef.md b/scripting-docs/chakra-hosting/jsprojectioncallback-typedef.md deleted file mode 100644 index 3f658b18571..00000000000 --- a/scripting-docs/chakra-hosting/jsprojectioncallback-typedef.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "JsProjectionCallback Typedef | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 32f22d37-e57e-4196-b6cd-a3fc75bd0632 -caps.latest.revision: 3 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsProjectionCallback Typedef -The JsRT callback which should be called with the context passed to `JsProjectionEnqueueCallback` on the correct thread. - -## Syntax - -``` -typedef void (CALLBACK *JsProjectionCallback)( - _In_ JsProjectionCallbackContext jsContext -); -``` - -#### Parameters - `jsContext` - Requires calling `JsSetProjectionEnqueueCallback` to receive callbacks. - -## Remarks - This API is supported only in Edge mode. - -## Requirements - jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsprojectioncallbackcontext-typedef.md b/scripting-docs/chakra-hosting/jsprojectioncallbackcontext-typedef.md deleted file mode 100644 index be71501ff6d..00000000000 --- a/scripting-docs/chakra-hosting/jsprojectioncallbackcontext-typedef.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "JsProjectionCallbackContext Typedef | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 50c705c5-664f-4a1a-92f6-4882fc718ab1 -caps.latest.revision: 2 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsProjectionCallbackContext Typedef -The context passed into application callback, JsProjectionEnqueueCallback, from JsRT and then passed back to JsRT in the provided callback, `JsProjectionCallback`, by the application on the correct thread. - -## Syntax - -```cpp -typedef void *JsProjectionCallbackContext; -``` - -## Remarks - Requires calling `JsSetProjectionEnqueueCallback` to receive callbacks. - - This API is supported only in Edge mode. - -## Requirements - jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsprojectionenqueuecallback-typedef.md b/scripting-docs/chakra-hosting/jsprojectionenqueuecallback-typedef.md deleted file mode 100644 index 36d0d222d0b..00000000000 --- a/scripting-docs/chakra-hosting/jsprojectionenqueuecallback-typedef.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: "JsProjectionEnqueueCallback Typedef | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 19c1cefb-a7be-4196-b780-9fe6adf35ba5 -caps.latest.revision: 4 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsProjectionEnqueueCallback Typedef -The application callback which is called by JsRT when a projection API is completed on a different thread than the original. - -## Syntax - -``` -typedef void (CALLBACK *JsProjectionEnqueueCallback)( - _In_ JsProjectionCallback jsCallback, - _In_ JsProjectionCallbackContext jsContext, - _In_opt_ void *callbackState -); -``` - -#### Parameters - `jsCallback` - The callback to be invoked on the original thread. - - `jsContext` - The applications context. - - `callbackState` - The JsRT context that must be passed into `jsCallback`. - -## Remarks - Requires calling JsSetProjectionEnqueueCallback to receive callbacks. - - This API is supported only in Edge mode. - -## Requirements - jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsprojectwinrtnamespace-function.md b/scripting-docs/chakra-hosting/jsprojectwinrtnamespace-function.md deleted file mode 100644 index 6f1bc6950a8..00000000000 --- a/scripting-docs/chakra-hosting/jsprojectwinrtnamespace-function.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "JsProjectWinRTNamespace Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 8a23c154-df4b-4ce3-9fef-f41f90acdb87 -caps.latest.revision: 5 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsProjectWinRTNamespace Function -Project a WinRT namespace. - -## Syntax - -``` -STDAPI_(JsErrorCode) - JsProjectWinRTNamespace( - _In_z_ const wchar_t *namespaceName -); -``` - -#### Parameters - `namespaceName` - The WinRT namespace to be projected. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - - This API is supported only in Edge mode. - -> [!NOTE] -> WinRT was the platform name before Universal Windows Platform (UWP). - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jspromisecontinuationcallback-typedef.md b/scripting-docs/chakra-hosting/jspromisecontinuationcallback-typedef.md deleted file mode 100644 index e61380362cb..00000000000 --- a/scripting-docs/chakra-hosting/jspromisecontinuationcallback-typedef.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "JsPromiseContinuationCallback Typedef | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 51a3fd02-9668-4cf7-bb0b-e1fd03b2528f -caps.latest.revision: 3 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsPromiseContinuationCallback Typedef -A promise continuation callback. - -## Syntax - -``` -typedef void (CALLBACK *JsPromiseContinuationCallback)( - _In_ JsValueRef task, - _In_opt_ void *callbackState -); -``` - -#### Parameters - `task` - `callbackState` - -## Remarks - The host can specify a promise continuation callback in `JsSetPromiseContinuationCallback`. If a script creates a task to be run later, then the promise continuation callback will be called with the task and the task should be put in a FIFO queue, to be run when the current script is done executing. - - This API is supported only in Edge mode. - -## Requirements - jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jspropertyidref-typedef.md b/scripting-docs/chakra-hosting/jspropertyidref-typedef.md deleted file mode 100644 index cb114b8abda..00000000000 --- a/scripting-docs/chakra-hosting/jspropertyidref-typedef.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "JsPropertyIdRef Typedef | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 39976437-4e02-4f68-b473-94de209a73f1 -caps.latest.revision: 6 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsPropertyIdRef Typedef -A property identifier. - -## Syntax - -``` -typedef JsRef JsPropertyIdRef; -``` - -## Remarks - Property identifiers are used to refer to properties of JavaScript objects instead of using strings. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jspropertyidtype-enumeration.md b/scripting-docs/chakra-hosting/jspropertyidtype-enumeration.md deleted file mode 100644 index ab4b6aa2b89..00000000000 --- a/scripting-docs/chakra-hosting/jspropertyidtype-enumeration.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "JsPropertyIdType Enumeration | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 1b8293ca-a040-402d-8ea5-4299390adcd0 -caps.latest.revision: 2 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsPropertyIdType Enumeration -Type enumeration of a JavaScript property. - -## Syntax - -```vb -enum JsPropertyIdType; -``` - -## Members - -### Values - -|Name|Description| -|----------|-----------------| -|JsPropertyIdTypeString|Type enumeration of a JavaScript string property| -|JsPropertyIdTypeSymbol|Type enumeration of a JavaScript symbol property| - -## Requirements - jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsref-typedef.md b/scripting-docs/chakra-hosting/jsref-typedef.md deleted file mode 100644 index 597135c6892..00000000000 --- a/scripting-docs/chakra-hosting/jsref-typedef.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "JsRef Typedef | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 6aafc39f-6b9c-457f-8bf0-48831bffe9b8 -caps.latest.revision: 6 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsRef Typedef -A reference to an object owned by the Chakra garbage collector. - -## Syntax - -``` -typedef void *JsRef; -``` - -## Remarks - A Chakra runtime will automatically track JsRef references as long as they are on stored in local variables or in parameters (i.e. on the stack). Storing a JsRef somewhere other than on the stack requires calling JsAddRef and JsRelease to manage the lifetime of the object, otherwise the garbage collector may free the object while it is still in use. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsrelease-function.md b/scripting-docs/chakra-hosting/jsrelease-function.md deleted file mode 100644 index a831603f863..00000000000 --- a/scripting-docs/chakra-hosting/jsrelease-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsRelease Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsRelease" -helpviewer_keywords: - - "JsRelease function" -ms.assetid: 8714fd0b-5b66-48e0-927e-7b93af6cde7b -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsRelease Function -Releases a reference to a garbage collected object. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsRelease( - _In_ JsRef ref, - _Out_opt_ unsigned int *count -); -``` - -#### Parameters - `ref` - The object to add a reference to. - - `count` - The object's new reference count (can pass in null). - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Removes a reference to a `JsRef` handle that was created by `JsAddRef`. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsrunscript-function.md b/scripting-docs/chakra-hosting/jsrunscript-function.md deleted file mode 100644 index 3572e6564de..00000000000 --- a/scripting-docs/chakra-hosting/jsrunscript-function.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "JsRunScript Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsRunScript" -helpviewer_keywords: - - "JsRunScript function" -ms.assetid: 8d6b8c9a-af3a-4e21-a330-5a6b535423a3 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsRunScript Function -Executes a script. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsRunScript( - _In_z_ const wchar_t *script, - _In_ JsSourceContext sourceContext, - _In_z_ const wchar_t *sourceUrl, - _Out_ JsValueRef *result -); -``` - -#### Parameters - `script` - The script to run. - - `sourceContext` - A cookie identifying the script that can be used by debuggable script contexts. - - `sourceUrl` - The location the script came from. - - `result` - The result of the script, if any. This parameter can be null. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsrunserializedscript-function.md b/scripting-docs/chakra-hosting/jsrunserializedscript-function.md deleted file mode 100644 index 2c68fce2e1a..00000000000 --- a/scripting-docs/chakra-hosting/jsrunserializedscript-function.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "JsRunSerializedScript Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsRunSerializedScript" -helpviewer_keywords: - - "JsRunSerializedScript function" -ms.assetid: 3fd3f6f1-eb3e-4751-92a5-c93b1035f3b2 -caps.latest.revision: 13 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsRunSerializedScript Function -Runs a serialized script. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsRunSerializedScript( - _In_z_ const wchar_t *script, - _In_ BYTE *buffer, - _In_ JsSourceContext sourceContext, - _In_z_ const wchar_t *sourceUrl, - _Out_ JsValueRef *result -); -``` - -#### Parameters - `script` - The source code of the serialized script. - - `buffer` - The serialized script. - - `sourceContext` - A cookie identifying the script that can be used by debuggable script contexts. - - `sourceUrl` - The location the script came from. - - `result` - The result of running the script, if any. This parameter can be null. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - - The buffer is not persisted in memory by the scripting engine, so your code must keep it alive for as long as it might be used to execute scripts. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsrunserializedscriptwithcallback-function.md b/scripting-docs/chakra-hosting/jsrunserializedscriptwithcallback-function.md deleted file mode 100644 index 99f3dddb73b..00000000000 --- a/scripting-docs/chakra-hosting/jsrunserializedscriptwithcallback-function.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "JsRunSerializedScriptWithCallback Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "article" -ms.assetid: 0608d778-f65b-4dc5-a745-364aac57ef59 -caps.latest.revision: 4 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsRunSerializedScriptWithCallback Function -Runs a serialized script. Provides the ability to lazy load the script source only if/when it is needed. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsRunSerializedScriptWithCallback( - _In_ JsSerializedScriptLoadSourceCallback scriptLoadCallback, - _In_ JsSerializedScriptUnloadCallback scriptUnloadCallback, - _In_ BYTE *buffer, - _In_ JsSourceContext sourceContext, - _In_z_ const wchar_t *sourceUrl, - _Out_opt_ JsValueRef *result -); - -``` - -#### Parameters - `scriptLoadCallback` - Callback called when the source code of the script needs to be loaded. - - `scriptUnloadCallback` - Callback called when the serialized script and source code are no longer needed. - - `buffer` - The serialized script. - - `sourceContext` - A cookie identifying the script that can be used by debuggable script contexts. This context will passed into scriptLoadCallback and scriptUnloadCallback. - - `sourceUrl` - The location the script came from. - - `result` - The result of running the script, if any. This parameter can be null. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - -> [!NOTE] -> This API is not yet available for Store apps. - - Requires an active script context. - - The runtime will hold on to the buffer until all instances of any functions created from the buffer are garbage collected. It will then call scriptUnloadCallback to inform the caller that it is safe to release. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsruntimeattributes-enumeration.md b/scripting-docs/chakra-hosting/jsruntimeattributes-enumeration.md deleted file mode 100644 index caa78475326..00000000000 --- a/scripting-docs/chakra-hosting/jsruntimeattributes-enumeration.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: "JsRuntimeAttributes Enumeration | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsRuntimeAttributes" -helpviewer_keywords: - - "JsRuntimeAttributes enumeration" -ms.assetid: f76d82e9-a695-4d6a-96c1-b3a4d27fed68 -caps.latest.revision: 14 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsRuntimeAttributes Enumeration -Attributes of a runtime. - -## Syntax - -``` -enum JsRuntimeAttributes; -``` - -## Members - -### Values - -|Name|Description| -|----------|-----------------| -|`JsRuntimeAttributeAllowScriptInterrupt`|The runtime should support reliable script interruption. This increases the number of places where the runtime will check for a script interrupt request at the cost of a small amount of runtime performance.| -|`JsRuntimeAttributeDisableBackgroundWork`|The runtime will not do any work (such as garbage collection) on background threads.| -|`JsRuntimeAttributeDisableEval`|Using `eval` or `function` constructor will throw an exception.| -|`JsRuntimeAttributeDisableNativeCodeGeneration`|Runtime will not generate native code.| -|`JsRuntimeAttributeEnableExperimentalFeatures`|Runtime will enable all experimental features.| -|`JsRuntimeAttributeEnableIdleProcessing`|Host will call `JsIdle`, so enable idle processing. Otherwise, the runtime will manage memory slightly more aggressively.| -|`JsRuntimeAttributeDispatchSetExceptionsToDebugger`|Calling `JsSetException` will also dispatch the exception to the script debugger (if any) giving the debugger a chance to break on the exception.| -|`JsRuntimeAttributeNone`|No special attributes.| - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsruntimehandle-typedef.md b/scripting-docs/chakra-hosting/jsruntimehandle-typedef.md deleted file mode 100644 index b0a1806495d..00000000000 --- a/scripting-docs/chakra-hosting/jsruntimehandle-typedef.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "JsRuntimeHandle Typedef | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 69e59bfd-9b0e-4710-9aa8-fbd6844171bc -caps.latest.revision: 6 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsRuntimeHandle Typedef -A handle to a Chakra runtime. - -## Syntax - -``` -typedef void *JsRuntimeHandle; -``` - -## Remarks - Each Chakra runtime has its own independent execution engine, JIT compiler, and garbage collected heap. As such, each runtime is completely isolated from other runtimes. - - Runtimes can be used on any thread, but only one thread can call into a runtime at any time. - -> [!WARNING] -> A JsRuntimeHandle, unlike other object references in the Chakra hosting API, is not garbage collected since it contains the garbage collected heap itself. A runtime will continue to exist until JsDisposeRuntime is called. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsruntimeversion-enumeration.md b/scripting-docs/chakra-hosting/jsruntimeversion-enumeration.md deleted file mode 100644 index 1965550e061..00000000000 --- a/scripting-docs/chakra-hosting/jsruntimeversion-enumeration.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: "JsRuntimeVersion Enumeration | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsRuntimeVersion" -helpviewer_keywords: - - "JsRuntimeVersion enumeration" -ms.assetid: 3de69423-3bee-4d20-8ae7-2cf56c848be7 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsRuntimeVersion Enumeration -Version of the runtime. - -## Syntax - -``` -enum JsRuntimeVersion; -``` - -## Members - -### Values - -|Name|Description| -|----------|-----------------| -|`JsRuntimeVersion10`|Create runtime with IE10 version.| -|`JsRuntimeVersion11`|Create runtime with IE11 version.| -|`JsRuntimeVersionEdge`|Create runtime with highest version present on the machine at runtime.| - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsserializedscriptloadsourcecallback-typedef.md b/scripting-docs/chakra-hosting/jsserializedscriptloadsourcecallback-typedef.md deleted file mode 100644 index d5cd11dfe2b..00000000000 --- a/scripting-docs/chakra-hosting/jsserializedscriptloadsourcecallback-typedef.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "JsSerializedScriptLoadSourceCallback Typedef | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "article" -ms.assetid: 9406c488-76ac-49e5-b305-39751f3412ea -caps.latest.revision: 3 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsSerializedScriptLoadSourceCallback Typedef -Called by the runtime to load the source code of the serialized script. The caller must keep the script buffer valid until the `JsSerializedScriptUnloadCallback`. - -## Syntax - -``` -typedef bool (CALLBACK * JsSerializedScriptLoadSourceCallback)( - _In_ JsSourceContextsourceContext, - _Outptr_result_z_ const wchar_t** scriptBuffer -); -``` - -#### Parameters - `sourceContext` - The context passed to `JsParseSerializedScriptWithCallback` or `JsRunSerializedScriptWithCallback`. - - `scriptBuffer` - The script returned. - -## Remarks - -> [!WARNING] -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsserializedscriptunloadcallback-typedef.md b/scripting-docs/chakra-hosting/jsserializedscriptunloadcallback-typedef.md deleted file mode 100644 index be3909a0b88..00000000000 --- a/scripting-docs/chakra-hosting/jsserializedscriptunloadcallback-typedef.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "JsSerializedScriptUnloadCallback typedef | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "article" -ms.assetid: 8d18c392-cca0-411e-9f2b-0d788b16161a -caps.latest.revision: 3 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsSerializedScriptUnloadCallback typedef -Called by the runtime when it is finished with all resources related to the script execution. The caller should free the source if loaded, the byte code, and the context at this time. - -## Syntax - -``` - typedef void (CALLBACK * JsSerializedScriptUnloadCallback)( - _In_ JsSourceContext sourceContext -); -``` - -#### Parameters - `sourceContext` - The context passed to `JsParseSerializedScriptWithCallback` or `JsRunSerializedScriptWithCallback`. - -## Remarks - -> [!WARNING] -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsserializescript-function.md b/scripting-docs/chakra-hosting/jsserializescript-function.md deleted file mode 100644 index ede0554ae62..00000000000 --- a/scripting-docs/chakra-hosting/jsserializescript-function.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "JsSerializeScript Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsSerializeScript" -helpviewer_keywords: - - "JsSerializeScript function" -ms.assetid: ca42c194-e1c1-407d-b542-b9d494e3ac4e -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsSerializeScript Function -Serializes a parsed script to a buffer than can be reused. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsSerializeScript( - _In_z_ const wchar_t *script, - _Out_writes_to_opt_(*bufferSize, - *bufferSize) BYTE *buffer, - _Inout_ unsigned long *bufferSize -); -``` - -#### Parameters - `script` - The script to serialize. - - `buffer` - The buffer to put the serialized script into. Can be null. - - `bufferSize` - On entry, the size of the buffer, in bytes; on exit, the size of the buffer, in bytes, required to hold the serialized script. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - `JsSerializeScript` parses a script and then stores the parsed form of the script in a runtime-independent format. The serialized script then can be deserialized in any runtime without requiring the script to be re-parsed. - - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jssetcontextdata-function.md b/scripting-docs/chakra-hosting/jssetcontextdata-function.md deleted file mode 100644 index a581807c2b0..00000000000 --- a/scripting-docs/chakra-hosting/jssetcontextdata-function.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "JsSetContextData Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "article" -ms.assetid: be90aa6a-b001-4a6f-90c5-c2135e913be0 -caps.latest.revision: 4 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsSetContextData Function -Sets the internal data of JsrtContext. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsSetContextData( - _In_ JsContextRef context, - _In_ void *data -); - -``` - -#### Parameters - `context` - The context to set the data to. - - `data` - The pointer to the data to be set. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jssetcurrentcontext-function.md b/scripting-docs/chakra-hosting/jssetcurrentcontext-function.md deleted file mode 100644 index b675044f133..00000000000 --- a/scripting-docs/chakra-hosting/jssetcurrentcontext-function.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "JsSetCurrentContext Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsSetCurrentContext" -helpviewer_keywords: - - "JsSetCurrentContext function" -ms.assetid: 603cc94c-6585-411b-89f9-c6f144e2aa30 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsSetCurrentContext Function -Sets the current script context on the thread. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsSetCurrentContext( - _In_ JsContextRef context -); -``` - -#### Parameters - `context` - The script context to make current. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jssetexception-function.md b/scripting-docs/chakra-hosting/jssetexception-function.md deleted file mode 100644 index a452766efa6..00000000000 --- a/scripting-docs/chakra-hosting/jssetexception-function.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "JsSetException Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsSetException" -helpviewer_keywords: - - "JsSetException function" -ms.assetid: c528793a-2e1b-4ee1-bd2e-e63fd547dc40 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsSetException Function -Sets the runtime of the current context to an exception state. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsSetException( - _In_ JsValueRef exception -); -``` - -#### Parameters - `exception` - The JavaScript exception to set for the runtime of the current context. - -## Return Value - `JsNoError` if the engine was set into an exception state, a failure code otherwise. - -## Remarks - If the runtime of the current context is already in an exception state, this API will return `JsErrorInExceptionState`. - - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jssetexternaldata-function.md b/scripting-docs/chakra-hosting/jssetexternaldata-function.md deleted file mode 100644 index 23ba97b2a33..00000000000 --- a/scripting-docs/chakra-hosting/jssetexternaldata-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsSetExternalData Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsSetExternalData" -helpviewer_keywords: - - "JsSetExternalData function" -ms.assetid: 94e0ad34-67d7-4f7f-88a3-3b057ef5e4b9 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsSetExternalData Function -Sets the external data on an external object. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsSetExternalData( - _In_ JsValueRef object, - _In_opt_ void *externalData -); -``` - -#### Parameters - `object` - The external object. - - `externalData` - The external data stored in the object. Can be null if no external data is stored in the object. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jssetindexedpropertiestoexternaldata-function.md b/scripting-docs/chakra-hosting/jssetindexedpropertiestoexternaldata-function.md deleted file mode 100644 index 91148601cbe..00000000000 --- a/scripting-docs/chakra-hosting/jssetindexedpropertiestoexternaldata-function.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "JsSetIndexedPropertiesToExternalData Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: cee2d86d-ed42-4acb-86ef-95a67e63d0d6 -caps.latest.revision: 2 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsSetIndexedPropertiesToExternalData Function -Sets an object's indexed properties to external data. The external data will be used as back store for the object's indexed properties and accessed like a typed array. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsSetIndexedPropertiesToExternalData( - _In_ JsValueRef object, - _In_ void* data, - _In_ JsTypedArrayType arrayType, - _In_ unsigned int elementLength -); -``` - -#### Parameters - `object` - The object to operate on. - - `data` - The external data to be used as back store for the object's indexed properties. - - `arrayType` - The array element type in external data. - - `elementLength` - The number of array elements in external data. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - - This API is supported only in Edge mode. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jssetindexedproperty-function.md b/scripting-docs/chakra-hosting/jssetindexedproperty-function.md deleted file mode 100644 index b51bbb81a86..00000000000 --- a/scripting-docs/chakra-hosting/jssetindexedproperty-function.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "JsSetIndexedProperty Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsSetIndexedProperty" -helpviewer_keywords: - - "JsSetIndexedProperty function" -ms.assetid: ccbc5bf4-d99b-485c-ab25-d2bd1ed2142e -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsSetIndexedProperty Function -Set the value at the specified index of an object. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsSetIndexedProperty( - _In_ JsValueRef object, - _In_ JsValueRef index, - _In_ JsValueRef value -); -``` - -#### Parameters - `object` - The object to operate on. - - `index` - The index to set. - - `value` - The value to set. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jssetobjectbeforecollectcallback-function.md b/scripting-docs/chakra-hosting/jssetobjectbeforecollectcallback-function.md deleted file mode 100644 index 86ec59ad868..00000000000 --- a/scripting-docs/chakra-hosting/jssetobjectbeforecollectcallback-function.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "JsSetObjectBeforeCollectCallback Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: ea2cbd94-d8b0-4fa9-a4a1-c75a4e338eaf -caps.latest.revision: 3 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsSetObjectBeforeCollectCallback Function -Sets a callback function that is called by the runtime before garbage collection of an object. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsSetObjectBeforeCollectCallback( - _In_ JsRef ref, - _In_opt_ void *callbackState, - _In_ JsObjectBeforeCollectCallback objectBeforeCollectCallback -); -``` - -#### Parameters - `ref` - The object for which to register the callback. - - `callbackState` - User-provided state that will be passed back to the callback. - - `objectBeforeCollectCallback` - The callback function being set. Use null to clear previously registered callback. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - The callback is invoked on the current runtime execution thread, therefore execution is blocked until the callback completes. - - This API is supported only in Edge mode. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jssetprojectionenqueuecallback-function.md b/scripting-docs/chakra-hosting/jssetprojectionenqueuecallback-function.md deleted file mode 100644 index 7099b4fcef4..00000000000 --- a/scripting-docs/chakra-hosting/jssetprojectionenqueuecallback-function.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: "JsSetProjectionEnqueueCallback Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: c751ccef-20d2-4d41-9568-1c54adf47cdf -caps.latest.revision: 4 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsSetProjectionEnqueueCallback Function -Sets the callback to be used in order to invoke a projection completion back to the callers required thread. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsSetProjectionEnqueueCallback( - _In_ JsProjectionEnqueueCallback projectionEnqueueCallback, - _In_opt_ void *projectionEnqueueContext); - -``` - -#### Parameters - `projectionEnqueueContext` - The callback that will be invoked any time a projection completion occurs on a background thread. - - `callbackState` - The application context provided to `projectionEnqueueContext`. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - - The call should be coming from a different COM apartment or from a different thread in the same MTA. - - This API is supported only in Edge mode. - -> [!CAUTION] -> PInvoke is not currently supported for this API. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jssetpromisecontinuationcallback-function.md b/scripting-docs/chakra-hosting/jssetpromisecontinuationcallback-function.md deleted file mode 100644 index ab210816a62..00000000000 --- a/scripting-docs/chakra-hosting/jssetpromisecontinuationcallback-function.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "JsSetPromiseContinuationCallback Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 6ef0faf4-1500-4bd9-aeca-c208492af8ea -caps.latest.revision: 2 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsSetPromiseContinuationCallback Function -Sets a promise continuation callback function that is called by the context when a task needs to be queued for future execution. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsSetPromiseContinuationCallback( - _In_ JsPromiseContinuationCallback promiseContinuationCallback, - _In_opt_ void *callbackState -); -``` - -#### Parameters - `promiseContinuationCallback` - The callback function being set. - - `callbackState` - User provided state that will be passed back to the callback. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - - This API is supported only in Edge mode. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jssetproperty-function.md b/scripting-docs/chakra-hosting/jssetproperty-function.md deleted file mode 100644 index 4c2716e3167..00000000000 --- a/scripting-docs/chakra-hosting/jssetproperty-function.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "JsSetProperty Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsSetProperty" -helpviewer_keywords: - - "JsSetProperty function" -ms.assetid: 2c36bebf-ec86-425c-8131-2dd75fd30f40 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsSetProperty Function -Puts an object's property. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsSetProperty( - _In_ JsValueRef object, - _In_ JsPropertyIdRef propertyId, - _In_ JsValueRef value, - _In_ bool useStrictRules -); -``` - -#### Parameters - `object` - The object that contains the property. - - `propertyId` - The ID of the property. - - `value` - The new value of the property. - - `useStrictRules` - The property set should follow strict mode rules. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jssetprototype-function.md b/scripting-docs/chakra-hosting/jssetprototype-function.md deleted file mode 100644 index c2c5a57f106..00000000000 --- a/scripting-docs/chakra-hosting/jssetprototype-function.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "JsSetPrototype Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 88e1e421-4ae5-4e3b-b377-19256cc80e9f -caps.latest.revision: 4 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsSetPrototype Function -Sets the prototype of an object. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsSetPrototype( - _In_ JsValueRef object, - _In_ JsValueRef prototypeObject -); -``` - -#### Parameters - `object` - The object whose prototype is to be changed. - - `prototypeObject` - The object's new prototype. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jssetruntimebeforecollectcallback-function.md b/scripting-docs/chakra-hosting/jssetruntimebeforecollectcallback-function.md deleted file mode 100644 index 57cc4829f15..00000000000 --- a/scripting-docs/chakra-hosting/jssetruntimebeforecollectcallback-function.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "JsSetRuntimeBeforeCollectCallback Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsSetRuntimeBeforeCollectCallback" -helpviewer_keywords: - - "JsSetRuntimeBeforeCollectCallback function" -ms.assetid: 7b2fb911-6007-4ed9-a307-66cefe590ea4 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsSetRuntimeBeforeCollectCallback Function -Sets a callback function that is called by the runtime before garbage collection. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsSetRuntimeBeforeCollectCallback( - _In_ JsRuntimeHandle runtime, - _In_opt_ void *callbackState, - _In_ JsBeforeCollectCallback beforeCollectCallback -); -``` - -#### Parameters - `runtime` - The runtime for which to register the allocation callback. - - `callbackState` - User provided state that will be passed back to the callback. - - `beforeCollectCallback` - The callback function being set. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - The callback is invoked on the current runtime execution thread, therefore execution is blocked until the callback completes. - - The callback can be used by hosts to prepare for garbage collection. For example, by releasing unnecessary references on Chakra objects. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jssetruntimememoryallocationcallback-function.md b/scripting-docs/chakra-hosting/jssetruntimememoryallocationcallback-function.md deleted file mode 100644 index 3163ff06025..00000000000 --- a/scripting-docs/chakra-hosting/jssetruntimememoryallocationcallback-function.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "JsSetRuntimeMemoryAllocationCallback Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsSetRuntimeMemoryAllocationCallback" -helpviewer_keywords: - - "JsSetRuntimeMemoryAllocationCallback function" -ms.assetid: 6aa7d58d-6456-4df1-815f-1ba36fb4ae14 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsSetRuntimeMemoryAllocationCallback Function -Sets a memory allocation callback for specified runtime - -## Syntax - -``` -STDAPI_(JsErrorCode) JsSetRuntimeMemoryAllocationCallback( - _In_ JsRuntimeHandle runtime, - _In_opt_ void *callbackState, - _In_ JsMemoryAllocationCallback allocationCallback -); -``` - -#### Parameters - `runtime` - The runtime for which to register the allocation callback. - - `callbackState` - User provided state that will be passed back to the callback. - - `allocationCallback` - Memory allocation callback to be called for memory allocation events. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Registering a memory allocation callback will cause the runtime to call back to the host whenever it acquires memory from, or releases memory to, the OS. The callback routine is called before the runtime memory manager allocates a block of memory. The allocation will be rejected if the callback returns false. The runtime memory manager will also invoke the callback routine after freeing a block of memory, as well as after allocation failures. - - The callback is invoked on the current runtime execution thread, therefore execution is blocked until the callback completes. - - The return value of the callback is not stored; previously rejected allocations will not prevent the runtime from invoking the callback again later for new memory allocations. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jssetruntimememorylimit-function.md b/scripting-docs/chakra-hosting/jssetruntimememorylimit-function.md deleted file mode 100644 index 491d97bb046..00000000000 --- a/scripting-docs/chakra-hosting/jssetruntimememorylimit-function.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "JsSetRuntimeMemoryLimit Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsSetRuntimeMemoryLimit" -helpviewer_keywords: - - "JsSetRuntimeMemoryLimit function" -ms.assetid: 74feb31f-19f6-43e3-b117-0694c59ac593 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsSetRuntimeMemoryLimit Function -Sets the current memory limit for a runtime. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsSetRuntimeMemoryLimit( - _In_ JsRuntimeHandle runtime, - _In_ size_t memoryLimit -); -``` - -#### Parameters - `runtime` - The runtime whose memory limit is to be set. - - `memoryLimit` - The new runtime memory limit, in bytes, or -1 for no memory limit. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - A memory limit will cause any operation which exceeds the limit to fail with an "out of memory" error. Setting a runtime's memory limit to -1 means that the runtime has no memory limit. New runtimes default to having no memory limit. If the new memory limit exceeds current usage, the call will succeed and any future allocations in this runtime will fail until the runtime's memory usage drops below the limit. - - A runtime's memory limit can be always be set, regardless of whether or not the runtime is active on another thread. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jssourcecontext-typedef.md b/scripting-docs/chakra-hosting/jssourcecontext-typedef.md deleted file mode 100644 index 2f2ba29877e..00000000000 --- a/scripting-docs/chakra-hosting/jssourcecontext-typedef.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "JsSourceContext Typedef | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 0ee67e5d-a66b-4d4f-ab30-4711ef25c091 -caps.latest.revision: 5 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsSourceContext Typedef -A cookie that identifies a script for debugging purposes. - -## Syntax - -``` -typedef DWORD_PTR JsSourceContext; -``` - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsstartdebugging-function.md b/scripting-docs/chakra-hosting/jsstartdebugging-function.md deleted file mode 100644 index b79d1fb9d03..00000000000 --- a/scripting-docs/chakra-hosting/jsstartdebugging-function.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "JsStartDebugging Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsStartDebugging" -helpviewer_keywords: - - "JsStartDebugging function" -ms.assetid: c48ba02d-6d47-466f-a970-02f087d525f3 -caps.latest.revision: 15 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsStartDebugging Function -Starts debugging in the current context. - -## Syntax - -``` -// Edge mode signature -STDAPI_(JsErrorCode) JsStartDebugging(); - -// Legacy mode signature -STDAPI_(JsErrorCode) JsStartDebugging( - _In_ IDebugApplication *debugApplication -); -``` - -#### Parameters - `debugApplication` - The debug application to use for debugging. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - The host should make sure that `CoInitializeEx` is called with `COINIT_MULTITHREADED` or `COINIT_APARTMENTTHREADED` at least once before using this API - - The `debugApplication` parameter is not supported in Edge mode. For more information on using this API in Edge mode, see [Targeting Edge vs. Legacy Engines](../chakra-hosting/targeting-edge-vs-legacy-engines-in-jsrt-apis.md). - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsstartprofiling-function.md b/scripting-docs/chakra-hosting/jsstartprofiling-function.md deleted file mode 100644 index 54db7cbea8a..00000000000 --- a/scripting-docs/chakra-hosting/jsstartprofiling-function.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "JsStartProfiling Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsStartProfiling" -helpviewer_keywords: - - "JsStartProfiling function" -ms.assetid: 638da395-42dd-4fc5-b581-819e647e887d -caps.latest.revision: 13 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsStartProfiling Function -Starts profiling in the current context. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsStartProfiling( - _In_ IActiveScriptProfilerCallback *callback, - _In_ PROFILER_EVENT_MASK eventMask, - _In_ unsigned long context -); -``` - -#### Parameters - `callback` - The profiling callback to use. - - `eventMask` - The profiling events to callback with. - - `context` - A context to pass to the profiling callback. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Requires an active script context. - - This API is supported in desktop apps, but is not supported in Store apps. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsstopprofiling-function.md b/scripting-docs/chakra-hosting/jsstopprofiling-function.md deleted file mode 100644 index 3707fb466bd..00000000000 --- a/scripting-docs/chakra-hosting/jsstopprofiling-function.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "JsStopProfiling Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsStopProfiling" -helpviewer_keywords: - - "JsStopProfiling function" -ms.assetid: 3639c04f-a0f9-418b-be39-92f64b4e7ef8 -caps.latest.revision: 13 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsStopProfiling Function -Stops profiling in the current context. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsStopProfiling( - _In_ HRESULT reason -); -``` - -#### Parameters - `reason` - The reason for stopping profiling to pass to the profiler callback. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - Will not return an error if profiling has not started. - - Requires an active script context. - - This API is supported in desktop apps, but is not supported in Store apps. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsstrictequals-function.md b/scripting-docs/chakra-hosting/jsstrictequals-function.md deleted file mode 100644 index c833c56910b..00000000000 --- a/scripting-docs/chakra-hosting/jsstrictequals-function.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "JsStrictEquals Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsStrictEquals" -helpviewer_keywords: - - "JsStrictEquals function" -ms.assetid: b35bc655-7ff8-496a-b678-8950bb976047 -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsStrictEquals Function -Compare two JavaScript values for strict equality. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsStrictEquals( - _In_ JsValueRef object1, - _In_ JsValueRef object2, - _Out_ bool *result -); -``` - -#### Parameters - `object1` - The first object to compare. - - `object2` - The second object to compare. - - `result` - Whether the values are strictly equal. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - This function is equivalent to the `===` operator in Javascript. - - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsstringtopointer-function.md b/scripting-docs/chakra-hosting/jsstringtopointer-function.md deleted file mode 100644 index fc47215a78c..00000000000 --- a/scripting-docs/chakra-hosting/jsstringtopointer-function.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "JsStringToPointer Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsStringToPointer" -helpviewer_keywords: - - "JsStringToPointer function" -ms.assetid: c7aa7a09-489d-4435-8f8a-aeb62f8875ae -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsStringToPointer Function -Retrieves the string pointer of a string value. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsStringToPointer( - _In_ JsValueRef value, - _Outptr_result_buffer_(*stringLength) const wchar_t **stringValue, - _Out_ size_t *stringLength -); -``` - -#### Parameters - `value` - The string value to convert to a string pointer. - - `stringValue` - The string pointer. - - `stringLength` - The length of the string. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - This function retrieves the string pointer of a string value. It will fail with `JsErrorInvalidArgument` if the type of the value is not string. The lifetime of the string returned will be the same as the lifetime of the value it came from, however the string pointer is not considered a reference to the value (and so will not keep it from being collected). - - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsthreadservicecallback-typedef.md b/scripting-docs/chakra-hosting/jsthreadservicecallback-typedef.md deleted file mode 100644 index f8e12821364..00000000000 --- a/scripting-docs/chakra-hosting/jsthreadservicecallback-typedef.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "JsThreadServiceCallback Typedef | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: dbe67be5-418a-4f66-8b68-b38078a6d140 -caps.latest.revision: 6 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsThreadServiceCallback Typedef -A thread service callback. - -## Syntax - -``` -typedef bool (CALLBACK *JsThreadServiceCallback)( - _In_ JsBackgroundWorkItemCallback callback, - _In_opt_ void *callbackData -); -``` - -#### Parameters - callback - The callback for the background work item. - - callbackData - The data argument to be passed to the callback. - -## Remarks - The host can specify a background thread service when calling JsCreateRuntime. If specified, then background work items will be passed to the host using this callback. The host is expected to either begin executing the background work item immediately and return true or return false and the runtime will handle the work item in-thread. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jstypedarraytype-enumeration.md b/scripting-docs/chakra-hosting/jstypedarraytype-enumeration.md deleted file mode 100644 index 56fccb03fc6..00000000000 --- a/scripting-docs/chakra-hosting/jstypedarraytype-enumeration.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "JsTypedArrayType Enumeration | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 67f3e51c-acbb-4fff-a414-0868a0dd5051 -caps.latest.revision: 2 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsTypedArrayType Enumeration -The type of a typed JavaScript array. - -## Syntax - -```cpp -enum JsTypedArrayType; -``` - -## Members - -### Values - -|Name|Description| -|----------|-----------------| -|`JsArrayTypeInt8`|An int8 array.| -|`JsArrayTypeUint8`|An uint8 array.| -|`JsArrayTypeUint8Clamped`|An uint8 clamped array.| -|`JsArrayTypeInt16`|An int16 array.| -|`JsArrayTypeUint16`|An uint16 array.| -|`JsArrayTypeInt32`|An int32 array.| -|`JsArrayTypeUint32`|An uint32 array.| -|`JsArrayTypeFloat32`|A float32 array.| -|`JsArrayTypeFloat64`|A float64 array.| - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsvalueref-typedef.md b/scripting-docs/chakra-hosting/jsvalueref-typedef.md deleted file mode 100644 index 5cb5698c615..00000000000 --- a/scripting-docs/chakra-hosting/jsvalueref-typedef.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "JsValueRef Typedef | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 78a64aad-70b3-49b0-b961-6064eae19129 -caps.latest.revision: 6 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsValueRef Typedef -A reference to a JavaScript value. - -## Syntax - -``` -typedef JsRef JsValueRef; -``` - -## Remarks - A JavaScript value is one of the following types of values: Undefined, Null, Boolean, String, Number, or Object. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsvaluetovariant-function.md b/scripting-docs/chakra-hosting/jsvaluetovariant-function.md deleted file mode 100644 index f350468799a..00000000000 --- a/scripting-docs/chakra-hosting/jsvaluetovariant-function.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "JsValueToVariant Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsValueToVariant" -helpviewer_keywords: - - "JsValueToVariant function" -ms.assetid: 070244be-a69d-4b78-971b-69c0579c03cf -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsValueToVariant Function -Initializes the passed in `VARIANT` as a projection of a JavaScript value. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsValueToVariant( - _In_ JsValueRef object, - _Out_ VARIANT *variant -); -``` - -#### Parameters - `object` - A JavaScript value to project as a `VARIANT`. - - `variant` - A pointer to a `VARIANT` struct that will be initialized as a projection. - -## Return Value - -## Remarks - The projection `VARIANT` can be used by COM automation clients to call into the projected JavaScript object. - - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsvaluetype-enumeration.md b/scripting-docs/chakra-hosting/jsvaluetype-enumeration.md deleted file mode 100644 index 2d30ea2ebd1..00000000000 --- a/scripting-docs/chakra-hosting/jsvaluetype-enumeration.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "JsValueType Enumeration | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsValueType" -helpviewer_keywords: - - "JsValueType enumeration" -ms.assetid: 6645e723-e554-41fc-b622-ab54ee044b3d -caps.latest.revision: 16 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsValueType Enumeration -The JavaScript type of a JsValueRef. - -## Syntax - -``` -enum JsValueType { - JsUndefined = 0, - JsNull = 1, - JsNumber = 2, - JsString = 3, - JsBoolean = 4, - JsObject = 5, - JsFunction = 6, - JsError = 7, - JsArray = 8, - JsSymbol = 9, - JsArrayBuffer = 10, - JsTypedArray = 11, - JsDataView = 12, -}; -``` - -## Members - -### Values - -|Name|Description| -|----------|-----------------| -|`JsUndefined`|The value is the `undefined` value.| -|`JsNull`|The value is the `null` value.| -|`JsNumber`|The value is a JavaScript number value.| -|`JsString`|The value is a JavaScript string value.| -|`JsBoolean`|The value is a JavaScript Boolean value.| -|`JsObject`|The value is a JavaScript object value.| -|`JsFunction`|The value is a JavaScript function object value.| -|`JsError`|The value is a JavaScript error object value.| -|`JsArray`|The value is a JavaScript array object value.| -|`JsSymbol`|The value is a JavaScript symbol value.

This enumeration value is supported only in Edge mode.| -|`JsArrayBuffer`|The value is a JavaScript `ArrayBuffer` object value.

This enumeration value is supported only in Edge mode.| -|`JsTypedArray`|The value is a JavaScript typed array object value.

This enumeration value is supported only in Edge mode.| -|`JsDataView`|The value is a JavaScript `DataView` object value.

This enumeration value is supported only in Edge mode.| - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/jsvarianttovalue-function.md b/scripting-docs/chakra-hosting/jsvarianttovalue-function.md deleted file mode 100644 index bef803571c8..00000000000 --- a/scripting-docs/chakra-hosting/jsvarianttovalue-function.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "JsVariantToValue Function | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -f1_keywords: - - "jsrt/JsVariantToValue" -helpviewer_keywords: - - "JsVariantToValue function" -ms.assetid: e8f9eb8b-55b3-4b65-927e-cad5b482edee -caps.latest.revision: 12 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# JsVariantToValue Function -Creates a JavaScript value that is a projection of the passed in `VARIANT`. - -## Syntax - -``` -STDAPI_(JsErrorCode) JsVariantToValue( - _In_ VARIANT *variant, - _Out_ JsValueRef *value -); -``` - -#### Parameters - `variant` - A `VARIANT` to be projected. - - `value` - A JavaScript value that is a projection of the `VARIANT`. - -## Return Value - The code `JsNoError` if the operation succeeded, a failure code otherwise. - -## Remarks - The projected value can be used by script to call a COM automation object from script. Hosts are responsible for enforcing COM threading rules. - - Requires an active script context. - -## Requirements - **Header:** jsrt.h - -## See Also - [Reference (JavaScript Runtime)](../chakra-hosting/reference-javascript-runtime.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/reference-javascript-runtime.md b/scripting-docs/chakra-hosting/reference-javascript-runtime.md deleted file mode 100644 index fd4270f6963..00000000000 --- a/scripting-docs/chakra-hosting/reference-javascript-runtime.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -title: "Reference (JavaScript Runtime) | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "reference" -ms.assetid: 0bfe50da-fd79-4e00-9458-bc667769b415 -caps.latest.revision: 9 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# Reference (JavaScript Runtime) -JavaScript Runtime (JsRT) APIs enable you to add scripting capabilities to desktop and server-side applications running on Windows. - - If you intend to embed [ChakraCore](https://github.com/Microsoft/ChakraCore) in your application, please refer to [ChakraCore Wiki](http://aka.ms/corejsrtref) for JSRT references instead. - -## In This Section - Typedefs, constants, and enumerations that support JsRT hosting are described here: - -- [JavaScript Runtime Typedefs, Constants, and Enumerations](../chakra-hosting/javascript-runtime-typedefs-constants-and-enumerations.md) - - The following functions enable JsRT hosting: - -- [JsAddRef Function](../chakra-hosting/jsaddref-function.md) - -- [JsBooleanToBool Function](../chakra-hosting/jsbooleantobool-function.md) - -- [JsBoolToBoolean Function](../chakra-hosting/jsbooltoboolean-function.md) - -- [JsCallFunction Function](../chakra-hosting/jscallfunction-function.md) - -- [JsCollectGarbage Function](../chakra-hosting/jscollectgarbage-function.md) - -- [JsConstructObject Function](../chakra-hosting/jsconstructobject-function.md) - -- [JsConvertValueToBoolean Function](../chakra-hosting/jsconvertvaluetoboolean-function.md) - -- [JsConvertValueToNumber Function](../chakra-hosting/jsconvertvaluetonumber-function.md) - -- [JsConvertValueToObject Function](../chakra-hosting/jsconvertvaluetoobject-function.md) - -- [JsConvertValueToString Function](../chakra-hosting/jsconvertvaluetostring-function.md) - -- [JsCreateArray Function](../chakra-hosting/jscreatearray-function.md) - -- [JsCreateArrayBuffer Function](../chakra-hosting/jscreatearraybuffer-function.md) - -- [JsCreateContext Function](../chakra-hosting/jscreatecontext-function.md) - -- [JsCreateDataView Function](../chakra-hosting/jscreatedataview-function.md) - -- [JsCreateError Function](../chakra-hosting/jscreateerror-function.md) - -- [JsCreateExternalArrayBuffer Function](../chakra-hosting/jscreateexternalarraybuffer-function.md) - -- [JsCreateExternalObject Function](../chakra-hosting/jscreateexternalobject-function.md) - -- [JsCreateFunction Function](../chakra-hosting/jscreatefunction-function.md) - -- [JsCreateNamedFunction Function](../chakra-hosting/jscreatenamedfunction-function.md) - -- [JsCreateObject Function](../chakra-hosting/jscreateobject-function.md) - -- [JsCreateRangeError Function](../chakra-hosting/jscreaterangeerror-function.md) - -- [JsCreateReferenceError Function](../chakra-hosting/jscreatereferenceerror-function.md) - -- [JsCreateRuntime Function](../chakra-hosting/jscreateruntime-function.md) - -- [JsCreateSymbol Function](../chakra-hosting/jscreatesymbol-function.md) - -- [JsCreateSyntaxError Function](../chakra-hosting/jscreatesyntaxerror-function.md) - -- [JsCreateTypeError Function](../chakra-hosting/jscreatetypeerror-function.md) - -- [JsCreateTypedArray Function](../chakra-hosting/jscreatetypedarray-function.md) - -- [JsCreateURIError Function](../chakra-hosting/jscreateurierror-function.md) - -- [JsDefineProperty Function](../chakra-hosting/jsdefineproperty-function.md) - -- [JsDeleteIndexedProperty Function](../chakra-hosting/jsdeleteindexedproperty-function.md) - -- [JsDeleteProperty Function](../chakra-hosting/jsdeleteproperty-function.md) - -- [JsDisableRuntimeExecution Function](../chakra-hosting/jsdisableruntimeexecution-function.md) - -- [JsDisposeRuntime Function](../chakra-hosting/jsdisposeruntime-function.md) - -- [JsDoubleToNumber Function](../chakra-hosting/jsdoubletonumber-function.md) - -- [JsEnableRuntimeExecution Function](../chakra-hosting/jsenableruntimeexecution-function.md) - -- [JsEnumerateHeap Function](../chakra-hosting/jsenumerateheap-function.md) - -- [JsEquals Function](../chakra-hosting/jsequals-function.md) - -- [JsGetAndClearException Function](../chakra-hosting/jsgetandclearexception-function.md) - -- [JsGetArrayBufferStorage Function](../chakra-hosting/jsgetarraybufferstorage-function.md) - -- [JsGetContextData Function](../chakra-hosting/jsgetcontextdata-function.md) - -- [JsGetContextOfObject Function](../chakra-hosting/jsgetcontextofobject-function.md) - -- [JsGetCurrentContext Function](../chakra-hosting/jsgetcurrentcontext-function.md) - -- [JsGetDataViewStorage Function](../chakra-hosting/jsgetdataviewstorage-function.md) - -- [JsGetExtensionAllowed Function](../chakra-hosting/jsgetextensionallowed-function.md) - -- [JsGetExternalData Function](../chakra-hosting/jsgetexternaldata-function.md) - -- [JsGetFalseValue Function](../chakra-hosting/jsgetfalsevalue-function.md) - -- [JsGetGlobalObject Function](../chakra-hosting/jsgetglobalobject-function.md) - -- [JsGetIndexedPropertiesExternalData Function](../chakra-hosting/jsgetindexedpropertiesexternaldata-function.md) - -- [JsGetIndexedProperty Function](../chakra-hosting/jsgetindexedproperty-function.md) - -- [JsGetNullValue Function](../chakra-hosting/jsgetnullvalue-function.md) - -- [JsGetOwnPropertyDescriptor Function](../chakra-hosting/jsgetownpropertydescriptor-function.md) - -- [JsGetOwnPropertyNames Function](../chakra-hosting/jsgetownpropertynames-function.md) - -- [JsGetOwnPropertySymbols Function](../chakra-hosting/jsgetownpropertysymbols-function.md) - -- [JsGetProperty Function](../chakra-hosting/jsgetproperty-function.md) - -- [JsGetPropertyIdFromName Function](../chakra-hosting/jsgetpropertyidfromname-function.md) - -- [JsGetPropertyIdFromSymbol Function](../chakra-hosting/jsgetpropertyidfromsymbol-function.md) - -- [JsGetPropertyIdType Function](../chakra-hosting/jsgetpropertyidtype-function.md) - -- [JsGetPropertyNameFromId Function](../chakra-hosting/jsgetpropertynamefromid-function.md) - -- [JsGetPrototype Function](../chakra-hosting/jsgetprototype-function.md) - -- [JsGetRuntime Function](../chakra-hosting/jsgetruntime-function.md) - -- [JsGetRuntimeMemoryLimit Function](../chakra-hosting/jsgetruntimememorylimit-function.md) - -- [JsGetRuntimeMemoryUsage Function](../chakra-hosting/jsgetruntimememoryusage-function.md) - -- [JsGetStringLength Function](../chakra-hosting/jsgetstringlength-function.md) - -- [JsGetSymbolFromPropertyId Function](../chakra-hosting/jsgetsymbolfrompropertyid-function.md) - -- [JsGetTrueValue Function](../chakra-hosting/jsgettruevalue-function.md) - -- [JsGetTypedArrayInfo Function](../chakra-hosting/jsgettypedarrayinfo-function.md) - -- [JsGetTypedArrayStorage Function](../chakra-hosting/jsgettypedarraystorage-function.md) - -- [JsGetUndefinedValue Function](../chakra-hosting/jsgetundefinedvalue-function.md) - -- [JsGetValueType Function](../chakra-hosting/jsgetvaluetype-function.md) - -- [JsHasException Function](../chakra-hosting/jshasexception-function.md) - -- [JsHasExternalData Function](../chakra-hosting/jshasexternaldata-function.md) - -- [JsHasIndexedPropertiesExternalData Function](../chakra-hosting/jshasindexedpropertiesexternaldata-function.md) - -- [JsHasIndexedProperty Function](../chakra-hosting/jshasindexedproperty-function.md) - -- [JsHasProperty Function](../chakra-hosting/jshasproperty-function.md) - -- [JsIdle Function](../chakra-hosting/jsidle-function.md) - -- [JsInspectableToObject Function](../chakra-hosting/jsinspectabletoobject-function.md) - -- [JsInstanceOf Function](../chakra-hosting/jsinstanceof-function.md) - -- [JsIntToNumber Function](../chakra-hosting/jsinttonumber-function.md) - -- [JsIsEnumeratingHeap Function](../chakra-hosting/jsisenumeratingheap-function.md) - -- [JsIsRuntimeExecutionDisabled Function](../chakra-hosting/jsisruntimeexecutiondisabled-function.md) - -- [JsNumberToDouble Function](../chakra-hosting/jsnumbertodouble-function.md) - -- [JsNumberToInt Function](../chakra-hosting/jsnumbertoint-function.md) - -- [JsObjectToInspectable Function](../chakra-hosting/jsobjecttoinspectable-function.md) - -- [JsParseScript Function](../chakra-hosting/jsparsescript-function.md) - -- [JsParseSerializedScript Function](../chakra-hosting/jsparseserializedscript-function.md) - -- [JsParseSerializedScriptWithCallback Function](../chakra-hosting/jsparseserializedscriptwithcallback-function.md) - -- [JsPointerToString Function](../chakra-hosting/jspointertostring-function.md) - -- [JsPreventExtension Function](../chakra-hosting/jspreventextension-function.md) - -- [JsProjectWinRTNamespace Function](../chakra-hosting/jsprojectwinrtnamespace-function.md) - -- [JsRelease Function](../chakra-hosting/jsrelease-function.md) - -- [JsRunScript Function](../chakra-hosting/jsrunscript-function.md) - -- [JsRunSerializedScript Function](../chakra-hosting/jsrunserializedscript-function.md) - -- [JsRunSerializedScriptWithCallback Function](../chakra-hosting/jsrunserializedscriptwithcallback-function.md) - -- [JsSerializeScript Function](../chakra-hosting/jsserializescript-function.md) - -- [JsSetContextData Function](../chakra-hosting/jssetcontextdata-function.md) - -- [JsSetCurrentContext Function](../chakra-hosting/jssetcurrentcontext-function.md) - -- [JsSetException Function](../chakra-hosting/jssetexception-function.md) - -- [JsSetExternalData Function](../chakra-hosting/jssetexternaldata-function.md) - -- [JsSetIndexedPropertiesToExternalData Function](../chakra-hosting/jssetindexedpropertiestoexternaldata-function.md) - -- [JsSetIndexedProperty Function](../chakra-hosting/jssetindexedproperty-function.md) - -- [JsSetObjectBeforeCollectCallback Function](../chakra-hosting/jssetobjectbeforecollectcallback-function.md) - -- [JsSetProjectionEnqueueCallback Function](../chakra-hosting/jssetprojectionenqueuecallback-function.md) - -- [JsSetPromiseContinuationCallback Function](../chakra-hosting/jssetpromisecontinuationcallback-function.md) - -- [JsSetProperty Function](../chakra-hosting/jssetproperty-function.md) - -- [JsSetPrototype Function](../chakra-hosting/jssetprototype-function.md) - -- [JsSetRuntimeBeforeCollectCallback Function](../chakra-hosting/jssetruntimebeforecollectcallback-function.md) - -- [JsSetRuntimeMemoryAllocationCallback Function](../chakra-hosting/jssetruntimememoryallocationcallback-function.md) - -- [JsSetRuntimeMemoryLimit Function](../chakra-hosting/jssetruntimememorylimit-function.md) - -- [JsStartDebugging Function](../chakra-hosting/jsstartdebugging-function.md) - -- [JsStartProfiling Function](../chakra-hosting/jsstartprofiling-function.md) - -- [JsStopProfiling Function](../chakra-hosting/jsstopprofiling-function.md) - -- [JsStrictEquals Function](../chakra-hosting/jsstrictequals-function.md) - -- [JsStringToPointer Function](../chakra-hosting/jsstringtopointer-function.md) - -- [JsValueToVariant Function](../chakra-hosting/jsvaluetovariant-function.md) - -- [JsVariantToValue Function](../chakra-hosting/jsvarianttovalue-function.md) - -## See Also - [Hosting the JavaScript Runtime](../chakra-hosting/hosting-the-javascript-runtime.md) - [JavaScript Runtime Hosting](../chakra-hosting/javascript-runtime-hosting.md) \ No newline at end of file diff --git a/scripting-docs/chakra-hosting/targeting-edge-vs-legacy-engines-in-jsrt-apis.md b/scripting-docs/chakra-hosting/targeting-edge-vs-legacy-engines-in-jsrt-apis.md deleted file mode 100644 index 7f9bd254822..00000000000 --- a/scripting-docs/chakra-hosting/targeting-edge-vs-legacy-engines-in-jsrt-apis.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: "Targeting Edge vs. Legacy Engines in JsRT APIs | Microsoft Docs" -ms.custom: "" -ms.date: "01/18/2017" -ms.prod: "windows-client-threshold" -ms.reviewer: "" -ms.suite: "" -ms.tgt_pltfrm: "" -ms.topic: "article" -ms.assetid: cbc7df6c-0bc9-48f5-b9ad-b9ed31c42f92 -caps.latest.revision: 7 -author: "mikejo5000" -ms.author: "mikejo" -manager: "ghogen" ---- -# Targeting Edge vs. Legacy Engines in JsRT APIs -Starting in Windows 10, one of the changes that we've made to Chakra (the JavaScript engine), which is aligned with Windows 10's browser strategy of supporting a new Edge rendering engine, is to support two different Chakra engines: - -- The old Chakra engine (also called the *legacy engine* or jscript9.dll below) that ships with and supports Internet Explorer 11. This engine is frozen in time and will remain fundamentally unchanged from Win8.1/IE11 release. - -- The new Chakra engine (also called the *Edge engine* or chakra.dll below) that ships with and supports the new browser in Windows 10, Microsoft Edge. This engine will be continually updated and will support a "living" [Edge](http://blogs.msdn.com/b/ie/archive/2014/11/11/living-on-the-edge-our-next-step-in-interoperability.aspx) engine. A living Edge engine implies that unlike the legacy engine, the Edge engine would not carry forward any form of versioning script functionality to opt into. - - When creating an app using the JavaScript Runtime Hosting (JsRT) API, you can choose to target either the legacy or the Edge engine. - -- If you need to emphasize backward compatibility of your existing applications, target the legacy engine. - -- If you want your app to be forward looking and support new JavaScript features as they are released (for example, ECMAScript 6), target the Edge engine. - - This topic includes details that describe how to target the different engines. - -## Target your preferred version - When creating an app, you can select the version of the JsRT that supports either the Edge engine or the legacy engine. You can choose the JsRT version based on the guidelines above. To accommodate these distinctions, the following changes have been made to `JsCreateRuntime`, `JsCreateContext`, and `JsStartDebugging`. - - For `JsCreateRuntime`: - -- When targeting the legacy engine, the `JsRuntimeVersionEdge` enumeration value is deprecated, and a message will suggest using the `JsRuntimeVersionInternetExplorer11` value instead. - -- When targeting the edge engine, the version parameter is omitted from the `JsCreateRuntime` function. - - ```cpp - JsErrorCode JsCreateRuntime(JsRuntimeAttributes attributes, JsThreadServiceCallback callback, _Out_ JsRuntimeHandle* runtime); - ``` - - For `JsCreateContext` and `JsStartDebugging`: - -- When targeting the legacy engine, the `IDebugApplication` interface is used to supply your own non-remote debugging methods. For debugging purposes, `JsCreateContext` and `JsStartDebugging` functions take `IDebugApplication` as parameter. - -- When targeting the Edge engine, the `IDebugApplication` interface is deprecated. The Chakra engine enables native and script debugging capability with Visual Studio debugger without requiring an implementation of `IDebugApplication` from user. The interface is no longer a parameter for `JsCreateContext` and `JsStartDebugging` as a result. - - The signatures for the preceding APIs in the legacy engine are as follows: - -```cpp -JsErrorCode JsCreateRuntime(JsRuntimeAttributes attributes, JsRuntimeVersion version, JsThreadServiceCallback callback, _Out_ JsRuntimeHandle* runtime); - -JsErrorCode JsCreateContext(JsRuntimeHandle runtime, IDebugApplication *debugApplication, JsContextRef *newContext); - -JsErrorCode JsStartDebugging(IDebugApplication *debugApplication); -``` - - The signatures for the preceding APIs in the Edge engine are as follows: - -```cpp -JsErrorCode JsCreateRuntime(JsRuntimeAttributes attributes, JsThreadServiceCallback callback, _Out_ JsRuntimeHandle* runtime); - -JsErrorCode JsCreateContext(JsRuntimeHandle runtime, JsContextRef *newContext); - -JsErrorCode JsStartDebugging(); -``` - -## Compile for your preferred version using Visual C++ - When using Visual C++, import the JsRT API by including the jsrt.h header, and ensure that jsrt.lib is included in your linker input files list: - -```cpp -#include -``` - - ![Adding jsrt.lib as a linker input file](../chakra-hosting/media/js-chakra.png "JS_Chakra_") - - If you want to target the Edge engine binaries, you need to define the macro `USE_EDGEMODE_JSRT` before including jsrt.h, and instead of linking against jsrt.lib, you should link against chakrart.lib: - -```cpp -#define USE_EDGEMODE_JSRT -#include -``` - - ![Adding chakrart.lib as a linker input file](../chakra-hosting/media/js-chakra-hosting.png "JS_Chakra_Hosting_") - - If you're starting with a new application, you are now ready to start writing code against the JsRT API. - -## Compile for your preferred version using .NET - If you're using .NET and P/Invoke, you must change your JsRT API [DllImport] declarations to import chakra.dll instead of jscript9.dll. In addition, change the definition of `JsCreateRuntime` to remove the `JsRuntimeVersion` parameter and the definition of `JsCreateContext` and `JsStartDebugging` to remove the `IDebugApplication` parameter. - - For the legacy engine, use the following code. - -```c# -[DllImport("jscript9.dll")] -public static extern JsErrorCode JsCreateRuntime( - JsRuntimeAttributes attributes, - JsRuntimeVersion version, - JsThreadServiceCallback callback, - out JsRuntimeSafeHandle runtime -); - -[DllImport("jscript9.dll")] -public static extern JsErrorCode JsCreateContext( - JsRuntimeSafeHandle runtime, - IDebugApplication debugApplication, - out JsContextRef newContext -); - -[DllImport("jscript9.dll")] -public static extern JsErrorCode JsStartDebugging( - IDebugApplication debugApplication, -); -``` - - For the Edge engine, use the following code. - -```c# -[DllImport("chakra.dll")] -public static extern JsErrorCode JsCreateRuntime( - JsRuntimeAttributes attributes, - JsThreadServiceCallback callback, - out JsRuntimeSafeHandle runtime -); - -[DllImport("chakra.dll")] -public static extern JsErrorCode JsCreateContext( - JsRuntimeSafeHandle runtime, - out JsContextRef newContext -); - -[DllImport("chakra.dll")] -public static extern JsErrorCode JsStartDebugging(); -``` - -> [!CAUTION] -> If you are manually marshaling the function pointer (such as via LoadLibrary/GetProcAddress), it is critical that you do not mix the declarations of the method, or else you will unbalance the stack, which will result in unpredictable behavior such as causing your app to crash. The same problem will occur if you perform a global search-and-replace of instances of jscript9.dll in your import code, because you'll miss the `version` parameter being dropped. - -## Summary - In Windows 10, the JavaScript Runtime Hosting APIs are splitting into two. These APIs now support a "living" Edge engine, whose language capabilities will be aligned with the "living" Edge engine in the Microsoft Edge. You can leverage these capabilities from your desktop or Store apps to create new and exciting ways to extend your application and to leverage modern Web skills in your existing code base. However, because there are subtle differences between previous versions, you must be aware of the following points when targeting the Edge or legacy engine. - -- Your app can support only one version of JsRT per process. - - For example, you can't create an Edge engine runtime and then a legacy engine runtime and expect them to run correctly in the same process. This is unsupported and may result in undocumented behavior, such as failure to load the second DLL. - -- When targeting the Edge engine, your app may unexpectedly acquire new features when the underlying platform is automatically updated. - - For example, the Internet Explorer 11 mode of the legacy runtime supports block-scoping variable declarations such as `let` and `const`. If the Edge engine automatic versioning behavior had been the standard previously, code that had worked in Internet Explorer 10 mode, which did not have block-scoping rules, may have started failing when the platform had automatically upgraded. This must be a consideration when choosing which runtime model to use. While we believe you should target the Edge engine whenever possible, you must be careful about using JavaScript code structures that may become invalid in the future. - -- JsRT for the Windows Store only supports the Edge engine (chakra.dll). Apps attempting to link against any JsRT API in jscript9.dll will fail certification. - -- It is critical that you do not confuse the declaration of `JsCreateRuntime`, `JsCreateContext`, and `JsStartDebugging` between jscript9.dll and chakra.dll, because it will result in imbalancing the stack. - - When using C and C++, you will receive a linker error if you try to use the wrong declaration, as long as you're not doing something like calling `LoadLibrary` and then `GetProcAddress`. .NET developers may not find this problem as easily, so double-check your code when using this feature. - -## See Also - [JavaScript Runtime Hosting](../chakra-hosting/javascript-runtime-hosting.md) \ No newline at end of file