ISmsMessage::GetBodyToString Method

  • Article

Applies To: System Center Configuration Manager 2007, System Center Configuration Manager 2007 R2, System Center Configuration Manager 2007 R3, System Center Configuration Manager 2007 SP1, System Center Configuration Manager 2007 SP2

The ISmsMessage::GetBodyToString method, in Configuration Manager, gets the message body into a string.

[IDL]
HRESULT GetBodyToString( 
        LPWSTR*  pszString
);

Parameters

  • pszString
    Data type: LPWSTR

    Qualifiers: [out]

    Pointer to the message body data. The caller must free the memory using CoTaskMemFree.

Return Values

An HRESULT code. Possible values include, but are not limited to, the following:

  • S_OK
    The method succeeded.
  • SMS_ERR_DATATYPE_MISMATCH
    The body is not a null terminated Unicode string.

Remarks

This method fails unless the application has set the message body as a null-terminated Unicode string, for example, by using ISmsMessage::SetBodyFromString Method.

See Also

Concepts

ISmsMessage Interface