nf-bluetoothapis-bluetoothsdpgetstring.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:bluetoothapis.BluetoothSdpGetString	BluetoothSdpGetString function (bluetoothapis.h)	Converts a raw string embedded in the SDP record into a Unicode string.	BluetoothSdpGetString BluetoothSdpGetString function [Bluetooth] bluetooth.bluetoothsdpgetstring bluetoothapis/BluetoothSdpGetString	bluetooth\bluetoothsdpgetstring.htm	bluetooth	26a68fe3-6ffb-44ff-b9db-757d35022a41	12/05/2018	BluetoothSdpGetString, BluetoothSdpGetString function [Bluetooth], bluetooth.bluetoothsdpgetstring, bluetoothapis/BluetoothSdpGetString	bluetoothapis.h	Bthsdpdef.h, BluetoothAPIs.h	Windows	Windows Vista, Windows XP with SP2 [desktop apps only]	None supported										Bthprops.lib	bthprops.cpl		Windows			19H1	BluetoothSdpGetString bluetoothapis/BluetoothSdpGetString	c++	APIRef kbSyntax	DllExport	bthprops.cpl BluetoothAPIs.dll Ext-MS-Win-Bluetooth-APIs-l1-1-0.dll	BluetoothSdpGetString

BluetoothSdpGetString function

-description

The BluetoothSdpGetString function converts a raw string embedded in the SDP record into a Unicode string.

-parameters

-param pRecordStream [in]

A pointer to a valid record stream formatted as a single SDP record.

-param cbRecordLength [in]

The length, in bytes, of pRecordStream.

-param pStringData [in]

When set to NULL, the calling thread locale is used to search for a matching string in the SDP record. If not NULL, the mibeNum and attributeId members of the SDP_STRING_TYPE_DATA structure are used to find the string to convert.

-param usStringOffset [in]

SDP string type offset to convert. The usStringOffset is added to the base attribute identifier of the string. SDP specification-defined offsets are: STRING_NAME_OFFSET, STRING_DESCRIPTION_OFFSET, and STRING_PROVIDER_NAME_OFFSET. These offsets can be found in the bthdef.h header file.

-param pszString [out]

If not NULL, contains the converted string on output. When set to NULL, the pcchStringLength parameter is filled with the required number of characters, not bytes, to retrieve the converted string.

-param pcchStringLength [in, out]

On input, contains the length of pszString if pszString is not NULL, in characters.

Upon output, contains the number of required characters including NULL if an error is returned, or the number of characters written to pszString, including NULL.

-returns

Returns ERROR_SUCCESS upon successful completion; the pszString parameter contains the converted string. Returns error codes upon failure. Common errors are listed in the following table.

Return code	Description
ERROR_MORE_DATA	The pszString parameter was NULL or too small to contain the converted string; the pcchStringLength parameter contains, in characters, the required length.
ERROR_INVALID_DATA	The conversion cannot be performed.
ERROR_NO_SYSTEM_RESOURCES	The system cannot allocate memory internally to perform the conversion.
ERROR_INVALID_PARAMETER	One of the required pointers was NULL, the pRecordStream parameter was not a valid SDP stream, the pRecordStream was not a properly formatted record, or the requested attribute plus offset was not a string.

-see-also

BluetoothSdpEnumAttributes

BluetoothSdpGetAttributeValue

BluetoothSdpGetContainerElementData

BluetoothSdpGetElementData

SDP_ELEMENT_DATA

SDP_STRING_TYPE_DATA