HRESULT BeginTrans();
BeginTrans
description
Starts a transaction.
parameters
None.
return value
S_OK if successful, S_FALSE if it failed.
[propget] HRESULT Eof([in] IUnknown *pRecordset, [out, retval] VARIANT_BOOL * Result);
get_Bof this_:DWORD, pRecordset:DWORD, pdwResult:DWORD
description
Tells us if we are at the beginning of a recordset.
parameters
| pRecordset |
Pointer to a _Recordset interface. |
| pdwResult |
Pointer to a boolean which tells us if we are at the beginning of the recordset pointed by pRecordset. |
return value
S_OK if successful, S_FALSE if it failed.
HRESULT Close([in] IUnknown *pRecordset);
Close this_:DWORD, pRecordset:DWORD
description
Closes a recordset and releases the interface pointed by pRecordset.
parameters
| pRecordset |
Pointer to an opened _Recordset interface. |
return value
S_OK if successful, S_FALSE if it failed.
HRESULT CloseConnection();
CloseConnection this_:DWORD
description
Closes the connection.
parameters
None.return values
S_OK if successful, S_FALSE if it failed.
HRESULT CommitTrans();
CommitTrans this_:DWORD
description
Commits a transaction i.e. all changes since the beginning of the transaction are saved.
parameters
None.return value
S_OK if successful, S_FALSE if it failed.
[propget] HRESULT Count([in] IUnknown *pRecordset, [out, retval] long *pVal);
get_Count this_:DWORD, pRecordset:DWORD, pdwCount:DWORD
description
Commits a transaction i.e. all changes since the beginning of the transaction are saved.
parameters
| pRecordset |
Pointer to an opened _Recordset interface. |
| pdwCount |
Pointer to a dword which will be filled with the number of records of the recordset. |
return value
S_OK if successful, S_FALSE if it failed.
[propget] HRESULT Eof([in] IUnknown *pRecordset, [out, retval] VARIANT_BOOL * Result);
get_Eof this_:DWORD, pRecordset:DWORD, pdwResult:DWORD
description
Tells us if we are at the end of a recordset.
parameters| pRecordset |
Pointer to a _Recordset interface. |
| pdwResult |
Pointer to a boolean which tells us if we are at the end of the recordset pointed by pRecordset |
return value
S_OK if successful, S_FALSE if it failed.
HRESULT Execute([in] BSTR SQL, [out, retval] IUnknown ** ppRecordset);
Execute this_:DWORD, pbstrSQL:DWORD, ppRecordset:DWORD
description
Executes a SQL statement.
parameters
|
pbstrSQL |
Pointer to a bstr string which is the sql statement that you want to be executed. |
| ppRecordset |
Pointer to a pointer to a _Recordset interface which will be filled by the execute proc. This interface MUST be released by calling Close on ppRecordset when you don't need the recordset anymore. You can pass NULL instead of a pointer if you don't need the recordset. |
return value
S_OK if successful, S_FALSE if it failed.
HRESULT ExecuteSP([in] BSTR SPName, [in] VARIANT * Parameters, [out, retval] IUnknown ** ppRecordset);
ExecuteSP this_:DWORD, pbstrSPName:DWORD, pVParamArray:DWORD, ppRecordset:DWORD
description
Executes a stored procedure.
parameters
|
pbstrSPName |
Pointer to a bstr string which is the name of the stored procedure to be called. |
| pVParamArray | Pointer to an array of variants which are the parameters of the stored procedure. |
| ppRecordset |
Pointer to a pointer to a _Recordset interface which will be filled by the execute proc. This interface MUST be released by calling Close on ppRecordset when you don't need the recordset anymore. You can pass NULL instead of a pointer if you don't need the recordset. |
return value
S_OK if successful, S_FALSE if it failed.
HRESULT Export([in] BSTR Query, [in] BSTR ColDelimiter, [in] BSTR RowDelimiter, [out, retval] BSTR * Exported);
Export this_:DWORD, pbstrQuery:DWORD, pbstrColDelimiter:DWORD, pbstrRowDelimiter:DWORD, pbstrExported:DWORD
description
Exports the result of a sql query to a string.
parameters
| pbstrQuery | Pointer to a bstr string which is the sql statement that you want to be executed. |
| pbstrColDelimiter | Pointer to a bstr string which is the string which will be used to delimit columns. |
| pbstrRowDelimiter | Pointer to a bstr string which is the string which will be used to delimit rows. |
| pbstrExported | Pointer to bstr which will be filled by Export. You MUST free this bstr by calling SysFreeString on pbstrExported when you don't need anymore. |
return value
S_OK if successful, S_FALSE if it failed.
HRESULT ExportSP([in] BSTR SPname, [in] VARIANT * Parameters, [in] BSTR ColDelimiter, [in] BSTR RowDelimiter, [out, retval] BSTR * Exported);
ExportSP this_:DWORD, pbstrSPName:DWORD, pVParamArray:DWORD, pbstrColDelimiter:DWORD, pbstrRowDelimiter:DWORD, pbstrExported:DWORD
description
Exports the result of a stored procedure to a string.
parameters
| pbstrSPName | Pointer to a bstr string which is the name of the stored procedure to be called. |
| pbstrColDelimiter | Pointer to a bstr string which is the string which will be used to delimit columns. |
| pbstrRowDelimiter | Pointer to a bstr string which is the string which will be used to delimit rows. |
| pbstrExported | Pointer to bstr which will be filled by Export. You MUST free this bstr by calling SysFreeString on pbstrExported when you don't need anymore. |
return value
S_OK if successful, S_FALSE if it failed.
[propget] HRESULT Field([in] IUnknown *pRecordset, [in] long index, [out, retval] VARIANT *pVal);
get_Field this_:DWORD, pRecordset:DWORD, dwIndex:DWORD, pVResult:DWORD
description
Returns the value of a field from it's index.
parameters
| pRecordset | Pointer to an opened _Recordset interface. |
| dwIndex | Index of the field. |
| pVResult | Pointer to a variant which will be filled with the value of the field. |
return value
S_OK if successful, S_FALSE if it failed.
[propget] HRESULT FieldByName([in] IUnknown *pRecordset, [in] BSTR FieldName, [out, retval] VARIANT *pVal);
get_FieldByName this_:DWORD, pRecordset:DWORD, pbstrField:DWORD, pVResult:DWORD
description
Returns the value of a field from it's column name.
parameters
| pRecordset | Pointer to an opened _Recordset interface. |
| pbstrField | Pointer to a bstr which is the name of the field. |
| pVResult | Pointer to a variant which will be filled with the value of the field. |
return value
S_OK if successful, S_FALSE if it failed.
HRESULT First([in] IUnknown *pRecordset);
First this_:DWORD, pRecordset:DWORD
description
Goes to the first record of a recordset.
parameters
| pRecordset |
Pointer to an opened _Recordset interface. |
return value
S_OK if successful, S_FALSE if it failed.
HRESULT Last([in] IUnknown *pRecordset);
Last this_:DWORD, pRecordset:DWORD
description
Goes to the last record of a recordset.
parameters
| pRecordset |
Pointer to an opened _Recordset interface. |
return value
S_OK if successful, S_FALSE if it failed.
HRESULT Next([in] IUnknown *pRecordset);
Next this_:DWORD, pRecordset:DWORD
description
Goes to the next record of a recordset.
parameters
| pRecordset |
Pointer to an opened _Recordset interface. |
return value
S_OK if successful, S_FALSE if it failed.
HRESULT OpenConnection([in] BSTR ConnectionString, [in] BSTR USerID, [in] BSTR Password);
OpenConnection this_:DWORD, pbstrCnStr:DWORD, pbstrUserId:DWORD, pbstrPassword:DWORD
description
Opens a connection to a database.
parameters
| pbstrCnStr | Pointer to a bstr which is the connection string. |
| pbstrUserId | Pointer to a bstr which is the user id. |
| pbstrPassword | Pointer to a bstr which is the password. |
return value
S_OK if successful, S_FALSE if it failed.
HRESULT Prev([in] IUnknown *pRecordset);
Prev this_:DWORD, pRecordset:DWORD
description
Goes to the previous record of a recordset.
parameters
| pRecordset |
Pointer to an opened _Recordset interface. |
return value
S_OK if successful, S_FALSE if it failed.
HRESULT RollbackTrans();
RollbackTrans this_:DWORD
description
Rollbacks a transaction i.e. all changes since the beginning of the transaction are discarded.
parameters
None.
return value
S_OK if successful, S_FALSE if it failed.
Copyright (c) 2001 Maurice MONTGENIE