ISSCommandWithParameters::GetParameterProperties (OLE DB)
van toepassing op:SQL Server
Azure SQL Database
Azure SQL Managed Instance
Azure Synapse Analytics
Analytics Platform System (PDW)
OLE DB-stuurprogramma downloaden
Retourneert een matrix van SSPARAMPROPS-eigenschappensetstructuren, één SSPARAMPROPS-eigenschap die is ingesteld voor elke UDT- of XML-parameter.
Syntaxis
HRESULT GetParameterProperties(
DB_UPARAMS *pcParams,
SSPARAMPROPS **prgParamProperties);
Argumenten
pcParams[out][in]
Een aanwijzer naar het geheugen dat het aantal SSPARAMPROPS-structuren bevat dat is geretourneerd in prgParamProperties.
prgParamProperties[out]
Een aanwijzer naar het geheugen waarin een matrix van SSPARAMPROPS-structuren wordt geretourneerd. De provider wijst geheugen toe voor de structuren en retourneert het adres aan dit geheugen. De consument brengt dit geheugen vrij met IMalloc::Free
wanneer deze de structuren niet meer nodig heeft. Voordat u IMalloc::Free
aanroept voor prgParamProperties, moet de consument ook VariantClear
aanroepen voor de eigenschap vValue van elke DBPROP-structuur om een geheugenlek te voorkomen in gevallen waarin de variant een verwijzingstype zoals een BSTR bevat. Als pcParams nul is op de uitvoer of als er een andere fout optreedt dan DB_E_ERRORSOCCURRED, wijst de provider geen geheugen toe en zorgt ervoor dat prgParamProperties- een null-aanwijzer op de uitvoer is.
Retourcodewaarden
De methode GetParameterProperties
retourneert dezelfde foutcodes als de ICommandProperties::GetProperties
basismethode OLE DB, behalve dat DB_S_ERRORSOCCURRED en DB_E_ERRORSOCCURRED niet kunnen worden gegenereerd.
Opmerkingen
ISSCommandWithParameters::GetParameterProperties
methode gedraagt zich consistent met betrekking tot GetParameterInfo
. Als ISSCommandWithParameters::SetParameterProperties
of SetParameterInfo
niet zijn aangeroepen of zijn aangeroepen met cParams gelijk aan nul, worden GetParameterInfo
parametergegevens afgeleid en geretourneerd. Als ISSCommandWithParameters::SetParameterProperties
of SetParameterInfo
zijn aangeroepen voor ten minste één parameter, retourneert ISSCommandWithParameters::GetParameterProperties
methode alleen eigenschappen voor de parameters waarvoor ISSCommandWithParameters::SetParameterProperties
is aangeroepen. Als ISSCommandWithParameters::SetParameterProperties
wordt aangeroepen na ISSCommandWithParameters::GetParameterProperties
of GetParameterInfo
, retourneren volgende aanroepen naar ISSCommandWithParameters::GetParameterProperties
de overschreven waarden voor die parameters waarvoor ISSCommandWithParameters::SetParameterProperties
methode is aangeroepen.
De SSPARAMPROPS-structuur wordt als volgt gedefinieerd:
struct SSPARAMPROPS {
DBORDINAL iOrdinal;
ULONG cPropertySets;
DBPROPSET *rgPropertySets;
};
Lid | Beschrijving |
---|---|
iOrdinal- | Het rangtelwoord van de doorgegeven parameter. |
cPropertySets | Het aantal DBPROPSET-structuren in rgPropertySets. |
rgPropertySets | Een aanwijzer naar het geheugen waarin een matrix van DBPROPSET-structuren moet worden geretourneerd. |