IPropertyDescription::GetEditInvitation method

Gets the text used in edit controls hosted in various dialog boxes.

Syntax


HRESULT GetEditInvitation(
  [out]  LPWSTR *pszInvite
);

Parameters

pszInvite [out]

Type: LPWSTR*

When this method returns, contains the address of a pointer to a null-terminated Unicode buffer that holds the invitation text.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The information retrieved by this method comes from the invitationText attribute of the labelInfo element in the property's .propdesc file.

It is the responsibility of the calling application to use CoTaskMemFree to release the string referred to by pszInvite when it is no longer needed.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Shobjidl.h

IDL

Shobjidl.idl

See also

IPropertyDescription
Property Description Schema

 

 

Community Additions

ADD
Show:
© 2014 Microsoft