Skip to content

getsvcinstanceidfromname.md

Latest commit

 

History

History
49 lines (36 loc) · 1.17 KB

getsvcinstanceidfromname.md

File metadata and controls

49 lines (36 loc) · 1.17 KB
description GetSvcInstanceIDFromName()
title GetSvcInstanceIDFromName | Microsoft Docs
ms.custom
ms.date 06/18/2021
ms.prod sql
ms.reviewer
apiname
GetSvcInstanceIDFromName
apilocation
instapi.dll
apitype DllExport
ms.topic reference
author MikeRayMSFT
ms.author mikeray

GetSvcInstanceIDFromName()

Retrieves the instance ID of an instance when given the friendly name, conditioned to search only the instance maps for the given service.

This article describes a native code API that is used by SQL Server and may also be called by other Microsoft products. For a managed code method, see InstAPI.GetSvcInstanceIDFromName Method.

GetSvcInstanceIDFromName(
    LPCWSTR     sInstanceName,
    SQL_SVCS    Service,
    PINST_ID    pInstanceID
    );

Parameters

sInstanceName[in]

A pointer to the instance ID of the relevant instance.

Service[in]

The service type of the server whose instance ID is being looked for.

pInstanceID[out]

A pointer to a buffer to receive the instance ID.

Returns

Boolean true if the call succeeded; otherwise, false.