winstring.h File Reference

#include <hstring.h>

Include dependency graph for winstring.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
HRESULT WINAPI	WindowsCompareStringOrdinal (HSTRING str1, HSTRING str2, INT32 *order)
HRESULT WINAPI	WindowsConcatString (HSTRING str1, HSTRING str2, HSTRING *out)
HRESULT WINAPI	WindowsCreateString (LPCWSTR ptr, UINT32 len, HSTRING *out)
HRESULT WINAPI	WindowsCreateStringReference (LPCWSTR ptr, UINT32 len, HSTRING_HEADER *header, HSTRING *out)
HRESULT WINAPI	WindowsDeleteString (HSTRING str)
HRESULT WINAPI	WindowsDeleteStringBuffer (HSTRING_BUFFER buf)
HRESULT WINAPI	WindowsDuplicateString (HSTRING str, HSTRING *out)
UINT32 WINAPI	WindowsGetStringLen (HSTRING str)
LPCWSTR WINAPI	WindowsGetStringRawBuffer (HSTRING str, UINT32 *len)
BOOL WINAPI	WindowsIsStringEmpty (HSTRING str)
HRESULT WINAPI	WindowsPreallocateStringBuffer (UINT32 len, WCHAR **outptr, HSTRING_BUFFER *out)
HRESULT WINAPI	WindowsPromoteStringBuffer (HSTRING_BUFFER buf, HSTRING *out)
HRESULT WINAPI	WindowsReplaceString (HSTRING haystack, HSTRING needle, HSTRING replacement, HSTRING *out)
HRESULT WINAPI	WindowsStringHasEmbeddedNull (HSTRING str, BOOL *out)
HRESULT WINAPI	WindowsSubstring (HSTRING str, UINT32 pos, HSTRING *out)
HRESULT WINAPI	WindowsSubstringWithSpecifiedLength (HSTRING str, UINT32 pos, UINT32 len, HSTRING *out)
HRESULT WINAPI	WindowsTrimStringEnd (HSTRING str, HSTRING charstr, HSTRING *out)
HRESULT WINAPI	WindowsTrimStringStart (HSTRING str, HSTRING charstr, HSTRING *out)

Function Documentation

WindowsCompareStringOrdinal()

HRESULT WINAPI WindowsCompareStringOrdinal	(	HSTRING	str1,
		HSTRING	str2,
		INT32 *	order
	)

Definition at line 400 of file string.c.

{
    struct hstring_private *priv1 = impl_from_HSTRING(str1);
    struct hstring_private *priv2 = impl_from_HSTRING(str2);
    const WCHAR *buf1 = empty, *buf2 = empty;
    UINT32 len1 = 0, len2 = 0;
 
    TRACE("(%p, %p, %p)\n", str1, str2, res);
 
    if (res == NULL)
        return E_INVALIDARG;
    if (str1 == str2)
    {
        *res = 0;
        return S_OK;
    }
    if (str1)
    {
        buf1 = priv1->header.str;
        len1 = priv1->header.length;
    }
    if (str2)
    {
        buf2 = priv2->header.str;
        len2 = priv2->header.length;
    }
    *res = CompareStringOrdinal(buf1, len1, buf2, len2, FALSE) - CSTR_EQUAL;
    return S_OK;
}

Referenced by test_compare().

WindowsConcatString()

HRESULT WINAPI WindowsConcatString	(	HSTRING	str1,
		HSTRING	str2,
		HSTRING *	out
	)

Definition at line 356 of file string.c.

{
    struct hstring_private *priv1 = impl_from_HSTRING(str1);
    struct hstring_private *priv2 = impl_from_HSTRING(str2);
    struct hstring_private *priv;
 
    TRACE("(%p, %p, %p)\n", str1, str2, out);
 
    if (out == NULL)
        return E_INVALIDARG;
    if (str1 == NULL)
        return WindowsDuplicateString(str2, out);
    if (str2 == NULL)
        return WindowsDuplicateString(str1, out);
    if (!priv1->header.length && !priv2->header.length)
    {
        *out = NULL;
        return S_OK;
    }
    if (!alloc_string(priv1->header.length + priv2->header.length, out))
        return E_OUTOFMEMORY;
    priv = impl_from_HSTRING(*out);
    memcpy(priv->buffer, priv1->header.str, priv1->header.length * sizeof(*priv1->buffer));
    memcpy(priv->buffer + priv1->header.length, priv2->header.str, priv2->header.length * sizeof(*priv2->buffer));
    return S_OK;
}

Referenced by test_concat().

WindowsCreateString()

HRESULT WINAPI WindowsCreateString	(	LPCWSTR	ptr,
		UINT32	len,
		HSTRING *	out
	)

Definition at line 87 of file string.c.

{
    struct hstring_private *priv;
 
    TRACE("(%s, %u, %p)\n", debugstr_wn(ptr, len), len, out);
 
    if (out == NULL)
        return E_INVALIDARG;
    if (len == 0)
    {
        *out = NULL;
        return S_OK;
    }
    if (ptr == NULL)
        return E_POINTER;
    if (!alloc_string(len, out))
        return E_OUTOFMEMORY;
    priv = impl_from_HSTRING(*out);
    memcpy(priv->buffer, ptr, len * sizeof(*priv->buffer));
    return S_OK;
}

Referenced by mta_init_implicit_thread(), test_access(), test_ActivationFactories(), test_compare(), test_concat(), test_create_delete(), test_duplicate(), test_hstring_struct(), test_implicit_mta(), test_substring(), test_trim(), WindowsDuplicateString(), WindowsSubstring(), WindowsSubstringWithSpecifiedLength(), WindowsTrimStringEnd(), and WindowsTrimStringStart().

WindowsCreateStringReference()

HRESULT WINAPI WindowsCreateStringReference	(	LPCWSTR	ptr,
		UINT32	len,
		HSTRING_HEADER *	header,
		HSTRING *	out
	)

Definition at line 113 of file string.c.

{
    struct hstring_private *priv = impl_from_HSTRING_HEADER(header);
 
    TRACE("(%s, %u, %p, %p)\n", debugstr_wn(ptr, len), len, header, out);
 
    if (out == NULL || header == NULL)
        return E_INVALIDARG;
    if (ptr != NULL && ptr[len] != '\0')
        return E_INVALIDARG;
    if (len == 0)
    {
        *out = NULL;
        return S_OK;
    }
    if (ptr == NULL)
        return E_POINTER;
 
    priv->header.str = ptr;
    priv->header.length = len;
    priv->header.flags = HSTRING_REFERENCE_FLAG;
 
    *out = (HSTRING)priv;
    return S_OK;
}

Referenced by test_access(), test_compare(), test_concat(), test_create_delete(), test_duplicate(), test_hstring_struct(), test_substring(), and test_trim().

WindowsDeleteString()

HRESULT WINAPI WindowsDeleteString

(

HSTRING

str

)

Definition at line 143 of file string.c.

{
    struct hstring_private *priv = impl_from_HSTRING(str);
 
    TRACE("(%p)\n", str);
 
    if (str == NULL)
        return S_OK;
    if (priv->header.flags & HSTRING_REFERENCE_FLAG)
        return S_OK;
    if (InterlockedDecrement(&priv->refcount) == 0)
        free(priv);
    return S_OK;
}

Referenced by mta_init_implicit_thread(), test_access(), test_ActivationFactories(), test_compare(), test_concat(), test_create_delete(), test_duplicate(), test_hstring_struct(), test_implicit_mta(), test_string_buffer(), test_substring(), test_trim(), and WindowsDeleteStringBuffer().

WindowsDeleteStringBuffer()

HRESULT WINAPI WindowsDeleteStringBuffer

(

HSTRING_BUFFER

buf

)

Definition at line 212 of file string.c.

{
    struct hstring_private *priv = NULL;
 
    TRACE("(%p)\n", buf);
 
    if(buf)
        priv = impl_from_HSTRING_BUFFER(buf);
 
    return WindowsDeleteString((HSTRING)priv);
}

Referenced by test_string_buffer().

WindowsDuplicateString()

HRESULT WINAPI WindowsDuplicateString	(	HSTRING	str,
		HSTRING *	out
	)

Definition at line 161 of file string.c.

{
    struct hstring_private *priv = impl_from_HSTRING(str);
 
    TRACE("(%p, %p)\n", str, out);
 
    if (out == NULL)
        return E_INVALIDARG;
    if (str == NULL)
    {
        *out = NULL;
        return S_OK;
    }
    if (priv->header.flags & HSTRING_REFERENCE_FLAG)
        return WindowsCreateString(priv->header.str, priv->header.length, out);
    InterlockedIncrement(&priv->refcount);
    *out = str;
    return S_OK;
}

Referenced by test_duplicate(), test_hstring_struct(), WindowsConcatString(), WindowsTrimStringEnd(), and WindowsTrimStringStart().

WindowsGetStringLen()

UINT32 WINAPI WindowsGetStringLen

(

HSTRING

str

)

Definition at line 249 of file string.c.

{
    struct hstring_private *priv = impl_from_HSTRING(str);
 
    TRACE("(%p)\n", str);
 
    if (str == NULL)
        return 0;
    return priv->header.length;
}

Referenced by _check_string(), WindowsSubstring(), and WindowsSubstringWithSpecifiedLength().

WindowsGetStringRawBuffer()

LPCWSTR WINAPI WindowsGetStringRawBuffer	(	HSTRING	str,
		UINT32 *	len
	)

Definition at line 263 of file string.c.

{
    struct hstring_private *priv = impl_from_HSTRING(str);
 
    TRACE("(%p, %p)\n", str, len);
 
    if (str == NULL)
    {
        if (len)
            *len = 0;
        return empty;
    }
    if (len)
        *len = priv->header.length;
    return priv->header.str;
}

Referenced by _check_string(), DllGetActivationFactory(), and RoGetActivationFactory().

WindowsIsStringEmpty()

BOOL WINAPI WindowsIsStringEmpty

(

HSTRING

str

)

Definition at line 386 of file string.c.

{
    struct hstring_private *priv = impl_from_HSTRING(str);
 
    TRACE("(%p)\n", str);
 
    if (str == NULL)
        return TRUE;
    return priv->header.length == 0;
}

Referenced by _check_string().

WindowsPreallocateStringBuffer()

HRESULT WINAPI WindowsPreallocateStringBuffer	(	UINT32	len,
		WCHAR **	outptr,
		HSTRING_BUFFER *	out
	)

Definition at line 184 of file string.c.

{
    struct hstring_private *priv;
    HSTRING str;
 
    TRACE("(%u, %p, %p)\n", len, outptr, out);
 
    if (outptr == NULL || out == NULL)
        return E_POINTER;
    if (len == 0)
    {
        *outptr = (LPWSTR)empty;
        *out = NULL;
        return S_OK;
    }
 
    if (!alloc_string(len, &str))
        return E_OUTOFMEMORY;
    priv = impl_from_HSTRING(str);
    *outptr = priv->buffer;
    *out = (HSTRING_BUFFER)&priv->buffer;
    return S_OK;
}

Referenced by test_string_buffer().

WindowsPromoteStringBuffer()

HRESULT WINAPI WindowsPromoteStringBuffer	(	HSTRING_BUFFER	buf,
		HSTRING *	out
	)

Definition at line 227 of file string.c.

{
    struct hstring_private *priv = impl_from_HSTRING_BUFFER(buf);
 
    TRACE("(%p, %p)\n", buf, out);
 
    if (out == NULL)
        return E_POINTER;
    if (buf == NULL)
    {
        *out = NULL;
        return S_OK;
    }
    if (priv->buffer[priv->header.length] != 0 || priv->header.flags & HSTRING_REFERENCE_FLAG || priv->refcount != 1)
        return E_INVALIDARG;
    *out = (HSTRING)priv;
    return S_OK;
}

Referenced by test_string_buffer().

WindowsReplaceString()

HRESULT WINAPI WindowsReplaceString	(	HSTRING	haystack,
		HSTRING	needle,
		HSTRING	replacement,
		HSTRING *	out
	)

WindowsStringHasEmbeddedNull()

HRESULT WINAPI WindowsStringHasEmbeddedNull	(	HSTRING	str,
		BOOL *	out
	)

Definition at line 283 of file string.c.

{
    UINT32 i;
    struct hstring_private *priv = impl_from_HSTRING(str);
 
    TRACE("(%p, %p)\n", str, out);
 
    if (out == NULL)
        return E_INVALIDARG;
    if (str == NULL)
    {
        *out = FALSE;
        return S_OK;
    }
    for (i = 0; i < priv->header.length; i++)
    {
        if (priv->header.str[i] == '\0')
        {
            *out = TRUE;
            return S_OK;
        }
    }
    *out = FALSE;
    return S_OK;
}

Referenced by _check_string().

WindowsSubstring()

HRESULT WINAPI WindowsSubstring	(	HSTRING	str,
		UINT32	pos,
		HSTRING *	out
	)

Definition at line 312 of file string.c.

{
    struct hstring_private *priv = impl_from_HSTRING(str);
    UINT32 len = WindowsGetStringLen(str);
 
    TRACE("(%p, %u, %p)\n", str, start, out);
 
    if (out == NULL)
        return E_INVALIDARG;
    if (start > len)
        return E_BOUNDS;
    if (start == len)
    {
        *out = NULL;
        return S_OK;
    }
    return WindowsCreateString(&priv->header.str[start], len - start, out);
}

Referenced by test_substring().

WindowsSubstringWithSpecifiedLength()

HRESULT WINAPI WindowsSubstringWithSpecifiedLength	(	HSTRING	str,
		UINT32	pos,
		UINT32	len,
		HSTRING *	out
	)

Definition at line 334 of file string.c.

{
    struct hstring_private *priv = impl_from_HSTRING(str);
 
    TRACE("(%p, %u, %u, %p)\n", str, start, len, out);
 
    if (out == NULL)
        return E_INVALIDARG;
    if (start + len < start ||
        start + len > WindowsGetStringLen(str))
        return E_BOUNDS;
    if (len == 0)
    {
        *out = NULL;
        return S_OK;
    }
    return WindowsCreateString(&priv->header.str[start], len, out);
}

Referenced by test_substring().

WindowsTrimStringEnd()

HRESULT WINAPI WindowsTrimStringEnd	(	HSTRING	str,
		HSTRING	charstr,
		HSTRING *	out
	)

Definition at line 460 of file string.c.

{
    struct hstring_private *priv1 = impl_from_HSTRING(str1);
    struct hstring_private *priv2 = impl_from_HSTRING(str2);
    UINT32 len;
 
    TRACE("(%p, %p, %p)\n", str1, str2, out);
 
    if (!out || !str2 || !priv2->header.length)
        return E_INVALIDARG;
    if (!str1)
    {
        *out = NULL;
        return S_OK;
    }
    for (len = priv1->header.length; len > 0; len--)
    {
        if (!wmemchr(priv2->header.str, priv1->header.str[len - 1], priv2->header.length))
            break;
    }
    return (len < priv1->header.length) ? WindowsCreateString(priv1->header.str, len, out) :
                                   WindowsDuplicateString(str1, out);
}

Referenced by test_trim().

WindowsTrimStringStart()

HRESULT WINAPI WindowsTrimStringStart	(	HSTRING	str,
		HSTRING	charstr,
		HSTRING *	out
	)

Definition at line 433 of file string.c.

{
    struct hstring_private *priv1 = impl_from_HSTRING(str1);
    struct hstring_private *priv2 = impl_from_HSTRING(str2);
    UINT32 start;
 
    TRACE("(%p, %p, %p)\n", str1, str2, out);
 
    if (!out || !str2 || !priv2->header.length)
        return E_INVALIDARG;
    if (!str1)
    {
        *out = NULL;
        return S_OK;
    }
    for (start = 0; start < priv1->header.length; start++)
    {
        if (!wmemchr(priv2->header.str, priv1->header.str[start], priv2->header.length))
            break;
    }
    return start ? WindowsCreateString(&priv1->header.str[start], priv1->header.length - start, out) :
                   WindowsDuplicateString(str1, out);
}

Referenced by test_trim().