Share via


StringFromGUID2

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function converts a globally unique identifier (GUID) into a string of printable characters.

Syntax

StringFromGUID2(
  REFGUID rguid, 
  LPOLESTR lpsz, 
  int cbMax
); 

Parameters

  • rguid
    [in] Interface identifier to be converted.
  • lpsz
    [out] Long pointer to the resulting null-terminated string on return.
  • cbMax
    [in] Character count of the string indicated by lpsz.

Return Value

Nonzero indicates the number of characters in the returned string, including the terminating null character. Zero indicates that the buffer is too small for returned string.

Remarks

The string that the lpsz parameter receives has a format like that of the following sample:

{c200e360-38c5–11ce-ae62-08002b2b79ef}

where the successive fields break the GUID into the form DWORD-WORD-WORD-WORD-WORD.DWORD covering the 128-bit GUID. The string includes enclosing braces. These are an OLE convention.

Passing into this function any invalid and, under some circumstances, NULL pointers result in unexpected termination of the application.

To determine whether the platform supports this function, see Determining Supported COM APIs.

Requirements

Header objbase.h
Library ole32.lib
Windows Embedded CE Windows CE 2.0 and later
Windows Mobile Windows Mobile Version 5.0 and later