ISSCommandWithParameters::GetParameterProperties (OLE DB)

Berlaku untuk: SQL Server Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics Analytics Platform System (PDW)

Unduh driver OLE DB

Mengembalikan array struktur kumpulan properti SSPARAMPROPS, satu properti SSPARAMPROPS yang ditetapkan untuk setiap parameter UDT atau XML.

Sintaks

  
HRESULT GetParameterProperties(  
      DB_UPARAMS *pcParams,  
      SSPARAMPROPS **prgParamProperties);  

Argumen

pcParams[out][in]
Pointer ke memori yang berisi jumlah struktur SSPARAMPROPS yang dikembalikan dalam prgParamProperties.

prgParamProperties[out]
Pointer ke memori di mana array struktur SSPARAMPROPS dikembalikan. Penyedia mengalokasikan memori untuk struktur dan mengembalikan alamat ke memori ini, konsumen merilis memori ini ketika IMalloc::Free tidak lagi membutuhkan struktur. Sebelum memanggil IMalloc::Free prgParamProperties, konsumen juga harus memanggil VariantClear properti vValue dari setiap struktur DBPROP untuk mencegah kebocoran memori jika varian berisi jenis referensi seperti BSTR. Jika pcParams nol pada output atau kesalahan selain DB_E_ERRORSOCCURRED terjadi, penyedia tidak mengalokasikan memori apa pun dan memastikan prgParamProperties adalah pointer null pada output.

Mengembalikan Nilai Kode

Metode ini GetParameterProperties mengembalikan kode kesalahan yang sama dengan metode OLE DB ICommandProperties::GetProperties inti, kecuali bahwa DB_S_ERRORSOCCURRED dan DB_E_ERRORSOCCURED tidak dapat dinaikkan.

Keterangan

ISSCommandWithParameters::GetParameterProperties metode bertingkat secara konsisten sehubungan GetParameterInfodengan . Jika ISSCommandWithParameters::SetParameterProperties atau SetParameterInfo belum dipanggil atau telah dipanggil dengan cParams sama dengan nol, GetParameterInfo mendapatkan informasi parameter dan mengembalikannya. Jika ISSCommandWithParameters::SetParameterProperties atau SetParameterInfo telah dipanggil untuk setidaknya satu parameter, ISSCommandWithParameters::GetParameterProperties metode mengembalikan properti hanya untuk parameter ISSCommandWithParameters::SetParameterProperties yang telah dipanggil. Jika ISSCommandWithParameters::SetParameterProperties dipanggil setelah ISSCommandWithParameters::GetParameterProperties atau GetParameterInfo, panggilan berikutnya untuk ISSCommandWithParameters::GetParameterProperties mengembalikan nilai yang ditimpa untuk parameter tersebut yang ISSCommandWithParameters::SetParameterProperties metodenya telah dipanggil.

Struktur SSPARAMPROPS didefinisikan sebagai berikut:

struct SSPARAMPROPS {

DBORDINAL iOrdinal;

ULONG cPropertySets;

DBPROPSET *rgPropertySets;

};

Anggota	Deskripsi
iOrdinal	Ordinal parameter yang dilewatkan.
cPropertySets	Jumlah struktur DBPROPSET di rgPropertySets.
rgPropertySets	Pointer ke memori untuk mengembalikan array struktur DBPROPSET.

Lihat Juga

ISSCommandWithParameters (OLE DB)