SQLSetStmtAttr İşlevi

Uygunluk
Tanıtılan Sürüm: ODBC 3.0 Standartlarına Uyum: ISO 92

Özet
SQLSetStmtAttr , bir ifadeyle ilgili öznitelikleri ayarlar.

Syntax

  
SQLRETURN SQLSetStmtAttr(  
     SQLHSTMT      StatementHandle,  
     SQLINTEGER    Attribute,  
     SQLPOINTER    ValuePtr,  
     SQLINTEGER    StringLength);  

Arguments

StatementHandle
[Giriş] Deyim tanıtıcısı.

Öznitelik
[Giriş] "Yorumlar" bölümünde ayarlama seçeneği var.

Valueptr
[Giriş] Öznitelik ile ilişkilendirilecek değer. Özniteliğin değerine bağlı olarak, ValuePtr aşağıdakilerden biri olacaktır:

• ODBC tanımlayıcı kullanıcı adı.

• Bir SQLUINTeger değeri.

• A SQLULEN değeri.

• Aşağıdakilerden birine işaret eder:

  • Null-sonlu bir karakter dizisi.

  • İkili bir tampon.

  • SQLLEN, SQLULEN veya SQLUSMALLINT tipinde bir değer veya dizi.

  • Sürücü tarafından tanımlanan bir değer.

Attribute argümanı sürücüye özgü bir değerse, ValuePtr imzalı bir tam sayı olabilir.

StringLength
[Giriş] Eğer Attribute ODBC tarafından tanımlanmış bir öznitelikse ve ValuePtr bir karakter dizisine veya ikili tampona işaret ediyorsa, bu argüman *ValuePtr uzunluğu olmalıdır. Attribute ODBC ile tanımlanmış bir öznitelikse ve ValuePtr bir tam sayıysa, StringLength göz ardı edilir.

Eğer Attribute sürücü tarafından tanımlanan bir öznitelikse, uygulama StringLength argümanını ayarlayarak Driver Manager'a özniteliğin niteliğini gösterir. StringLength aşağıdaki değerlere sahip olabilir:

• Eğer ValuePtr bir karakter dizisine işaret eden bir işaret ise, StringLength dizinin veya SQL_NTS'nin uzunluğudur.

• Eğer ValuePtr ikili tampona işaret eden bir işaretçiyse, uygulama SQL_LEN_BINARY_ATTR(uzunluk) makrosunun sonucunu StringLength'e yerleştirir. Bu, StringLength değerinde negatif bir değer verir.

• Eğer ValuePtr, karakter dizisi veya ikili bir dizi dışındaki bir değere işaret ediyorsa, StringLength SQL_IS_POINTER değerine sahip olmalıdır.

• Eğer ValuePtr sabit uzunluklu bir değer içeriyorsa, StringLength uygun şekilde ya SQL_IS_INTEGER ya da SQL_IS_UINTEGER olur.

İadeler

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR veya SQL_INVALID_HANDLE.

Diagnostics

SQLSetStmtAttr SQL_ERROR veya SQL_SUCCESS_WITH_INFO döndürdüğünde, ilişkili bir SQLSTATE değeri, SQL_HANDLE_STMT HandleType ve StatementHandleile SQLGetDiagRec çağrılarak elde edilebilir. Aşağıdaki tablo, SQLSetStmtAttr tarafından sıkça döndürülen SQLSTATE değerlerini listeler; her birini bu fonksiyon bağlamında açıklar; "(DM)" gösterimi, Sürücü Yöneticisi tarafından döndürülen SQLSTATE açıklamalarından önce gelir. Aksi belirtilmediği sürece, her SQLSTATE değeriyle ilişkili dönüş kodu SQL_ERROR.

Comments

Bir ifade için özetlikler, başka bir çağrı ile değiştirilene veya SQLFreeHandle çağrısıyla ifade kaldırılana kadar geçerlidir. SQLFreeStmt'yi SQL_CLOSE, SQL_UNBIND veya SQL_RESET_PARAMS seçeneğiyle çağırmak ifade özelliklerini sıfırlamaz.

Bazı ifade öznitelikleri, veri kaynağı ValuePtr'de belirtilen değeri desteklemiyorsa benzer bir değerin değiştirilmesini destekler. Böyle durumlarda, sürücü SQL_SUCCESS_WITH_INFO ve SQLSTATE 01S02 (Seçenek değeri değiştirildi) döndürür. Örneğin, Attribute SQL_ATTR_CONCURRENCY ve ValuePtr SQL_CONCUR_ROWVER ise ve veri kaynağı bunu desteklemiyorsa, sürücü SQL_CONCUR_VALUES yerine koyar ve SQL_SUCCESS_WITH_INFO döndürür. Yerine getirilen değeri belirlemek için bir uygulama SQLGetStmtAttr çağrısını yapar.

ValuePtr ile bilgi setinin formatı, belirtilen Özniteliğe bağlıdır. SQLSetStmtAttr , öznitelik bilgisini iki farklı formattan birinde kabul eder: bir karakter dizisi veya bir tamsayı değeri. Her birinin formatı özniteliğin açıklamasında belirtilmiştir. Bu format, SQLGetStmtAttr'deki her öznitelik için döndürülen bilgiler için geçerlidir. SQLSetStmtAttr'ninValuePtr argümanı tarafından işaretlenen karakter dizileri StringLength uzunluğuna sahiptir.

Tanımlayıcı Alanları Belirleyen Özetleme Özellikleri

Birçok ifade özniteliği, bir tanımlayıcının başlık alanına karşılık gelir. Bu nitelikleri ayarlamak aslında tanımlayıcı alanlarının ayarlanmasına yol açar. Alanları SQLSetStmtAttr çağrısıyla ayarlamak, fonksiyon çağrısı için tanımlayıcı kolunun alınmasına gerek kalmamasıdır.

Bir tanımlayıcı alan, ilgili ifade özniteliğinin ayarlanması sonucu ayarlandığında, alan yalnızca StatementHandle argümanı tarafından tanımlanan ifadeyle ilişkilendirilen mevcut tanımlayıcılar için ayarlanır ve nitelik ayarı, gelecekte o ifadeyle ilişkilendirilebilecek herhangi bir tanımlayıcıyı etkilemez. Aynı zamanda bir ifade özniteliği olan bir tanımlayıcı alan, SQLSetDescField çağrısıyla ayarlandığında, karşılık gelen ifade özniteliği ayarlanır. Açıkça tahsis edilen bir tanımlayıcı bir ifadeden ayrılırsa, başlık alanına karşılık gelen bir ifade özniteliği, örtük olarak tahsis edilen tanımlayıcıdaki alanın değerine geri dönecektir.

Bir ifade tahsis edildiğinde ( bkz. SQLAllocHandle), dört tanımlayıcı tutamacı otomatik olarak tahsis edilir ve ifadeyle ilişkilendirilir. Açıkça tahsis edilen tanımlayıcı tutamaçları, bir tanımlayıcı tutamacını tahsis etmek için SQLAllocHandle ile fHandleType SQL_HANDLE_DESC çağırarak ve ardından SQLSetStmtAttr çağrılıp, tanımlayıcı tutacağı ile ilişkilendirilerek ifade ile ilişkilendirilebilir.

Aşağıdaki tablodaki ifade öznitelikleri, tanımlayıcı başlık alanlarına karşılık gelir.

Beyan Öznitelikleri

Şu anda tanımlanmış özellikler ve tanıtıldıkları ODBC versiyonu aşağıdaki tabloda gösterilmiştir; Farklı veri kaynaklarından faydalanmak için sürücüler tarafından daha fazla özniteliğin tanımlanması beklenmektedir. ODBC tarafından çeşitli özellikler ayrılmıştır; sürücü geliştiricileri, Open Group'tan kendi sürücüye özgü kullanımları için değerleri ayırmalıdır. Daha fazla bilgi için bkz. Driver-Specific Veri Türleri, Tanımlayıcı Türleri, Bilgi Türleri, Tanılama Türleri ve Öznitelikler.

[1] Bu fonksiyonlar, tanımlayıcı uygulama tanımlayıcısı değil, uygulama tanımlayıcısı ise asenkron olarak çağrılabilir.

Bkz. Column-Wise Bağlama ve Row-Wise Bağlama.

İlgili Fonksiyonlar

Ayrıca Bkz.

ODBC API Referansı
ODBC Üst Bilgi Dosyaları