IDataInitialize Interface

IID_IDataInitialize

{2206CCB1-19C1-11D1-89E0-00C04FD7A829}

Use the IDataInitialize interface to create a data source object using a connection string. You can also retrieve a connection string from an existing data source object.

To build a connection string, use the prompting user interface available through the IDBPromptInitialize interface and then use IDataInitialize to get a data source object based on that connection string.

For more information, see "Creating Data Source Objects" in Chapter 2: Data Source and Session Objects.

Documentation: IDataInitialize

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IDataInitialize Methods

Description

GetDataSource

Given a connection string, instantiates and returns a data source object.

GetInitializationString

Given a data source object, returns a connection string.

CreateDBInstance

Creates a data source object. Analogous to CoCreateInstance.

CreateDBInstanceEx

Creates a data source object. Analogous to CoCreateInstanceEx.

LoadStringFromStorage

Loads a connection string from storage.

WriteStringToStorage

Writes a connection string to storage.

GetDataSource

DECKARE FUNCTION Proto_IDataInitialize_GetDataSource ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL pUnkOuter AS DWORD _

, BYVAL dwClsCtx AS DWORD _

, BYVAL pwszInitializationString AS DWORD _

, BYREF riid AS GUID _

, BYREF ppDataSource AS DWORD _

  ) AS LONG

FUNCTION IDataInitialize_GetDataSource ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL pUnkOuter AS DWORD _

, BYVAL dwClsCtx AS DWORD _

, BYVAL strInitializationString AS STRING _

, BYREF riid AS GUID _

, BYREF ppDataSource AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  LOCAL pwszInitializationString AS DWORD
  IF LEN(strInitializationString) THEN
     strInitializationString = UCODE$(strInitializationString) & $NUL
     pwszInitializationString = STRPTR(strInitializationString)
  END IF
  CALL DWORD @@pthis[3] USING Proto_IDataInitialize_GetDataSource (pthis, pUnkOuter, dwClsCtx, STRPTR(strInitializationString), riid, ppDataSource) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetInitializationString

FUNCTION IDataInitialize_GetInitializationString ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL pDataSource AS DWORD _

, BYVAL fIncludePassword AS LONG _

, BYREF ppwszInitString AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[4] USING Proto_IDataInitialize_GetInitializationString (pthis, pDataSource, fIncludePassword, ppwszInitString) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

CreateDBInstance

FUNCTION IDataInitialize_CreateDBInstance ( _
  BYVAL pthis AS DWORD PTR _

, BYREF clsidProvider AS GUID _

, BYVAL pUnkOuter AS DWORD _

, BYVAL dwClsCtx AS DWORD _

, BYVAL pwszReserved AS DWORD _

, BYREF riid AS GUID _

, BYREF ppDataSource AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[5] USING IDataInitialize_CreateDBInstance (pthis, clsidProvider, pUnkOuter, dwClsCtx, pwszReserved, riid, ppDataSource) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

CreateDBInstanceEx

FUNCTION IDataInitialize_CreateDBInstanceEx ( _
  BYVAL pthis AS DWORD PTR _

, BYREF clsidProvider AS GUID _

, BYVAL pUnkOuter AS DWORD _

, BYVAL dwClsCtx AS DWORD _

, BYVAL pwszReserved AS DWORD _

, BYREF pServerInfo AS COSERVERINFO _

, BYVAL cmq AS DWORD _

, BYREF rgpmqResults AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[6] USING IDataInitialize_CreateDBInstanceEx (pthis, clsidProvider, pUnkOuter, dwClsCtx, pwszReserved, pServerInfo, cmq, rgpmqResults) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

LoadStringFromStorage

FUNCTION IDataInitialize_LoadStringFromStorage ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL strFileName AS STRING _
, BYREF ppwszInitializationString AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  strFileName = UCODE$(strFileName) & $NUL
  CALL DWORD @@pthis[7] USING IDataInitialize_LoadStringFromStorage (pthis, strFileName, ppwszInitializationString) TO HRESULT
   FUNCTION = HRESULT

END FUNCTION
 

WriteStringToStorage

FUNCTION IDataInitialize_WriteStringToStorage ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL strFileName AS STRING _

, BYVAL strInitializationString AS STRING _

, BYVAL dwCreationDisposition AS DWORD _

) AS LONG

  LOCAL HRESULT AS LONG
  strFileName = UCODE$(strFileName) & $NUL
  strInitializationString = UCODE$(strInitializationString) & $NUL
  CALL DWORD @@pthis[8] USING IDataInitialize_WriteStringToStorage (pthis, strFileName, strInitializationString, dwCreationDisposition) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION