MessageQueue.PeekByLookupId Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Представлено в MSMQ 3.0. Считывает конкретное сообщение из очереди. Сообщение может быть задано кодом просмотра либо его положением относительно начала или конца очереди.
Перегрузки
PeekByLookupId(Int64) |
Представлено в MSMQ 3.0. Считывает сообщение, соответствующее заданному идентификатору просмотра, из нетранзакционной очереди. |
PeekByLookupId(MessageLookupAction, Int64) |
Представлено в MSMQ 3.0. Считывает конкретное сообщение из очереди. Сообщение может быть задано кодом просмотра либо его положением относительно начала или конца очереди. |
PeekByLookupId(Int64)
Представлено в MSMQ 3.0. Считывает сообщение, соответствующее заданному идентификатору просмотра, из нетранзакционной очереди.
public:
System::Messaging::Message ^ PeekByLookupId(long lookupId);
public System.Messaging.Message PeekByLookupId (long lookupId);
member this.PeekByLookupId : int64 -> System.Messaging.Message
Public Function PeekByLookupId (lookupId As Long) As Message
Параметры
Возвращаемое значение
Объект Message, свойство LookupId которого соответствует переданному в объект параметру lookupId
.
Исключения
Приложение MSMQ 3.0 не установлено.
Не удалось найти сообщение с указанным параметром lookupId
.
При обращении к методу службы очереди сообщений возникла ошибка.
Комментарии
Используйте этот метод для чтения сообщения с известным идентификатором поиска, не удаляя его из очереди. Этот метод немедленно создает исключение, если сообщение отсутствует в очереди.
Свойство LookupId сообщения уникально для очереди, в которой находится сообщение, поэтому в очереди будет не более одного сообщения, соответствующего заданному lookupId
параметру.
Чтобы прочитать сообщение с указанным идентификатором поиска и удалить его из очереди, используйте ReceiveByLookupId метод .
В следующей таблице показано, доступен ли этот метод в различных режимах рабочей группы.
Режим рабочей группы | Доступно |
---|---|
Локальный компьютер | Да |
Имя локального компьютера и прямого формата | Да |
Удаленный компьютер | Нет |
Имя удаленного компьютера и прямого формата | Да |
См. также раздел
Применяется к
PeekByLookupId(MessageLookupAction, Int64)
Представлено в MSMQ 3.0. Считывает конкретное сообщение из очереди. Сообщение может быть задано кодом просмотра либо его положением относительно начала или конца очереди.
public:
System::Messaging::Message ^ PeekByLookupId(System::Messaging::MessageLookupAction action, long lookupId);
public System.Messaging.Message PeekByLookupId (System.Messaging.MessageLookupAction action, long lookupId);
member this.PeekByLookupId : System.Messaging.MessageLookupAction * int64 -> System.Messaging.Message
Public Function PeekByLookupId (action As MessageLookupAction, lookupId As Long) As Message
Параметры
- action
- MessageLookupAction
Одно из значений MessageLookupAction, задающее порядок чтения сообщения в очереди. Укажите одно из следующих значений:
MessageLookupAction.Current
: считывает сообщение, заданное параметром lookupId
.
MessageLookupAction.Next
: считывает сообщение, следующее за сообщением, заданным параметром lookupId
.
MessageLookupAction.Previous
: считывает сообщение, предшествующее сообщению, заданному параметром lookupId
.
MessageLookupAction.First
: считывает первое сообщение в очереди. Параметр lookupId
должен быть установлен равным 0.
MessageLookupAction.Last
: считывает последнее сообщение в очереди. Параметр lookupId
должен быть установлен равным 0.
- lookupId
- Int64
Свойство LookupId считываемого сообщения или значение 0. Значение, равное 0, используется при доступе к первому или последнему сообщению в очереди.
Возвращаемое значение
Объект Message, задаваемый передаваемыми параметрами action
и lookupId
.
Исключения
Приложение MSMQ 3.0 не установлено.
Не удалось найти сообщение с указанным параметром lookupId
.
При обращении к методу службы очереди сообщений возникла ошибка.
Параметр action
не является одним из членов MessageLookupAction.
Комментарии
Используйте этот метод для чтения сообщения с известным идентификатором поиска, не удаляя его из очереди. Этот метод немедленно создает исключение, если сообщение отсутствует в очереди.
Свойство LookupId сообщения уникально для очереди, в которой находится сообщение, поэтому в очереди будет не более одного сообщения, соответствующего заданному lookupId
параметру.
Чтобы прочитать сообщение с указанным идентификатором и удалить его из очереди, используйте ReceiveByLookupId метод .
В следующей таблице показано, доступен ли этот метод в различных режимах рабочей группы.
Режим рабочей группы | Доступно |
---|---|
Локальный компьютер | Да |
Имя локального компьютера и прямого формата | Да |
Удаленный компьютер | Нет |
Имя удаленного компьютера и прямого формата | Да |