From 188d6b220cc5654abd2453dd84c8db1443bcff99 Mon Sep 17 00:00:00 2001 From: Xiaoyin Liu Date: Tue, 22 Aug 2017 15:25:07 -0400 Subject: [PATCH] Rename JsCopyPropertyIdUtf8 to JsCopyPropertyId (#42) Rename Js(Copy|Create)PropertyIdUtf8 to Js(Copy|Create)PropertyId --- JavaScript-Runtime-(JSRT)-Reference.md | 4 ++-- reference/{JsCopyPropertyIdUtf8.md => JsCopyPropertyId.md} | 4 ++-- .../{JsCreatePropertyIdUtf8.md => JsCreatePropertyId.md} | 2 +- reference/JsGetPropertyIdFromName.md | 2 +- reference/JsGetPropertyNameFromId.md | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) rename reference/{JsCopyPropertyIdUtf8.md => JsCopyPropertyId.md} (92%) rename reference/{JsCreatePropertyIdUtf8.md => JsCreatePropertyId.md} (96%) diff --git a/JavaScript-Runtime-(JSRT)-Reference.md b/JavaScript-Runtime-(JSRT)-Reference.md index d0ee2d2..41470e9 100644 --- a/JavaScript-Runtime-(JSRT)-Reference.md +++ b/JavaScript-Runtime-(JSRT)-Reference.md @@ -48,7 +48,7 @@ References of JSRT typedefs, constants, enumerations and APIs. * [[JsCopyString]] * [[JsCopyStringOneByte]] * [[JsCopyStringUtf16]] -* [[JsCopyPropertyIdUtf8]] +* [[JsCopyPropertyId]] * [[JsCreateArray]] * [[JsCreateArrayBuffer]] * [[JsCreateContext]] @@ -60,7 +60,7 @@ References of JSRT typedefs, constants, enumerations and APIs. * [[JsCreateNamedFunction]] * [[JsCreateObject]] * [[JsCreatePromise]] -* [[JsCreatePropertyIdUtf8]] +* [[JsCreatePropertyId]] * [[JsCreateRangeError]] * [[JsCreateReferenceError]] * [[JsCreateRuntime]] diff --git a/reference/JsCopyPropertyIdUtf8.md b/reference/JsCopyPropertyId.md similarity index 92% rename from reference/JsCopyPropertyIdUtf8.md rename to reference/JsCopyPropertyId.md index 943b732..05e80b3 100644 --- a/reference/JsCopyPropertyIdUtf8.md +++ b/reference/JsCopyPropertyId.md @@ -2,9 +2,9 @@ Copies the name associated with the property ID into a buffer. ### Syntax ``` CHAKRA_API - JsCopyPropertyIdUtf8( + JsCopyPropertyId( _In_ JsPropertyIdRef propertyId, - _Out_ uint8_t* buffer, + _Out_ char* buffer, _In_ size_t bufferSize, _Out_ size_t* length); ``` diff --git a/reference/JsCreatePropertyIdUtf8.md b/reference/JsCreatePropertyId.md similarity index 96% rename from reference/JsCreatePropertyIdUtf8.md rename to reference/JsCreatePropertyId.md index 364c449..ced21e1 100644 --- a/reference/JsCreatePropertyIdUtf8.md +++ b/reference/JsCreatePropertyId.md @@ -2,7 +2,7 @@ Creates the property ID associated with the name. ### Syntax ``` CHAKRA_API - JsCreatePropertyIdUtf8( + JsCreatePropertyId( _In_z_ const char *name, _In_ size_t length, _Out_ JsPropertyIdRef *propertyId); diff --git a/reference/JsGetPropertyIdFromName.md b/reference/JsGetPropertyIdFromName.md index 1d8aa5a..e972f25 100644 --- a/reference/JsGetPropertyIdFromName.md +++ b/reference/JsGetPropertyIdFromName.md @@ -14,6 +14,6 @@ STDAPI_(JsErrorCode) The code **JsNoError** if the operation succeeded, a failure code otherwise. ### Remarks -This API is Windows-only (see [[JsCreatePropertyIdUtf8]] for cross-platform equivalent). +This API is Windows-only (see [[JsCreatePropertyId]] for cross-platform equivalent). Property IDs are specific to a context and cannot be used across contexts. Requires an active script context. diff --git a/reference/JsGetPropertyNameFromId.md b/reference/JsGetPropertyNameFromId.md index f4ba0a2..57aeb51 100644 --- a/reference/JsGetPropertyNameFromId.md +++ b/reference/JsGetPropertyNameFromId.md @@ -14,7 +14,7 @@ STDAPI_(JsErrorCode) The code **JsNoError** if the operation succeeded, a failure code otherwise. ### Remarks -This API is Windows-only (see [[JsCopyPropertyIdUtf8]] for cross-platform equivalent). +This API is Windows-only (see [[JsCopyPropertyId]] for cross-platform equivalent). 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.