Skip to content

Commit feff2e0

Browse files
authored
Release apiscan (#19532)
* Staging for native API reference * Staging native API calls * Update API article * Update API with wrong metadata * Rename files, add metadata input feedback. * Rename files save all and commit. * Upate in/out * Update API name * Update metadata
1 parent 16fa85f commit feff2e0

3 files changed

Lines changed: 110 additions & 0 deletions

File tree

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
description: "GetSQLInstanceRegStringByID(INST_ID, String, String, StringBuilder, UInt32) "
3+
title: "GetSQLInstanceRegStringByID(INST_ID, String, String, StringBuilder, UInt32) | Microsoft Docs"
4+
ms.custom: ""
5+
ms.date: "06/30/2021"
6+
ms.prod: sql
7+
ms.reviewer: ""
8+
apiname:
9+
- "GetSQLInstanceRegStringByID"
10+
apilocation:
11+
- "instapi.dll"
12+
apitype: "DllExport"
13+
ms.topic: reference
14+
author: MikeRayMSFT
15+
ms.author: mikeray
16+
---
17+
18+
# GetSQLInstanceRegStringByID()
19+
20+
Retrieves a registry string from an instance specific registry tree by the given instance ID, the subtree, and the name of the value.
21+
22+
```c
23+
GetSQLInstanceRegStringByID(
24+
PINST_ID pInstanceID,
25+
LPCWSTR sRegPath,
26+
LPCWSTR sValueName,
27+
LPWSTR sString,
28+
PDWORD pdwSize
29+
);
30+
```
31+
32+
## Arguments
33+
34+
*pInstanceID*[in]
35+
36+
A pointer to the instance ID of the relevant instance.
37+
38+
*sRegPath*[in]
39+
40+
A pointer to registry path of the string to retrieve.
41+
42+
*sValueName*[in]
43+
44+
A pointer to a string that contains the value name to retrieve.
45+
46+
*sString*[out]
47+
48+
A pointer to a buffer to receive the string that will be retrieved.
49+
50+
*pdwSize*[out]
51+
52+
A pointer to a `DWORD` value to supply the length of the buffer. Returns the required length if the supplied buffer is too small.
53+
54+
## Returns
55+
56+
Boolean
57+
`true` if the call succeeded; otherwise, `false`.
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
description: "GetSvcInstanceIDFromName"
3+
title: "GetSvcInstanceIDFromName | Microsoft Docs"
4+
ms.custom: ""
5+
ms.date: "06/30/2021"
6+
ms.prod: sql
7+
ms.reviewer: ""
8+
apiname:
9+
- "GetSvcInstanceIDFromName"
10+
apilocation:
11+
- "instapi.dll"
12+
apitype: "DllExport"
13+
ms.topic: reference
14+
author: MikeRayMSFT
15+
ms.author: mikeray
16+
---
17+
18+
# GetSvcInstanceIDFromName()
19+
20+
Retrieves the instance ID of an instance when given the friendly name, conditioned to search only the instance maps for the given service.
21+
22+
```c
23+
GetSvcInstanceIDFromName(
24+
LPCWSTR sInstanceName,
25+
SQL_SVCS Service,
26+
PINST_ID pInstanceID
27+
);
28+
```
29+
30+
## Parameters
31+
32+
*sInstanceName*[in]
33+
34+
A pointer to the instance ID of the relevant instance.
35+
36+
*Service*[in]
37+
38+
The service type of the server whose instance ID is being looked for.
39+
40+
*pInstanceID*[out]
41+
42+
A pointer to a buffer to receive the instance ID.
43+
44+
## Returns
45+
46+
Boolean
47+
`true` if the call succeeded; otherwise, `false`.

docs/toc.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11556,6 +11556,12 @@ items:
1155611556
href: relational-databases/event-classes/user-configurable-event-class.md
1155711557
- name: ObjectType Trace Event Column
1155811558
href: relational-databases/event-classes/objecttype-trace-event-column.md
11559+
- name: Native interfaces
11560+
items:
11561+
- name: GetSvcInstanceIDFromName
11562+
href: native-interfaces/getsvcinstanceidfromname.md
11563+
- name: GetSQLInstanceRegStringByID
11564+
href: native-interfaces/getsqlinstanceregstringbyid.md
1155911565
- name: SQL PowerShell
1156011566
items:
1156111567
- name: Install SQL PowerShell module

0 commit comments

Comments
 (0)