DS_GetActualURL
- Updated2023-02-21
- 1 minute(s) read
HRESULT DS_GetActualURL (DSHandle DSHandle, char buffer[], unsigned int bufferSize);
Purpose
Returns the actual URL of the DataSocket data source to which a DataSocket object is connected.
The actual URL might not be the same URL that you pass to DS_Open. The actual URL is different when the URL you pass points to a link that redirects the connection to a new URL.
Parameters
| Input | ||
| Name | Type | Description |
| DSHandle | DSHandle | Pass the handle you obtained from DS_Open, DS_GetAttrHandle, or DS_CreateAttrHandle to identify the DataSocket object. |
| bufferSize | unsigned int | The size, in bytes, of the buffer that you pass in the buffer parameter of this function. |
| Output | ||
| Name | Type | Description |
| buffer | char [] | Returns the URL. If the buffer you pass is too small to hold the URL, LabWindows/CVI truncates the URL to fit in the buffer. |
Return Value
| Name | Type | Description |
| status | HRESULT | The value that indicates whether an error occurred. A negative error code indicates function failure. Error codes are defined in CVIversion\toolslib\datasock\dataskt.h and <Program Files>\National Instruments\Shared\MSDTRedistributables\SDKHeaderFiles\8.1\winerror.h. Other error codes in winerror.h are generated by ActiveX Servers and are passed on to you by the DataSocket Library. |
Additional Information
Library: DataSocket Library
Include file: datasock\dataskt.h
LabWindows/CVI compatibility: LabWindows/CVI 5.5 and later