Bagikan melalui


sp_OASetProperty (T-SQL)

Berlaku untuk:SQL Server

Mengatur properti objek OLE ke nilai baru.

Konvensi sintaks transact-SQL

Sintaks

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

Argumen

Penting

Argumen untuk prosedur tersimpan yang diperluas harus dimasukkan dalam urutan tertentu seperti yang dijelaskan di bagian Sintaks. Jika parameter dimasukkan di luar urutan, pesan kesalahan terjadi.

objecttoken

Token objek objek OLE yang sebelumnya dibuat oleh sp_OACreate.

nama properti

Nama properti objek OLE untuk diatur ke nilai baru.

nilai baru

Nilai baru properti, dan harus merupakan nilai dari jenis data yang sesuai.

index

Parameter indeks. Jika ditentukan, indeks harus merupakan nilai dari jenis data yang sesuai.

Beberapa properti memiliki parameter. Properti ini disebut properti terindeks, dan parameter disebut parameter indeks. Properti dapat memiliki beberapa parameter indeks.

Catatan

Parameter untuk prosedur tersimpan ini ditentukan berdasarkan posisi, bukan nama.

Mengembalikan nilai kode

0 (berhasil) atau angka bukan nol (kegagalan) yang merupakan nilai bilangan bulat HRESULT yang dikembalikan oleh objek OLE Automation.

Untuk informasi selengkapnya tentang kode pengembalian HRESULT, lihat kode pengembalian otomatisasi OLE dan informasi kesalahan.

Izin

Memerlukan keanggotaan dalam peran server tetap sysadmin atau menjalankan izin langsung pada prosedur tersimpan ini. Opsi konfigurasi server Prosedur Ole Automation harus diaktifkan untuk menggunakan prosedur sistem apa pun yang terkait dengan OLE Automation.

Contoh

Contoh berikut mengatur HostName properti (dari objek yang dibuat SQLServer sebelumnya) ke nilai baru.

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

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