Microsoft DirectX 8.0

文字列関数

宣言 : Wxutil.h

AMGetWideString既存の非ワイド文字列のワイド文字列バージョンを割り当ておよび作成する。
atoi文字列を整数に変換する。
FreeBSTRタスクが割り当てた BSTR 文字列を解放する。
IntToWstr整数をワイド文字列に変換する。
lstrcmpiW大文字/小文字を無視して 2 つのワイド文字列を比較する。
lstrcmpW2 つのワイド文字列を比較する。
lstrcpynWワイド文字列を最大長までコピーする。
lstrcpyWワイド文字列をコピーする。
lstrlenWワイド文字でのワイド文字列の長さを取得する。
WriteBSTRタスクが割り当てたメモリを割り当て、ワイド文字列をメモリにコピーして、タスクが割り当てた BSTR 文字列を作成する。
WstrToIntワイド文字列を整数に変換する。

AMGetWideString

文字列関数

既存の非 Unicode™ 文字列の Unicode バージョンを割り当ておよび作成する。

構文

STDAPI AMGetWideString(
    LPCWSTR pszString,
    LPWSTR *ppszReturn
    );

パラメータ

pszString
非 Unicode ソース 文字列へのポインタ。
ppszReturn
pszString を格納する Unicode™ 文字列へのポインタのアドレス。

戻り値

成功した場合は S_OK を返す。ppszReturn が NULL の場合は E_POINTER を、利用可能なメモリが不足している場合は E_OUTOFMEMORY を返す。

atoi

文字列関数

文字列を整数に変換する。

構文

int WINAPI atoi(
    const TCHAR *sz
    );

パラメータ

sz
ソース文字列へのポインタ。

戻り値

文字列の整数値を返す。

注意

この版の atoi は、10 進数のみをサポートし、先頭にあるスペースまたは記号は許可されない。Unicode™ 文字列と ANSI 文字列の両方をサポートする。ほかの版では異なることがある。

FreeBSTR

文字列関数

タスクが割り当てた BSTR 文字列をメモリから解放する

構文

STDAPI FreeBSTR(
    BSTR *pstr
    );

パラメータ

pstr
解放する BSTR へのポインタ。

戻り値

成功の場合は S_OK を返し、pstr が NULL の場合は S_FALSE を返す。

注意

メモリは、CoTaskMemAlloc を呼び出すことによって、インターフェイスにまたがったオブジェクト間の受け渡しのために割り当てられる。また、CoTaskMemFree の呼び出しによって解放される。集中メモリ アロケータを使うと、異なるプログラミング言語で作成されたオブジェクト間で、メモリの割り当て、受け渡し、および解放を安全に行うことができる。

IntToWstr

文字列関数

整数値をワイド文字列に変換する。

構文

void IntToWstr(
    int i,
    LPWSTR wstrDest
    );

パラメータ

i
変換する整数値。
wstrDest
変換された文字列が含まれるワイド文字列へのポインタ。

戻り値

戻り値はない。

lstrcmpiW

文字列関数

2 つのワイド文字列を比較する。大文字と/小文字は区別されない。

構文

int lstrcmpiW(
    LPCWSTR lpszString1,
    LPCWSTR lpszString2
    );

パラメータ

lpszString1
比較対象の NULL で終了する 1 番目のワイド文字列へのポインタ。
lpszString2
比較対象の NULL で終了する 2 番目のワイド文字列へのポインタ。

戻り値

関数が成功した場合、および lpszString1 によって示される文字列が lpszString2 によって示される文字列よりも小さい場合は、負の値を返す。lpszString1 によって示される文字列が lpszString2 によって示される文字列よりも大きい場合は、正の値を返す。2 つの文字列が等しい場合はゼロを返す。

注意

lstrcmpiW 関数は、2 つのワイド文字列の同じ位置にある文字どうし (たとえば 1番目の文字、2 番目の文字、...) を不一致が検出されるかまたは文字列の終わりに到達するまで照合して比較する。

この関数は、最初に検出した不一致文字の値の差を返す。たとえば lstrcmpiW は L"abcz" を L"abcdefg" より大きいと判断し、L'z' と L'd' の差を返す。

言語 (ロケール) は常に英語として扱われる。

lstrcmpW

文字列関数

2 つのワイド文字列を比較する。大文字と小文字が区別される。

構文

int lstrcmpW(
    LPCWSTR lpszString1,
    LPCWSTR lpszString2
    );

パラメータ

lpszString1
比較対象の NULL で終了する 1 番目のワイド文字列へのポインタ。
lpszString2
比較対象の NULL で終了する 2 番目のワイド文字列へのポインタ。

戻り値

関数が成功した場合、および lpszString1 によって示される文字列が lpszString2 によって示される文字列よりも小さい場合は、負の値を返す。lpszString1 によって示される文字列が lpszString2 によって示される文字列よりも大きい場合は、正の値を返す。2 つの文字列が等しい場合はゼロを返す。

注意

lstrcmpW 関数は、2 つのワイド文字列の同じ位置にある文字どうし (たとえば 1番目の文字、2 番目の文字、...) を不一致が検出されるかまたは文字列の終わりに到達するまで照合して比較する。

この関数は、最初に検出した不一致文字の値の差を返す。たとえば lstrcmpW は L"abcz" を L"abcdefg" より大きいと判断し、L'z' と L'd' の差を返す。

言語 (ロケール) は常に英語として扱われる。

lstrcpyW

文字列関数

ワイド文字列をバッファにコピーする。

構文

LPWSTR lstrcpyW(
    LPWSTR lpszString1,
    LPCWSTR lpszString2
    );

パラメータ

lpszString1
lpszString2 パラメータによって指し示される文字列の内容を受け取るバッファへのポインタ。バッファは、終端のワイド NULL 文字を含めた文字列を格納するのに十分な大きさを持たなければならない。
lpszString2
コピー対象の NULL で終了するワイド文字列へのポインタ。

戻り値

バッファへのポインタを返す。

lstrcpynW

文字列関数

指定されたワイド文字数までのワイド文字列をバッファにコピーする。

構文

LPWSTR lstrcpynW(
    LPWSTR lpszString1,
    LPCWSTR lpszString2,
    int iMaxLength
    );

パラメータ

lpszString1
lpszString2 によって指し示される文字列の内容を受け取るバッファへのポインタ。バッファは、終端のワイド NULL 文字を含めた文字列を格納するのに十分な大きさを持たなければならない。
lpszString2
コピー対象の NULL で終了するワイド文字列へのポインタ。
iMaxLength
終端 NULL 文字を含めた、コピーするワイド文字の最大数。

戻り値

バッファへのポインタを返す。

注意

iMaxLength がゼロ以外の値の場合、lstrcpynW は必ずコピー先の文字列に終端 NULL ワイド文字を挿入する。これにより、ソース文字列が切り捨てられることがある。

lstrlenW

文字列関数

指定されたワイド文字列の長さを取得する。

構文

int lstrlenW(
    LPCWSTR lpszString
    );

パラメータ

lpszString
NULL で終了するワイド文字列へのポインタ。

戻り値

関数が成功した場合、戻り値は文字列のワイド文字での長さを表す。

WriteBSTR

文字列関数

タスクが割り当てた BSTR 文字列の割り当てと埋め込みを行う。

構文

STDAPI WriteBSTR(
    BSTR *pstrDest,
    LPCWSTR szSrc
    );

パラメータ

pstrDest
割り当てられた BSTR の格納先へのポインタ。
szSrc
新しく割り当てられた BSTR 文字列にコピーされるワイド (Unicode™) 文字列へのポインタ。

戻り値

HRESULT 値を返す。

注意

メモリは、CoTaskMemAlloc を呼び出すことによって、インターフェイスにまたがったオブジェクト間の受け渡しのために割り当てられる。また、CoTaskMemFree の呼び出しによって解放される。集中メモリ アロケータを使うと、異なるプログラミング言語で作成されたオブジェクト間で、メモリの割り当て、受け渡し、および解放を安全に行うことができる。

WstrToInt

文字列関数

ワイド文字列を整数に変換する。

構文

int WstrToInt(
    LPCWSTR wstrSrc
    );

パラメータ

wstrSrc
ソースのワイド文字列へのポインタ。

戻り値

文字列の整数値を返す。