IPropertyDescription::GetEditInvitation method (propsys.h)
Gets the text used in edit controls hosted in various dialog boxes.
Syntax
HRESULT GetEditInvitation(
[out] LPWSTR *ppszInvite
);
Parameters
[out] ppszInvite
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
Requirement | Value |
---|---|
Minimum supported client | Windows Vista [desktop apps only] |
Minimum supported server | Windows Server 2008 [desktop apps only] |
Target Platform | Windows |
Header | propsys.h (include Shobjidl.h) |
See also
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for