目次 - SDL 3.0 API(機能別) - プロパティ - SDL_GetStringProperty

SDL_GetStringProperty

プロパティグループから文字列型プロパティを得る

ヘッダ

SDL3/SDL_properties.h

構文

const char * SDL_GetStringProperty(SDL_PropertiesID props, const char *name, const char *default_value);

引数

SDL_PropertiesIDprops問い合わせるプロパティグループ
const char *name問い合わせるプロパティの名前
void *default_valueプロパティのデフォルト値

戻り値

(const char *) プロパティの値を戻す. 値が設定されていない, または文字列型プロパティでない場合はdefault_valueを戻す.

スレッドセーフ

この関数はどのスレッドからも安全に呼べるが, 戻されたデータは保護されておらず, 別のスレッドから同じプロパティに対してSDL_SetStringProperty()やSDL_ClearProperty()が呼ばれて解放されてしまう可能性がある. これを防ぐためには, SDL_LockProperties()とSDL_UnlockProperties()を使ってロックする必要がある.

バージョン

SDL 3.2.0以降

関連項目

SDL Wikiへのリンク

SDL_GetStringProperty - SDL Wiki