PreviousDTI Programmer's Guide (v10) Next

PvGetDbServerName()

Chapter contents

Retrieves the name of the server where the named database resides.

Header file: CATALOG.H
Requires: W3DBAV75.DLL or higher version

Syntax

BTI_SINT PvGetDbServerName( 
	BTI_LONG           hConnection, 
	BTI_CHAR_PTR       dbName, 
	BTI_ULONG_PTR      pBufSize, 
	BTI_CHAR_PTR       serverName, 
	BTI_SINT_PTR       pIsLocal); 

Arguments

In
hConnection
Connection handle that identifies the server. Connection handles are obtained with the PvConnectServer() function.
In
dbName
Name of the database. A list of all database names for a particular server is obtained with the PvGetDbNamesData() function. A single database name from the resulting list can be obtained with the PvGetDbName() function.
In/Out
pBufSize
Address of an unsigned long containing the size of the buffer. Actual size of server name is returned.
Out
serverName
Contains server name if successful, empty string otherwise.
Out
pIsLocal
Returns zero for remote server, non-zero for local server.

Return Values

P_OK
The operation was successful.
P_E_INVALID_HANDLE
Invalid connection handle.
P_E_NULL_PTR
Call with NULL pointer
P_E_BUFFER_TOO_SMALL
The buffer is too small for the string. In this case, the required buffer size is returned in pBufSize.
P_E_NOT_EXIST
Named database does not exist.
P_E_FAIL
Failed for other reasons.

Remarks

The following preconditions must be met:

See Also

PvStart()
PvConnectServer()
PvGetDbNamesData()
PvGetDbName()
PvDisconnect()
PvStop()


Chapter contents
Book contents

Prev topic: PvGetDbNamesData()
Next topic: PvGetDSN()