Dela via


ISSCommandWithParameters::GetParameterProperties (OLE DB)

gäller för:SQL ServerAzure SQL DatabaseAzure SQL Managed InstanceAzure Synapse AnalyticsAnalytics Platform System (PDW)

Ladda ned OLE DB-drivrutins

Returnerar en matris med SSPARAMPROPS-egenskapsuppsättningsstrukturer, en SSPARAMPROPS-egenskapsuppsättning för varje UDT- eller XML-parameter.

Syntax

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

Argument

pcParams[out][in]
En pekare till minnet som innehåller antalet SSPARAMPROPS-strukturer som returneras i prgParamProperties.

prgParamProperties[ut]
En pekare till minnet där en matris med SSPARAMPROPS-strukturer returneras. Providern allokerar minne för strukturerna och returnerar adressen till det här minnet, konsumenten släpper det här minnet med IMalloc::Free när det inte längre behöver strukturerna. Innan du anropar IMalloc::Free för prgParamPropertiesmåste konsumenten också anropa VariantClear för egenskapen vValue för varje DBPROP-struktur för att förhindra en minnesläcka i fall där varianten innehåller en referenstyp, till exempel en BSTR. Om pcParams är noll på utdata eller om ett annat fel än DB_E_ERRORSOCCURRED inträffar allokerar providern inget minne och ser till att prgParamProperties är en null-pekare på utdata.

Returnera kodvärden

Metoden GetParameterProperties returnerar samma felkoder som ole db-kärnmetoden ICommandProperties::GetProperties, förutom att DB_S_ERRORSOCCURRED och DB_E_ERRORSOCCURRED inte kan aktiveras.

Anmärkningar

ISSCommandWithParameters::GetParameterProperties-metoden fungerar konsekvent med avseende på GetParameterInfo. Om ISSCommandWithParameters::SetParameterProperties eller SetParameterInfo inte har anropats eller har anropats med cParams som är lika med noll, härleder GetParameterInfo parameterinformation och returnerar den. Om ISSCommandWithParameters::SetParameterProperties eller SetParameterInfo har anropats för minst en parameter returnerar ISSCommandWithParameters::GetParameterProperties-metoden endast egenskaper för de parametrar som ISSCommandWithParameters::SetParameterProperties har anropats för. Om ISSCommandWithParameters::SetParameterProperties anropas efter ISSCommandWithParameters::GetParameterProperties eller GetParameterInforeturnerar efterföljande anrop till ISSCommandWithParameters::GetParameterProperties de åsidosatta värdena för de parametrar som ISSCommandWithParameters::SetParameterProperties-metoden har anropats för.

SSPARAMPROPS-strukturen definieras på följande sätt:

struct SSPARAMPROPS {

DBORDINAL iOrdinal;

ULONG cPropertySets;

DBPROPSET *rgPropertySets;

};

Medlem Beskrivning
iOrdinal Ordningstalet för den överförda parametern.
cPropertySets Antalet DBPROPSET-strukturer i rgPropertySets.
rgPropertySets En pekare till minnet där en matris med DBPROPSET-strukturer ska returneras.

Se även

ISSCommandWithParameters (OLE DB)