IInkDisp::Save method (msinkaut.h)
Converts the ink to the specified InkPersistenceFormat, saves the ink by using the specified InkPersistenceCompressionMode, and returns the binary data in an array of bytes.
Syntax
HRESULT Save(
[in, optional] InkPersistenceFormat PersistenceFormat,
[in, optional] InkPersistenceCompressionMode CompressionMode,
[out, retval] VARIANT *Data
);
Parameters
[in, optional] PersistenceFormat
Optional. Sets one of the InkPersistenceFormat values that indicates the format of the persisted ink. The default value is InkSerializedFormat.
[in, optional] CompressionMode
Optional. One of the InkPersistenceCompressionMode values that specifies the compression mode of the persisted ink. The default value is IPCM_Default.
[out, retval] Data
When this method returns, contains the byte array that contains the persisted ink.
For more information about the VARIANT structure, see Using the COM Library.
Return value
This method can return one of these values.
Return code | Description |
---|---|
|
Success. |
|
A parameter contained an invalid pointer. |
|
An exception occurred inside the method. |
|
Invalid compression mode. |
|
Cannot allocate byte array. |
|
Occurs if you attempt to save an empty Ink object in GIF format. |
Remarks
Attempting to save an empty InkDisp object in GIF format generates an error.
Requirements
Requirement | Value |
---|---|
Minimum supported client | Windows XP Tablet PC Edition [desktop apps only] |
Minimum supported server | None supported |
Target Platform | Windows |
Header | msinkaut.h |
Library | InkObj.dll |
See also
InkPersistenceCompressionMode Enumeration
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