Dela via


sp_OASetProperty (Transact-SQL)

gäller för:SQL Server

Anger en egenskap för ett OLE-objekt till ett nytt värde.

Transact-SQL syntaxkonventioner

Syntax

sp_OASetProperty objecttoken
    , propertyname
    , newvalue
    [ , index... ]
[ ; ]

Argument

Viktig

Argument för utökade lagrade procedurer måste anges i den specifika ordning som beskrivs i avsnittet Syntax. Om parametrarna anges i fel ordning visas ett felmeddelande.

objekttoken

Objekttoken för ett OLE-objekt som tidigare skapats av sp_OACreate.

egenskapsnamn

Egenskapsnamnet för OLE-objektet som ska anges till ett nytt värde.

newvalue

Det nya värdet för egenskapen och måste vara ett värde av lämplig datatyp.

index

En indexparameter. Om det anges måste index vara ett värde av lämplig datatyp.

Vissa egenskaper har parametrar. Dessa egenskaper kallas indexerade egenskaper och parametrarna kallas indexparametrar. En egenskap kan ha flera indexparametrar.

Not

Parametrarna för den här lagrade proceduren anges efter position, inte namn.

Returnera kodvärden

0 (lyckades) eller ett icke-nolltal (fel) som är heltalsvärdet för HRESULT som returneras av OLE Automation-objektet.

Mer information om HRESULT-returkoder finns i RETURkoder för OLE Automation och felinformation.

Behörigheter

Kräver medlemskap i sysadmin fast serverroll eller kör behörighet direkt på den här lagrade proceduren. Alternativet Ole Automation-procedurer serverkonfiguration måste vara aktiverat för att kunna använda alla systemprocedurer som är relaterade till OLE Automation.

Exempel

I följande exempel anges egenskapen HostName (för det tidigare skapade SQLServer-objektet) till ett nytt värde.

EXECUTE
    @hr = sp_OASetProperty
    @object,
    'HostName',
    'Gizmo';

IF @hr <> 0
BEGIN
    EXECUTE sp_OAGetErrorInfo @object;
    RETURN;
END